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_warning_entries | **Optional.** Number of found entries to result in warning status.
691 ldap_critical_entries | **Optional.** Number of found entries to result in critical status.
692 ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
693 ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
695 ### <a id="plugin-check-command-load"></a> load
697 The [check_load](https://www.monitoring-plugins.org/doc/man/check_load.html) plugin
698 tests the current system load average.
700 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
703 ----------------|--------------
704 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
705 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
706 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
707 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
708 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
709 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
710 load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
712 ### <a id="plugin-check-command-mailq"></a> mailq
714 The [check_mailq](https://www.monitoring-plugins.org/doc/man/check_mailq.html) plugin
715 checks the number of messages in the mail queue (supports multiple sendmail queues, qmail).
717 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
720 ------------------------|--------------
721 mailq_warning | **Required.** Min. number of messages in queue to generate warning.
722 mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ).
723 mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning
724 mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ).
725 mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15).
726 mailq_servertype | **Optional.** [ sendmail \| qmail \| postfix \| exim \| nullmailer ] (default = autodetect).
727 mailq_sudo | **Optional.** Use sudo to execute the mailq command.
729 ### <a id="plugin-check-command-mysql"></a> mysql
731 The [check_mysql](https://www.monitoring-plugins.org/doc/man/check_mysql.html) plugin
732 tests connections to a MySQL server.
734 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
737 ------------------------|---------------------------------------------------------------
738 mysql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
739 mysql_port | **Optional.** Port number (default: 3306).
740 mysql_socket | **Optional.** Use the specified socket (has no effect if `mysql_hostname` is used).
741 mysql_ignore_auth | **Optional.** Ignore authentication failure and check for mysql connectivity only.
742 mysql_database | **Optional.** Check database with indicated name.
743 mysql_file | **Optional.** Read from the specified client options file.
744 mysql_group | **Optional.** Use a client options group.
745 mysql_username | **Optional.** Connect using the indicated username.
746 mysql_password | **Optional.** Use the indicated password to authenticate the connection.
747 mysql_check_slave | **Optional.** Check if the slave thread is running properly.
748 mysql_warning | **Optional.** Exit with WARNING status if slave server is more than INTEGER seconds behind master.
749 mysql_critical | **Optional.** Exit with CRITICAL status if slave server is more then INTEGER seconds behind master.
750 mysql_ssl | **Optional.** Use ssl encryptation.
751 mysql_cacert | **Optional.** Path to CA signing the cert.
752 mysql_cert | **Optional.** Path to SSL certificate.
753 mysql_key | **Optional.** Path to private SSL key.
754 mysql_cadir | **Optional.** Path to CA directory.
755 mysql_ciphers | **Optional.** List of valid SSL ciphers.
758 ### <a id="plugin-check-command-mysql-query"></a> mysql_query
760 The [check_mysql_query](https://www.monitoring-plugins.org/doc/man/check_mysql_query.html) plugin
761 checks a query result against threshold levels.
762 The result from the query should be numeric. For extra security, create a user with minimal access.
764 **Note**: You must specify `mysql_query_password` with an empty string to force an empty password,
765 overriding any my.cnf settings.
767 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
770 ------------------------|---------------------------------------------------------------
771 mysql_query_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
772 mysql_query_port | **Optional.** Port number (default: 3306).
773 mysql_query_database | **Optional.** Check database with indicated name.
774 mysql_query_file | **Optional.** Read from the specified client options file.
775 mysql_query_group | **Optional.** Use a client options group.
776 mysql_query_username | **Optional.** Connect using the indicated username.
777 mysql_query_password | **Optional.** Use the indicated password to authenticate the connection.
778 mysql_query_execute | **Required.** SQL Query to run on the MySQL Server.
779 mysql_query_warning | **Optional.** Exit with WARNING status if query is outside of the range (format: start:end).
780 mysql_query_critical | **Optional.** Exit with CRITICAL status if query is outside of the range.
783 ### <a id="plugin-check-command-negate"></a> negate
785 The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin
786 negates the status of a plugin (returns OK for CRITICAL and vice-versa).
787 Additional switches can be used to control which state becomes what.
789 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
792 ------------------------|---------------------------------------------------------------
793 negate_timeout | **Optional.** Seconds before plugin times out (default: 11).
794 negate_timeout_result | **Optional.** Custom result on Negate timeouts, default to UNKNOWN.
795 negate_ok | **Optional.** OK, WARNING, CRITICAL or UNKNOWN.
796 negate_warning | Numeric values are accepted.
797 negate_critical | If nothing is specified, permutes OK and CRITICAL.
798 negate_substitute | **Optional.** Substitute output text as well. Will only substitute text in CAPITALS.
799 negate_command | **Required.** Command to be negated.
800 negate_arguments | **Optional.** Arguments for the negated command.
802 ### <a id="plugin-check-command-nrpe"></a> nrpe
804 The `check_nrpe` plugin can be used to query an [NRPE](https://docs.icinga.com/latest/en/nrpe.html)
805 server or [NSClient++](https://www.nsclient.org). **Note**: This plugin
806 is considered insecure/deprecated.
808 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
811 ----------------|--------------
812 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
813 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
814 nrpe_command | **Optional.** The command that should be executed.
815 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
816 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
817 nrpe_timeout | **Optional.** The timeout in seconds.
818 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
819 nrpe_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
820 nrpe_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
821 nrpe_version_2 | **Optional.** Use this if you want to connect using NRPE v2 protocol. Defaults to false.
824 ### <a id="plugin-check-command-nscp"></a> nscp
826 The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin
827 collects data from the [NSClient++](https://www.nsclient.org) service.
829 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
832 ----------------|--------------
833 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
834 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
835 nscp_password | **Optional.** The NSClient++ password.
836 nscp_variable | **Required.** The variable that should be checked.
837 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
838 nscp_warn | **Optional.** The warning threshold.
839 nscp_crit | **Optional.** The critical threshold.
840 nscp_timeout | **Optional.** The query timeout in seconds.
841 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
844 ### <a id="plugin-check-command-ntp-time"></a> ntp_time
846 The [check_ntp_time](https://www.monitoring-plugins.org/doc/man/check_ntp_time.html) plugin
847 checks the clock offset between the local host and a remote NTP server.
849 **Note**: If you want to monitor an NTP server, please use `ntp_peer`.
851 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
854 ----------------|--------------
855 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
856 ntp_port | **Optional.** Port number (default: 123).
857 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
858 ntp_warning | **Optional.** Offset to result in warning status (seconds).
859 ntp_critical | **Optional.** Offset to result in critical status (seconds).
860 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
861 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
862 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
863 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
866 ### <a id="plugin-check-command-ntp-peer"></a> ntp_peer
868 The [check_ntp_peer](https://www.monitoring-plugins.org/doc/man/check_ntp_peer.html) plugin
869 checks the health of an NTP server. It supports checking the offset with the sync peer, the
870 jitter and stratum. This plugin will not check the clock offset between the local host and NTP
871 server; please use `ntp_time` for that purpose.
873 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
876 ----------------|--------------
877 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
878 ntp_port | **Optional.** The port to use. Default to 123.
879 ntp_warning | **Optional.** Offset to result in warning status (seconds).
880 ntp_critical | **Optional.** Offset to result in critical status (seconds).
881 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
882 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
883 ntp_wjitter | **Optional.** Warning threshold for jitter.
884 ntp_cjitter | **Optional.** Critical threshold for jitter.
885 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
886 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
887 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
888 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
889 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
892 ### <a id="plugin-check-command-passive"></a> passive
894 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
896 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
899 ----------------|--------------
900 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
901 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
903 ### <a id="plugin-check-command-pgsql"></a> pgsql
905 The [check_pgsql](https://www.monitoring-plugins.org/doc/man/check_pgsql.html) plugin
906 tests a PostgreSQL DBMS to determine whether it is active and accepting queries.
907 If a query is specified using the `pgsql_query` attribute, it will be executed after
908 connecting to the server. The result from the query has to be numeric in order
909 to compare it against the query thresholds if set.
911 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
914 ------------------------|---------------------------------------------------------------
915 pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
916 pgsql_port | **Optional.** Port number (default: 5432).
917 pgsql_database | **Optional.** Database to check (default: template1).
918 pgsql_username | **Optional.** Login name of user.
919 pgsql_password | **Optional.** Password (BIG SECURITY ISSUE).
920 pgsql_options | **Optional.** Connection parameters (keyword = value), see below.
921 pgsql_warning | **Optional.** Response time to result in warning status (seconds).
922 pgsql_critical | **Optional.** Response time to result in critical status (seconds).
923 pgsql_timeout | **Optional.** Seconds before connection times out (default: 10).
924 pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read.
925 pgsql_query_warning | **Optional.** SQL query value to result in warning status (double).
926 pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
928 ### <a id="plugin-check-command-ping"></a> ping
930 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
931 uses the ping command to probe the specified host for packet loss (percentage) and
932 round trip average (milliseconds).
934 This command uses the host's `address` attribute if available and falls back to using
935 the `address6` attribute if the `address` attribute is not set.
937 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
940 ----------------|--------------
941 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
942 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
943 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
944 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
945 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
946 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
947 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
950 ### <a id="plugin-check-command-ping4"></a> ping4
952 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
953 uses the ping command to probe the specified host for packet loss (percentage) and
954 round trip average (milliseconds).
956 This command uses the host's `address` attribute if not explicitely specified using
957 the `ping_address` attribute.
959 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
962 ----------------|--------------
963 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
964 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
965 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
966 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
967 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
968 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
969 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
971 ### <a id="plugin-check-command-ping6"></a> ping6
973 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
974 uses the ping command to probe the specified host for packet loss (percentage) and
975 round trip average (milliseconds).
977 This command uses the host's `address6` attribute if not explicitely specified using
978 the `ping_address` attribute.
980 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
983 ----------------|--------------
984 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
985 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
986 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
987 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
988 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
989 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
990 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
993 ### <a id="plugin-check-command-pop"></a> pop
995 The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin
996 tests POP connections with the specified host (or unix socket).
998 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1001 ---------------------|--------------
1002 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1003 pop_port | **Optional.** The port that should be checked. Defaults to 110.
1004 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.
1005 pop_send | **Optional.** String to send to the server.
1006 pop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1007 pop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1008 pop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1009 pop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1010 pop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1011 pop_jail | **Optional.** Hide output from TCP socket.
1012 pop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1013 pop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1014 pop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1015 pop_ssl | **Optional.** Use SSL for the connection.
1016 pop_warning | **Optional.** Response time to result in warning status (seconds).
1017 pop_critical | **Optional.** Response time to result in critical status (seconds).
1018 pop_timeout | **Optional.** Seconds before connection times out (default: 10).
1019 pop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1020 pop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1023 ### <a id="plugin-check-command-processes"></a> procs
1025 The [check_procs](https://www.monitoring-plugins.org/doc/man/check_procs.html) plugin
1026 checks all processes and generates WARNING or CRITICAL states if the specified
1027 metric is outside the required threshold ranges. The metric defaults to number
1028 of processes. Search filters can be applied to limit the processes to check.
1030 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1033 ---------------------|--------------
1034 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
1035 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
1036 procs_metric | **Optional.** Check thresholds against metric.
1037 procs_timeout | **Optional.** Seconds before plugin times out.
1038 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
1039 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
1040 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
1041 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
1042 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
1043 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
1044 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
1045 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
1046 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
1047 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
1048 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
1051 ### <a id="plugin-check-command-radius"></a> radius
1053 The [check_radius](https://www.monitoring-plugins.org/doc/man/check_radius.html) plugin
1054 checks a RADIUS server to see if it is accepting connections. The server to test
1055 must be specified in the invocation, as well as a user name and password. A configuration
1056 file may also be present. The format of the configuration file is described in the
1057 radiusclient library sources. The password option presents a substantial security
1058 issue because the password can possibly be determined by careful watching of the
1059 command line in a process listing. This risk is exacerbated because the plugin will
1060 typically be executed at regular predictable intervals. Please be sure that the
1061 password used does not allow access to sensitive system resources.
1064 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1067 -------------------|--------------
1068 radius_address | **Optional.** The radius server's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1069 radius_config_file | **Required.** The radius configuration file.
1070 radius_username | **Required.** The radius username to test.
1071 radius_password | **Required.** The radius password to test.
1072 radius_port | **Optional.** The radius port number (default 1645).
1073 radius_nas_id | **Optional.** The NAS identifier.
1074 radius_nas_address | **Optional.** The NAS IP address.
1075 radius_expect | **Optional.** The response string to expect from the server.
1076 radius_retries | **Optional.** The number of times to retry a failed connection.
1077 radius_timeout | **Optional.** The number of seconds before connection times out (default: 10).
1080 ### <a id="plugin-check-command-simap"></a> simap
1082 The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
1083 tests SIMAP connections with the specified host (or unix socket).
1085 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1088 -----------------------|--------------
1089 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1090 simap_port | **Optional.** The port that should be checked. Defaults to 993.
1091 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.
1092 simap_send | **Optional.** String to send to the server.
1093 simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1094 simap_all | **Optional.** All expect strings need to occur in server response. Default is any.
1095 simap_quit | **Optional.** String to send server to initiate a clean close of the connection.
1096 simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1097 simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1098 simap_jail | **Optional.** Hide output from TCP socket.
1099 simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1100 simap_delay | **Optional.** Seconds to wait between sending string and polling for response.
1101 simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1102 simap_ssl | **Optional.** Use SSL for the connection.
1103 simap_warning | **Optional.** Response time to result in warning status (seconds).
1104 simap_critical | **Optional.** Response time to result in critical status (seconds).
1105 simap_timeout | **Optional.** Seconds before connection times out (default: 10).
1106 simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1107 simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1109 ### <a id="plugin-check-command-smart"></a> smart
1111 The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
1112 checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
1114 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1117 ----------------|--------------
1118 smart_device | **Required.** The name of a local hard drive to monitor.
1121 ### <a id="plugin-check-command-smtp"></a> smtp
1123 The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
1124 will attempt to open an SMTP connection with the host.
1126 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1129 ----------------------|--------------
1130 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1131 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
1132 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
1133 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
1134 smtp_command | **Optional.** SMTP command (may be used repeatedly).
1135 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
1136 smtp_helo_fqdn | **Optional.** FQDN used for HELO
1137 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1138 smtp_starttls | **Optional.** Use STARTTLS for the connection.
1139 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
1140 smtp_authuser | **Optional.** SMTP AUTH username.
1141 smtp_authpass | **Optional.** SMTP AUTH password.
1142 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
1143 smtp_warning | **Optional.** Response time to result in warning status (seconds).
1144 smtp_critical | **Optional.** Response time to result in critical status (seconds).
1145 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1146 smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1147 smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1150 ### <a id="plugin-check-command-snmp"></a> snmp
1152 The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin
1153 checks the status of remote machines and obtains system information via SNMP.
1155 **Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
1157 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1160 --------------------|--------------
1161 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1162 snmp_oid | **Required.** The SNMP OID.
1163 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1164 snmp_port | **Optional.** The SNMP port. Defaults to "161".
1165 snmp_retries | **Optional.** Number of retries to be used in the SNMP requests.
1166 snmp_warn | **Optional.** The warning threshold.
1167 snmp_crit | **Optional.** The critical threshold.
1168 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
1169 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
1170 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
1171 snmp_label | **Optional.** Prefix label for output value
1172 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
1173 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1174 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
1175 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
1176 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1177 snmp_rate | **Optional.** Boolean. Enable rate calculation.
1178 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
1179 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1181 ### <a id="plugin-check-command-snmpv3"></a> snmpv3
1183 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1184 plugin, using SNMPv3 authentication and encryption options.
1186 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1189 ---------------------|--------------
1190 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1191 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
1192 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
1193 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
1194 snmpv3_user | **Required.** The username to log in with.
1195 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
1196 snmpv3_priv_key | **Required.** The encryption key.
1197 snmpv3_oid | **Required.** The SNMP OID.
1198 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
1199 snmpv3_warn | **Optional.** The warning threshold.
1200 snmpv3_crit | **Optional.** The critical threshold.
1201 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
1202 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
1203 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
1204 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
1205 snmpv3_label | **Optional.** Prefix label for output value.
1206 snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1207 snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1208 snmpv3_rate | **Optional.** Boolean. Enable rate calculation.
1209 snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1211 ### <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
1213 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1214 plugin, using the uptime OID by default.
1216 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1219 ----------------|--------------
1220 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1221 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
1222 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1225 ### <a id="plugin-check-command-spop"></a> spop
1227 The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
1228 tests SPOP connections with the specified host (or unix socket).
1230 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1233 ----------------------|--------------
1234 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1235 spop_port | **Optional.** The port that should be checked. Defaults to 995.
1236 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.
1237 spop_send | **Optional.** String to send to the server.
1238 spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1239 spop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1240 spop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1241 spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1242 spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1243 spop_jail | **Optional.** Hide output from TCP socket.
1244 spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1245 spop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1246 spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1247 spop_ssl | **Optional.** Use SSL for the connection.
1248 spop_warning | **Optional.** Response time to result in warning status (seconds).
1249 spop_critical | **Optional.** Response time to result in critical status (seconds).
1250 spop_timeout | **Optional.** Seconds before connection times out (default: 10).
1251 spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1252 spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1255 ### <a id="plugin-check-command-ssh"></a> ssh
1257 The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
1258 connects to an SSH server at a specified host and port.
1260 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1263 ----------------|--------------
1264 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1265 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
1266 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1267 ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1268 ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1271 ### <a id="plugin-check-command-ssl"></a> ssl
1273 Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
1274 using ssl-related options.
1276 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1279 ------------------------------|--------------
1280 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1281 ssl_port | **Required.** The port that should be checked.
1282 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
1283 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.
1284 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.
1285 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$".
1288 ### <a id="plugin-check-command-ssmtp"></a> ssmtp
1290 The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
1291 tests SSMTP connections with the specified host (or unix socket).
1293 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1296 -----------------------|--------------
1297 ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1298 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
1299 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.
1300 ssmtp_send | **Optional.** String to send to the server.
1301 ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1302 ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any.
1303 ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1304 ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1305 ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1306 ssmtp_jail | **Optional.** Hide output from TCP socket.
1307 ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1308 ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1309 ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1310 ssmtp_ssl | **Optional.** Use SSL for the connection.
1311 ssmtp_warning | **Optional.** Response time to result in warning status (seconds).
1312 ssmtp_critical | **Optional.** Response time to result in critical status (seconds).
1313 ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1314 ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1315 ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1318 ### <a id="plugin-check-command-swap"></a> swap
1320 The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
1321 checks the swap space on a local machine.
1323 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1326 ----------------|--------------
1327 swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`.
1328 swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`.
1329 swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
1330 swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false.
1331 swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".
1334 ### <a id="plugin-check-command-tcp"></a> tcp
1336 The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
1337 tests TCP connections with the specified host (or unix socket).
1339 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1342 ----------------|--------------
1343 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1344 tcp_port | **Required.** The port that should be checked.
1345 tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1346 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
1347 tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
1348 tcp_send | **Optional.** String to send to the server.
1349 tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
1350 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1351 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
1352 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
1353 tcp_jail | **Optional.** Hide output from TCP socket.
1354 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1355 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1356 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.
1357 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
1358 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
1359 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
1360 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1361 tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1362 tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1365 ### <a id="plugin-check-command-udp"></a> udp
1367 The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
1368 tests UDP connections with the specified host (or unix socket).
1370 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1373 ----------------|--------------
1374 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1375 udp_port | **Required.** The port that should be checked.
1376 udp_send | **Required.** The payload to send in the UDP datagram.
1377 udp_expect | **Required.** The payload to expect in the response datagram.
1378 udp_quit | **Optional.** The payload to send to 'close' the session.
1379 udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1380 udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1383 ### <a id="plugin-check-command-ups"></a> ups
1385 The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin
1386 tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
1387 must be running for this plugin to work.
1389 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1392 ----------------|--------------
1393 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1394 ups_name | **Required.** The UPS name. Defaults to `ups`.
1395 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
1396 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`.
1397 ups_warning | **Optional.** The warning threshold for the selected variable.
1398 ups_critical | **Optional.** The critical threshold for the selected variable.
1399 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
1400 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
1403 ### <a id="plugin-check-command-users"></a> users
1405 The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin
1406 checks the number of users currently logged in on the local system and generates an
1407 error if the number exceeds the thresholds specified.
1409 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1412 ----------------|--------------
1413 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
1414 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
1416 ## <a id="windows-plugins"></a> Windows Plugins for Icinga 2
1418 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.
1420 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:
1422 include <windows-plugins>
1424 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.
1427 ### <a id="windows-plugins-thresholds"></a> Threshold syntax
1429 So not specified differently the thresholds for the plugins all follow the same pattern
1432 :------------|:----------
1433 "29" | The threshold is 29.
1434 "!29" | The threshold is 29, but the negative of the result is returned.
1435 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
1436 "![10-40]" | Same as above, but the result is inverted.
1439 ### <a id="windows-plugins-disk-windows"></a> disk-windows
1441 Check command object for the `check_disk.exe` plugin.
1442 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.).
1446 > Percentage based thresholds can be used by adding a '%' to the threshold
1452 :-------------------|:------------
1453 disk\_win\_warn | **Optional**. The warning threshold.
1454 disk\_win\_crit | **Optional**. The critical threshold.
1455 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1456 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.
1457 disk\_win\_exclude | **Optional**. Exclude these drives from check.
1459 ### <a id="windows-plugins-load-windows"></a> load-windows
1461 Check command object for the `check_load.exe` plugin.
1462 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).
1467 :---------------|:------------
1468 load\_win\_warn | **Optional**. The warning threshold.
1469 load\_win\_crit | **Optional**. The critical threshold.
1472 ### <a id="windows-plugins-memory-windows"></a> memory-windows
1474 Check command object for the `check_memory.exe` plugin.
1475 The memory collection is instant.
1479 > Percentage based thresholds can be used by adding a '%' to the threshold
1480 > value. Keep in mind that memory\_win\_unit is applied before the
1481 > value is calculated.
1486 :-----------------|:------------
1487 memory\_win\_warn | **Optional**. The warning threshold.
1488 memory\_win\_crit | **Optional**. The critical threshold.
1489 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.
1492 ### <a id="windows-plugins-network-windows"></a> network-windows
1494 Check command object for the `check_network.exe` plugin.
1495 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).
1500 :-------------------|:------------
1501 network\_win\_warn | **Optional**. The warning threshold.
1502 network\_win\_crit | **Optional**. The critical threshold.
1503 network\_no\_isatap | **Optional**. Do not print ISATAP interfaces.
1506 ### <a id="windows-plugins-perfmon-windows"></a> perfmon-windows
1508 Check command object for the `check_perfmon.exe` plugin.
1509 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`.
1511 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"`
1516 :---------------------|:------------
1517 perfmon\_win\_warn | **Optional**. The warning threshold.
1518 perfmon\_win\_crit | **Optional**. The critical threshold.
1519 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1520 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1521 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
1522 perfmon\_win\_syntax | **Optional**. Use this in the performance output instead of `perfmon\_win\_counter`. Exists for graphice compatibility reasons.
1525 ### <a id="windows-plugins-ping-windows"></a> ping-windows
1527 Check command object for the `check_ping.exe` plugin.
1528 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.
1533 :------------------|:------------
1534 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma.
1535 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma.
1536 ping\_win\_address | **Required**. An IPv4 or IPv6 address
1537 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1538 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1541 ### <a id="windows-plugins-procs-windows"></a> procs-windows
1543 Check command object for `check_procs.exe` plugin.
1544 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.
1549 :----------------|:------------
1550 procs\_win\_warn | **Optional**. The warning threshold.
1551 procs\_win\_crit | **Optional**. The critical threshold.
1552 procs\_win\_user | **Optional**. Count this useres processes.
1555 ### <a id="windows-plugins-service-windows"></a> service-windows
1557 Check command object for `check_service.exe` plugin.
1558 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.
1563 :---------------------|:------------
1564 service\_win\_warn | **Optional**. Warn when service is not running.
1565 service\_win\_service | **Required**. The critical threshold.
1568 ### <a id="windows-plugins-swap-windows"></a> swap-windows
1570 Check command object for `check_swap.exe` plugin.
1571 The data collection is instant.
1576 :---------------|:------------
1577 swap\_win\_warn | **Optional**. The warning threshold.
1578 swap\_win\_crit | **Optional**. The critical threshold.
1579 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1582 ### <a id="windows-plugins-update-windows"></a> update-windows
1584 Check command object for `check_update.exe` plugin.
1585 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.
1589 > The Network Services Account which runs Icinga 2 by default does not have the required
1590 > permissions to run this check.
1595 :-------------------|:------------
1596 update\_win\_warn | **Optional**. If set, returns warning when important updates are available.
1597 update\_win\_crit | **Optional**. If set, return critical when important updates that require a reboot are available.
1598 update\_win\_reboot | **Optional**. Set to treat 'may need update' as 'definitely needs update'. Please Note that this is true for almost every update and is therefore not recommended.
1601 In contrast to most other plugins, the values of check_update's custom attributes do not set thresholds, but just enable/disable the behaviour described in the table above.
1602 It can be enabled/disabled for example by setting them to "true" or "false", "1" or "0" would also work.
1603 Thresholds will always be "1".
1607 > If they are enabled, performance data will be shown in the webinterface.
1608 > If run without the optional parameters, the plugin will output critical if any important updates are available.
1611 ### <a id="windows-plugins-uptime-windows"></a> uptime-windows
1613 Check command opject for `check_uptime.exe` plugin.
1614 Uses GetTickCount64 to get the uptime, so boot time is not included.
1619 :-----------------|:------------
1620 uptime\_win\_warn | **Optional**. The warning threshold.
1621 uptime\_win\_crit | **Optional**. The critical threshold.
1622 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).
1625 ### <a id="windows-plugins-users-windows"></a> users-windows
1627 Check command object for `check_users.exe` plugin.
1632 :----------------|:------------
1633 users\_win\_warn | **Optional**. The warning threshold.
1634 users\_win\_crit | **Optional**. The critical threshold.
1637 ## <a id="nscp-plugin-check-commands"></a> Plugin Check Commands for NSClient++
1639 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1641 You can enable these check commands by adding the following the include directive in your
1642 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1646 You can also optionally specify an alternative installation directory for NSClient++ by adding
1647 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1650 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1652 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1653 not be necessary to manually set this constant.
1655 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1657 ### <a id="nscp-check-local"></a> nscp-local
1659 Check command object for NSClient++
1661 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1664 ----------------|--------------
1665 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1666 nscp_load_all | **Optional.** Whether to load all modules. Defaults to false.
1667 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`.
1668 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1669 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1670 nscp_arguments | **Optional.** An array of query arguments.
1671 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1673 ### <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1675 Check command object for the `check_cpu` NSClient++ plugin.
1678 --------------------|------------------
1679 nscp_cpu_time | **Optional.** Calculate avarage usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1680 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1681 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1682 nscp_cpu_arguments | **Optional.** Additional arguments.
1683 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1685 ### <a id="nscp-check-local-memory"></a> nscp-local-memory
1687 Check command object for the `check_memory` NSClient++ plugin.
1690 ----------------------|------------------
1691 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1692 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1693 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1694 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolut (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1695 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolut (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1696 nscp_memory_arguments | **Optional.** Additional arguments.
1697 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1699 ### <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1701 Check command object for the `check_os_version` NSClient++ plugin.
1703 This command has the same custom attributes like the `nscp-local` check command.
1705 ### <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1707 Check command object for the `check_pagefile` NSClient++ plugin.
1709 This command has the same custom attributes like the `nscp-local` check command.
1711 ### <a id="nscp-check-local-process"></a> nscp-local-process
1713 Check command object for the `check_process` NSClient++ plugin.
1715 This command has the same custom attributes like the `nscp-local` check command.
1717 ### <a id="nscp-check-local-service"></a> nscp-local-service
1719 Check command object for the `check_service` NSClient++ plugin.
1722 -----------------------|------------------
1723 nscp_service_name | **Required.** Name of service to check.
1724 nscp_service_type | **Optional.** Type to check, default to state.
1725 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1726 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1727 nscp_service_warning | **Optional.** State for return an WARNING.
1728 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1729 nscp_service_critical | **Optional.** State for return an CRITICAL.
1730 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1731 nscp_service_arguments | **Optional.** Additional arguments.
1732 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1734 ### <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1736 Check command object for the `check_uptime` NSClient++ plugin.
1738 This command has the same custom attributes like the `nscp-local` check command.
1740 ### <a id="nscp-check-local-version"></a> nscp-local-version
1742 Check command object for the `check_version` NSClient++ plugin.
1744 This command has the same custom attributes like the `nscp-local` check command.
1745 In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
1747 ### <a id="nscp-check-local-disk"></a> nscp-local-disk
1749 Check command object for the `check_drivesize` NSClient++ plugin.
1752 -----------------------|------------------
1753 nscp_disk_drive | **Optional.** Drive character, default to all drives.
1754 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1755 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolut (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1756 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolut (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1757 nscp_disk_arguments | **Optional.** Additional arguments.
1758 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1759 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`.
1761 ### <a id="nscp-check-local-counter"></a> nscp-local-counter
1763 Check command object for the `check_pdh` NSClient++ plugin.
1766 -----------------------|------------------
1767 nscp_counter_name | **Required.** Performance counter name.
1768 nscp_counter_warning | **Optional.** WARNING Threshold.
1769 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1770 nscp_counter_arguments | **Optional.** Additional arguments.
1771 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1772 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1776 ## <a id="snmp-manubulon-plugin-check-commands"></a> Plugin Check Commands for Manubulon SNMP
1778 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1779 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1781 **Note:** Some plugin parameters are only available in Debian packages or in a
1782 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1784 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1785 is set to the path where the Manubublon SNMP plugins are installed.
1787 You can enable these plugin check commands by adding the following the include directive in your
1788 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1792 ### Checks by Host Type
1794 **N/A** : Not available for this type.
1796 **SNMP** : Available for simple SNMP query.
1800 **Specific** : Script name for platform specific checks.
1803 Host type | Interface | storage | load/cpu | mem | process | env | specific
1804 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1805 Linux | Yes | Yes | Yes | Yes | Yes | No |
1806 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1807 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1808 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1809 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1810 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1811 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1812 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1813 AS400 | Yes | Yes | Yes | Yes | No | No |
1814 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1815 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1816 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1817 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1820 ### <a id="plugin-check-command-snmp-load"></a> snmp-load
1822 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1824 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1828 ------------------------|--------------
1829 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1830 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1831 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1832 snmp_port | **Optional.** The SNMP port connection.
1833 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1834 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1835 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1836 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1837 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1838 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1839 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1840 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1841 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1842 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1843 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.
1844 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1845 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1847 ### <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1849 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1851 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1854 ------------------------|--------------
1855 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1856 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1857 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1858 snmp_port | **Optional.** The SNMP port connection.
1859 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1860 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1861 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1862 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1863 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1864 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1865 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1866 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1867 snmp_warn | **Optional.** The warning threshold.
1868 snmp_crit | **Optional.** The critical threshold.
1869 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1870 snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
1871 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1872 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1874 ### <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1876 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1878 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1881 ------------------------|--------------
1882 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1883 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1884 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1885 snmp_port | **Optional.** The SNMP port connection.
1886 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1887 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1888 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1889 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1890 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1891 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1892 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1893 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1894 snmp_warn | **Optional.** The warning threshold.
1895 snmp_crit | **Optional.** The critical threshold.
1896 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1897 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1898 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1900 ### <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1902 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1904 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1907 ----------------------------|--------------
1908 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1909 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1910 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1911 snmp_port | **Optional.** The SNMP port connection.
1912 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1913 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1914 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1915 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1916 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1917 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1918 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1919 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1920 snmp_warn | **Optional.** The warning threshold.
1921 snmp_crit | **Optional.** The critical threshold.
1922 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1923 snmp_interface_inverse | **Optional.** Inverse Interface check, down is ok. Defaults to false as it is missing.
1924 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1925 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
1926 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.
1927 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1928 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1929 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.
1930 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1931 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1932 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1933 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1934 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.
1935 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name.
1936 snmp_interface_ifalias | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name.
1937 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1938 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1940 ### <a id="plugin-check-command-snmp-process"></a> snmp-process
1942 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1944 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1947 ---------------------------|--------------
1948 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1949 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1950 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1951 snmp_port | **Optional.** The SNMP port connection.
1952 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1953 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1954 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1955 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1956 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1957 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1958 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1959 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1960 snmp_warn | **Optional.** The warning threshold.
1961 snmp_crit | **Optional.** The critical threshold.
1962 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1963 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1964 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1965 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.
1966 snmp_process_mem_usage | **Optional.** Define to check memory usage for the process. Defaults to false.
1967 snmp_process_mem_threshold | **Optional.** Defines the warning and critical thresholds in Mb when snmp_process_mem_usage set to true. Example "512,1024". Defaults to "0,0".
1968 snmp_process_cpu_usage | **Optional.** Define to check CPU usage for the process. Defaults to false.
1969 snmp_process_cpu_threshold | **Optional.** Defines the warning and critical thresholds in % when snmp_process_cpu_usage set to true. If more than one CPU, value can be > 100% : 100%=1 CPU. Example "15,50". Defaults to "0,0".
1972 ## <a id="plugin-contrib"></a> Contributed Plugin Check Commands
1974 The contributed Plugin Check Commands provides various additional command definitions
1975 contributed by community members.
1977 These check commands assume that the global constant named `PluginContribDir`
1978 is set to the path where the user installs custom plugins and can be enabled by
1979 uncommenting the corresponding line in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf):
1982 vim /etc/icinga2/icinga2.conf
1984 include <plugin-contrib>
1987 This is enabled by default since Icinga 2 2.5.0.
1989 ### <a id="plugin-contrib-databases"></a> Databases
1991 This category contains plugins for various database servers.
1993 #### <a id="plugin-contrib-command-db2_health"></a> db2_health
1995 The [check_db2_health](https://labs.consol.de/nagios/check_db2_health/) plugin
1996 uses the `DBD::DB2` Perl library to monitor a [DB2](https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/)
1999 The Git repository is located on [GitHub](https://github.com/lausser/check_db2_health).
2001 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2004 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2005 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)
2006 db2_health_username | **Optional.** The username for the database connection.
2007 db2_health_password | **Optional.** The password for the database connection.
2008 db2_health_port | **Optional.** The port where DB2 is listening.
2009 db2_health_warning | **Optional.** The warning threshold depending on the mode.
2010 db2_health_critical | **Optional.** The critical threshold depending on the mode.
2011 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
2012 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).
2013 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.
2014 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.
2015 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
2016 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".
2017 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
2018 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
2019 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
2020 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".
2021 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
2023 #### <a id="plugin-contrib-command-mssql_health"></a> mssql_health
2025 The [check_mssql_health](https://labs.consol.de/nagios/check_mssql_health/index.html) plugin
2026 uses the `DBD::Sybase` Perl library based on [FreeTDS](http://www.freetds.org/) to monitor a
2027 [MS SQL](https://www.microsoft.com/en-us/sql-server/) server.
2029 The Git repository is located on [GitHub](https://github.com/lausser/check_mssql_health).
2031 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2034 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2035 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
2036 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
2037 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
2038 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
2039 mssql_health_username | **Optional.** The username for the database connection.
2040 mssql_health_password | **Optional.** The password for the database connection.
2041 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
2042 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
2043 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
2044 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).
2045 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
2046 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.
2047 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
2048 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".
2049 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
2050 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
2051 mssql_health_notemp | **Optional.** Set this to true to ignore temporary databases/tablespaces. Defaults to false.
2052 mssql_health_nooffline | **Optional.** Set this to true to ignore offline databases. Defaults to false.
2053 mssql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates.
2055 #### <a id="plugin-contrib-command-mysql_health"></a> mysql_health
2057 The [check_mysql_health](https://labs.consol.de/nagios/check_mysql_health/index.html) plugin
2058 uses the `DBD::MySQL` Perl library to monitor a
2059 [MySQL](https://dev.mysql.com/downloads/mysql/) or [MariaDB](https://mariadb.org/about/) database.
2061 The Git repository is located on [GitHub](https://github.com/lausser/check_mysql_health).
2063 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2066 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2067 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
2068 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
2069 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
2070 mysql_health_username | **Optional.** The username for the database connection.
2071 mysql_health_password | **Optional.** The password for the database connection.
2072 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
2073 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
2074 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
2075 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
2076 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
2077 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
2078 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
2079 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::* module.
2080 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
2081 mysql_health_nooffline | **Optional.** Skip the offline databases.
2082 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
2083 mysql_health_name | **Optional.** The name of a specific component to check.
2084 mysql_health_name2 | **Optional.** The secondary name of a component.
2085 mysql_health_name3 | **Optional.** The tertiary name of a component.
2086 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".
2087 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2088 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2089 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components"
2090 mysql_health_mitigation | **Optional.** "The parameter allows you to change a critical error to a warning."
2091 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates."
2092 mysql_health_environment | **Optional.** Add a variable to the plugin's environment."
2093 mysql_health_morphmessage | **Optional.** Modify the final output message."
2094 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels."
2095 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data."
2096 mysql_health_report | **Optional.** Can be used to shorten the output."
2097 mysql_health_multiline | **Optional.** Multiline output."
2098 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical."
2099 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory."
2100 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files."
2101 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time."
2102 mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2104 #### <a id="plugin-contrib-command-oracle_health"></a> oracle_health
2106 The [check_oracle_health](https://labs.consol.de/nagios/check_oracle_health/index.html) plugin
2107 uses the `DBD::Oracle` Perl library to monitor an [Oracle](https://www.oracle.com/database/) database.
2109 The Git repository is located on [GitHub](https://github.com/lausser/check_oracle_health).
2111 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2114 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2115 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2116 oracle_health_username | **Optional.** The username for the database connection.
2117 oracle_health_password | **Optional.** The password for the database connection.
2118 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2119 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2120 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2121 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2122 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.
2123 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.
2124 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2125 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".
2126 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2127 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2128 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2129 oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2130 oracle_health_report | **Optional.** Select the plugin output format. Can be short or long. Default to long.
2135 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2136 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".
2137 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".
2139 #### <a id="plugin-contrib-command-postgres"></a> postgres
2141 The [check_postgres](https://bucardo.org/wiki/Check_postgres) plugin
2142 uses the `psql` binary to monitor a [PostgreSQL](https://www.postgresql.org/about/) database.
2144 The Git repository is located on [GitHub](https://github.com/bucardo/check_postgres).
2146 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2149 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2150 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.
2151 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2152 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2153 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2154 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2155 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2156 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2157 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2158 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2159 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2160 postgres_includeuser | **Optional.** Include objects owned by certain users.
2161 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2162 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
2163 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2164 postgres_action | **Required.** Determines the test executed.
2165 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2166 postgres_query | **Optional.** Query for "custom_query" action.
2167 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2168 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2169 postgres_tempdir | **Optional.** Specify directory for temporary files. The default directory is dependent on the OS. More details [here](https://perldoc.perl.org/File/Spec.html).
2171 #### <a id="plugin-contrib-command-mongodb"></a> mongodb
2173 The [check_mongodb.py](https://github.com/mzupan/nagios-plugin-mongodb) plugin
2174 uses the `pymongo` Python library to monitor a [MongoDB](https://docs.mongodb.com/manual/) instance.
2176 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2179 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2180 mongodb_host | **Required.** Specifies the hostname or address.
2181 mongodb_port | **Required.** The port mongodb is runnung on.
2182 mongodb_user | **Optional.** The username you want to login as
2183 mongodb_passwd | **Optional.** The password you want to use for that user
2184 mongodb_warning | **Optional.** The warning threshold we want to set
2185 mongodb_critical | **Optional.** The critical threshold we want to set
2186 mongodb_action | **Required.** The action you want to take
2187 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
2188 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
2189 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
2190 mongodb_database | **Optional.** Specify the database to check
2191 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
2192 mongodb_ssl | **Optional.** Connect using SSL
2193 mongodb_replicaset | **Optional.** Connect to replicaset
2194 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check
2195 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second
2196 mongodb_collection | **Optional.** Specify the collection to check
2197 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
2199 #### <a id="plugin-contrib-command-elasticsearch"></a> elasticsearch
2201 The [check_elasticsearch](https://github.com/anchor/nagios-plugin-elasticsearch) plugin
2202 uses the HTTP API to monitor an [Elasticsearch](https://www.elastic.co/products/elasticsearch) node.
2204 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2207 -----------------------------|-------------------------------------------------------------------------------------------------------
2208 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2209 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
2210 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.
2211 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2212 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2213 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2215 #### <a id="plugin-contrib-command-redis"></a> redis
2217 The [check_redis.pl](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl) plugin
2218 uses the `Redis` Perl library to monitor a [Redis](https://redis.io/) instance. The plugin can
2219 measure response time, hitrate, memory utilization, check replication synchronization, etc. It is
2220 also possible to test data in a specified key and calculate averages or summaries on ranges.
2222 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2225 -------------------------|--------------------------------------------------------------------------------------------------------------
2226 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
2227 redis_port | **Optional.** Port number to query. Default to "6379".
2228 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2229 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2230 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2231 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2232 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2233 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.
2234 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.
2235 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.
2236 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2237 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.
2238 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".
2239 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2240 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2241 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.
2242 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2243 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.
2244 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2245 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2248 ### <a id="plugin-contrib-hardware"></a> Hardware
2250 This category includes all plugin check commands for various hardware checks.
2252 #### <a id="plugin-contrib-command-hpasm"></a> hpasm
2254 The [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) plugin
2255 monitors the hardware health of HP Proliant Servers, provided that the `hpasm`
2256 (HP Advanced Server Management) software is installed. It is also able to monitor
2257 the system health of HP Bladesystems and storage systems.
2259 The plugin can run in two different ways:
2261 1. Local execution using the `hpasmcli` command line tool.
2262 2. Remote SNMP query which invokes the HP Insight Tools on the remote node.
2264 You can either set or omit `hpasm_hostname` custom attribute and select the corresponding node.
2266 The `hpasm_remote` attribute enables the plugin to execute remote SNMP queries if set to `true`.
2267 For compatibility reasons this attribute uses `true` as default value, and ensures that
2268 specifying the `hpasm_hostname` always enables remote checks.
2270 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2273 --------------------------------|-----------------------------------------------------------------------
2274 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2275 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2276 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2277 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2278 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2279 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2280 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2281 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2282 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.
2283 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.
2284 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2285 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2286 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2287 hpasm_privpassword | **Optional.** The password for authPriv security level.
2288 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2289 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2290 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.
2291 hpasm_remote | **Optional.** Run remote SNMP checks if enabled. Otherwise checks are executed locally using the `hpasmcli` binary. Defaults to `true`.
2293 #### <a id="plugin-contrib-command-adaptec-raid"></a> adaptec-raid
2295 The [check_adaptec_raid](https://github.com/thomas-krenn/check_adaptec_raid) plugin
2296 uses the `arcconf` binary to monitor Adaptec RAID controllers.
2298 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2301 --------------------------------|-----------------------------------------------------------------------
2302 adaptec_controller_number | **Required.** Controller number to monitor.
2303 arcconf_path | **Required.** Path to the `arcconf` binary, e.g. "/sbin/arcconf".
2305 #### <a id="plugin-contrib-command-lsi-raid"></a> lsi-raid
2307 The [check_lsi_raid](https://github.com/thomas-krenn/check_lsi_raid) plugin
2308 uses the `storcli` binary to monitor MegaRAID RAID controllers.
2310 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2313 --------------------------------|-----------------------------------------------------------------------
2314 lsi_controller_number | **Required.** Controller number to monitor.
2315 storcli_path | **Required.** Path to the `storcli` binary, e.g. "/usr/sbin/storcli".
2317 #### <a id="plugin-contrib-command-smart-attributes"></a> smart-attributes
2319 The [check_smart_attributes](https://github.com/thomas-krenn/check_smart_attributes) plugin
2320 uses the `smartctl` binary to monitor SMART values of SSDs and HDDs.
2322 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2325 --------------------------------|-----------------------------------------------------------------------
2326 smart_attributes_config_path | **Required.** Path to the smart attributes config file (e.g. check_smartdb.json).
2327 smart_attributes_device | **Required.** Device name (e.g. /dev/sda) to monitor.
2330 ### <a id="plugin-contrib-icingacli"></a> IcingaCLI
2332 This category includes all plugins using the icingacli provided by Icinga Web 2.
2334 #### <a id="plugin-contrib-icingacli-businessprocess"></a> Business Process
2336 This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process)
2337 and executed as `icingacli businessprocess` CLI command.
2339 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2342 ------------------------------------------|-----------------------------------------------------------------------------------------
2343 icingacli_businessprocess_process | **Required.** Business process to monitor.
2344 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2345 icingacli_businessprocess_details | **Optional.** Get details for root cause analysis. Defaults to false.
2346 icingacli_businessprocess_statetype | **Optional.** Define which state type to look at, `soft` or `hard`. Overrides the default value inside the businessprocess module, if configured.
2349 ### <a id="plugin-contrib-ipmi"></a> IPMI Devices
2351 This category includes all plugins for IPMI devices.
2353 #### <a id="plugin-contrib-command-ipmi-sensor"></a> ipmi-sensor
2355 The [check_ipmi_sensor](https://github.com/thomas-krenn/check_ipmi_sensor_v3) plugin
2356 uses the `ipmimonitoring` binary to monitor sensor data for IPMI devices. Please
2357 read the [documentation](https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin)
2358 for installation and configuration details.
2360 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2363 ---------------------------------|-----------------------------------------------------------------------------------------------------
2364 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2365 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2366 ipmi_username | **Optional.** The IPMI username.
2367 ipmi_password | **Optional.** The IPMI password.
2368 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2369 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2370 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2371 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.
2372 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2373 ipmi_exclude_sensor | **Optional.** Exclude sensor based on IPMI sensor type. (Comma-separated)
2374 ipmi_exclude_sel | **Optional.** Exclude SEL entries of specific sensor types. (comma-separated list).
2375 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2376 ipmi_protocol_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2377 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2378 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2379 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2380 ipmi_verbose | **Optional.** Be Verbose multi line output, also with additional details for warnings.
2381 ipmi_debug | **Optional.** Be Verbose debugging output, followed by normal multi line output.
2383 #### <a id="plugin-contrib-command-ipmi-alive"></a> ipmi-alive
2385 The `ipmi-alive` check commands allows you to create a ping check for the IPMI Interface.
2387 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2390 ---------------------------------|-----------------------------------------------------------------------------------------------------
2391 ping_address | **Optional.** The address of the IPMI interface. Defaults to "$address$" if the IPMI interface's `address` attribute is set, "$address6$" otherwise.
2392 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 5000.
2393 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 100.
2394 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
2395 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
2396 ping_packets | **Optional.** The number of packets to send. Defaults to 1.
2397 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
2400 ### <a id="plugins-contrib-log-management"></a> Log Management
2402 This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
2404 #### <a id="plugins-contrib-command-logstash"></a> logstash
2406 The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
2407 the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
2409 The Node API is not activated by default. You have to configure your Logstash
2410 installation in order to allow plugin connections.
2413 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2414 logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
2415 logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
2416 logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
2417 logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
2418 logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
2419 logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
2420 logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
2421 logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
2422 logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
2423 logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
2426 ### <a id="plugin-contrib-metrics"></a> Metrics
2428 This category includes all plugins for metric-based checks.
2430 #### <a id="plugin-contrib-command-graphite"></a> graphite
2432 The [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin
2433 uses the `rest-client` Ruby library to monitor a [Graphite](https://graphiteapp.org) instance.
2435 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2438 ------------------------------------|-----------------------------------------------------------------------------------------------------
2439 graphite_url | **Required.** Target url.
2440 graphite_metric | **Required.** Metric path string.
2441 graphite_shortname | **Optional.** Metric short name (used for performance data).
2442 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2443 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2444 graphite_warning | **Required.** Warning threshold.
2445 graphite_critical | **Required.** Critical threshold.
2446 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.
2447 graphite_message | **Optional.** Text message to output (default: "metric count:").
2448 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2449 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2451 ### <a id="plugin-contrib-network-components"></a> Network Components
2453 This category includes all plugins for various network components like routers, switches and firewalls.
2455 #### <a id="plugin-contrib-command-interfacetable"></a> interfacetable
2457 The [check_interfacetable_v3t](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) plugin
2458 generates a html page containing information about the monitored node and all of its interfaces.
2460 The Git repository is located on [GitHub](https://github.com/Tontonitch/interfacetable_v3t).
2462 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2465 ------------------------------------|-----------------------------------------------------------------------------------------------------
2466 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2467 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2468 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2469 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2470 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2471 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2472 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2473 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2474 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2475 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2476 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2477 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2478 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.
2479 interfacetable_trackproperty | **Optional.** List of tracked properties.
2480 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2481 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2482 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
2483 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
2484 interfacetable_login | **Optional.** Login for snmpv3 authentication.
2485 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
2486 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
2487 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
2488 interfacetable_domain | **Optional.** SNMP transport domain.
2489 interfacetable_contextname | **Optional.** Context name for the snmp requests.
2490 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
2491 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
2492 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
2493 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
2494 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
2495 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.
2496 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
2497 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
2498 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
2499 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
2500 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
2501 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
2502 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
2503 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
2504 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
2505 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".
2506 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
2507 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
2508 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"
2509 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
2510 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
2511 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.
2512 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.
2513 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
2514 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
2515 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
2516 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
2517 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
2518 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
2519 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
2520 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
2521 interfacetable_config | **Optional.** Specify a config file to load.
2522 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
2523 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
2524 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
2525 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
2526 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
2528 #### <a id="plugin-contrib-command-iftraffic"></a> iftraffic
2530 The [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic) plugin
2531 checks the utilization of a given interface name using the SNMP protocol.
2533 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2536 ------------------------|---------------------------------------------------------
2537 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
2538 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2539 iftraffic_interface | **Required.** Queried interface name.
2540 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2541 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2542 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2543 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2544 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2546 #### <a id="plugin-contrib-command-iftraffic64"></a> iftraffic64
2548 The [check_iftraffic64](https://exchange.icinga.com/exchange/iftraffic64) plugin
2549 checks the utilization of a given interface name using the SNMP protocol.
2551 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2554 ------------------------|---------------------------------------------------------
2555 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
2556 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2557 iftraffic64_interface | **Required.** Queried interface name.
2558 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2559 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2560 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2561 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2562 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2564 #### <a id="plugin-contrib-command-interfaces"></a> interfaces
2566 The [check_interfaces](https://git.netways.org/plugins/check_interfaces) plugin
2567 uses SNMP to monitor network interfaces and their utilization.
2569 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2572 --------------------------|---------------------------------------------------------
2573 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2574 interfaces_regex | **Optional.** Interface list regexp.
2575 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
2576 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
2577 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
2578 interfaces_perfdata | **Optional.** perfdata from last check result.
2579 interfaces_prefix | **Optional.** Prefix interface names with this label.
2580 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
2581 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
2582 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
2583 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
2584 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
2585 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
2586 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
2587 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
2588 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
2589 interfaces_user | **Optional.** SNMPv3 User
2590 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
2591 interfaces_aliases | **Optional.** Retrieves the interface description.
2592 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
2593 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
2594 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
2595 interfaces_names | **Optional.** If set to true, use ifName instead of ifDescr.
2597 #### <a id="plugin-contrib-command-nwc_health"></a> nwc_health
2599 The [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html) plugin
2600 uses SNMP to monitor network components. The plugin is able to generate interface statistics,
2601 check hardware (CPU, memory, fan, power, etc.), monitor firewall policies, HRSP, load-balancer
2602 pools, processor and memory usage.
2604 Currently the following network components are supported: Cisco IOS, Cisco Nexus, Cisco ASA,
2605 Cisco PIX, F5 BIG-IP, CheckPoint Firewall1, Juniper NetScreen, HP Procurve, Nortel, Brocade 4100/4900,
2606 EMC DS 4700, EMC DS 24, Allied Telesyn. Blue Coat SG600, Cisco Wireless Lan Controller 5500,
2607 Brocade ICX6610-24-HPOE, Cisco UC Telefonzeugs, FOUNDRY-SN-AGENT-MIB, FRITZ!BOX 7390, FRITZ!DECT 200,
2608 Juniper IVE, Pulse-Gateway MAG4610, Cisco IronPort AsyncOS, Foundry, etc. A complete list can be
2609 found in the plugin [documentation](https://labs.consol.de/nagios/check_nwc_health/index.html).
2611 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2614 --------------------------------|---------------------------------------------------------
2615 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2616 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).
2617 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
2618 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
2619 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
2620 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).
2621 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2622 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2623 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2624 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
2625 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2626 nwc_health_privpassword | **Optional.** The password for authPriv security level.
2627 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2628 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
2629 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
2630 nwc_health_name | **Optional.** The name of an interface (ifDescr).
2631 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
2632 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
2633 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
2634 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
2635 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
2636 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
2637 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
2638 nwc_health_name2 | **Optional.** The secondary name of a component.
2639 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
2640 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)
2641 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.
2642 nwc_health_warning | **Optional.** The warning threshold
2643 nwc_health_critical | **Optional.** The critical threshold
2644 nwc_health_warningx | **Optional.** The extended warning thresholds
2645 nwc_health_criticalx | **Optional.** The extended critical thresholds
2646 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning (1) or ok (0).
2647 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.
2648 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'
2649 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
2650 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
2651 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
2652 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2653 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
2654 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
2655 nwc_health_multiline | **Optional.** Multiline output
2658 ### <a id="plugin-contrib-operating-system"></a> Operating System
2660 This category contains plugins which receive details about your operating system
2661 or the guest system.
2663 #### <a id="plugin-contrib-command-mem"></a> mem
2665 The [check_mem.pl](https://github.com/justintime/nagios-plugins) plugin checks the
2666 memory usage on linux and unix hosts. It is able to count cache memory as free when
2667 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).
2669 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2672 -------------|-----------------------------------------------------------------------------------------------------------------------
2673 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
2674 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
2675 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
2676 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
2677 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
2679 #### <a id="plugin-contrib-command-running_kernel"></a> running_kernel
2681 The [check_running_kernel](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin
2682 is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu.
2687 ---------------------------|-------------
2688 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
2690 #### <a id="plugin-contrib-command-iostats"></a> iostats
2692 The [check_iostats](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostats) plugin
2693 uses the `iostat` binary to monitor I/O on a Linux host. The default thresholds are rather high
2694 so you can use a grapher for baselining before setting your own.
2696 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2699 ---------------|-----------------------------------------------------------------------------------------------------------------------
2700 iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2701 iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000)
2702 iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000)
2703 iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000)
2704 iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50)
2705 iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000)
2706 iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000)
2707 iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000)
2708 iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80)
2710 #### <a id="plugin-contrib-command-iostat"></a> iostat
2712 The [check_iostat](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostat) plugin
2713 uses the `iostat` binary to monitor disk I/O on a Linux host. The default thresholds are rather high
2714 so you can use a grapher for baselining before setting your own.
2716 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2719 ---------------|-----------------------------------------------------------------------------------------------------------------------
2720 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2721 iostat\_wtps | **Required.** Warning threshold for tps (default: 100)
2722 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100)
2723 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100)
2724 iostat\_ctps | **Required.** Critical threshold for tps (default: 200)
2725 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200)
2726 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200)
2728 #### <a id="plugin-contrib-command-yum"></a> yum
2730 The [check_yum](https://github.com/calestyo/check_yum) plugin checks the YUM package
2731 management system for package updates.
2732 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
2734 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2737 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2738 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.
2739 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
2740 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.
2741 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.
2742 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.
2743 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.
2744 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.
2745 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
2746 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
2748 ### <a id="plugins-contrib-storage"></a> Storage
2750 This category includes all plugins for various storage and object storage technologies.
2752 #### <a id="plugins-contrib-command-glusterfs"></a> glusterfs
2754 The [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) plugin
2755 is used to check the GlusterFS storage health on the server.
2756 The plugin requires `sudo` permissions.
2758 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2761 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2762 glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
2763 glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
2764 glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
2765 glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
2766 glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
2767 glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
2768 glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
2771 ### <a id="plugin-contrib-virtualization"></a> Virtualization
2773 This category includes all plugins for various virtualization technologies.
2775 #### <a id="plugin-contrib-command-esxi-hardware"></a> esxi_hardware
2777 The [check_esxi_hardware.py](https://www.claudiokuenzler.com/nagios-plugins/check_esxi_hardware.php) plugin
2778 uses the [pywbem](https://pywbem.github.io/pywbem/) Python library to monitor the hardware of ESXi servers
2779 through the [VMWare API](https://www.vmware.com/support/pubs/sdk_pubs.html) and CIM service.
2781 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2784 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2785 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
2786 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.
2787 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.
2788 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
2789 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
2790 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
2791 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
2792 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
2793 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2794 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2795 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2796 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2797 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2799 #### <a id="plugin-contrib-vmware"></a> VMware
2801 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
2803 **vmware-esx-dc-volumes**
2805 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2807 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2810 ------------------------|--------------
2811 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2812 vmware_cluster | **Optional.** ESX or ESXi clustername.
2813 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2814 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2815 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2816 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2817 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2818 vmware_sessionfile | **Optional.** Session file name enhancement.
2819 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2820 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2821 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2822 vmware_password | **Optional.** The username's password. No value defined as default.
2823 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2824 vmware_subselect | **Optional.** Volume name to be checked the free space.
2825 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2826 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2827 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2828 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2829 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2830 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2831 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
2832 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2833 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2836 **vmware-esx-dc-runtime-info**
2838 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
2840 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2843 ------------------------|--------------
2844 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2845 vmware_cluster | **Optional.** ESX or ESXi clustername.
2846 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2847 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2848 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2849 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2850 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2851 vmware_sessionfile | **Optional.** Session file name enhancement.
2852 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2853 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2854 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2855 vmware_password | **Optional.** The username's password. No value defined as default.
2856 vmware_authfile | **Optional.** Use auth file instead username/password 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-esx-dc-runtime-listvms**
2861 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.
2863 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2866 ------------------------|--------------
2867 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2868 vmware_cluster | **Optional.** ESX or ESXi clustername.
2869 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2870 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2871 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2872 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2873 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2874 vmware_sessionfile | **Optional.** Session file name enhancement.
2875 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2876 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2877 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2878 vmware_password | **Optional.** The username's password. No value defined as default.
2879 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2880 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2881 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2882 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2883 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2884 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.
2887 **vmware-esx-dc-runtime-listhost**
2889 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
2891 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2894 ------------------------|--------------
2895 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2896 vmware_cluster | **Optional.** ESX or ESXi clustername.
2897 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2898 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2899 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2900 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2901 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2902 vmware_sessionfile | **Optional.** Session file name enhancement.
2903 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2904 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2905 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2906 vmware_password | **Optional.** The username's password. No value defined as default.
2907 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2908 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2909 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
2910 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
2911 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2912 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.
2915 **vmware-esx-dc-runtime-listcluster**
2917 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
2919 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2922 ------------------------|--------------
2923 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2924 vmware_cluster | **Optional.** ESX or ESXi clustername.
2925 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2926 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2927 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2928 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2929 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2930 vmware_sessionfile | **Optional.** Session file name enhancement.
2931 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2932 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2933 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2934 vmware_password | **Optional.** The username's password. No value defined as default.
2935 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2936 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2937 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
2938 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
2939 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2940 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.
2943 **vmware-esx-dc-runtime-issues**
2945 Check command object for the `check_vmware_esx` plugin. All issues for the host.
2947 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2950 ------------------------|--------------
2951 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2952 vmware_cluster | **Optional.** ESX or ESXi clustername.
2953 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2954 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2955 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2956 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2957 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2958 vmware_sessionfile | **Optional.** Session file name enhancement.
2959 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2960 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2961 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2962 vmware_password | **Optional.** The username's password. No value defined as default.
2963 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2964 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
2965 vmware_include | **Optional.** Whitelist issues. No value defined as default.
2966 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2967 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.
2970 **vmware-esx-dc-runtime-status**
2972 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2974 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2977 ------------------------|--------------
2978 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2979 vmware_cluster | **Optional.** ESX or ESXi clustername.
2980 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2981 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2982 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2983 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2984 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2985 vmware_sessionfile | **Optional.** Session file name enhancement.
2986 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2987 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2988 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2989 vmware_password | **Optional.** The username's password. No value defined as default.
2990 vmware_authfile | **Optional.** Use auth file instead username/password 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-esx-dc-runtime-tools**
2995 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
2997 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3000 ------------------------|--------------
3001 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3002 vmware_cluster | **Optional.** ESX or ESXi clustername.
3003 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3004 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3005 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3006 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3007 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3008 vmware_sessionfile | **Optional.** Session file name enhancement.
3009 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3010 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3011 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3012 vmware_password | **Optional.** The username's password. No value defined as default.
3013 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3014 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
3015 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
3016 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
3017 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
3018 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3019 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.
3020 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
3023 **vmware-esx-soap-host-check**
3025 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
3027 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3030 ------------------------|--------------
3031 vmware_host | **Required.** ESX or ESXi hostname.
3032 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3033 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3034 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3035 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3036 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3037 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3038 vmware_sessionfile | **Optional.** Session file name enhancement.
3039 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3040 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3041 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3042 vmware_password | **Optional.** The username's password. No value defined as default.
3043 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3046 **vmware-esx-soap-host-uptime**
3048 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
3050 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3053 ------------------------|--------------
3054 vmware_host | **Required.** ESX or ESXi hostname.
3055 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3056 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3057 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3058 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3059 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3060 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3061 vmware_sessionfile | **Optional.** Session file name enhancement.
3062 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3063 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3064 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3065 vmware_password | **Optional.** The username's password. No value defined as default.
3066 vmware_authfile | **Optional.** Use auth file instead username/password 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-esx-soap-host-cpu**
3071 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
3073 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3076 ------------------------|--------------
3077 vmware_host | **Required.** ESX or ESXi hostname.
3078 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3079 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3080 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3081 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3082 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3083 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3084 vmware_sessionfile | **Optional.** Session file name enhancement.
3085 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3086 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3087 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3088 vmware_password | **Optional.** The username's password. No value defined as default.
3089 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3090 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3091 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3094 **vmware-esx-soap-host-cpu-ready**
3096 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.
3098 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3101 ------------------------|--------------
3102 vmware_host | **Required.** ESX or ESXi hostname.
3103 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3104 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3105 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3106 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3107 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3108 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3109 vmware_sessionfile | **Optional.** Session file name enhancement.
3110 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3111 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3112 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3113 vmware_password | **Optional.** The username's password. No value defined as default.
3114 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3117 **vmware-esx-soap-host-cpu-wait**
3119 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.
3121 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3124 ------------------------|--------------
3125 vmware_host | **Required.** ESX or ESXi hostname.
3126 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3127 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3128 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3129 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3130 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3131 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3132 vmware_sessionfile | **Optional.** Session file name enhancement.
3133 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3134 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3135 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3136 vmware_password | **Optional.** The username's password. No value defined as default.
3137 vmware_authfile | **Optional.** Use auth file instead username/password 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-esx-soap-host-cpu-usage**
3142 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.
3144 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3147 ------------------------|--------------
3148 vmware_host | **Required.** ESX or ESXi hostname.
3149 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3150 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3151 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3152 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3153 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3154 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3155 vmware_sessionfile | **Optional.** Session file name enhancement.
3156 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3157 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3158 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3159 vmware_password | **Optional.** The username's password. No value defined as default.
3160 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3161 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3162 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3165 **vmware-esx-soap-host-mem**
3167 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3169 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3172 ------------------------|--------------
3173 vmware_host | **Required.** ESX or ESXi hostname.
3174 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3175 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3176 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3177 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3178 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3179 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3180 vmware_sessionfile | **Optional.** Session file name enhancement.
3181 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3182 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3183 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3184 vmware_password | **Optional.** The username's password. No value defined as default.
3185 vmware_authfile | **Optional.** Use auth file instead username/password 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-esx-soap-host-mem-usage**
3190 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3192 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3195 ------------------------|--------------
3196 vmware_host | **Required.** ESX or ESXi hostname.
3197 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3198 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3199 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3200 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3201 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3202 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3203 vmware_sessionfile | **Optional.** Session file name enhancement.
3204 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3205 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3206 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3207 vmware_password | **Optional.** The username's password. No value defined as default.
3208 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3209 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3210 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3213 **vmware-esx-soap-host-mem-consumed**
3215 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.
3217 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3220 ------------------------|--------------
3221 vmware_host | **Required.** ESX or ESXi hostname.
3222 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3223 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3224 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3225 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3226 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3227 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3228 vmware_sessionfile | **Optional.** Session file name enhancement.
3229 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3230 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3231 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3232 vmware_password | **Optional.** The username's password. No value defined as default.
3233 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3234 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3235 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3238 **vmware-esx-soap-host-mem-swapused**
3240 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.
3242 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3245 ------------------------|--------------
3246 vmware_host | **Required.** ESX or ESXi hostname.
3247 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3248 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3249 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3250 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3251 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3252 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3253 vmware_sessionfile | **Optional.** Session file name enhancement.
3254 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3255 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3256 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3257 vmware_password | **Optional.** The username's password. No value defined as default.
3258 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3259 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3260 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3261 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.
3264 **vmware-esx-soap-host-mem-overhead**
3266 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3268 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3271 ------------------------|--------------
3272 vmware_host | **Required.** ESX or ESXi hostname.
3273 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3274 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3275 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3276 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3277 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3278 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3279 vmware_sessionfile | **Optional.** Session file name enhancement.
3280 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3281 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3282 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3283 vmware_password | **Optional.** The username's password. No value defined as default.
3284 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3285 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3286 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3289 **vmware-esx-soap-host-mem-memctl**
3291 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.
3293 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3296 ------------------------|--------------
3297 vmware_host | **Required.** ESX or ESXi hostname.
3298 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3299 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3300 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3301 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3302 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3303 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3304 vmware_sessionfile | **Optional.** Session file name enhancement.
3305 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3306 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3307 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3308 vmware_password | **Optional.** The username's password. No value defined as default.
3309 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3310 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3311 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3312 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.
3315 **vmware-esx-soap-host-net**
3317 Check command object for the `check_vmware_esx` plugin. Shows net info.
3319 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3322 ------------------------|--------------
3323 vmware_host | **Required.** ESX or ESXi hostname.
3324 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3325 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3326 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3327 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3328 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3329 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3330 vmware_sessionfile | **Optional.** Session file name enhancement.
3331 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3332 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3333 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3334 vmware_password | **Optional.** The username's password. No value defined as default.
3335 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3336 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3337 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3340 **vmware-esx-soap-host-net-usage**
3342 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3344 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3347 ------------------------|--------------
3348 vmware_host | **Required.** ESX or ESXi hostname.
3349 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3350 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3351 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3352 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3353 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3354 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3355 vmware_sessionfile | **Optional.** Session file name enhancement.
3356 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3357 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3358 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3359 vmware_password | **Optional.** The username's password. No value defined as default.
3360 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3361 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3362 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3365 **vmware-esx-soap-host-net-receive**
3367 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
3369 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3372 ------------------------|--------------
3373 vmware_host | **Required.** ESX or ESXi hostname.
3374 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3375 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3376 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3377 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3378 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3379 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3380 vmware_sessionfile | **Optional.** Session file name enhancement.
3381 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3382 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3383 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3384 vmware_password | **Optional.** The username's password. No value defined as default.
3385 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3386 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3387 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3390 **vmware-esx-soap-host-net-send**
3392 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
3394 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3397 ------------------------|--------------
3398 vmware_host | **Required.** ESX or ESXi hostname.
3399 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3400 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3401 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3402 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3403 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3404 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3405 vmware_sessionfile | **Optional.** Session file name enhancement.
3406 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3407 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3408 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3409 vmware_password | **Optional.** The username's password. No value defined as default.
3410 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3411 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3412 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3415 **vmware-esx-soap-host-net-nic**
3417 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
3419 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3422 ------------------------|--------------
3423 vmware_host | **Required.** ESX or ESXi hostname.
3424 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3425 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3426 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3427 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3428 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3429 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3430 vmware_sessionfile | **Optional.** Session file name enhancement.
3431 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3432 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3433 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3434 vmware_password | **Optional.** The username's password. No value defined as default.
3435 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3436 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3437 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3440 **vmware-esx-soap-host-volumes**
3442 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
3444 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3447 ------------------------|--------------
3448 vmware_host | **Required.** ESX or ESXi hostname.
3449 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3450 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3451 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3452 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3453 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3454 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3455 vmware_sessionfile | **Optional.** Session file name enhancement.
3456 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3457 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3458 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3459 vmware_password | **Optional.** The username's password. No value defined as default.
3460 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3461 vmware_subselect | **Optional.** Volume name to be checked the free space.
3462 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3463 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3464 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3465 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3466 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3467 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3468 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3469 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3470 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
3473 **vmware-esx-soap-host-io**
3475 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.
3477 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3480 ------------------------|--------------
3481 vmware_host | **Required.** ESX or ESXi hostname.
3482 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3483 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3484 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3485 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3486 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3487 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3488 vmware_sessionfile | **Optional.** Session file name enhancement.
3489 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3490 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3491 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3492 vmware_password | **Optional.** The username's password. No value defined as default.
3493 vmware_authfile | **Optional.** Use auth file instead username/password 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-esx-soap-host-io-aborted**
3498 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
3500 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3503 ------------------------|--------------
3504 vmware_host | **Required.** ESX or ESXi hostname.
3505 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3506 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3507 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3508 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3509 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3510 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3511 vmware_sessionfile | **Optional.** Session file name enhancement.
3512 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3513 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3514 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3515 vmware_password | **Optional.** The username's password. No value defined as default.
3516 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3517 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3518 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3521 **vmware-esx-soap-host-io-resets**
3523 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
3525 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3528 ------------------------|--------------
3529 vmware_host | **Required.** ESX or ESXi hostname.
3530 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3531 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3532 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3533 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3534 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3535 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3536 vmware_sessionfile | **Optional.** Session file name enhancement.
3537 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3538 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3539 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3540 vmware_password | **Optional.** The username's password. No value defined as default.
3541 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3542 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3543 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3546 **vmware-esx-soap-host-io-read**
3548 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3550 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3553 ------------------------|--------------
3554 vmware_host | **Required.** ESX or ESXi hostname.
3555 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3556 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3557 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3558 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3559 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3560 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3561 vmware_sessionfile | **Optional.** Session file name enhancement.
3562 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3563 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3564 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3565 vmware_password | **Optional.** The username's password. No value defined as default.
3566 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3567 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3568 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3571 **vmware-esx-soap-host-io-read-latency**
3573 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.
3575 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3578 ------------------------|--------------
3579 vmware_host | **Required.** ESX or ESXi hostname.
3580 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3581 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3582 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3583 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3584 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3585 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3586 vmware_sessionfile | **Optional.** Session file name enhancement.
3587 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3588 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3589 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3590 vmware_password | **Optional.** The username's password. No value defined as default.
3591 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3592 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3593 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3596 **vmware-esx-soap-host-io-write**
3598 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3600 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3603 ------------------------|--------------
3604 vmware_host | **Required.** ESX or ESXi hostname.
3605 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3606 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3607 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3608 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3609 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3610 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3611 vmware_sessionfile | **Optional.** Session file name enhancement.
3612 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3613 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3614 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3615 vmware_password | **Optional.** The username's password. No value defined as default.
3616 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3617 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3618 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3621 **vmware-esx-soap-host-io-write-latency**
3623 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.
3625 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3628 ------------------------|--------------
3629 vmware_host | **Required.** ESX or ESXi hostname.
3630 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3631 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3632 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3633 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3634 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3635 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3636 vmware_sessionfile | **Optional.** Session file name enhancement.
3637 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3638 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3639 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3640 vmware_password | **Optional.** The username's password. No value defined as default.
3641 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3642 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3643 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3646 **vmware-esx-soap-host-io-usage**
3648 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.
3650 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3653 ------------------------|--------------
3654 vmware_host | **Required.** ESX or ESXi hostname.
3655 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3656 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3657 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3658 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3659 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3660 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3661 vmware_sessionfile | **Optional.** Session file name enhancement.
3662 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3663 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3664 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3665 vmware_password | **Optional.** The username's password. No value defined as default.
3666 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3667 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3668 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3671 **vmware-esx-soap-host-io-kernel-latency**
3673 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
3675 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3678 ------------------------|--------------
3679 vmware_host | **Required.** ESX or ESXi hostname.
3680 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3681 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3682 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3683 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3684 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3685 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3686 vmware_sessionfile | **Optional.** Session file name enhancement.
3687 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3688 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3689 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3690 vmware_password | **Optional.** The username's password. No value defined as default.
3691 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3692 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3693 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3696 **vmware-esx-soap-host-io-device-latency**
3698 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
3700 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3703 ------------------------|--------------
3704 vmware_host | **Required.** ESX or ESXi hostname.
3705 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3706 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3707 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3708 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3709 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3710 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3711 vmware_sessionfile | **Optional.** Session file name enhancement.
3712 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3713 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3714 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3715 vmware_password | **Optional.** The username's password. No value defined as default.
3716 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3717 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3718 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3721 **vmware-esx-soap-host-io-queue-latency**
3723 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
3725 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3728 ------------------------|--------------
3729 vmware_host | **Required.** ESX or ESXi hostname.
3730 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3731 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3732 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3733 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3734 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3735 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3736 vmware_sessionfile | **Optional.** Session file name enhancement.
3737 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3738 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3739 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3740 vmware_password | **Optional.** The username's password. No value defined as default.
3741 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3742 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3743 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3746 **vmware-esx-soap-host-io-total-latency**
3748 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.
3750 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3753 ------------------------|--------------
3754 vmware_host | **Required.** ESX or ESXi hostname.
3755 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3756 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3757 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3758 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3759 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3760 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3761 vmware_sessionfile | **Optional.** Session file name enhancement.
3762 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3763 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3764 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3765 vmware_password | **Optional.** The username's password. No value defined as default.
3766 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3767 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3768 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3771 **vmware-esx-soap-host-media**
3773 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.
3775 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3778 ------------------------|--------------
3779 vmware_host | **Required.** ESX or ESXi hostname.
3780 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3781 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3782 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3783 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3784 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3785 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3786 vmware_sessionfile | **Optional.** Session file name enhancement.
3787 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3788 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3789 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3790 vmware_password | **Optional.** The username's password. No value defined as default.
3791 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3792 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3793 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3794 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3795 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.
3798 **vmware-esx-soap-host-service**
3800 Check command object for the `check_vmware_esx` plugin. Shows host service info.
3802 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3805 ------------------------|--------------
3806 vmware_host | **Required.** ESX or ESXi hostname.
3807 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3808 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3809 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3810 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3811 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3812 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3813 vmware_sessionfile | **Optional.** Session file name enhancement.
3814 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3815 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3816 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3817 vmware_password | **Optional.** The username's password. No value defined as default.
3818 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3819 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
3820 vmware_include | **Optional.** Whitelist services name. No value defined as default.
3821 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3822 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.
3825 **vmware-esx-soap-host-runtime**
3827 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.
3829 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3832 ------------------------|--------------
3833 vmware_host | **Required.** ESX or ESXi hostname.
3834 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3835 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3836 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3837 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3838 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3839 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3840 vmware_sessionfile | **Optional.** Session file name enhancement.
3841 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3842 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3843 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3844 vmware_password | **Optional.** The username's password. No value defined as default.
3845 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3848 **vmware-esx-soap-host-runtime-con**
3850 Check command object for the `check_vmware_esx` plugin. Shows connection state.
3852 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3855 ------------------------|--------------
3856 vmware_host | **Required.** ESX or ESXi hostname.
3857 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3858 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3859 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3860 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3861 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3862 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3863 vmware_sessionfile | **Optional.** Session file name enhancement.
3864 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3865 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3866 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3867 vmware_password | **Optional.** The username's password. No value defined as default.
3868 vmware_authfile | **Optional.** Use auth file instead username/password 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-esx-soap-host-runtime-listvms**
3873 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
3875 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3878 ------------------------|--------------
3879 vmware_host | **Required.** ESX or ESXi hostname.
3880 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3881 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3882 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3883 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3884 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3885 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3886 vmware_sessionfile | **Optional.** Session file name enhancement.
3887 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3888 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3889 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3890 vmware_password | **Optional.** The username's password. No value defined as default.
3891 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3892 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3893 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3894 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3895 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.
3898 **vmware-esx-soap-host-runtime-status**
3900 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3902 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3905 ------------------------|--------------
3906 vmware_host | **Required.** ESX or ESXi hostname.
3907 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3908 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3909 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3910 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3911 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3912 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3913 vmware_sessionfile | **Optional.** Session file name enhancement.
3914 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3915 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3916 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3917 vmware_password | **Optional.** The username's password. No value defined as default.
3918 vmware_authfile | **Optional.** Use auth file instead username/password 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-esx-soap-host-runtime-health**
3923 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
3925 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3928 ------------------------|--------------
3929 vmware_host | **Required.** ESX or ESXi hostname.
3930 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3931 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3932 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3933 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3934 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3935 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3936 vmware_sessionfile | **Optional.** Session file name enhancement.
3937 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3938 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3939 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3940 vmware_password | **Optional.** The username's password. No value defined as default.
3941 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3942 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3943 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3944 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3947 **vmware-esx-soap-host-runtime-health-listsensors**
3949 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
3951 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3954 ------------------------|--------------
3955 vmware_host | **Required.** ESX or ESXi hostname.
3956 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3957 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3958 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3959 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3960 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3961 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3962 vmware_sessionfile | **Optional.** Session file name enhancement.
3963 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3964 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3965 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3966 vmware_password | **Optional.** The username's password. No value defined as default.
3967 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3968 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3969 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3970 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3973 **vmware-esx-soap-host-runtime-health-nostoragestatus**
3975 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**.
3977 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3980 ------------------------|--------------
3981 vmware_host | **Required.** ESX or ESXi hostname.
3982 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3983 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3984 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3985 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3986 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3987 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3988 vmware_sessionfile | **Optional.** Session file name enhancement.
3989 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3990 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3991 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3992 vmware_password | **Optional.** The username's password. No value defined as default.
3993 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3994 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3995 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3996 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3999 **vmware-esx-soap-host-runtime-storagehealth**
4001 Check command object for the `check_vmware_esx` plugin. Local storage status check.
4003 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4006 ------------------------|--------------
4007 vmware_host | **Required.** ESX or ESXi hostname.
4008 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4009 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4010 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4011 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4012 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4013 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4014 vmware_sessionfile | **Optional.** Session file name enhancement.
4015 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4016 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4017 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4018 vmware_password | **Optional.** The username's password. No value defined as default.
4019 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4020 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
4021 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
4022 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4023 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.
4026 **vmware-esx-soap-host-runtime-temp**
4028 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
4030 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4033 ------------------------|--------------
4034 vmware_host | **Required.** ESX or ESXi hostname.
4035 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4036 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4037 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4038 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4039 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4040 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4041 vmware_sessionfile | **Optional.** Session file name enhancement.
4042 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4043 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4044 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4045 vmware_password | **Optional.** The username's password. No value defined as default.
4046 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4047 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
4048 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
4049 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4050 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.
4053 **vmware-esx-soap-host-runtime-issues**
4055 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
4057 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4060 ------------------------|--------------
4061 vmware_host | **Required.** ESX or ESXi hostname.
4062 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4063 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4064 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4065 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4066 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4067 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4068 vmware_sessionfile | **Optional.** Session file name enhancement.
4069 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4070 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4071 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4072 vmware_password | **Optional.** The username's password. No value defined as default.
4073 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4074 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
4075 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
4076 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4077 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.
4080 **vmware-esx-soap-host-storage**
4082 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
4084 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4087 ------------------------|--------------
4088 vmware_host | **Required.** ESX or ESXi hostname.
4089 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4090 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4091 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4092 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4093 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4094 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4095 vmware_sessionfile | **Optional.** Session file name enhancement.
4096 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4097 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4098 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4099 vmware_password | **Optional.** The username's password. No value defined as default.
4100 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4101 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
4102 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
4103 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4106 **vmware-esx-soap-host-storage-adapter**
4108 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
4110 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4113 ------------------------|--------------
4114 vmware_host | **Required.** ESX or ESXi hostname.
4115 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4116 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4117 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4118 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4119 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4120 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4121 vmware_sessionfile | **Optional.** Session file name enhancement.
4122 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4123 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4124 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4125 vmware_password | **Optional.** The username's password. No value defined as default.
4126 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4127 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
4128 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
4129 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4130 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.
4133 **vmware-esx-soap-host-storage-lun**
4135 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.
4137 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4140 ------------------------|--------------
4141 vmware_host | **Required.** ESX or ESXi hostname.
4142 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4143 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4144 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4145 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4146 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4147 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4148 vmware_sessionfile | **Optional.** Session file name enhancement.
4149 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4150 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4151 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4152 vmware_password | **Optional.** The username's password. No value defined as default.
4153 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4154 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
4155 vmware_include | **Optional.** Whitelist luns. No value defined as default.
4156 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4157 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.
4160 **vmware-esx-soap-host-storage-path**
4162 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
4164 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4167 ------------------------|--------------
4168 vmware_host | **Required.** ESX or ESXi hostname.
4169 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4170 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4171 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4172 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4173 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4174 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4175 vmware_sessionfile | **Optional.** Session file name enhancement.
4176 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4177 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4178 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4179 vmware_password | **Optional.** The username's password. No value defined as default.
4180 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4181 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4182 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4183 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4184 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4185 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.
4188 **vmware-esx-soap-vm-cpu**
4190 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4192 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4195 ------------------------|--------------
4196 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4197 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4198 vmware_vmname | **Required.** Virtual machine name.
4199 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4200 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4201 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4202 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4203 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4204 vmware_sessionfile | **Optional.** Session file name enhancement.
4205 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4206 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4207 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4208 vmware_password | **Optional.** The username's password. No value defined as default.
4209 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4213 **vmware-esx-soap-vm-cpu-ready**
4215 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.
4217 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4220 ------------------------|--------------
4221 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4222 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4223 vmware_vmname | **Required.** Virtual machine name.
4224 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4225 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4226 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4227 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4228 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4229 vmware_sessionfile | **Optional.** Session file name enhancement.
4230 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4231 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4232 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4233 vmware_password | **Optional.** The username's password. No value defined as default.
4234 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4235 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4236 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4239 **vmware-esx-soap-vm-cpu-wait**
4241 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.
4243 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4246 ------------------------|--------------
4247 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4248 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4249 vmware_vmname | **Required.** Virtual machine name.
4250 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4251 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4252 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4253 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4254 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4255 vmware_sessionfile | **Optional.** Session file name enhancement.
4256 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4257 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4258 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4259 vmware_password | **Optional.** The username's password. No value defined as default.
4260 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4261 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4262 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4265 **vmware-esx-soap-vm-cpu-usage**
4267 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.
4269 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4272 ------------------------|--------------
4273 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4274 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4275 vmware_vmname | **Required.** Virtual machine name.
4276 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4277 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4278 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4279 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4280 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4281 vmware_sessionfile | **Optional.** Session file name enhancement.
4282 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4283 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4284 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4285 vmware_password | **Optional.** The username's password. No value defined as default.
4286 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4287 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4288 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4291 **vmware-esx-soap-vm-mem**
4293 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4295 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4298 ------------------------|--------------
4299 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4300 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4301 vmware_vmname | **Required.** Virtual machine name.
4302 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4303 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4304 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4305 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4306 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4307 vmware_sessionfile | **Optional.** Session file name enhancement.
4308 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4309 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4310 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4311 vmware_password | **Optional.** The username's password. No value defined as default.
4312 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4315 **vmware-esx-soap-vm-mem-usage**
4317 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4319 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4322 ------------------------|--------------
4323 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4324 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4325 vmware_vmname | **Required.** Virtual machine name.
4326 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4327 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4328 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4329 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4330 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4331 vmware_sessionfile | **Optional.** Session file name enhancement.
4332 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4333 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4334 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4335 vmware_password | **Optional.** The username's password. No value defined as default.
4336 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4337 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4338 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4341 **vmware-esx-soap-vm-mem-consumed**
4343 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>
4344 **vm consumed memory = memory granted -- memory saved**
4346 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4349 ------------------------|--------------
4350 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4351 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4352 vmware_vmname | **Required.** Virtual machine name.
4353 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4354 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4355 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4356 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4357 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4358 vmware_sessionfile | **Optional.** Session file name enhancement.
4359 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4360 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4361 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4362 vmware_password | **Optional.** The username's password. No value defined as default.
4363 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4364 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4365 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4368 **vmware-esx-soap-vm-mem-memctl**
4370 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.
4372 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4375 ------------------------|--------------
4376 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4377 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4378 vmware_vmname | **Required.** Virtual machine name.
4379 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4380 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4381 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4382 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4383 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4384 vmware_sessionfile | **Optional.** Session file name enhancement.
4385 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4386 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4387 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4388 vmware_password | **Optional.** The username's password. No value defined as default.
4389 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4390 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4391 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4395 **vmware-esx-soap-vm-net**
4397 Check command object for the `check_vmware_esx` plugin. Shows net info.
4399 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4402 ------------------------|--------------
4403 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4404 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4405 vmware_vmname | **Required.** Virtual machine name.
4406 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4407 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4408 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4409 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4410 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4411 vmware_sessionfile | **Optional.** Session file name enhancement.
4412 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4413 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4414 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4415 vmware_password | **Optional.** The username's password. No value defined as default.
4416 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4419 **vmware-esx-soap-vm-net-usage**
4421 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4423 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4426 ------------------------|--------------
4427 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4428 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4429 vmware_vmname | **Required.** Virtual machine name.
4430 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4431 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4432 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4433 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4434 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4435 vmware_sessionfile | **Optional.** Session file name enhancement.
4436 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4437 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4438 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4439 vmware_password | **Optional.** The username's password. No value defined as default.
4440 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4441 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4442 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4445 **vmware-esx-soap-vm-net-receive**
4447 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
4449 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4452 ------------------------|--------------
4453 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4454 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4455 vmware_vmname | **Required.** Virtual machine name.
4456 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4457 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4458 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4459 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4460 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4461 vmware_sessionfile | **Optional.** Session file name enhancement.
4462 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4463 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4464 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4465 vmware_password | **Optional.** The username's password. No value defined as default.
4466 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4467 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4468 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4471 **vmware-esx-soap-vm-net-send**
4473 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
4475 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4478 ------------------------|--------------
4479 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4480 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4481 vmware_vmname | **Required.** Virtual machine name.
4482 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4483 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4484 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4485 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4486 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4487 vmware_sessionfile | **Optional.** Session file name enhancement.
4488 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4489 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4490 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4491 vmware_password | **Optional.** The username's password. No value defined as default.
4492 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4493 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4494 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4497 **vmware-esx-soap-vm-io**
4499 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.
4501 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4504 ------------------------|--------------
4505 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4506 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4507 vmware_vmname | **Required.** Virtual machine name.
4508 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4509 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4510 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4511 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4512 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4513 vmware_sessionfile | **Optional.** Session file name enhancement.
4514 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4515 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4516 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4517 vmware_password | **Optional.** The username's password. No value defined as default.
4518 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4521 **vmware-esx-soap-vm-io-read**
4523 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4525 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4528 ------------------------|--------------
4529 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4530 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4531 vmware_vmname | **Required.** Virtual machine name.
4532 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4533 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4534 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4535 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4536 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4537 vmware_sessionfile | **Optional.** Session file name enhancement.
4538 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4539 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4540 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4541 vmware_password | **Optional.** The username's password. No value defined as default.
4542 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4543 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4544 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4547 **vmware-esx-soap-vm-io-write**
4549 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4551 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4554 ------------------------|--------------
4555 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4556 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4557 vmware_vmname | **Required.** Virtual machine name.
4558 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4559 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4560 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4561 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4562 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4563 vmware_sessionfile | **Optional.** Session file name enhancement.
4564 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4565 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4566 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4567 vmware_password | **Optional.** The username's password. No value defined as default.
4568 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4569 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4570 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4573 **vmware-esx-soap-vm-io-usage**
4575 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
4577 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4580 ------------------------|--------------
4581 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4582 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4583 vmware_vmname | **Required.** Virtual machine name.
4584 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4585 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4586 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4587 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4588 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4589 vmware_sessionfile | **Optional.** Session file name enhancement.
4590 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4591 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4592 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4593 vmware_password | **Optional.** The username's password. No value defined as default.
4594 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4595 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4596 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4599 **vmware-esx-soap-vm-runtime**
4601 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
4603 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4606 ------------------------|--------------
4607 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4608 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4609 vmware_vmname | **Required.** Virtual machine name.
4610 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4611 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4612 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4613 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4614 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4615 vmware_sessionfile | **Optional.** Session file name enhancement.
4616 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4617 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4618 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4619 vmware_password | **Optional.** The username's password. No value defined as default.
4620 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4623 **vmware-esx-soap-vm-runtime-con**
4625 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
4627 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4630 ------------------------|--------------
4631 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4632 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4633 vmware_vmname | **Required.** Virtual machine name.
4634 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4635 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4636 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4637 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4638 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4639 vmware_sessionfile | **Optional.** Session file name enhancement.
4640 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4641 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4642 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4643 vmware_password | **Optional.** The username's password. No value defined as default.
4644 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4647 **vmware-esx-soap-vm-runtime-powerstate**
4649 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
4651 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4654 ------------------------|--------------
4655 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4656 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4657 vmware_vmname | **Required.** Virtual machine name.
4658 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4659 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4660 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4661 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4662 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4663 vmware_sessionfile | **Optional.** Session file name enhancement.
4664 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4665 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4666 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4667 vmware_password | **Optional.** The username's password. No value defined as default.
4668 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4671 **vmware-esx-soap-vm-runtime-status**
4673 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4675 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4678 ------------------------|--------------
4679 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4680 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4681 vmware_vmname | **Required.** Virtual machine name.
4682 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4683 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4684 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4685 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4686 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4687 vmware_sessionfile | **Optional.** Session file name enhancement.
4688 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4689 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4690 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4691 vmware_password | **Optional.** The username's password. No value defined as default.
4692 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4695 **vmware-esx-soap-vm-runtime-consoleconnections**
4697 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
4699 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4702 ------------------------|--------------
4703 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4704 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4705 vmware_vmname | **Required.** Virtual machine name.
4706 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4707 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4708 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4709 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4710 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4711 vmware_sessionfile | **Optional.** Session file name enhancement.
4712 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4713 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4714 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4715 vmware_password | **Optional.** The username's password. No value defined as default.
4716 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4717 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4718 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4721 **vmware-esx-soap-vm-runtime-gueststate**
4723 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
4725 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4728 ------------------------|--------------
4729 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4730 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4731 vmware_vmname | **Required.** Virtual machine name.
4732 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4733 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4734 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4735 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4736 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4737 vmware_sessionfile | **Optional.** Session file name enhancement.
4738 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4739 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4740 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4741 vmware_password | **Optional.** The username's password. No value defined as default.
4742 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4744 **vmware-esx-soap-vm-runtime-tools**
4746 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
4748 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4751 ------------------------|--------------
4752 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4753 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4754 vmware_vmname | **Required.** Virtual machine name.
4755 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4756 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4757 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4758 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4759 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4760 vmware_sessionfile | **Optional.** Session file name enhancement.
4761 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4762 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4763 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4764 vmware_password | **Optional.** The username's password. No value defined as default.
4765 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4766 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
4769 **vmware-esx-soap-vm-runtime-issues**
4771 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
4773 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4776 ------------------------|--------------
4777 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4778 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4779 vmware_vmname | **Required.** Virtual machine name.
4780 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4781 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4782 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4783 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4784 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4785 vmware_sessionfile | **Optional.** Session file name enhancement.
4786 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4787 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4788 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4789 vmware_password | **Optional.** The username's password. No value defined as default.
4790 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4791 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.
4794 ### <a id="plugin-contrib-web"></a> Web
4796 This category includes all plugins for web-based checks.
4798 #### <a id="plugin-contrib-command-webinject"></a> webinject
4800 The [check_webinject](https://labs.consol.de/de/nagios/check_webinject/index.html) plugin
4801 uses [WebInject](https://www.webinject.org/manual.html) to test web applications
4802 and web services in an automated fashion.
4803 It can be used to test individual system components that have HTTP interfaces
4804 (JSP, ASP, CGI, PHP, AJAX, Servlets, HTML Forms, XML/SOAP Web Services, REST, etc),
4805 and can be used as a test harness to create a suite of HTTP level automated functional,
4806 acceptance, and regression tests. A test harness allows you to run many test cases
4807 and collect/report your results. WebInject offers real-time results
4808 display and may also be used for monitoring system response times.
4810 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4813 ------------------------|--------------
4814 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.
4815 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.
4816 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
4817 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.
4818 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.
4819 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.
4821 #### <a id="plugin-contrib-command-jmx4perl"></a> jmx4perl
4823 The [check_jmx4perl](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl) plugin
4824 uses the HTTP API exposed by the [Jolokia](https://jolokia.org)
4825 web application and queries Java message beans on an application server. It is
4826 part of the `JMX::Jmx4Perl` Perl module which includes detailed
4827 [documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl).
4829 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4832 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
4833 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
4834 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
4835 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.
4836 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
4837 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
4838 jmx4perl_operation | **Optional.** Operation to execute.
4839 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
4840 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
4841 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
4842 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
4843 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
4844 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
4845 jmx4perl_proxy | **Optional.** Proxy to use.
4846 jmx4perl_user | **Optional.** User for HTTP authentication.
4847 jmx4perl_password | **Optional.** Password for HTTP authentication.
4848 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
4849 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
4850 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.
4851 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
4852 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
4853 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
4854 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.
4855 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
4856 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
4857 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
4858 jmx4perl_critical | **Optional.** Critical threshold for value.
4859 jmx4perl_warning | **Optional.** Warning threshold for value.
4860 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
4861 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
4862 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
4863 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
4864 jmx4perl_config | **Optional.** Path to configuration file.
4865 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
4866 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
4868 #### <a id="plugin-contrib-command-squid"></a> squid
4870 The [check_squid](https://exchange.icinga.com/exchange/check_squid) plugin
4871 uses the `squidclient` binary to monitor a [Squid proxy](http://www.squid-cache.org).
4873 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4876 ------------------------|----------------------------------------------------------------------------------
4877 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
4878 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
4879 squid_port | **Optional.** Port number (default: 3128).
4880 squid_user | **Optional.** WWW user
4881 squid_password | **Optional.** WWW password
4882 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4883 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4884 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
4885 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
4888 #### <a id="plugin-contrib-command-nginx_status"></a> nginx_status
4890 The [check_nginx_status.pl](https://github.com/regilero/check_nginx_status) plugin
4891 uses the [/nginx_status](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
4892 HTTP endpoint which provides metrics for monitoring Nginx.
4894 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4897 --------------------------------|----------------------------------------------------------------------------------
4898 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4899 nginx_status_port | **Optional.** the http port.
4900 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
4901 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
4902 nginx_status_ssl | **Optional.** set to use ssl connection
4903 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
4904 nginx_status_user | **Optional.** Username for basic auth
4905 nginx_status_pass | **Optional.** Password for basic auth
4906 nginx_status_realm | **Optional.** Realm for basic auth
4907 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
4908 nginx_status_timeout | **Optional.** timeout in seconds
4909 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
4910 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
4913 #### <a id="plugin-contrib-command-apache_status"></a> apache_status
4915 The [check_apache_status.pl](https://github.com/lbetz/check_apache_status) plugin
4916 uses the [/server-status](https://httpd.apache.org/docs/current/mod/mod_status.html)
4917 HTTP endpoint to monitor status metrics for the Apache webserver.
4919 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4922 ------------------------|----------------------------------------------------------------------------------
4923 apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4924 apache_status_port | **Optional.** the http port.
4925 apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
4926 apache_status_ssl | **Optional.** set to use ssl connection
4927 apache_status_timeout | **Optional.** timeout in seconds
4928 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
4929 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
4932 #### <a id="plugin-contrib-command-kdc"></a> kdc
4934 The [check_kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details) plugin
4935 uses the Kerberos `kinit` binary to monitor Kerberos 5 KDC by acquiring a ticket.
4937 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4940 ----------------|--------------------------------------------------------------------------
4941 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4942 kdc_port | **Optional** Port on which KDC runs (default 88).
4943 kdc_principal | **Required** Principal name to authenticate as (including realm).
4944 kdc_keytab | **Required** Keytab file containing principal's key.
4947 #### <a id="plugin-contrib-command-rbl"></a> rbl
4949 The [check_rbl](https://github.com/matteocorti/check_rbl) plugin
4950 uses the `Net::DNS` Perl library to check whether your SMTP server
4953 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4956 ----------------|--------------------------------------------------------------------------
4957 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.
4958 rbl_server | **Required** List of RBL servers as an array.
4959 rbl_warning | **Optional** Number of blacklisting servers for a warning.
4960 rbl_critical | **Optional** Number of blacklisting servers for a critical.
4961 tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
projects / icinga2 / blob