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 uses 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_socket | **Optional.** Use the specified socket (has no effect if `mysql_hostname` is used).
739 mysql_ignore_auth | **Optional.** Ignore authentication failure and check for mysql connectivity only.
740 mysql_database | **Optional.** Check database with indicated name.
741 mysql_file | **Optional.** Read from the specified client options file.
742 mysql_group | **Optional.** Use a client options group.
743 mysql_username | **Optional.** Connect using the indicated username.
744 mysql_password | **Optional.** Use the indicated password to authenticate the connection.
745 mysql_check_slave | **Optional.** Check if the slave thread is running properly.
746 mysql_warning | **Optional.** Exit with WARNING status if slave server is more than INTEGER seconds behind master.
747 mysql_critical | **Optional.** Exit with CRITICAL status if slave server is more then INTEGER seconds behind master.
748 mysql_ssl | **Optional.** Use ssl encryptation.
749 mysql_cacert | **Optional.** Path to CA signing the cert.
750 mysql_cert | **Optional.** Path to SSL certificate.
751 mysql_key | **Optional.** Path to private SSL key.
752 mysql_cadir | **Optional.** Path to CA directory.
753 mysql_ciphers | **Optional.** List of valid SSL ciphers.
756 ### <a id="plugin-check-command-mysql-query"></a> mysql_query
758 The [check_mysql_query](https://www.monitoring-plugins.org/doc/man/check_mysql_query.html) plugin
759 checks a query result against threshold levels.
760 The result from the query should be numeric. For extra security, create a user with minimal access.
762 **Note**: You must specify `mysql_query_password` with an empty string to force an empty password,
763 overriding any my.cnf settings.
765 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
768 ------------------------|---------------------------------------------------------------
769 mysql_query_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
770 mysql_query_port | **Optional.** Port number (default: 3306).
771 mysql_query_database | **Optional.** Check database with indicated name.
772 mysql_query_file | **Optional.** Read from the specified client options file.
773 mysql_query_group | **Optional.** Use a client options group.
774 mysql_query_username | **Optional.** Connect using the indicated username.
775 mysql_query_password | **Optional.** Use the indicated password to authenticate the connection.
776 mysql_query_execute | **Required.** SQL Query to run on the MySQL Server.
777 mysql_query_warning | **Optional.** Exit with WARNING status if query is outside of the range (format: start:end).
778 mysql_query_critical | **Optional.** Exit with CRITICAL status if query is outside of the range.
781 ### <a id="plugin-check-command-negate"></a> negate
783 The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin
784 negates the status of a plugin (returns OK for CRITICAL and vice-versa).
785 Additional switches can be used to control which state becomes what.
787 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
790 ------------------------|---------------------------------------------------------------
791 negate_timeout | **Optional.** Seconds before plugin times out (default: 11).
792 negate_timeout_result | **Optional.** Custom result on Negate timeouts, default to UNKNOWN.
793 negate_ok | **Optional.** OK, WARNING, CRITICAL or UNKNOWN.
794 negate_warning | Numeric values are accepted.
795 negate_critical | If nothing is specified, permutes OK and CRITICAL.
796 negate_substitute | **Optional.** Substitute output text as well. Will only substitute text in CAPITALS.
797 negate_command | **Required.** Command to be negated.
798 negate_arguments | **Optional.** Arguments for the negated command.
800 ### <a id="plugin-check-command-nrpe"></a> nrpe
802 The `check_nrpe` plugin can be used to query an [NRPE](http://docs.icinga.com/latest/en/nrpe.html)
803 server or [NSClient++](https://www.nsclient.org). **Note**: This plugin
804 is considered insecure/deprecated.
806 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
809 ----------------|--------------
810 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
811 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
812 nrpe_command | **Optional.** The command that should be executed.
813 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
814 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
815 nrpe_timeout | **Optional.** The timeout in seconds.
816 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
817 nrpe_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
818 nrpe_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
821 ### <a id="plugin-check-command-nscp"></a> nscp
823 The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin
824 collects data from the [NSClient++](https://www.nsclient.org) service.
826 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
829 ----------------|--------------
830 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
831 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
832 nscp_password | **Optional.** The NSClient++ password.
833 nscp_variable | **Required.** The variable that should be checked.
834 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
835 nscp_warn | **Optional.** The warning threshold.
836 nscp_crit | **Optional.** The critical threshold.
837 nscp_timeout | **Optional.** The query timeout in seconds.
838 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
841 ### <a id="plugin-check-command-ntp-time"></a> ntp_time
843 The [check_ntp_time](https://www.monitoring-plugins.org/doc/man/check_ntp_time.html) plugin
844 checks the clock offset between the local host and a remote NTP server.
846 **Note**: If you want to monitor an NTP server, please use `ntp_peer`.
848 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
851 ----------------|--------------
852 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
853 ntp_port | **Optional.** Port number (default: 123).
854 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
855 ntp_warning | **Optional.** Offset to result in warning status (seconds).
856 ntp_critical | **Optional.** Offset to result in critical status (seconds).
857 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
858 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
859 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
860 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
863 ### <a id="plugin-check-command-ntp-peer"></a> ntp_peer
865 The [check_ntp_peer](https://www.monitoring-plugins.org/doc/man/check_ntp_peer.html) plugin
866 checks the health of an NTP server. It supports checking the offset with the sync peer, the
867 jitter and stratum. This plugin will not check the clock offset between the local host and NTP
868 server; please use `ntp_time` for that purpose.
870 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
873 ----------------|--------------
874 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
875 ntp_port | **Optional.** The port to use. Default to 123.
876 ntp_warning | **Optional.** Offset to result in warning status (seconds).
877 ntp_critical | **Optional.** Offset to result in critical status (seconds).
878 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
879 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
880 ntp_wjitter | **Optional.** Warning threshold for jitter.
881 ntp_cjitter | **Optional.** Critical threshold for jitter.
882 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
883 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
884 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
885 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
886 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
889 ### <a id="plugin-check-command-passive"></a> passive
891 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
893 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
896 ----------------|--------------
897 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
898 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
900 ### <a id="plugin-check-command-pgsql"></a> pgsql
902 The [check_pgsql](https://www.monitoring-plugins.org/doc/man/check_pgsql.html) plugin
903 tests a PostgreSQL DBMS to determine whether it is active and accepting queries.
904 If a query is specified using the `pgsql_query` attribute, it will be executed after
905 connecting to the server. The result from the query has to be numeric in order
906 to compare it against the query thresholds if set.
908 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
911 ------------------------|---------------------------------------------------------------
912 pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
913 pgsql_port | **Optional.** Port number (default: 5432).
914 pgsql_database | **Optional.** Database to check (default: template1).
915 pgsql_username | **Optional.** Login name of user.
916 pgsql_password | **Optional.** Password (BIG SECURITY ISSUE).
917 pgsql_options | **Optional.** Connection parameters (keyword = value), see below.
918 pgsql_warning | **Optional.** Response time to result in warning status (seconds).
919 pgsql_critical | **Optional.** Response time to result in critical status (seconds).
920 pgsql_timeout | **Optional.** Seconds before connection times out (default: 10).
921 pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read.
922 pgsql_query_warning | **Optional.** SQL query value to result in warning status (double).
923 pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
925 ### <a id="plugin-check-command-ping"></a> ping
927 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
928 uses the ping command to probe the specified host for packet loss (percentage) and
929 round trip average (milliseconds).
931 This command uses the host's `address` attribute if available and falls back to using
932 the `address6` attribute if the `address` attribute is not set.
934 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
937 ----------------|--------------
938 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
939 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
940 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
941 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
942 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
943 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
944 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
947 ### <a id="plugin-check-command-ping4"></a> ping4
949 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
950 uses the ping command to probe the specified host for packet loss (percentage) and
951 round trip average (milliseconds).
953 This command uses the host's `address` attribute if not explicitely specified using
954 the `ping_address` attribute.
956 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
959 ----------------|--------------
960 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
961 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
962 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
963 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
964 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
965 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
966 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
968 ### <a id="plugin-check-command-ping6"></a> ping6
970 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
971 uses the ping command to probe the specified host for packet loss (percentage) and
972 round trip average (milliseconds).
974 This command uses the host's `address6` attribute if not explicitely specified using
975 the `ping_address` attribute.
977 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
980 ----------------|--------------
981 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
982 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
983 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
984 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
985 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
986 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
987 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
990 ### <a id="plugin-check-command-pop"></a> pop
992 The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin
993 tests POP connections with the specified host (or unix socket).
995 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
998 ---------------------|--------------
999 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1000 pop_port | **Optional.** The port that should be checked. Defaults to 110.
1001 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.
1002 pop_send | **Optional.** String to send to the server.
1003 pop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1004 pop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1005 pop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1006 pop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1007 pop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1008 pop_jail | **Optional.** Hide output from TCP socket.
1009 pop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1010 pop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1011 pop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1012 pop_ssl | **Optional.** Use SSL for the connection.
1013 pop_warning | **Optional.** Response time to result in warning status (seconds).
1014 pop_critical | **Optional.** Response time to result in critical status (seconds).
1015 pop_timeout | **Optional.** Seconds before connection times out (default: 10).
1016 pop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1017 pop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1020 ### <a id="plugin-check-command-processes"></a> procs
1022 The [check_procs](https://www.monitoring-plugins.org/doc/man/check_procs.html) plugin
1023 checks all processes and generates WARNING or CRITICAL states if the specified
1024 metric is outside the required threshold ranges. The metric defaults to number
1025 of processes. Search filters can be applied to limit the processes to check.
1027 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1030 ---------------------|--------------
1031 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
1032 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
1033 procs_metric | **Optional.** Check thresholds against metric.
1034 procs_timeout | **Optional.** Seconds before plugin times out.
1035 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
1036 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
1037 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
1038 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
1039 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
1040 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
1041 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
1042 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
1043 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
1044 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
1045 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
1048 ### <a id="plugin-check-command-radius"></a> radius
1050 The [check_radius](https://www.monitoring-plugins.org/doc/man/check_radius.html) plugin
1051 checks a RADIUS server to see if it is accepting connections. The server to test
1052 must be specified in the invocation, as well as a user name and password. A configuration
1053 file may also be present. The format of the configuration file is described in the
1054 radiusclient library sources. The password option presents a substantial security
1055 issue because the password can possibly be determined by careful watching of the
1056 command line in a process listing. This risk is exacerbated because the plugin will
1057 typically be executed at regular predictable intervals. Please be sure that the
1058 password used does not allow access to sensitive system resources.
1061 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1064 -------------------|--------------
1065 radius_address | **Optional.** The radius server's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1066 radius_config_file | **Required.** The radius configuration file.
1067 radius_username | **Required.** The radius username to test.
1068 radius_password | **Required.** The radius password to test.
1069 radius_port | **Optional.** The radius port number (default 1645).
1070 radius_nas_id | **Optional.** The NAS identifier.
1071 radius_nas_address | **Optional.** The NAS IP address.
1072 radius_expect | **Optional.** The response string to expect from the server.
1073 radius_retries | **Optional.** The number of times to retry a failed connection.
1074 radius_timeout | **Optional.** The number of seconds before connection times out (default: 10).
1077 ### <a id="plugin-check-command-simap"></a> simap
1079 The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
1080 tests SIMAP connections with the specified host (or unix socket).
1082 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1085 -----------------------|--------------
1086 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1087 simap_port | **Optional.** The port that should be checked. Defaults to 993.
1088 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.
1089 simap_send | **Optional.** String to send to the server.
1090 simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1091 simap_all | **Optional.** All expect strings need to occur in server response. Default is any.
1092 simap_quit | **Optional.** String to send server to initiate a clean close of the connection.
1093 simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1094 simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1095 simap_jail | **Optional.** Hide output from TCP socket.
1096 simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1097 simap_delay | **Optional.** Seconds to wait between sending string and polling for response.
1098 simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1099 simap_ssl | **Optional.** Use SSL for the connection.
1100 simap_warning | **Optional.** Response time to result in warning status (seconds).
1101 simap_critical | **Optional.** Response time to result in critical status (seconds).
1102 simap_timeout | **Optional.** Seconds before connection times out (default: 10).
1103 simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1104 simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1106 ### <a id="plugin-check-command-smart"></a> smart
1108 The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
1109 checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
1111 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1114 ----------------|--------------
1115 smart_device | **Required.** The name of a local hard drive to monitor.
1118 ### <a id="plugin-check-command-smtp"></a> smtp
1120 The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
1121 will attempt to open an SMTP connection with the host.
1123 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1126 ----------------------|--------------
1127 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1128 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
1129 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
1130 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
1131 smtp_command | **Optional.** SMTP command (may be used repeatedly).
1132 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
1133 smtp_helo_fqdn | **Optional.** FQDN used for HELO
1134 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1135 smtp_starttls | **Optional.** Use STARTTLS for the connection.
1136 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
1137 smtp_authuser | **Optional.** SMTP AUTH username.
1138 smtp_authpass | **Optional.** SMTP AUTH password.
1139 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
1140 smtp_warning | **Optional.** Response time to result in warning status (seconds).
1141 smtp_critical | **Optional.** Response time to result in critical status (seconds).
1142 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1143 smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1144 smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1147 ### <a id="plugin-check-command-snmp"></a> snmp
1149 The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin
1150 checks the status of remote machines and obtains system information via SNMP.
1152 **Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
1154 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1157 --------------------|--------------
1158 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1159 snmp_oid | **Required.** The SNMP OID.
1160 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1161 snmp_port | **Optional.** The SNMP port. Defaults to "161".
1162 snmp_retries | **Optional.** Number of retries to be used in the SNMP requests.
1163 snmp_warn | **Optional.** The warning threshold.
1164 snmp_crit | **Optional.** The critical threshold.
1165 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
1166 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
1167 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
1168 snmp_label | **Optional.** Prefix label for output value
1169 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
1170 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1171 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
1172 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
1173 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1174 snmp_rate | **Optional.** Boolean. Enable rate calculation.
1175 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
1176 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1178 ### <a id="plugin-check-command-snmpv3"></a> snmpv3
1180 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1181 plugin, using SNMPv3 authentication and encryption options.
1183 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1186 ---------------------|--------------
1187 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1188 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
1189 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
1190 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
1191 snmpv3_user | **Required.** The username to log in with.
1192 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
1193 snmpv3_priv_key | **Required.** The encryption key.
1194 snmpv3_oid | **Required.** The SNMP OID.
1195 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
1196 snmpv3_warn | **Optional.** The warning threshold.
1197 snmpv3_crit | **Optional.** The critical threshold.
1198 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
1199 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
1200 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
1201 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
1202 snmpv3_label | **Optional.** Prefix label for output value.
1203 snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1204 snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1205 snmpv3_rate | **Optional.** Boolean. Enable rate calculation.
1206 snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1208 ### <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
1210 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1211 plugin, using the uptime OID by default.
1213 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1216 ----------------|--------------
1217 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1218 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
1219 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1222 ### <a id="plugin-check-command-spop"></a> spop
1224 The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
1225 tests SPOP connections with the specified host (or unix socket).
1227 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1230 ----------------------|--------------
1231 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1232 spop_port | **Optional.** The port that should be checked. Defaults to 995.
1233 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.
1234 spop_send | **Optional.** String to send to the server.
1235 spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1236 spop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1237 spop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1238 spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1239 spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1240 spop_jail | **Optional.** Hide output from TCP socket.
1241 spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1242 spop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1243 spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1244 spop_ssl | **Optional.** Use SSL for the connection.
1245 spop_warning | **Optional.** Response time to result in warning status (seconds).
1246 spop_critical | **Optional.** Response time to result in critical status (seconds).
1247 spop_timeout | **Optional.** Seconds before connection times out (default: 10).
1248 spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1249 spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1252 ### <a id="plugin-check-command-ssh"></a> ssh
1254 The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
1255 connects to an SSH server at a specified host and port.
1257 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1260 ----------------|--------------
1261 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1262 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
1263 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1264 ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1265 ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1268 ### <a id="plugin-check-command-ssl"></a> ssl
1270 Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
1271 using ssl-related options.
1273 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1276 ------------------------------|--------------
1277 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1278 ssl_port | **Required.** The port that should be checked.
1279 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
1280 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.
1281 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.
1282 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$".
1285 ### <a id="plugin-check-command-ssmtp"></a> ssmtp
1287 The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
1288 tests SSMTP connections with the specified host (or unix socket).
1290 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1293 -----------------------|--------------
1294 ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1295 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
1296 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.
1297 ssmtp_send | **Optional.** String to send to the server.
1298 ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1299 ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any.
1300 ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1301 ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1302 ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1303 ssmtp_jail | **Optional.** Hide output from TCP socket.
1304 ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1305 ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1306 ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1307 ssmtp_ssl | **Optional.** Use SSL for the connection.
1308 ssmtp_warning | **Optional.** Response time to result in warning status (seconds).
1309 ssmtp_critical | **Optional.** Response time to result in critical status (seconds).
1310 ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1311 ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1312 ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1315 ### <a id="plugin-check-command-swap"></a> swap
1317 The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
1318 checks the swap space on a local machine.
1320 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1323 ----------------|--------------
1324 swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`.
1325 swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`.
1326 swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
1327 swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false.
1328 swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".
1331 ### <a id="plugin-check-command-tcp"></a> tcp
1333 The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
1334 tests TCP connections with the specified host (or unix socket).
1336 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1339 ----------------|--------------
1340 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1341 tcp_port | **Required.** The port that should be checked.
1342 tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1343 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
1344 tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
1345 tcp_send | **Optional.** String to send to the server.
1346 tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
1347 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1348 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
1349 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
1350 tcp_jail | **Optional.** Hide output from TCP socket.
1351 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1352 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1353 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.
1354 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
1355 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
1356 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
1357 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1358 tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1359 tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1362 ### <a id="plugin-check-command-udp"></a> udp
1364 The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
1365 tests UDP connections with the specified host (or unix socket).
1367 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1370 ----------------|--------------
1371 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1372 udp_port | **Required.** The port that should be checked.
1373 udp_send | **Required.** The payload to send in the UDP datagram.
1374 udp_expect | **Required.** The payload to expect in the response datagram.
1375 udp_quit | **Optional.** The payload to send to 'close' the session.
1376 udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1377 udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1380 ### <a id="plugin-check-command-ups"></a> ups
1382 The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin
1383 tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
1384 must be running for this plugin to work.
1386 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1389 ----------------|--------------
1390 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1391 ups_name | **Required.** The UPS name. Defaults to `ups`.
1392 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
1393 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`.
1394 ups_warning | **Optional.** The warning threshold for the selected variable.
1395 ups_critical | **Optional.** The critical threshold for the selected variable.
1396 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
1397 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
1400 ### <a id="plugin-check-command-users"></a> users
1402 The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin
1403 checks the number of users currently logged in on the local system and generates an
1404 error if the number exceeds the thresholds specified.
1406 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1409 ----------------|--------------
1410 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
1411 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
1413 ## <a id="windows-plugins"></a> Windows Plugins for Icinga 2
1415 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.
1417 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:
1419 include <windows-plugins>
1421 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.
1424 ### <a id="windows-plugins-thresholds"></a> Threshold syntax
1426 So not specified differently the thresholds for the plugins all follow the same pattern
1429 :------------|:----------
1430 "29" | The threshold is 29.
1431 "!29" | The threshold is 29, but the negative of the result is returned.
1432 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
1433 "![10-40]" | Same as above, but the result is inverted.
1436 ### <a id="windows-plugins-disk-windows"></a> disk-windows
1438 Check command object for the `check_disk.exe` plugin.
1439 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.).
1444 :-------------------|:------------
1445 disk\_win\_warn | **Optional**. The warning threshold.
1446 disk\_win\_crit | **Optional**. The critical threshold.
1447 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1448 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.
1449 disk\_win\_exclude | **Optional**. Exclude these drives from check.
1451 ### <a id="windows-plugins-load-windows"></a> load-windows
1453 Check command object for the `check_load.exe` plugin.
1454 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).
1459 :---------------|:------------
1460 load\_win\_warn | **Optional**. The warning threshold.
1461 load\_win\_crit | **Optional**. The critical threshold.
1464 ### <a id="windows-plugins-memory-windows"></a> memory-windows
1466 Check command object for the `check_memory.exe` plugin.
1467 The memory collection is instant.
1471 > Percentage based thresholds can be used by adding a '%' to the threshold
1472 > value. Keep in mind that memory\_win\_unit is applied before the
1473 > value is calculated.
1478 :-----------------|:------------
1479 memory\_win\_warn | **Optional**. The warning threshold.
1480 memory\_win\_crit | **Optional**. The critical threshold.
1481 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.
1484 ### <a id="windows-plugins-network-windows"></a> network-windows
1486 Check command object for the `check_network.exe` plugin.
1487 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).
1492 :-------------------|:------------
1493 network\_win\_warn | **Optional**. The warning threshold.
1494 network\_win\_crit | **Optional**. The critical threshold.
1495 network\_no\_isatap | **Optional**. Do not print ISATAP interfaces.
1498 ### <a id="windows-plugins-perfmon-windows"></a> perfmon-windows
1500 Check command object for the `check_perfmon.exe` plugin.
1501 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`.
1503 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"`
1508 :---------------------|:------------
1509 perfmon\_win\_warn | **Optional**. The warning threshold.
1510 perfmon\_win\_crit | **Optional**. The critical threshold.
1511 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1512 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1513 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
1514 perfmon\_win\_syntax | **Optional**. Use this in the performance output instead of `perfmon\_win\_counter`. Exists for graphice compatibility reasons.
1517 ### <a id="windows-plugins-ping-windows"></a> ping-windows
1519 Check command object for the `check_ping.exe` plugin.
1520 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.
1525 :------------------|:------------
1526 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma.
1527 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma.
1528 ping\_win\_address | **Required**. An IPv4 or IPv6 address
1529 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1530 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1533 ### <a id="windows-plugins-procs-windows"></a> procs-windows
1535 Check command object for `check_procs.exe` plugin.
1536 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.
1541 :----------------|:------------
1542 procs\_win\_warn | **Optional**. The warning threshold.
1543 procs\_win\_crit | **Optional**. The critical threshold.
1544 procs\_win\_user | **Optional**. Count this useres processes.
1547 ### <a id="windows-plugins-service-windows"></a> service-windows
1549 Check command object for `check_service.exe` plugin.
1550 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.
1555 :---------------------|:------------
1556 service\_win\_warn | **Optional**. Warn when service is not running.
1557 service\_win\_service | **Required**. The critical threshold.
1560 ### <a id="windows-plugins-swap-windows"></a> swap-windows
1562 Check command object for `check_swap.exe` plugin.
1563 The data collection is instant.
1568 :---------------|:------------
1569 swap\_win\_warn | **Optional**. The warning threshold.
1570 swap\_win\_crit | **Optional**. The critical threshold.
1571 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1574 ### <a id="windows-plugins-update-windows"></a> update-windows
1576 Check command object for `check_update.exe` plugin.
1577 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.
1581 > The Network Services Account which runs Icinga 2 by default does not have the required
1582 > permissions to run this check.
1587 :-------------------|:------------
1588 update\_win\_warn | If set, returns warning when important updates are available
1589 update\_win\_crit | If set, return critical when important updates that require a reboot are available.
1590 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1593 ### <a id="windows-plugins-uptime-windows"></a> uptime-windows
1595 Check command opject for `check_uptime.exe` plugin.
1596 Uses GetTickCount64 to get the uptime, so boot time is not included.
1601 :-----------------|:------------
1602 uptime\_win\_warn | **Optional**. The warning threshold.
1603 uptime\_win\_crit | **Optional**. The critical threshold.
1604 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).
1607 ### <a id="windows-plugins-users-windows"></a> users-windows
1609 Check command object for `check_users.exe` plugin.
1614 :----------------|:------------
1615 users\_win\_warn | **Optional**. The warning threshold.
1616 users\_win\_crit | **Optional**. The critical threshold.
1619 ## <a id="nscp-plugin-check-commands"></a> Plugin Check Commands for NSClient++
1621 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1623 You can enable these check commands by adding the following the include directive in your
1624 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1628 You can also optionally specify an alternative installation directory for NSClient++ by adding
1629 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1632 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1634 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1635 not be necessary to manually set this constant.
1637 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1639 ### <a id="nscp-check-local"></a> nscp-local
1641 Check command object for NSClient++
1643 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1646 ----------------|--------------
1647 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1648 nscp_load_all | **Optional.** Whether to load all modules. Defaults to false.
1649 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`.
1650 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1651 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1652 nscp_arguments | **Optional.** An array of query arguments.
1653 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1655 ### <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1657 Check command object for the `check_cpu` NSClient++ plugin.
1660 --------------------|------------------
1661 nscp_cpu_time | **Optional.** Calculate avarage usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1662 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1663 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1664 nscp_cpu_arguments | **Optional.** Additional arguments.
1665 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1667 ### <a id="nscp-check-local-memory"></a> nscp-local-memory
1669 Check command object for the `check_memory` NSClient++ plugin.
1672 ----------------------|------------------
1673 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1674 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1675 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1676 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolut (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1677 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolut (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1678 nscp_memory_arguments | **Optional.** Additional arguments.
1679 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1681 ### <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1683 Check command object for the `check_os_version` NSClient++ plugin.
1685 This command has the same custom attributes like the `nscp-local` check command.
1687 ### <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1689 Check command object for the `check_pagefile` NSClient++ plugin.
1691 This command has the same custom attributes like the `nscp-local` check command.
1693 ### <a id="nscp-check-local-process"></a> nscp-local-process
1695 Check command object for the `check_process` NSClient++ plugin.
1697 This command has the same custom attributes like the `nscp-local` check command.
1699 ### <a id="nscp-check-local-service"></a> nscp-local-service
1701 Check command object for the `check_service` NSClient++ plugin.
1704 -----------------------|------------------
1705 nscp_service_name | **Required.** Name of service to check.
1706 nscp_service_type | **Optional.** Type to check, default to state.
1707 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1708 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1709 nscp_service_warning | **Optional.** State for return an WARNING.
1710 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1711 nscp_service_critical | **Optional.** State for return an CRITICAL.
1712 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1713 nscp_service_arguments | **Optional.** Additional arguments.
1714 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1716 ### <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1718 Check command object for the `check_uptime` NSClient++ plugin.
1720 This command has the same custom attributes like the `nscp-local` check command.
1722 ### <a id="nscp-check-local-version"></a> nscp-local-version
1724 Check command object for the `check_version` NSClient++ plugin.
1726 This command has the same custom attributes like the `nscp-local` check command.
1727 In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
1729 ### <a id="nscp-check-local-disk"></a> nscp-local-disk
1731 Check command object for the `check_drivesize` NSClient++ plugin.
1734 -----------------------|------------------
1735 nscp_disk_drive | **Optional.** Drive character, default to all drives.
1736 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1737 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolut (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1738 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolut (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1739 nscp_disk_arguments | **Optional.** Additional arguments.
1740 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1741 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`.
1743 ### <a id="nscp-check-local-counter"></a> nscp-local-counter
1745 Check command object for the `check_pdh` NSClient++ plugin.
1748 -----------------------|------------------
1749 nscp_counter_name | **Required.** Performance counter name.
1750 nscp_counter_warning | **Optional.** WARNING Threshold.
1751 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1752 nscp_counter_arguments | **Optional.** Additional arguments.
1753 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1754 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1758 ## <a id="snmp-manubulon-plugin-check-commands"></a> Plugin Check Commands for Manubulon SNMP
1760 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1761 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1763 **Note:** Some plugin parameters are only available in Debian packages or in a
1764 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1766 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1767 is set to the path where the Manubublon SNMP plugins are installed.
1769 You can enable these plugin check commands by adding the following the include directive in your
1770 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1774 ### Checks by Host Type
1776 **N/A** : Not available for this type.
1778 **SNMP** : Available for simple SNMP query.
1782 **Specific** : Script name for platform specific checks.
1785 Host type | Interface | storage | load/cpu | mem | process | env | specific
1786 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1787 Linux | Yes | Yes | Yes | Yes | Yes | No |
1788 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1789 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1790 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1791 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1792 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1793 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1794 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1795 AS400 | Yes | Yes | Yes | Yes | No | No |
1796 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1797 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1798 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1799 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1802 ### <a id="plugin-check-command-snmp-load"></a> snmp-load
1804 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1806 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1810 ------------------------|--------------
1811 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1812 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1813 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1814 snmp_port | **Optional.** The SNMP port connection.
1815 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1816 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1817 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1818 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1819 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1820 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1821 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1822 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1823 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1824 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1825 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.
1826 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1827 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1829 ### <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1831 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1833 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1836 ------------------------|--------------
1837 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1838 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1839 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1840 snmp_port | **Optional.** The SNMP port connection.
1841 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1842 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1843 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1844 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1845 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1846 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1847 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1848 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1849 snmp_warn | **Optional.** The warning threshold.
1850 snmp_crit | **Optional.** The critical threshold.
1851 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1852 snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
1853 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1854 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1856 ### <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1858 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1860 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1863 ------------------------|--------------
1864 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1865 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1866 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1867 snmp_port | **Optional.** The SNMP port connection.
1868 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1869 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1870 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1871 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1872 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1873 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1874 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1875 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1876 snmp_warn | **Optional.** The warning threshold.
1877 snmp_crit | **Optional.** The critical threshold.
1878 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1879 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1880 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1882 ### <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1884 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1886 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1889 ----------------------------|--------------
1890 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1891 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1892 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1893 snmp_port | **Optional.** The SNMP port connection.
1894 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1895 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1896 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1897 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1898 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1899 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1900 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1901 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1902 snmp_warn | **Optional.** The warning threshold.
1903 snmp_crit | **Optional.** The critical threshold.
1904 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1905 snmp_interface_inverse | **Optional.** Inverse Interface check, down is ok. Defaults to false as it is missing.
1906 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1907 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
1908 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.
1909 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1910 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1911 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.
1912 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1913 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1914 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1915 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1916 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.
1917 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name.
1918 snmp_interface_ifalias | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name.
1919 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1920 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1922 ### <a id="plugin-check-command-snmp-process"></a> snmp-process
1924 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1926 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1929 ------------------------|--------------
1930 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1931 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1932 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1933 snmp_port | **Optional.** The SNMP port connection.
1934 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1935 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1936 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1937 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1938 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1939 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1940 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1941 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1942 snmp_warn | **Optional.** The warning threshold.
1943 snmp_crit | **Optional.** The critical threshold.
1944 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1945 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1946 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1947 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.
1951 ## <a id="plugin-contrib"></a> Contributed Plugin Check Commands
1953 The contributed Plugin Check Commands provides various additional command definitions
1954 contributed by community members.
1956 These check commands assume that the global constant named `PluginContribDir`
1957 is set to the path where the user installs custom plugins and can be enabled by
1958 uncommenting the corresponding line in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf):
1961 vim /etc/icinga2/icinga2.conf
1963 include <plugin-contrib>
1966 This is enabled by default since Icinga 2 2.5.0.
1968 ### <a id="plugin-contrib-databases"></a> Databases
1970 This category contains plugins for various database servers.
1972 #### <a id="plugin-contrib-command-db2_health"></a> db2_health
1974 The [check_db2_health](https://labs.consol.de/nagios/check_db2_health/) plugin
1975 uses the `DBD::DB2` Perl library to monitor a [DB2](https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/)
1978 The Git repository is located on [GitHub](https://github.com/lausser/check_db2_health).
1980 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1983 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1984 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)
1985 db2_health_username | **Optional.** The username for the database connection.
1986 db2_health_password | **Optional.** The password for the database connection.
1987 db2_health_port | **Optional.** The port where DB2 is listening.
1988 db2_health_warning | **Optional.** The warning threshold depending on the mode.
1989 db2_health_critical | **Optional.** The critical threshold depending on the mode.
1990 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
1991 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).
1992 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.
1993 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.
1994 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
1995 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".
1996 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
1997 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
1998 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
1999 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".
2000 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
2002 #### <a id="plugin-contrib-command-mssql_health"></a> mssql_health
2004 The [check_mssql_health](https://labs.consol.de/nagios/check_mssql_health/index.html) plugin
2005 uses the `DBD::Sybase` Perl library based on [FreeTDS](http://www.freetds.org/) to monitor a
2006 [MS SQL](https://www.microsoft.com/en-us/sql-server/) server.
2008 The Git repository is located on [GitHub](https://github.com/lausser/check_mssql_health).
2010 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2013 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2014 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
2015 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
2016 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
2017 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
2018 mssql_health_username | **Optional.** The username for the database connection.
2019 mssql_health_password | **Optional.** The password for the database connection.
2020 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
2021 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
2022 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
2023 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).
2024 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
2025 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.
2026 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
2027 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".
2028 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
2029 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
2030 mssql_health_notemp | **Optional.** Set this to true to ignore temporary databases/tablespaces. Defaults to false.
2031 mssql_health_nooffline | **Optional.** Set this to true to ignore offline databases. Defaults to false.
2032 mssql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates.
2034 #### <a id="plugin-contrib-command-mysql_health"></a> mysql_health
2036 The [check_mysql_health](https://labs.consol.de/nagios/check_mysql_health/index.html) plugin
2037 uses the `DBD::MySQL` Perl library to monitor a
2038 [MySQL](https://dev.mysql.com/downloads/mysql/) or [MariaDB](https://mariadb.org/about/) database.
2040 The Git repository is located on [GitHub](https://github.com/lausser/check_mysql_health).
2042 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2045 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2046 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
2047 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
2048 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
2049 mysql_health_username | **Optional.** The username for the database connection.
2050 mysql_health_password | **Optional.** The password for the database connection.
2051 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
2052 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
2053 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
2054 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
2055 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
2056 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
2057 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
2058 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::* module.
2059 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
2060 mysql_health_nooffline | **Optional.** Skip the offline databases.
2061 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
2062 mysql_health_name | **Optional.** The name of a specific component to check.
2063 mysql_health_name2 | **Optional.** The secondary name of a component.
2064 mysql_health_name3 | **Optional.** The tertiary name of a component.
2065 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".
2066 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2067 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2068 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components"
2069 mysql_health_mitigation | **Optional.** "The parameter allows you to change a critical error to a warning."
2070 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates."
2071 mysql_health_environment | **Optional.** Add a variable to the plugin's environment."
2072 mysql_health_morphmessage | **Optional.** Modify the final output message."
2073 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels."
2074 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data."
2075 mysql_health_report | **Optional.** Can be used to shorten the output."
2076 mysql_health_multiline | **Optional.** Multiline output."
2077 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical."
2078 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory."
2079 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files."
2080 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time."
2081 mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2083 #### <a id="plugin-contrib-command-oracle_health"></a> oracle_health
2085 The [check_oracle_health](https://labs.consol.de/nagios/check_oracle_health/index.html) plugin
2086 uses the `DBD::Oracle` Perl library to monitor an [Oracle](https://www.oracle.com/database/) database.
2088 The Git repository is located on [GitHub](https://github.com/lausser/check_oracle_health).
2090 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2093 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2094 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2095 oracle_health_username | **Optional.** The username for the database connection.
2096 oracle_health_password | **Optional.** The password for the database connection.
2097 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2098 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2099 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2100 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2101 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.
2102 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.
2103 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2104 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".
2105 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2106 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2107 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2108 oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2109 oracle_health_report | **Optional.** Select the plugin output format. Can be short or long. Default to long.
2114 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2115 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".
2116 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".
2118 #### <a id="plugin-contrib-command-postgres"></a> postgres
2120 The [check_postgres](https://bucardo.org/wiki/Check_postgres) plugin
2121 uses the `psql` binary to monitor a [PostgreSQL](https://www.postgresql.org/about/) database.
2123 The Git repository is located on [GitHub](https://github.com/bucardo/check_postgres).
2125 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2128 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2129 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.
2130 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2131 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2132 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2133 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2134 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2135 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2136 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2137 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2138 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2139 postgres_includeuser | **Optional.** Include objects owned by certain users.
2140 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2141 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
2142 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2143 postgres_action | **Required.** Determines the test executed.
2144 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2145 postgres_query | **Optional.** Query for "custom_query" action.
2146 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2147 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2148 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).
2150 #### <a id="plugin-contrib-command-mongodb"></a> mongodb
2152 The [check_mongodb.py](https://github.com/mzupan/nagios-plugin-mongodb) plugin
2153 uses the `pymongo` Python library to monitor a [MongoDB](https://docs.mongodb.com/manual/) instance.
2155 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2158 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2159 mongodb_host | **Required.** Specifies the hostname or address.
2160 mongodb_port | **Required.** The port mongodb is runnung on.
2161 mongodb_user | **Optional.** The username you want to login as
2162 mongodb_passwd | **Optional.** The password you want to use for that user
2163 mongodb_warning | **Optional.** The warning threshold we want to set
2164 mongodb_critical | **Optional.** The critical threshold we want to set
2165 mongodb_action | **Required.** The action you want to take
2166 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
2167 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
2168 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
2169 mongodb_database | **Optional.** Specify the database to check
2170 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
2171 mongodb_ssl | **Optional.** Connect using SSL
2172 mongodb_replicaset | **Optional.** Connect to replicaset
2173 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check
2174 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second
2175 mongodb_collection | **Optional.** Specify the collection to check
2176 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
2178 #### <a id="plugin-contrib-command-elasticsearch"></a> elasticsearch
2180 The [check_elasticsearch](https://github.com/anchor/nagios-plugin-elasticsearch) plugin
2181 uses the HTTP API to monitor an [Elasticsearch](https://www.elastic.co/products/elasticsearch) node.
2183 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2186 -----------------------------|-------------------------------------------------------------------------------------------------------
2187 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2188 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
2189 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.
2190 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2191 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2192 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2194 #### <a id="plugin-contrib-command-redis"></a> redis
2196 The [check_redis.pl](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl) plugin
2197 uses the `Redis` Perl library to monitor a [Redis](https://redis.io/) instance. The plugin can
2198 measure response time, hitrate, memory utilization, check replication synchronization, etc. It is
2199 also possible to test data in a specified key and calculate averages or summaries on ranges.
2201 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2204 -------------------------|--------------------------------------------------------------------------------------------------------------
2205 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
2206 redis_port | **Optional.** Port number to query. Default to "6379".
2207 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2208 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2209 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2210 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2211 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2212 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.
2213 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.
2214 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.
2215 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2216 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.
2217 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".
2218 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2219 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2220 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.
2221 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2222 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.
2223 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2224 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2227 ### <a id="plugin-contrib-hardware"></a> Hardware
2229 This category includes all plugin check commands for various hardware checks.
2231 #### <a id="plugin-contrib-command-hpasm"></a> hpasm
2233 The [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) plugin
2234 monitors the hardware health of HP Proliant Servers, provided that the `hpasm`
2235 (HP Advanced Server Management) software is installed. It is also able to monitor
2236 the system health of HP Bladesystems and storage systems.
2238 The plugin can run in two different ways:
2240 1. Local execution using the `hpasmcli` command line tool.
2241 2. Remote SNMP query which invokes the HP Insight Tools on the remote node.
2243 You can either set or omit `hpasm_hostname` custom attribute and select the corresponding node.
2245 The `hpasm_remote` attribute enables the plugin to execute remote SNMP queries if set to `true`.
2246 For compatibility reasons this attribute uses `true` as default value, and ensures that
2247 specifying the `hpasm_hostname` always enables remote checks.
2249 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2252 --------------------------------|-----------------------------------------------------------------------
2253 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2254 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2255 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2256 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2257 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2258 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2259 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2260 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2261 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.
2262 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.
2263 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2264 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2265 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2266 hpasm_privpassword | **Optional.** The password for authPriv security level.
2267 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2268 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2269 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.
2270 hpasm_remote | **Optional.** Run remote SNMP checks if enabled. Otherwise checks are executed locally using the `hpasmcli` binary. Defaults to `true`.
2272 #### <a id="plugin-contrib-command-adaptec-raid"></a> adaptec-raid
2274 The [check_adaptec_raid](https://github.com/thomas-krenn/check_adaptec_raid) plugin
2275 uses the `arcconf` binary to monitor Adaptec RAID controllers.
2277 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2280 --------------------------------|-----------------------------------------------------------------------
2281 adaptec_controller_number | **Required.** Controller number to monitor.
2282 arcconf_path | **Required.** Path to the `arcconf` binary, e.g. "/sbin/arcconf".
2284 #### <a id="plugin-contrib-command-lsi-raid"></a> lsi-raid
2286 The [check_lsi_raid](https://github.com/thomas-krenn/check_lsi_raid) plugin
2287 uses the `storcli` binary to monitor MegaRAID RAID controllers.
2289 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2292 --------------------------------|-----------------------------------------------------------------------
2293 lsi_controller_number | **Required.** Controller number to monitor.
2294 storcli_path | **Required.** Path to the `storcli` binary, e.g. "/usr/sbin/storcli".
2296 #### <a id="plugin-contrib-command-smart-attributes"></a> smart-attributes
2298 The [check_smart_attributes](https://github.com/thomas-krenn/check_smart_attributes) plugin
2299 uses the `smartctl` binary to monitor SMART values of SSDs and HDDs.
2301 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2304 --------------------------------|-----------------------------------------------------------------------
2305 smart_attributes_config_path | **Required.** Path to the smart attributes config file (e.g. check_smartdb.json).
2306 smart_attributes_device | **Required.** Device name (e.g. /dev/sda) to monitor.
2309 ### <a id="plugin-contrib-icingacli"></a> IcingaCLI
2311 This category includes all plugins using the icingacli provided by Icinga Web 2.
2313 #### <a id="plugin-contrib-icingacli-businessprocess"></a> Business Process
2315 This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process)
2316 and executed as `icingacli businessprocess` CLI command.
2318 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2321 ------------------------------------------|-----------------------------------------------------------------------------------------
2322 icingacli_businessprocess_process | **Required.** Business process to monitor.
2323 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2324 icingacli_businessprocess_details | **Optional.** Get details for root cause analysis. Defaults to false.
2325 icingacli_businessprocess_statetype | **Optional.** Define which state type to look at, `soft` or `hard`. Overrides the default value inside the businessprocess module, if configured.
2328 ### <a id="plugin-contrib-ipmi"></a> IPMI Devices
2330 This category includes all plugins for IPMI devices.
2332 #### <a id="plugin-contrib-command-ipmi-sensor"></a> ipmi-sensor
2334 The [check_ipmi_sensor](https://github.com/thomas-krenn/check_ipmi_sensor_v3) plugin
2335 uses the `ipmimonitoring` binary to monitor sensor data for IPMI devices. Please
2336 read the [documentation](https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin)
2337 for installation and configuration details.
2339 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2342 ---------------------------------|-----------------------------------------------------------------------------------------------------
2343 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2344 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2345 ipmi_username | **Optional.** The IPMI username.
2346 ipmi_password | **Optional.** The IPMI password.
2347 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2348 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2349 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2350 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.
2351 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2352 ipmi_exclude_sensor | **Optional.** Exclude sensor based on IPMI sensor type. (Comma-separated)
2353 ipmi_exclude_sel | **Optional.** Exclude SEL entries of specific sensor types. (comma-separated list).
2354 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2355 ipmi_protocol_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2356 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2357 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2358 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2359 ipmi_verbose | **Optional.** Be Verbose multi line output, also with additional details for warnings.
2360 ipmi_debug | **Optional.** Be Verbose debugging output, followed by normal multi line output.
2362 #### <a id="plugin-contrib-command-ipmi-alive"></a> ipmi-alive
2364 The `ipmi-alive` check commands allows you to create a ping check for the IPMI Interface.
2366 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2369 ---------------------------------|-----------------------------------------------------------------------------------------------------
2370 ping_address | **Optional.** The address of the IPMI interface. Defaults to "$address$" if the IPMI interface's `address` attribute is set, "$address6$" otherwise.
2371 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 5000.
2372 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 100.
2373 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
2374 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
2375 ping_packets | **Optional.** The number of packets to send. Defaults to 1.
2376 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
2379 ### <a id="plugins-contrib-log-management"></a> Log Management
2381 This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
2383 #### <a id="plugins-contrib-command-logstash"></a> logstash
2385 The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
2386 the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
2388 The Node API is not activated by default. You have to configure your Logstash
2389 installation in order to allow plugin connections.
2392 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2393 logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
2394 logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
2395 logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
2396 logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
2397 logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
2398 logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
2399 logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
2400 logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
2401 logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
2402 logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
2405 ### <a id="plugin-contrib-metrics"></a> Metrics
2407 This category includes all plugins for metric-based checks.
2409 #### <a id="plugin-contrib-command-graphite"></a> graphite
2411 The [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin
2412 uses the `rest-client` Ruby library to monitor a [Graphite](https://graphiteapp.org) instance.
2414 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2417 ------------------------------------|-----------------------------------------------------------------------------------------------------
2418 graphite_url | **Required.** Target url.
2419 graphite_metric | **Required.** Metric path string.
2420 graphite_shortname | **Optional.** Metric short name (used for performance data).
2421 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2422 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2423 graphite_warning | **Required.** Warning threshold.
2424 graphite_critical | **Required.** Critical threshold.
2425 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.
2426 graphite_message | **Optional.** Text message to output (default: "metric count:").
2427 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2428 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2430 ### <a id="plugin-contrib-network-components"></a> Network Components
2432 This category includes all plugins for various network components like routers, switches and firewalls.
2434 #### <a id="plugin-contrib-command-interfacetable"></a> interfacetable
2436 The [check_interfacetable_v3t](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) plugin
2437 generates a html page containing information about the monitored node and all of its interfaces.
2439 The Git repository is located on [GitHub](https://github.com/Tontonitch/interfacetable_v3t).
2441 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2444 ------------------------------------|-----------------------------------------------------------------------------------------------------
2445 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2446 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2447 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2448 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2449 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2450 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2451 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2452 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2453 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2454 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2455 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2456 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2457 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.
2458 interfacetable_trackproperty | **Optional.** List of tracked properties.
2459 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2460 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2461 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
2462 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
2463 interfacetable_login | **Optional.** Login for snmpv3 authentication.
2464 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
2465 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
2466 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
2467 interfacetable_domain | **Optional.** SNMP transport domain.
2468 interfacetable_contextname | **Optional.** Context name for the snmp requests.
2469 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
2470 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
2471 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
2472 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
2473 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
2474 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.
2475 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
2476 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
2477 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
2478 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
2479 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
2480 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
2481 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
2482 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
2483 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
2484 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".
2485 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
2486 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
2487 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"
2488 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
2489 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
2490 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.
2491 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.
2492 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
2493 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
2494 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
2495 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
2496 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
2497 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
2498 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
2499 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
2500 interfacetable_config | **Optional.** Specify a config file to load.
2501 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
2502 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
2503 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
2504 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
2505 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
2507 #### <a id="plugin-contrib-command-iftraffic"></a> iftraffic
2509 The [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic) plugin
2510 checks the utilization of a given interface name using the SNMP protocol.
2512 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2515 ------------------------|---------------------------------------------------------
2516 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
2517 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2518 iftraffic_interface | **Required.** Queried interface name.
2519 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2520 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2521 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2522 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2523 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2525 #### <a id="plugin-contrib-command-iftraffic64"></a> iftraffic64
2527 The [check_iftraffic64](https://exchange.icinga.com/exchange/iftraffic64) plugin
2528 checks the utilization of a given interface name using the SNMP protocol.
2530 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2533 ------------------------|---------------------------------------------------------
2534 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
2535 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2536 iftraffic64_interface | **Required.** Queried interface name.
2537 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2538 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2539 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2540 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2541 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2543 #### <a id="plugin-contrib-command-interfaces"></a> interfaces
2545 The [check_interfaces](https://git.netways.org/plugins/check_interfaces) plugin
2546 uses SNMP to monitor network interfaces and their utilization.
2548 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2551 --------------------------|---------------------------------------------------------
2552 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2553 interfaces_regex | **Optional.** Interface list regexp.
2554 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
2555 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
2556 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
2557 interfaces_perfdata | **Optional.** perfdata from last check result.
2558 interfaces_prefix | **Optional.** Prefix interface names with this label.
2559 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
2560 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
2561 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
2562 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
2563 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
2564 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
2565 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
2566 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
2567 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
2568 interfaces_user | **Optional.** SNMPv3 User
2569 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
2570 interfaces_aliases | **Optional.** Retrieves the interface description.
2571 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
2572 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
2573 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
2574 interfaces_names | **Optional.** If set to true, use ifName instead of ifDescr.
2576 #### <a id="plugin-contrib-command-nwc_health"></a> nwc_health
2578 The [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html) plugin
2579 uses SNMP to monitor network components. The plugin is able to generate interface statistics,
2580 check hardware (CPU, memory, fan, power, etc.), monitor firewall policies, HRSP, load-balancer
2581 pools, processor and memory usage.
2583 Currently the following network components are supported: Cisco IOS, Cisco Nexus, Cisco ASA,
2584 Cisco PIX, F5 BIG-IP, CheckPoint Firewall1, Juniper NetScreen, HP Procurve, Nortel, Brocade 4100/4900,
2585 EMC DS 4700, EMC DS 24, Allied Telesyn. Blue Coat SG600, Cisco Wireless Lan Controller 5500,
2586 Brocade ICX6610-24-HPOE, Cisco UC Telefonzeugs, FOUNDRY-SN-AGENT-MIB, FRITZ!BOX 7390, FRITZ!DECT 200,
2587 Juniper IVE, Pulse-Gateway MAG4610, Cisco IronPort AsyncOS, Foundry, etc. A complete list can be
2588 found in the plugin [documentation](https://labs.consol.de/nagios/check_nwc_health/index.html).
2590 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2593 --------------------------------|---------------------------------------------------------
2594 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2595 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).
2596 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
2597 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
2598 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
2599 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).
2600 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2601 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2602 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2603 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
2604 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2605 nwc_health_privpassword | **Optional.** The password for authPriv security level.
2606 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2607 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
2608 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
2609 nwc_health_name | **Optional.** The name of an interface (ifDescr).
2610 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
2611 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
2612 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
2613 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
2614 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
2615 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
2616 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
2617 nwc_health_name2 | **Optional.** The secondary name of a component.
2618 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
2619 nwc_health_report | **Optional.** Can be used to shorten the output. Possible values are: 'long' (default), 'short' (to shorten if available), or 'html' (to produce some html outputs if available)
2620 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.
2621 nwc_health_warning | **Optional.** The warning threshold
2622 nwc_health_critical | **Optional.** The critical threshold
2623 nwc_health_warningx | **Optional.** The extended warning thresholds
2624 nwc_health_criticalx | **Optional.** The extended critical thresholds
2625 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning (1) or ok (0).
2626 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.
2627 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'
2628 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
2629 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
2630 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
2631 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2632 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
2633 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
2634 nwc_health_multiline | **Optional.** Multiline output
2637 ### <a id="plugin-contrib-operating-system"></a> Operating System
2639 This category contains plugins which receive details about your operating system
2640 or the guest system.
2642 #### <a id="plugin-contrib-command-mem"></a> mem
2644 The [check_mem.pl](https://github.com/justintime/nagios-plugins) plugin checks the
2645 memory usage on linux and unix hosts. It is able to count cache memory as free when
2646 compared to thresholds. More details can be found on [this blog entry]((http://sysadminsjourney.com/content/2009/06/04/new-and-improved-checkmempl-nagios-plugin).
2648 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2651 -------------|-----------------------------------------------------------------------------------------------------------------------
2652 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
2653 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
2654 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
2655 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
2656 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
2658 #### <a id="plugin-contrib-command-running_kernel"></a> running_kernel
2660 The [check_running_kernel](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin
2661 is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu.
2666 ---------------------------|-------------
2667 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
2669 #### <a id="plugin-contrib-command-iostats"></a> iostats
2671 The [check_iostats](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostats) plugin
2672 uses the `iostat` binary to monitor I/O on a Linux host. The default thresholds are rather high
2673 so you can use a grapher for baselining before setting your own.
2675 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2678 ---------------|-----------------------------------------------------------------------------------------------------------------------
2679 iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2680 iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000)
2681 iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000)
2682 iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000)
2683 iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50)
2684 iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000)
2685 iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000)
2686 iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000)
2687 iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80)
2689 #### <a id="plugin-contrib-command-iostat"></a> iostat
2691 The [check_iostat](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostat) plugin
2692 uses the `iostat` binary to monitor disk I/O on a Linux host. The default thresholds are rather high
2693 so you can use a grapher for baselining before setting your own.
2695 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2698 ---------------|-----------------------------------------------------------------------------------------------------------------------
2699 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2700 iostat\_wtps | **Required.** Warning threshold for tps (default: 100)
2701 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100)
2702 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100)
2703 iostat\_ctps | **Required.** Critical threshold for tps (default: 200)
2704 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200)
2705 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200)
2707 #### <a id="plugin-contrib-command-yum"></a> yum
2709 The [check_yum](https://github.com/calestyo/check_yum) plugin checks the YUM package
2710 management system for package updates.
2711 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
2713 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2716 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2717 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.
2718 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
2719 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.
2720 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.
2721 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.
2722 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.
2723 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.
2724 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
2725 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
2727 ### <a id="plugins-contrib-storage"></a> Storage
2729 This category includes all plugins for various storage and object storage technologies.
2731 #### <a id="plugins-contrib-command-glusterfs"></a> glusterfs
2733 The [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) plugin
2734 is used to check the GlusterFS storage health on the server.
2735 The plugin requires `sudo` permissions.
2737 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2740 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2741 glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
2742 glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
2743 glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
2744 glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
2745 glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
2746 glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
2747 glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
2750 ### <a id="plugin-contrib-virtualization"></a> Virtualization
2752 This category includes all plugins for various virtualization technologies.
2754 #### <a id="plugin-contrib-command-esxi-hardware"></a> esxi_hardware
2756 The [check_esxi_hardware.py](http://www.claudiokuenzler.com/nagios-plugins/check_esxi_hardware.php) plugin
2757 uses the [pywbem](http://pywbem.github.io/pywbem/) Python library to monitor the hardware of ESXi servers
2758 through the [VMWare API](https://www.vmware.com/support/pubs/sdk_pubs.html) and CIM service.
2760 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2763 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2764 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
2765 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.
2766 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.
2767 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
2768 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
2769 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
2770 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
2771 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
2772 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2773 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2774 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2775 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2776 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2778 #### <a id="plugin-contrib-vmware"></a> VMware
2780 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
2782 **vmware-esx-dc-volumes**
2784 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2786 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2789 ------------------------|--------------
2790 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2791 vmware_cluster | **Optional.** ESX or ESXi clustername.
2792 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2793 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2794 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2795 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2796 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2797 vmware_sessionfile | **Optional.** Session file name enhancement.
2798 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2799 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2800 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2801 vmware_password | **Optional.** The username's password. No value defined as default.
2802 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2803 vmware_subselect | **Optional.** Volume name to be checked the free space.
2804 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2805 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2806 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2807 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2808 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2809 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2810 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
2811 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2812 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2815 **vmware-esx-dc-runtime-info**
2817 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
2819 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2822 ------------------------|--------------
2823 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2824 vmware_cluster | **Optional.** ESX or ESXi clustername.
2825 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2826 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2827 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2828 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2829 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2830 vmware_sessionfile | **Optional.** Session file name enhancement.
2831 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2832 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2833 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2834 vmware_password | **Optional.** The username's password. No value defined as default.
2835 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2838 **vmware-esx-dc-runtime-listvms**
2840 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.
2842 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2845 ------------------------|--------------
2846 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2847 vmware_cluster | **Optional.** ESX or ESXi clustername.
2848 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2849 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2850 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2851 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2852 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2853 vmware_sessionfile | **Optional.** Session file name enhancement.
2854 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2855 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2856 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2857 vmware_password | **Optional.** The username's password. No value defined as default.
2858 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2859 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2860 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2861 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2862 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2863 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.
2866 **vmware-esx-dc-runtime-listhost**
2868 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
2870 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2873 ------------------------|--------------
2874 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2875 vmware_cluster | **Optional.** ESX or ESXi clustername.
2876 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2877 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2878 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2879 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2880 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2881 vmware_sessionfile | **Optional.** Session file name enhancement.
2882 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2883 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2884 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2885 vmware_password | **Optional.** The username's password. No value defined as default.
2886 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2887 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2888 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
2889 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
2890 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2891 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.
2894 **vmware-esx-dc-runtime-listcluster**
2896 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
2898 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2901 ------------------------|--------------
2902 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2903 vmware_cluster | **Optional.** ESX or ESXi clustername.
2904 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2905 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2906 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2907 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2908 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2909 vmware_sessionfile | **Optional.** Session file name enhancement.
2910 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2911 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2912 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2913 vmware_password | **Optional.** The username's password. No value defined as default.
2914 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2915 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2916 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
2917 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
2918 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2919 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.
2922 **vmware-esx-dc-runtime-issues**
2924 Check command object for the `check_vmware_esx` plugin. All issues for the host.
2926 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2929 ------------------------|--------------
2930 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2931 vmware_cluster | **Optional.** ESX or ESXi clustername.
2932 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2933 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2934 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2935 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2936 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2937 vmware_sessionfile | **Optional.** Session file name enhancement.
2938 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2939 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2940 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2941 vmware_password | **Optional.** The username's password. No value defined as default.
2942 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2943 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
2944 vmware_include | **Optional.** Whitelist issues. No value defined as default.
2945 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2946 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.
2949 **vmware-esx-dc-runtime-status**
2951 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2953 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2956 ------------------------|--------------
2957 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2958 vmware_cluster | **Optional.** ESX or ESXi clustername.
2959 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2960 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2961 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2962 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2963 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2964 vmware_sessionfile | **Optional.** Session file name enhancement.
2965 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2966 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2967 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2968 vmware_password | **Optional.** The username's password. No value defined as default.
2969 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2972 **vmware-esx-dc-runtime-tools**
2974 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
2976 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2979 ------------------------|--------------
2980 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2981 vmware_cluster | **Optional.** ESX or ESXi clustername.
2982 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2983 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2984 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2985 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2986 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2987 vmware_sessionfile | **Optional.** Session file name enhancement.
2988 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2989 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2990 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2991 vmware_password | **Optional.** The username's password. No value defined as default.
2992 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2993 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
2994 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2995 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
2996 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
2997 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2998 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.
2999 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
3002 **vmware-esx-soap-host-check**
3004 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
3006 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3009 ------------------------|--------------
3010 vmware_host | **Required.** ESX or ESXi hostname.
3011 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3012 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3013 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3014 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3015 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3016 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3017 vmware_sessionfile | **Optional.** Session file name enhancement.
3018 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3019 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3020 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3021 vmware_password | **Optional.** The username's password. No value defined as default.
3022 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3025 **vmware-esx-soap-host-uptime**
3027 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
3029 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3032 ------------------------|--------------
3033 vmware_host | **Required.** ESX or ESXi hostname.
3034 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3035 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3036 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3037 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3038 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3039 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3040 vmware_sessionfile | **Optional.** Session file name enhancement.
3041 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3042 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3043 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3044 vmware_password | **Optional.** The username's password. No value defined as default.
3045 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3048 **vmware-esx-soap-host-cpu**
3050 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
3052 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3055 ------------------------|--------------
3056 vmware_host | **Required.** ESX or ESXi hostname.
3057 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3058 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3059 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3060 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3061 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3062 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3063 vmware_sessionfile | **Optional.** Session file name enhancement.
3064 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3065 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3066 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3067 vmware_password | **Optional.** The username's password. No value defined as default.
3068 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3069 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3070 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3073 **vmware-esx-soap-host-cpu-ready**
3075 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.
3077 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3080 ------------------------|--------------
3081 vmware_host | **Required.** ESX or ESXi hostname.
3082 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3083 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3084 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3085 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3086 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3087 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3088 vmware_sessionfile | **Optional.** Session file name enhancement.
3089 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3090 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3091 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3092 vmware_password | **Optional.** The username's password. No value defined as default.
3093 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3096 **vmware-esx-soap-host-cpu-wait**
3098 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.
3100 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3103 ------------------------|--------------
3104 vmware_host | **Required.** ESX or ESXi hostname.
3105 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3106 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3107 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3108 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3109 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3110 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3111 vmware_sessionfile | **Optional.** Session file name enhancement.
3112 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3113 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3114 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3115 vmware_password | **Optional.** The username's password. No value defined as default.
3116 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3119 **vmware-esx-soap-host-cpu-usage**
3121 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.
3123 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3126 ------------------------|--------------
3127 vmware_host | **Required.** ESX or ESXi hostname.
3128 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3129 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3130 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3131 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3132 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3133 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3134 vmware_sessionfile | **Optional.** Session file name enhancement.
3135 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3136 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3137 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3138 vmware_password | **Optional.** The username's password. No value defined as default.
3139 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3140 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3141 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3144 **vmware-esx-soap-host-mem**
3146 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3148 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3151 ------------------------|--------------
3152 vmware_host | **Required.** ESX or ESXi hostname.
3153 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3154 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3155 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3156 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3157 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3158 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3159 vmware_sessionfile | **Optional.** Session file name enhancement.
3160 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3161 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3162 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3163 vmware_password | **Optional.** The username's password. No value defined as default.
3164 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3167 **vmware-esx-soap-host-mem-usage**
3169 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3171 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3174 ------------------------|--------------
3175 vmware_host | **Required.** ESX or ESXi hostname.
3176 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3177 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3178 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3179 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3180 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3181 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3182 vmware_sessionfile | **Optional.** Session file name enhancement.
3183 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3184 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3185 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3186 vmware_password | **Optional.** The username's password. No value defined as default.
3187 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3188 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3189 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3192 **vmware-esx-soap-host-mem-consumed**
3194 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.
3196 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3199 ------------------------|--------------
3200 vmware_host | **Required.** ESX or ESXi hostname.
3201 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3202 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3203 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3204 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3205 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3206 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3207 vmware_sessionfile | **Optional.** Session file name enhancement.
3208 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3209 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3210 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3211 vmware_password | **Optional.** The username's password. No value defined as default.
3212 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3213 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3214 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3217 **vmware-esx-soap-host-mem-swapused**
3219 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.
3221 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3224 ------------------------|--------------
3225 vmware_host | **Required.** ESX or ESXi hostname.
3226 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3227 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3228 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3229 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3230 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3231 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3232 vmware_sessionfile | **Optional.** Session file name enhancement.
3233 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3234 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3235 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3236 vmware_password | **Optional.** The username's password. No value defined as default.
3237 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3238 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3239 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3240 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.
3243 **vmware-esx-soap-host-mem-overhead**
3245 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3247 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3250 ------------------------|--------------
3251 vmware_host | **Required.** ESX or ESXi hostname.
3252 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3253 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3254 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3255 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3256 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3257 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3258 vmware_sessionfile | **Optional.** Session file name enhancement.
3259 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3260 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3261 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3262 vmware_password | **Optional.** The username's password. No value defined as default.
3263 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3264 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3265 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3268 **vmware-esx-soap-host-mem-memctl**
3270 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.
3272 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3275 ------------------------|--------------
3276 vmware_host | **Required.** ESX or ESXi hostname.
3277 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3278 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3279 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3280 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3281 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3282 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3283 vmware_sessionfile | **Optional.** Session file name enhancement.
3284 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3285 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3286 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3287 vmware_password | **Optional.** The username's password. No value defined as default.
3288 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3289 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3290 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3291 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.
3294 **vmware-esx-soap-host-net**
3296 Check command object for the `check_vmware_esx` plugin. Shows net info.
3298 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3301 ------------------------|--------------
3302 vmware_host | **Required.** ESX or ESXi hostname.
3303 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3304 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3305 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3306 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3307 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3308 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3309 vmware_sessionfile | **Optional.** Session file name enhancement.
3310 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3311 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3312 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3313 vmware_password | **Optional.** The username's password. No value defined as default.
3314 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3315 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3316 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3319 **vmware-esx-soap-host-net-usage**
3321 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3323 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3326 ------------------------|--------------
3327 vmware_host | **Required.** ESX or ESXi hostname.
3328 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3329 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3330 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3331 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3332 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3333 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3334 vmware_sessionfile | **Optional.** Session file name enhancement.
3335 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3336 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3337 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3338 vmware_password | **Optional.** The username's password. No value defined as default.
3339 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3340 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3341 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3344 **vmware-esx-soap-host-net-receive**
3346 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
3348 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3351 ------------------------|--------------
3352 vmware_host | **Required.** ESX or ESXi hostname.
3353 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3354 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3355 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3356 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3357 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3358 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3359 vmware_sessionfile | **Optional.** Session file name enhancement.
3360 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3361 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3362 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3363 vmware_password | **Optional.** The username's password. No value defined as default.
3364 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3365 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3366 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3369 **vmware-esx-soap-host-net-send**
3371 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
3373 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3376 ------------------------|--------------
3377 vmware_host | **Required.** ESX or ESXi hostname.
3378 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3379 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3380 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3381 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3382 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3383 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3384 vmware_sessionfile | **Optional.** Session file name enhancement.
3385 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3386 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3387 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3388 vmware_password | **Optional.** The username's password. No value defined as default.
3389 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3390 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3391 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3394 **vmware-esx-soap-host-net-nic**
3396 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
3398 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3401 ------------------------|--------------
3402 vmware_host | **Required.** ESX or ESXi hostname.
3403 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3404 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3405 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3406 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3407 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3408 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3409 vmware_sessionfile | **Optional.** Session file name enhancement.
3410 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3411 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3412 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3413 vmware_password | **Optional.** The username's password. No value defined as default.
3414 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3415 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3416 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3419 **vmware-esx-soap-host-volumes**
3421 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
3423 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3426 ------------------------|--------------
3427 vmware_host | **Required.** ESX or ESXi hostname.
3428 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3429 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3430 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3431 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3432 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3433 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3434 vmware_sessionfile | **Optional.** Session file name enhancement.
3435 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3436 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3437 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3438 vmware_password | **Optional.** The username's password. No value defined as default.
3439 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3440 vmware_subselect | **Optional.** Volume name to be checked the free space.
3441 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3442 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3443 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3444 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3445 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3446 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3447 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3448 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3449 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
3452 **vmware-esx-soap-host-io**
3454 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.
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
3475 **vmware-esx-soap-host-io-aborted**
3477 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
3479 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3482 ------------------------|--------------
3483 vmware_host | **Required.** ESX or ESXi hostname.
3484 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3485 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3486 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3487 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3488 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3489 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3490 vmware_sessionfile | **Optional.** Session file name enhancement.
3491 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3492 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3493 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3494 vmware_password | **Optional.** The username's password. No value defined as default.
3495 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3496 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3497 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3500 **vmware-esx-soap-host-io-resets**
3502 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
3504 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3507 ------------------------|--------------
3508 vmware_host | **Required.** ESX or ESXi hostname.
3509 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3510 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3511 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3512 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3513 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3514 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3515 vmware_sessionfile | **Optional.** Session file name enhancement.
3516 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3517 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3518 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3519 vmware_password | **Optional.** The username's password. No value defined as default.
3520 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3521 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3522 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3525 **vmware-esx-soap-host-io-read**
3527 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3529 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3532 ------------------------|--------------
3533 vmware_host | **Required.** ESX or ESXi hostname.
3534 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3535 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3536 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3537 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3538 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3539 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3540 vmware_sessionfile | **Optional.** Session file name enhancement.
3541 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3542 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3543 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3544 vmware_password | **Optional.** The username's password. No value defined as default.
3545 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3546 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3547 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3550 **vmware-esx-soap-host-io-read-latency**
3552 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.
3554 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3557 ------------------------|--------------
3558 vmware_host | **Required.** ESX or ESXi hostname.
3559 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3560 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3561 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3562 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3563 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3564 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3565 vmware_sessionfile | **Optional.** Session file name enhancement.
3566 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3567 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3568 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3569 vmware_password | **Optional.** The username's password. No value defined as default.
3570 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3571 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3572 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3575 **vmware-esx-soap-host-io-write**
3577 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3579 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3582 ------------------------|--------------
3583 vmware_host | **Required.** ESX or ESXi hostname.
3584 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3585 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3586 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3587 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3588 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3589 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3590 vmware_sessionfile | **Optional.** Session file name enhancement.
3591 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3592 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3593 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3594 vmware_password | **Optional.** The username's password. No value defined as default.
3595 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3596 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3597 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3600 **vmware-esx-soap-host-io-write-latency**
3602 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.
3604 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3607 ------------------------|--------------
3608 vmware_host | **Required.** ESX or ESXi hostname.
3609 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3610 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3611 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3612 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3613 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3614 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3615 vmware_sessionfile | **Optional.** Session file name enhancement.
3616 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3617 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3618 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3619 vmware_password | **Optional.** The username's password. No value defined as default.
3620 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3621 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3622 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3625 **vmware-esx-soap-host-io-usage**
3627 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.
3629 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3632 ------------------------|--------------
3633 vmware_host | **Required.** ESX or ESXi hostname.
3634 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3635 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3636 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3637 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3638 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3639 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3640 vmware_sessionfile | **Optional.** Session file name enhancement.
3641 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3642 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3643 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3644 vmware_password | **Optional.** The username's password. No value defined as default.
3645 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3646 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3647 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3650 **vmware-esx-soap-host-io-kernel-latency**
3652 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
3654 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3657 ------------------------|--------------
3658 vmware_host | **Required.** ESX or ESXi hostname.
3659 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3660 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3661 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3662 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3663 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3664 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3665 vmware_sessionfile | **Optional.** Session file name enhancement.
3666 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3667 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3668 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3669 vmware_password | **Optional.** The username's password. No value defined as default.
3670 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3671 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3672 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3675 **vmware-esx-soap-host-io-device-latency**
3677 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
3679 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3682 ------------------------|--------------
3683 vmware_host | **Required.** ESX or ESXi hostname.
3684 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3685 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3686 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3687 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3688 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3689 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3690 vmware_sessionfile | **Optional.** Session file name enhancement.
3691 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3692 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3693 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3694 vmware_password | **Optional.** The username's password. No value defined as default.
3695 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3696 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3697 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3700 **vmware-esx-soap-host-io-queue-latency**
3702 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
3704 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3707 ------------------------|--------------
3708 vmware_host | **Required.** ESX or ESXi hostname.
3709 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3710 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3711 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3712 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3713 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3714 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3715 vmware_sessionfile | **Optional.** Session file name enhancement.
3716 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3717 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3718 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3719 vmware_password | **Optional.** The username's password. No value defined as default.
3720 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3721 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3722 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3725 **vmware-esx-soap-host-io-total-latency**
3727 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.
3729 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3732 ------------------------|--------------
3733 vmware_host | **Required.** ESX or ESXi hostname.
3734 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3735 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3736 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3737 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3738 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3739 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3740 vmware_sessionfile | **Optional.** Session file name enhancement.
3741 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3742 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3743 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3744 vmware_password | **Optional.** The username's password. No value defined as default.
3745 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3746 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3747 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3750 **vmware-esx-soap-host-media**
3752 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.
3754 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3757 ------------------------|--------------
3758 vmware_host | **Required.** ESX or ESXi hostname.
3759 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3760 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3761 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3762 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3763 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3764 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3765 vmware_sessionfile | **Optional.** Session file name enhancement.
3766 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3767 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3768 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3769 vmware_password | **Optional.** The username's password. No value defined as default.
3770 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3771 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3772 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3773 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3774 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.
3777 **vmware-esx-soap-host-service**
3779 Check command object for the `check_vmware_esx` plugin. Shows host service info.
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 services name. No value defined as default.
3799 vmware_include | **Optional.** Whitelist services name. No value defined as default.
3800 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3801 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.
3804 **vmware-esx-soap-host-runtime**
3806 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.
3808 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3811 ------------------------|--------------
3812 vmware_host | **Required.** ESX or ESXi hostname.
3813 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3814 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3815 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3816 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3817 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3818 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3819 vmware_sessionfile | **Optional.** Session file name enhancement.
3820 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3821 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3822 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3823 vmware_password | **Optional.** The username's password. No value defined as default.
3824 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3827 **vmware-esx-soap-host-runtime-con**
3829 Check command object for the `check_vmware_esx` plugin. Shows connection state.
3831 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3834 ------------------------|--------------
3835 vmware_host | **Required.** ESX or ESXi hostname.
3836 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3837 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3838 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3839 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3840 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3841 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3842 vmware_sessionfile | **Optional.** Session file name enhancement.
3843 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3844 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3845 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3846 vmware_password | **Optional.** The username's password. No value defined as default.
3847 vmware_authfile | **Optional.** Use auth file instead username/password 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-esx-soap-host-runtime-listvms**
3852 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
3854 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3857 ------------------------|--------------
3858 vmware_host | **Required.** ESX or ESXi hostname.
3859 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3860 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3861 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3862 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3863 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3864 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3865 vmware_sessionfile | **Optional.** Session file name enhancement.
3866 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3867 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3868 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3869 vmware_password | **Optional.** The username's password. No value defined as default.
3870 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3871 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3872 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3873 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3874 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.
3877 **vmware-esx-soap-host-runtime-status**
3879 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3881 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3884 ------------------------|--------------
3885 vmware_host | **Required.** ESX or ESXi hostname.
3886 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3887 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3888 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3889 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3890 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3891 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3892 vmware_sessionfile | **Optional.** Session file name enhancement.
3893 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3894 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3895 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3896 vmware_password | **Optional.** The username's password. No value defined as default.
3897 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3900 **vmware-esx-soap-host-runtime-health**
3902 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
3904 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3907 ------------------------|--------------
3908 vmware_host | **Required.** ESX or ESXi hostname.
3909 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3910 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3911 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3912 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3913 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3914 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3915 vmware_sessionfile | **Optional.** Session file name enhancement.
3916 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3917 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3918 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3919 vmware_password | **Optional.** The username's password. No value defined as default.
3920 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3921 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3922 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3923 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3926 **vmware-esx-soap-host-runtime-health-listsensors**
3928 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
3930 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3933 ------------------------|--------------
3934 vmware_host | **Required.** ESX or ESXi hostname.
3935 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3936 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3937 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3938 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3939 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3940 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3941 vmware_sessionfile | **Optional.** Session file name enhancement.
3942 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3943 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3944 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3945 vmware_password | **Optional.** The username's password. No value defined as default.
3946 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3947 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3948 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3949 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3952 **vmware-esx-soap-host-runtime-health-nostoragestatus**
3954 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**.
3956 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3959 ------------------------|--------------
3960 vmware_host | **Required.** ESX or ESXi hostname.
3961 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3962 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3963 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3964 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3965 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3966 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3967 vmware_sessionfile | **Optional.** Session file name enhancement.
3968 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3969 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3970 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3971 vmware_password | **Optional.** The username's password. No value defined as default.
3972 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3973 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3974 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3975 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3978 **vmware-esx-soap-host-runtime-storagehealth**
3980 Check command object for the `check_vmware_esx` plugin. Local storage status check.
3982 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3985 ------------------------|--------------
3986 vmware_host | **Required.** ESX or ESXi hostname.
3987 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3988 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3989 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3990 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3991 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3992 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3993 vmware_sessionfile | **Optional.** Session file name enhancement.
3994 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3995 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3996 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3997 vmware_password | **Optional.** The username's password. No value defined as default.
3998 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3999 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
4000 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
4001 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4002 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.
4005 **vmware-esx-soap-host-runtime-temp**
4007 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
4009 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4012 ------------------------|--------------
4013 vmware_host | **Required.** ESX or ESXi hostname.
4014 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4015 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4016 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4017 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4018 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4019 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4020 vmware_sessionfile | **Optional.** Session file name enhancement.
4021 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4022 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4023 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4024 vmware_password | **Optional.** The username's password. No value defined as default.
4025 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4026 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
4027 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
4028 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4029 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.
4032 **vmware-esx-soap-host-runtime-issues**
4034 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
4036 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4039 ------------------------|--------------
4040 vmware_host | **Required.** ESX or ESXi hostname.
4041 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4042 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4043 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4044 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4045 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4046 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4047 vmware_sessionfile | **Optional.** Session file name enhancement.
4048 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4049 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4050 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4051 vmware_password | **Optional.** The username's password. No value defined as default.
4052 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4053 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
4054 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
4055 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4056 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.
4059 **vmware-esx-soap-host-storage**
4061 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
4063 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4066 ------------------------|--------------
4067 vmware_host | **Required.** ESX or ESXi hostname.
4068 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4069 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4070 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4071 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4072 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4073 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4074 vmware_sessionfile | **Optional.** Session file name enhancement.
4075 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4076 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4077 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4078 vmware_password | **Optional.** The username's password. No value defined as default.
4079 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4080 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
4081 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
4082 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4085 **vmware-esx-soap-host-storage-adapter**
4087 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
4089 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4092 ------------------------|--------------
4093 vmware_host | **Required.** ESX or ESXi hostname.
4094 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4095 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4096 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4097 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4098 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4099 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4100 vmware_sessionfile | **Optional.** Session file name enhancement.
4101 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4102 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4103 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4104 vmware_password | **Optional.** The username's password. No value defined as default.
4105 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4106 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
4107 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
4108 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4109 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.
4112 **vmware-esx-soap-host-storage-lun**
4114 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.
4116 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4119 ------------------------|--------------
4120 vmware_host | **Required.** ESX or ESXi hostname.
4121 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4122 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4123 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4124 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4125 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4126 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4127 vmware_sessionfile | **Optional.** Session file name enhancement.
4128 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4129 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4130 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4131 vmware_password | **Optional.** The username's password. No value defined as default.
4132 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4133 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
4134 vmware_include | **Optional.** Whitelist luns. No value defined as default.
4135 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4136 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.
4139 **vmware-esx-soap-host-storage-path**
4141 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
4143 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4146 ------------------------|--------------
4147 vmware_host | **Required.** ESX or ESXi hostname.
4148 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4149 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4150 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4151 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4152 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4153 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4154 vmware_sessionfile | **Optional.** Session file name enhancement.
4155 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4156 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4157 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4158 vmware_password | **Optional.** The username's password. No value defined as default.
4159 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4160 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4161 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4162 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4163 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4164 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.
4167 **vmware-esx-soap-vm-cpu**
4169 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4171 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4174 ------------------------|--------------
4175 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4176 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4177 vmware_vmname | **Required.** Virtual machine name.
4178 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4179 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4180 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4181 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4182 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4183 vmware_sessionfile | **Optional.** Session file name enhancement.
4184 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4185 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4186 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4187 vmware_password | **Optional.** The username's password. No value defined as default.
4188 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4192 **vmware-esx-soap-vm-cpu-ready**
4194 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.
4196 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4199 ------------------------|--------------
4200 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4201 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4202 vmware_vmname | **Required.** Virtual machine name.
4203 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4204 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4205 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4206 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4207 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4208 vmware_sessionfile | **Optional.** Session file name enhancement.
4209 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4210 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4211 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4212 vmware_password | **Optional.** The username's password. No value defined as default.
4213 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4214 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4215 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4218 **vmware-esx-soap-vm-cpu-wait**
4220 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.
4222 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4225 ------------------------|--------------
4226 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4227 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4228 vmware_vmname | **Required.** Virtual machine name.
4229 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4230 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4231 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4232 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4233 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4234 vmware_sessionfile | **Optional.** Session file name enhancement.
4235 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4236 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4237 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4238 vmware_password | **Optional.** The username's password. No value defined as default.
4239 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4240 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4241 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4244 **vmware-esx-soap-vm-cpu-usage**
4246 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.
4248 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4251 ------------------------|--------------
4252 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4253 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4254 vmware_vmname | **Required.** Virtual machine name.
4255 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4256 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4257 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4258 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4259 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4260 vmware_sessionfile | **Optional.** Session file name enhancement.
4261 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4262 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4263 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4264 vmware_password | **Optional.** The username's password. No value defined as default.
4265 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4266 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4267 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4270 **vmware-esx-soap-vm-mem**
4272 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4274 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4277 ------------------------|--------------
4278 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4279 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4280 vmware_vmname | **Required.** Virtual machine name.
4281 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4282 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4283 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4284 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4285 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4286 vmware_sessionfile | **Optional.** Session file name enhancement.
4287 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4288 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4289 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4290 vmware_password | **Optional.** The username's password. No value defined as default.
4291 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4294 **vmware-esx-soap-vm-mem-usage**
4296 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4298 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4301 ------------------------|--------------
4302 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4303 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4304 vmware_vmname | **Required.** Virtual machine name.
4305 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4306 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4307 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4308 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4309 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4310 vmware_sessionfile | **Optional.** Session file name enhancement.
4311 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4312 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4313 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4314 vmware_password | **Optional.** The username's password. No value defined as default.
4315 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4316 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4317 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4320 **vmware-esx-soap-vm-mem-consumed**
4322 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>
4323 **vm consumed memory = memory granted -- memory saved**
4325 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4328 ------------------------|--------------
4329 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4330 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4331 vmware_vmname | **Required.** Virtual machine name.
4332 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4333 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4334 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4335 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4336 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4337 vmware_sessionfile | **Optional.** Session file name enhancement.
4338 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4339 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4340 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4341 vmware_password | **Optional.** The username's password. No value defined as default.
4342 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4343 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4344 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4347 **vmware-esx-soap-vm-mem-memctl**
4349 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.
4351 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4354 ------------------------|--------------
4355 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4356 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4357 vmware_vmname | **Required.** Virtual machine name.
4358 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4359 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4360 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4361 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4362 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4363 vmware_sessionfile | **Optional.** Session file name enhancement.
4364 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4365 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4366 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4367 vmware_password | **Optional.** The username's password. No value defined as default.
4368 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4369 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4370 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4374 **vmware-esx-soap-vm-net**
4376 Check command object for the `check_vmware_esx` plugin. Shows net info.
4378 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4381 ------------------------|--------------
4382 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4383 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4384 vmware_vmname | **Required.** Virtual machine name.
4385 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4386 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4387 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4388 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4389 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4390 vmware_sessionfile | **Optional.** Session file name enhancement.
4391 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4392 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4393 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4394 vmware_password | **Optional.** The username's password. No value defined as default.
4395 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4398 **vmware-esx-soap-vm-net-usage**
4400 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4402 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4405 ------------------------|--------------
4406 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4407 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4408 vmware_vmname | **Required.** Virtual machine name.
4409 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4410 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4411 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4412 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4413 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4414 vmware_sessionfile | **Optional.** Session file name enhancement.
4415 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4416 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4417 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4418 vmware_password | **Optional.** The username's password. No value defined as default.
4419 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4420 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4421 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4424 **vmware-esx-soap-vm-net-receive**
4426 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
4428 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4431 ------------------------|--------------
4432 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4433 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4434 vmware_vmname | **Required.** Virtual machine name.
4435 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4436 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4437 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4438 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4439 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4440 vmware_sessionfile | **Optional.** Session file name enhancement.
4441 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4442 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4443 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4444 vmware_password | **Optional.** The username's password. No value defined as default.
4445 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4446 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4447 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4450 **vmware-esx-soap-vm-net-send**
4452 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
4454 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4457 ------------------------|--------------
4458 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4459 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4460 vmware_vmname | **Required.** Virtual machine name.
4461 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4462 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4463 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4464 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4465 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4466 vmware_sessionfile | **Optional.** Session file name enhancement.
4467 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4468 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4469 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4470 vmware_password | **Optional.** The username's password. No value defined as default.
4471 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4472 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4473 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4476 **vmware-esx-soap-vm-io**
4478 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.
4480 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4483 ------------------------|--------------
4484 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4485 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4486 vmware_vmname | **Required.** Virtual machine name.
4487 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4488 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4489 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4490 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4491 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4492 vmware_sessionfile | **Optional.** Session file name enhancement.
4493 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4494 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4495 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4496 vmware_password | **Optional.** The username's password. No value defined as default.
4497 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4500 **vmware-esx-soap-vm-io-read**
4502 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4504 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4507 ------------------------|--------------
4508 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4509 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4510 vmware_vmname | **Required.** Virtual machine name.
4511 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4512 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4513 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4514 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4515 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4516 vmware_sessionfile | **Optional.** Session file name enhancement.
4517 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4518 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4519 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4520 vmware_password | **Optional.** The username's password. No value defined as default.
4521 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4522 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4523 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4526 **vmware-esx-soap-vm-io-write**
4528 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4530 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4533 ------------------------|--------------
4534 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4535 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4536 vmware_vmname | **Required.** Virtual machine name.
4537 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4538 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4539 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4540 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4541 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4542 vmware_sessionfile | **Optional.** Session file name enhancement.
4543 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4544 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4545 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4546 vmware_password | **Optional.** The username's password. No value defined as default.
4547 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4548 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4549 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4552 **vmware-esx-soap-vm-io-usage**
4554 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
4556 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4559 ------------------------|--------------
4560 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4561 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4562 vmware_vmname | **Required.** Virtual machine name.
4563 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4564 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4565 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4566 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4567 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4568 vmware_sessionfile | **Optional.** Session file name enhancement.
4569 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4570 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4571 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4572 vmware_password | **Optional.** The username's password. No value defined as default.
4573 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4574 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4575 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4578 **vmware-esx-soap-vm-runtime**
4580 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
4582 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4585 ------------------------|--------------
4586 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4587 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4588 vmware_vmname | **Required.** Virtual machine name.
4589 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4590 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4591 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4592 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4593 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4594 vmware_sessionfile | **Optional.** Session file name enhancement.
4595 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4596 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4597 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4598 vmware_password | **Optional.** The username's password. No value defined as default.
4599 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4602 **vmware-esx-soap-vm-runtime-con**
4604 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
4606 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4609 ------------------------|--------------
4610 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4611 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4612 vmware_vmname | **Required.** Virtual machine name.
4613 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4614 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4615 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4616 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4617 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4618 vmware_sessionfile | **Optional.** Session file name enhancement.
4619 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4620 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4621 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4622 vmware_password | **Optional.** The username's password. No value defined as default.
4623 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4626 **vmware-esx-soap-vm-runtime-powerstate**
4628 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
4630 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4633 ------------------------|--------------
4634 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4635 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4636 vmware_vmname | **Required.** Virtual machine name.
4637 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4638 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4639 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4640 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4641 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4642 vmware_sessionfile | **Optional.** Session file name enhancement.
4643 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4644 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4645 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4646 vmware_password | **Optional.** The username's password. No value defined as default.
4647 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4650 **vmware-esx-soap-vm-runtime-status**
4652 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4654 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4657 ------------------------|--------------
4658 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4659 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4660 vmware_vmname | **Required.** Virtual machine name.
4661 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4662 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4663 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4664 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4665 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4666 vmware_sessionfile | **Optional.** Session file name enhancement.
4667 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4668 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4669 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4670 vmware_password | **Optional.** The username's password. No value defined as default.
4671 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4674 **vmware-esx-soap-vm-runtime-consoleconnections**
4676 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
4678 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4681 ------------------------|--------------
4682 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4683 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4684 vmware_vmname | **Required.** Virtual machine name.
4685 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4686 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4687 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4688 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4689 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4690 vmware_sessionfile | **Optional.** Session file name enhancement.
4691 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4692 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4693 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4694 vmware_password | **Optional.** The username's password. No value defined as default.
4695 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4696 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4697 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4700 **vmware-esx-soap-vm-runtime-gueststate**
4702 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
4704 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4707 ------------------------|--------------
4708 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4709 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4710 vmware_vmname | **Required.** Virtual machine name.
4711 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4712 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4713 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4714 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4715 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4716 vmware_sessionfile | **Optional.** Session file name enhancement.
4717 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4718 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4719 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4720 vmware_password | **Optional.** The username's password. No value defined as default.
4721 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4723 **vmware-esx-soap-vm-runtime-tools**
4725 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
4727 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4730 ------------------------|--------------
4731 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4732 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4733 vmware_vmname | **Required.** Virtual machine name.
4734 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4735 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4736 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4737 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4738 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4739 vmware_sessionfile | **Optional.** Session file name enhancement.
4740 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4741 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4742 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4743 vmware_password | **Optional.** The username's password. No value defined as default.
4744 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4745 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
4748 **vmware-esx-soap-vm-runtime-issues**
4750 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
4752 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4755 ------------------------|--------------
4756 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4757 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4758 vmware_vmname | **Required.** Virtual machine name.
4759 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4760 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4761 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4762 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4763 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4764 vmware_sessionfile | **Optional.** Session file name enhancement.
4765 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4766 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4767 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4768 vmware_password | **Optional.** The username's password. No value defined as default.
4769 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4770 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.
4773 ### <a id="plugin-contrib-web"></a> Web
4775 This category includes all plugins for web-based checks.
4777 #### <a id="plugin-contrib-command-webinject"></a> webinject
4779 The [check_webinject](https://labs.consol.de/de/nagios/check_webinject/index.html) plugin
4780 uses [WebInject](http://www.webinject.org/manual.html) to test web applications
4781 and web services in an automated fashion.
4782 It can be used to test individual system components that have HTTP interfaces
4783 (JSP, ASP, CGI, PHP, AJAX, Servlets, HTML Forms, XML/SOAP Web Services, REST, etc),
4784 and can be used as a test harness to create a suite of HTTP level automated functional,
4785 acceptance, and regression tests. A test harness allows you to run many test cases
4786 and collect/report your results. WebInject offers real-time results
4787 display and may also be used for monitoring system response times.
4789 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4792 ------------------------|--------------
4793 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.
4794 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.
4795 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
4796 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.
4797 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.
4798 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.
4800 #### <a id="plugin-contrib-command-jmx4perl"></a> jmx4perl
4802 The [check_jmx4perl](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl) plugin
4803 uses the HTTP API exposed by the [Jolokia](https://jolokia.org)
4804 web application and queries Java message beans on an application server. It is
4805 part of the `JMX::Jmx4Perl` Perl module which includes detailed
4806 [documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl).
4808 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4811 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
4812 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
4813 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
4814 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.
4815 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
4816 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
4817 jmx4perl_operation | **Optional.** Operation to execute.
4818 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
4819 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
4820 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
4821 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
4822 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
4823 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
4824 jmx4perl_proxy | **Optional.** Proxy to use.
4825 jmx4perl_user | **Optional.** User for HTTP authentication.
4826 jmx4perl_password | **Optional.** Password for HTTP authentication.
4827 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
4828 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
4829 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.
4830 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
4831 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
4832 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
4833 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.
4834 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
4835 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
4836 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
4837 jmx4perl_critical | **Optional.** Critical threshold for value.
4838 jmx4perl_warning | **Optional.** Warning threshold for value.
4839 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
4840 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
4841 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
4842 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
4843 jmx4perl_config | **Optional.** Path to configuration file.
4844 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
4845 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
4847 #### <a id="plugin-contrib-command-squid"></a> squid
4849 The [check_squid](https://exchange.icinga.com/exchange/check_squid) plugin
4850 uses the `squidclient` binary to monitor a [Squid proxy](http://www.squid-cache.org).
4852 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4855 ------------------------|----------------------------------------------------------------------------------
4856 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
4857 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
4858 squid_port | **Optional.** Port number (default: 3128).
4859 squid_user | **Optional.** WWW user
4860 squid_password | **Optional.** WWW password
4861 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4862 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4863 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
4864 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
4867 #### <a id="plugin-contrib-command-nginx_status"></a> nginx_status
4869 The [check_nginx_status.pl](https://github.com/regilero/check_nginx_status) plugin
4870 uses the [/nginx_status](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
4871 HTTP endpoint which provides metrics for monitoring Nginx.
4873 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4876 --------------------------------|----------------------------------------------------------------------------------
4877 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4878 nginx_status_port | **Optional.** the http port.
4879 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
4880 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
4881 nginx_status_ssl | **Optional.** set to use ssl connection
4882 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
4883 nginx_status_user | **Optional.** Username for basic auth
4884 nginx_status_pass | **Optional.** Password for basic auth
4885 nginx_status_realm | **Optional.** Realm for basic auth
4886 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
4887 nginx_status_timeout | **Optional.** timeout in seconds
4888 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
4889 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
4892 #### <a id="plugin-contrib-command-apache_status"></a> apache_status
4894 The [check_apache_status.pl](https://github.com/lbetz/check_apache_status) plugin
4895 uses the [/server-status](https://httpd.apache.org/docs/current/mod/mod_status.html)
4896 HTTP endpoint to monitor status metrics for the Apache webserver.
4898 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4901 ------------------------|----------------------------------------------------------------------------------
4902 apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4903 apache_status_port | **Optional.** the http port.
4904 apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
4905 apache_status_ssl | **Optional.** set to use ssl connection
4906 apache_status_timeout | **Optional.** timeout in seconds
4907 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
4908 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
4911 #### <a id="plugin-contrib-command-kdc"></a> kdc
4913 The [check_kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details) plugin
4914 uses the Kerberos `kinit` binary to monitor Kerberos 5 KDC by acquiring a ticket.
4916 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4919 ----------------|--------------------------------------------------------------------------
4920 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4921 kdc_port | **Optional** Port on which KDC runs (default 88).
4922 kdc_principal | **Required** Principal name to authenticate as (including realm).
4923 kdc_keytab | **Required** Keytab file containing principal's key.
4926 #### <a id="plugin-contrib-command-rbl"></a> rbl
4928 The [check_rbl](https://github.com/matteocorti/check_rbl) plugin
4929 uses the `Net::DNS` Perl library to check whether your SMTP server
4932 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4935 ----------------|--------------------------------------------------------------------------
4936 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.
4937 rbl_server | **Required** List of RBL servers as an array.
4938 rbl_warning | **Optional** Number of blacklisting servers for a warning.
4939 rbl_critical | **Optional** Number of blacklisting servers for a critical.
4940 tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
projects / icinga2 / blob