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 | If set, returns warning when important updates are available
1597 update\_win\_crit | If set, return critical when important updates that require a reboot are available.
1598 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1601 ### <a id="windows-plugins-uptime-windows"></a> uptime-windows
1603 Check command opject for `check_uptime.exe` plugin.
1604 Uses GetTickCount64 to get the uptime, so boot time is not included.
1609 :-----------------|:------------
1610 uptime\_win\_warn | **Optional**. The warning threshold.
1611 uptime\_win\_crit | **Optional**. The critical threshold.
1612 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).
1615 ### <a id="windows-plugins-users-windows"></a> users-windows
1617 Check command object for `check_users.exe` plugin.
1622 :----------------|:------------
1623 users\_win\_warn | **Optional**. The warning threshold.
1624 users\_win\_crit | **Optional**. The critical threshold.
1627 ## <a id="nscp-plugin-check-commands"></a> Plugin Check Commands for NSClient++
1629 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1631 You can enable these check commands by adding the following the include directive in your
1632 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1636 You can also optionally specify an alternative installation directory for NSClient++ by adding
1637 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1640 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1642 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1643 not be necessary to manually set this constant.
1645 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1647 ### <a id="nscp-check-local"></a> nscp-local
1649 Check command object for NSClient++
1651 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1654 ----------------|--------------
1655 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1656 nscp_load_all | **Optional.** Whether to load all modules. Defaults to false.
1657 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`.
1658 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1659 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1660 nscp_arguments | **Optional.** An array of query arguments.
1661 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1663 ### <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1665 Check command object for the `check_cpu` NSClient++ plugin.
1668 --------------------|------------------
1669 nscp_cpu_time | **Optional.** Calculate avarage usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1670 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1671 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1672 nscp_cpu_arguments | **Optional.** Additional arguments.
1673 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1675 ### <a id="nscp-check-local-memory"></a> nscp-local-memory
1677 Check command object for the `check_memory` NSClient++ plugin.
1680 ----------------------|------------------
1681 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1682 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1683 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1684 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolut (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1685 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolut (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1686 nscp_memory_arguments | **Optional.** Additional arguments.
1687 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1689 ### <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1691 Check command object for the `check_os_version` NSClient++ plugin.
1693 This command has the same custom attributes like the `nscp-local` check command.
1695 ### <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1697 Check command object for the `check_pagefile` NSClient++ plugin.
1699 This command has the same custom attributes like the `nscp-local` check command.
1701 ### <a id="nscp-check-local-process"></a> nscp-local-process
1703 Check command object for the `check_process` NSClient++ plugin.
1705 This command has the same custom attributes like the `nscp-local` check command.
1707 ### <a id="nscp-check-local-service"></a> nscp-local-service
1709 Check command object for the `check_service` NSClient++ plugin.
1712 -----------------------|------------------
1713 nscp_service_name | **Required.** Name of service to check.
1714 nscp_service_type | **Optional.** Type to check, default to state.
1715 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1716 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1717 nscp_service_warning | **Optional.** State for return an WARNING.
1718 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1719 nscp_service_critical | **Optional.** State for return an CRITICAL.
1720 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1721 nscp_service_arguments | **Optional.** Additional arguments.
1722 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1724 ### <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1726 Check command object for the `check_uptime` NSClient++ plugin.
1728 This command has the same custom attributes like the `nscp-local` check command.
1730 ### <a id="nscp-check-local-version"></a> nscp-local-version
1732 Check command object for the `check_version` NSClient++ plugin.
1734 This command has the same custom attributes like the `nscp-local` check command.
1735 In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
1737 ### <a id="nscp-check-local-disk"></a> nscp-local-disk
1739 Check command object for the `check_drivesize` NSClient++ plugin.
1742 -----------------------|------------------
1743 nscp_disk_drive | **Optional.** Drive character, default to all drives.
1744 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1745 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolut (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1746 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolut (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1747 nscp_disk_arguments | **Optional.** Additional arguments.
1748 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1749 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`.
1751 ### <a id="nscp-check-local-counter"></a> nscp-local-counter
1753 Check command object for the `check_pdh` NSClient++ plugin.
1756 -----------------------|------------------
1757 nscp_counter_name | **Required.** Performance counter name.
1758 nscp_counter_warning | **Optional.** WARNING Threshold.
1759 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1760 nscp_counter_arguments | **Optional.** Additional arguments.
1761 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1762 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1766 ## <a id="snmp-manubulon-plugin-check-commands"></a> Plugin Check Commands for Manubulon SNMP
1768 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1769 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1771 **Note:** Some plugin parameters are only available in Debian packages or in a
1772 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1774 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1775 is set to the path where the Manubublon SNMP plugins are installed.
1777 You can enable these plugin check commands by adding the following the include directive in your
1778 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1782 ### Checks by Host Type
1784 **N/A** : Not available for this type.
1786 **SNMP** : Available for simple SNMP query.
1790 **Specific** : Script name for platform specific checks.
1793 Host type | Interface | storage | load/cpu | mem | process | env | specific
1794 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1795 Linux | Yes | Yes | Yes | Yes | Yes | No |
1796 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1797 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1798 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1799 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1800 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1801 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1802 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1803 AS400 | Yes | Yes | Yes | Yes | No | No |
1804 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1805 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1806 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1807 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1810 ### <a id="plugin-check-command-snmp-load"></a> snmp-load
1812 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1814 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1818 ------------------------|--------------
1819 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1820 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1821 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1822 snmp_port | **Optional.** The SNMP port connection.
1823 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1824 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1825 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1826 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1827 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1828 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1829 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1830 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1831 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1832 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1833 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.
1834 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1835 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1837 ### <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1839 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1841 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1844 ------------------------|--------------
1845 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1846 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1847 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1848 snmp_port | **Optional.** The SNMP port connection.
1849 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1850 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1851 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1852 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1853 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1854 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1855 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1856 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1857 snmp_warn | **Optional.** The warning threshold.
1858 snmp_crit | **Optional.** The critical threshold.
1859 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1860 snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
1861 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1862 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1864 ### <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1866 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1868 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1871 ------------------------|--------------
1872 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1873 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1874 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1875 snmp_port | **Optional.** The SNMP port connection.
1876 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1877 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1878 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1879 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1880 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1881 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1882 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1883 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1884 snmp_warn | **Optional.** The warning threshold.
1885 snmp_crit | **Optional.** The critical threshold.
1886 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1887 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1888 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1890 ### <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1892 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1894 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1897 ----------------------------|--------------
1898 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1899 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1900 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1901 snmp_port | **Optional.** The SNMP port connection.
1902 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1903 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1904 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1905 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1906 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1907 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1908 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1909 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1910 snmp_warn | **Optional.** The warning threshold.
1911 snmp_crit | **Optional.** The critical threshold.
1912 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1913 snmp_interface_inverse | **Optional.** Inverse Interface check, down is ok. Defaults to false as it is missing.
1914 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1915 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
1916 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.
1917 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1918 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1919 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.
1920 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1921 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1922 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1923 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1924 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.
1925 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name.
1926 snmp_interface_ifalias | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name.
1927 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1928 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1930 ### <a id="plugin-check-command-snmp-process"></a> snmp-process
1932 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1934 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1937 ---------------------------|--------------
1938 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1939 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1940 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1941 snmp_port | **Optional.** The SNMP port connection.
1942 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1943 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1944 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1945 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1946 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1947 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1948 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1949 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1950 snmp_warn | **Optional.** The warning threshold.
1951 snmp_crit | **Optional.** The critical threshold.
1952 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1953 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1954 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1955 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.
1956 snmp_process_mem_usage | **Optional.** Define to check memory usage for the process. Defaults to false.
1957 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".
1958 snmp_process_cpu_usage | **Optional.** Define to check CPU usage for the process. Defaults to false.
1959 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".
1962 ## <a id="plugin-contrib"></a> Contributed Plugin Check Commands
1964 The contributed Plugin Check Commands provides various additional command definitions
1965 contributed by community members.
1967 These check commands assume that the global constant named `PluginContribDir`
1968 is set to the path where the user installs custom plugins and can be enabled by
1969 uncommenting the corresponding line in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf):
1972 vim /etc/icinga2/icinga2.conf
1974 include <plugin-contrib>
1977 This is enabled by default since Icinga 2 2.5.0.
1979 ### <a id="plugin-contrib-databases"></a> Databases
1981 This category contains plugins for various database servers.
1983 #### <a id="plugin-contrib-command-db2_health"></a> db2_health
1985 The [check_db2_health](https://labs.consol.de/nagios/check_db2_health/) plugin
1986 uses the `DBD::DB2` Perl library to monitor a [DB2](https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/)
1989 The Git repository is located on [GitHub](https://github.com/lausser/check_db2_health).
1991 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1994 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1995 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)
1996 db2_health_username | **Optional.** The username for the database connection.
1997 db2_health_password | **Optional.** The password for the database connection.
1998 db2_health_port | **Optional.** The port where DB2 is listening.
1999 db2_health_warning | **Optional.** The warning threshold depending on the mode.
2000 db2_health_critical | **Optional.** The critical threshold depending on the mode.
2001 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
2002 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).
2003 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.
2004 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.
2005 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
2006 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".
2007 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
2008 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
2009 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
2010 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".
2011 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
2013 #### <a id="plugin-contrib-command-mssql_health"></a> mssql_health
2015 The [check_mssql_health](https://labs.consol.de/nagios/check_mssql_health/index.html) plugin
2016 uses the `DBD::Sybase` Perl library based on [FreeTDS](http://www.freetds.org/) to monitor a
2017 [MS SQL](https://www.microsoft.com/en-us/sql-server/) server.
2019 The Git repository is located on [GitHub](https://github.com/lausser/check_mssql_health).
2021 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2024 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2025 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
2026 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
2027 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
2028 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
2029 mssql_health_username | **Optional.** The username for the database connection.
2030 mssql_health_password | **Optional.** The password for the database connection.
2031 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
2032 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
2033 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
2034 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).
2035 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
2036 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.
2037 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
2038 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".
2039 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
2040 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
2041 mssql_health_notemp | **Optional.** Set this to true to ignore temporary databases/tablespaces. Defaults to false.
2042 mssql_health_nooffline | **Optional.** Set this to true to ignore offline databases. Defaults to false.
2043 mssql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates.
2045 #### <a id="plugin-contrib-command-mysql_health"></a> mysql_health
2047 The [check_mysql_health](https://labs.consol.de/nagios/check_mysql_health/index.html) plugin
2048 uses the `DBD::MySQL` Perl library to monitor a
2049 [MySQL](https://dev.mysql.com/downloads/mysql/) or [MariaDB](https://mariadb.org/about/) database.
2051 The Git repository is located on [GitHub](https://github.com/lausser/check_mysql_health).
2053 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2056 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2057 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
2058 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
2059 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
2060 mysql_health_username | **Optional.** The username for the database connection.
2061 mysql_health_password | **Optional.** The password for the database connection.
2062 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
2063 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
2064 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
2065 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
2066 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
2067 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
2068 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
2069 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::* module.
2070 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
2071 mysql_health_nooffline | **Optional.** Skip the offline databases.
2072 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
2073 mysql_health_name | **Optional.** The name of a specific component to check.
2074 mysql_health_name2 | **Optional.** The secondary name of a component.
2075 mysql_health_name3 | **Optional.** The tertiary name of a component.
2076 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".
2077 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2078 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2079 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components"
2080 mysql_health_mitigation | **Optional.** "The parameter allows you to change a critical error to a warning."
2081 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates."
2082 mysql_health_environment | **Optional.** Add a variable to the plugin's environment."
2083 mysql_health_morphmessage | **Optional.** Modify the final output message."
2084 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels."
2085 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data."
2086 mysql_health_report | **Optional.** Can be used to shorten the output."
2087 mysql_health_multiline | **Optional.** Multiline output."
2088 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical."
2089 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory."
2090 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files."
2091 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time."
2092 mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2094 #### <a id="plugin-contrib-command-oracle_health"></a> oracle_health
2096 The [check_oracle_health](https://labs.consol.de/nagios/check_oracle_health/index.html) plugin
2097 uses the `DBD::Oracle` Perl library to monitor an [Oracle](https://www.oracle.com/database/) database.
2099 The Git repository is located on [GitHub](https://github.com/lausser/check_oracle_health).
2101 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2104 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2105 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2106 oracle_health_username | **Optional.** The username for the database connection.
2107 oracle_health_password | **Optional.** The password for the database connection.
2108 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2109 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2110 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2111 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2112 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.
2113 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.
2114 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2115 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".
2116 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2117 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2118 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2119 oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2120 oracle_health_report | **Optional.** Select the plugin output format. Can be short or long. Default to long.
2125 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2126 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".
2127 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".
2129 #### <a id="plugin-contrib-command-postgres"></a> postgres
2131 The [check_postgres](https://bucardo.org/wiki/Check_postgres) plugin
2132 uses the `psql` binary to monitor a [PostgreSQL](https://www.postgresql.org/about/) database.
2134 The Git repository is located on [GitHub](https://github.com/bucardo/check_postgres).
2136 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2139 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2140 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.
2141 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2142 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2143 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2144 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2145 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2146 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2147 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2148 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2149 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2150 postgres_includeuser | **Optional.** Include objects owned by certain users.
2151 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2152 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
2153 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2154 postgres_action | **Required.** Determines the test executed.
2155 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2156 postgres_query | **Optional.** Query for "custom_query" action.
2157 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2158 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2159 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).
2161 #### <a id="plugin-contrib-command-mongodb"></a> mongodb
2163 The [check_mongodb.py](https://github.com/mzupan/nagios-plugin-mongodb) plugin
2164 uses the `pymongo` Python library to monitor a [MongoDB](https://docs.mongodb.com/manual/) instance.
2166 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2169 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2170 mongodb_host | **Required.** Specifies the hostname or address.
2171 mongodb_port | **Required.** The port mongodb is runnung on.
2172 mongodb_user | **Optional.** The username you want to login as
2173 mongodb_passwd | **Optional.** The password you want to use for that user
2174 mongodb_warning | **Optional.** The warning threshold we want to set
2175 mongodb_critical | **Optional.** The critical threshold we want to set
2176 mongodb_action | **Required.** The action you want to take
2177 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
2178 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
2179 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
2180 mongodb_database | **Optional.** Specify the database to check
2181 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
2182 mongodb_ssl | **Optional.** Connect using SSL
2183 mongodb_replicaset | **Optional.** Connect to replicaset
2184 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check
2185 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second
2186 mongodb_collection | **Optional.** Specify the collection to check
2187 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
2189 #### <a id="plugin-contrib-command-elasticsearch"></a> elasticsearch
2191 The [check_elasticsearch](https://github.com/anchor/nagios-plugin-elasticsearch) plugin
2192 uses the HTTP API to monitor an [Elasticsearch](https://www.elastic.co/products/elasticsearch) node.
2194 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2197 -----------------------------|-------------------------------------------------------------------------------------------------------
2198 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2199 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
2200 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.
2201 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2202 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2203 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2205 #### <a id="plugin-contrib-command-redis"></a> redis
2207 The [check_redis.pl](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl) plugin
2208 uses the `Redis` Perl library to monitor a [Redis](https://redis.io/) instance. The plugin can
2209 measure response time, hitrate, memory utilization, check replication synchronization, etc. It is
2210 also possible to test data in a specified key and calculate averages or summaries on ranges.
2212 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2215 -------------------------|--------------------------------------------------------------------------------------------------------------
2216 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
2217 redis_port | **Optional.** Port number to query. Default to "6379".
2218 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2219 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2220 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2221 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2222 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2223 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.
2224 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.
2225 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.
2226 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2227 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.
2228 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".
2229 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2230 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2231 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.
2232 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2233 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.
2234 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2235 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2238 ### <a id="plugin-contrib-hardware"></a> Hardware
2240 This category includes all plugin check commands for various hardware checks.
2242 #### <a id="plugin-contrib-command-hpasm"></a> hpasm
2244 The [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) plugin
2245 monitors the hardware health of HP Proliant Servers, provided that the `hpasm`
2246 (HP Advanced Server Management) software is installed. It is also able to monitor
2247 the system health of HP Bladesystems and storage systems.
2249 The plugin can run in two different ways:
2251 1. Local execution using the `hpasmcli` command line tool.
2252 2. Remote SNMP query which invokes the HP Insight Tools on the remote node.
2254 You can either set or omit `hpasm_hostname` custom attribute and select the corresponding node.
2256 The `hpasm_remote` attribute enables the plugin to execute remote SNMP queries if set to `true`.
2257 For compatibility reasons this attribute uses `true` as default value, and ensures that
2258 specifying the `hpasm_hostname` always enables remote checks.
2260 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2263 --------------------------------|-----------------------------------------------------------------------
2264 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2265 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2266 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2267 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2268 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2269 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2270 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2271 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2272 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.
2273 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.
2274 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2275 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2276 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2277 hpasm_privpassword | **Optional.** The password for authPriv security level.
2278 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2279 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2280 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.
2281 hpasm_remote | **Optional.** Run remote SNMP checks if enabled. Otherwise checks are executed locally using the `hpasmcli` binary. Defaults to `true`.
2283 #### <a id="plugin-contrib-command-adaptec-raid"></a> adaptec-raid
2285 The [check_adaptec_raid](https://github.com/thomas-krenn/check_adaptec_raid) plugin
2286 uses the `arcconf` binary to monitor Adaptec RAID controllers.
2288 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2291 --------------------------------|-----------------------------------------------------------------------
2292 adaptec_controller_number | **Required.** Controller number to monitor.
2293 arcconf_path | **Required.** Path to the `arcconf` binary, e.g. "/sbin/arcconf".
2295 #### <a id="plugin-contrib-command-lsi-raid"></a> lsi-raid
2297 The [check_lsi_raid](https://github.com/thomas-krenn/check_lsi_raid) plugin
2298 uses the `storcli` binary to monitor MegaRAID RAID controllers.
2300 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2303 --------------------------------|-----------------------------------------------------------------------
2304 lsi_controller_number | **Required.** Controller number to monitor.
2305 storcli_path | **Required.** Path to the `storcli` binary, e.g. "/usr/sbin/storcli".
2307 #### <a id="plugin-contrib-command-smart-attributes"></a> smart-attributes
2309 The [check_smart_attributes](https://github.com/thomas-krenn/check_smart_attributes) plugin
2310 uses the `smartctl` binary to monitor SMART values of SSDs and HDDs.
2312 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2315 --------------------------------|-----------------------------------------------------------------------
2316 smart_attributes_config_path | **Required.** Path to the smart attributes config file (e.g. check_smartdb.json).
2317 smart_attributes_device | **Required.** Device name (e.g. /dev/sda) to monitor.
2320 ### <a id="plugin-contrib-icingacli"></a> IcingaCLI
2322 This category includes all plugins using the icingacli provided by Icinga Web 2.
2324 #### <a id="plugin-contrib-icingacli-businessprocess"></a> Business Process
2326 This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process)
2327 and executed as `icingacli businessprocess` CLI command.
2329 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2332 ------------------------------------------|-----------------------------------------------------------------------------------------
2333 icingacli_businessprocess_process | **Required.** Business process to monitor.
2334 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2335 icingacli_businessprocess_details | **Optional.** Get details for root cause analysis. Defaults to false.
2336 icingacli_businessprocess_statetype | **Optional.** Define which state type to look at, `soft` or `hard`. Overrides the default value inside the businessprocess module, if configured.
2339 ### <a id="plugin-contrib-ipmi"></a> IPMI Devices
2341 This category includes all plugins for IPMI devices.
2343 #### <a id="plugin-contrib-command-ipmi-sensor"></a> ipmi-sensor
2345 The [check_ipmi_sensor](https://github.com/thomas-krenn/check_ipmi_sensor_v3) plugin
2346 uses the `ipmimonitoring` binary to monitor sensor data for IPMI devices. Please
2347 read the [documentation](https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin)
2348 for installation and configuration details.
2350 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2353 ---------------------------------|-----------------------------------------------------------------------------------------------------
2354 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2355 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2356 ipmi_username | **Optional.** The IPMI username.
2357 ipmi_password | **Optional.** The IPMI password.
2358 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2359 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2360 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2361 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.
2362 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2363 ipmi_exclude_sensor | **Optional.** Exclude sensor based on IPMI sensor type. (Comma-separated)
2364 ipmi_exclude_sel | **Optional.** Exclude SEL entries of specific sensor types. (comma-separated list).
2365 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2366 ipmi_protocol_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2367 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2368 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2369 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2370 ipmi_verbose | **Optional.** Be Verbose multi line output, also with additional details for warnings.
2371 ipmi_debug | **Optional.** Be Verbose debugging output, followed by normal multi line output.
2373 #### <a id="plugin-contrib-command-ipmi-alive"></a> ipmi-alive
2375 The `ipmi-alive` check commands allows you to create a ping check for the IPMI Interface.
2377 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2380 ---------------------------------|-----------------------------------------------------------------------------------------------------
2381 ping_address | **Optional.** The address of the IPMI interface. Defaults to "$address$" if the IPMI interface's `address` attribute is set, "$address6$" otherwise.
2382 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 5000.
2383 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 100.
2384 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
2385 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
2386 ping_packets | **Optional.** The number of packets to send. Defaults to 1.
2387 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
2390 ### <a id="plugins-contrib-log-management"></a> Log Management
2392 This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
2394 #### <a id="plugins-contrib-command-logstash"></a> logstash
2396 The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
2397 the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
2399 The Node API is not activated by default. You have to configure your Logstash
2400 installation in order to allow plugin connections.
2403 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2404 logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
2405 logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
2406 logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
2407 logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
2408 logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
2409 logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
2410 logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
2411 logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
2412 logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
2413 logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
2416 ### <a id="plugin-contrib-metrics"></a> Metrics
2418 This category includes all plugins for metric-based checks.
2420 #### <a id="plugin-contrib-command-graphite"></a> graphite
2422 The [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin
2423 uses the `rest-client` Ruby library to monitor a [Graphite](https://graphiteapp.org) instance.
2425 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2428 ------------------------------------|-----------------------------------------------------------------------------------------------------
2429 graphite_url | **Required.** Target url.
2430 graphite_metric | **Required.** Metric path string.
2431 graphite_shortname | **Optional.** Metric short name (used for performance data).
2432 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2433 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2434 graphite_warning | **Required.** Warning threshold.
2435 graphite_critical | **Required.** Critical threshold.
2436 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.
2437 graphite_message | **Optional.** Text message to output (default: "metric count:").
2438 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2439 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2441 ### <a id="plugin-contrib-network-components"></a> Network Components
2443 This category includes all plugins for various network components like routers, switches and firewalls.
2445 #### <a id="plugin-contrib-command-interfacetable"></a> interfacetable
2447 The [check_interfacetable_v3t](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) plugin
2448 generates a html page containing information about the monitored node and all of its interfaces.
2450 The Git repository is located on [GitHub](https://github.com/Tontonitch/interfacetable_v3t).
2452 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2455 ------------------------------------|-----------------------------------------------------------------------------------------------------
2456 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2457 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2458 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2459 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2460 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2461 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2462 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2463 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2464 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2465 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2466 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2467 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2468 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.
2469 interfacetable_trackproperty | **Optional.** List of tracked properties.
2470 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2471 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2472 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
2473 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
2474 interfacetable_login | **Optional.** Login for snmpv3 authentication.
2475 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
2476 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
2477 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
2478 interfacetable_domain | **Optional.** SNMP transport domain.
2479 interfacetable_contextname | **Optional.** Context name for the snmp requests.
2480 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
2481 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
2482 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
2483 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
2484 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
2485 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.
2486 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
2487 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
2488 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
2489 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
2490 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
2491 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
2492 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
2493 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
2494 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
2495 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".
2496 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
2497 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
2498 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"
2499 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
2500 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
2501 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.
2502 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.
2503 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
2504 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
2505 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
2506 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
2507 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
2508 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
2509 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
2510 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
2511 interfacetable_config | **Optional.** Specify a config file to load.
2512 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
2513 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
2514 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
2515 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
2516 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
2518 #### <a id="plugin-contrib-command-iftraffic"></a> iftraffic
2520 The [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic) plugin
2521 checks the utilization of a given interface name using the SNMP protocol.
2523 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2526 ------------------------|---------------------------------------------------------
2527 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
2528 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2529 iftraffic_interface | **Required.** Queried interface name.
2530 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2531 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2532 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2533 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2534 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2536 #### <a id="plugin-contrib-command-iftraffic64"></a> iftraffic64
2538 The [check_iftraffic64](https://exchange.icinga.com/exchange/iftraffic64) plugin
2539 checks the utilization of a given interface name using the SNMP protocol.
2541 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2544 ------------------------|---------------------------------------------------------
2545 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
2546 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2547 iftraffic64_interface | **Required.** Queried interface name.
2548 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2549 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2550 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2551 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2552 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2554 #### <a id="plugin-contrib-command-interfaces"></a> interfaces
2556 The [check_interfaces](https://git.netways.org/plugins/check_interfaces) plugin
2557 uses SNMP to monitor network interfaces and their utilization.
2559 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2562 --------------------------|---------------------------------------------------------
2563 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2564 interfaces_regex | **Optional.** Interface list regexp.
2565 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
2566 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
2567 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
2568 interfaces_perfdata | **Optional.** perfdata from last check result.
2569 interfaces_prefix | **Optional.** Prefix interface names with this label.
2570 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
2571 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
2572 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
2573 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
2574 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
2575 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
2576 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
2577 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
2578 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
2579 interfaces_user | **Optional.** SNMPv3 User
2580 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
2581 interfaces_aliases | **Optional.** Retrieves the interface description.
2582 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
2583 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
2584 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
2585 interfaces_names | **Optional.** If set to true, use ifName instead of ifDescr.
2587 #### <a id="plugin-contrib-command-nwc_health"></a> nwc_health
2589 The [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html) plugin
2590 uses SNMP to monitor network components. The plugin is able to generate interface statistics,
2591 check hardware (CPU, memory, fan, power, etc.), monitor firewall policies, HRSP, load-balancer
2592 pools, processor and memory usage.
2594 Currently the following network components are supported: Cisco IOS, Cisco Nexus, Cisco ASA,
2595 Cisco PIX, F5 BIG-IP, CheckPoint Firewall1, Juniper NetScreen, HP Procurve, Nortel, Brocade 4100/4900,
2596 EMC DS 4700, EMC DS 24, Allied Telesyn. Blue Coat SG600, Cisco Wireless Lan Controller 5500,
2597 Brocade ICX6610-24-HPOE, Cisco UC Telefonzeugs, FOUNDRY-SN-AGENT-MIB, FRITZ!BOX 7390, FRITZ!DECT 200,
2598 Juniper IVE, Pulse-Gateway MAG4610, Cisco IronPort AsyncOS, Foundry, etc. A complete list can be
2599 found in the plugin [documentation](https://labs.consol.de/nagios/check_nwc_health/index.html).
2601 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2604 --------------------------------|---------------------------------------------------------
2605 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2606 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).
2607 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
2608 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
2609 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
2610 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).
2611 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2612 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2613 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2614 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
2615 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2616 nwc_health_privpassword | **Optional.** The password for authPriv security level.
2617 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2618 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
2619 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
2620 nwc_health_name | **Optional.** The name of an interface (ifDescr).
2621 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
2622 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
2623 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
2624 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
2625 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
2626 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
2627 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
2628 nwc_health_name2 | **Optional.** The secondary name of a component.
2629 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
2630 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)
2631 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.
2632 nwc_health_warning | **Optional.** The warning threshold
2633 nwc_health_critical | **Optional.** The critical threshold
2634 nwc_health_warningx | **Optional.** The extended warning thresholds
2635 nwc_health_criticalx | **Optional.** The extended critical thresholds
2636 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning (1) or ok (0).
2637 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.
2638 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'
2639 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
2640 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
2641 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
2642 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2643 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
2644 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
2645 nwc_health_multiline | **Optional.** Multiline output
2648 ### <a id="plugin-contrib-operating-system"></a> Operating System
2650 This category contains plugins which receive details about your operating system
2651 or the guest system.
2653 #### <a id="plugin-contrib-command-mem"></a> mem
2655 The [check_mem.pl](https://github.com/justintime/nagios-plugins) plugin checks the
2656 memory usage on linux and unix hosts. It is able to count cache memory as free when
2657 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).
2659 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2662 -------------|-----------------------------------------------------------------------------------------------------------------------
2663 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
2664 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
2665 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
2666 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
2667 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
2669 #### <a id="plugin-contrib-command-running_kernel"></a> running_kernel
2671 The [check_running_kernel](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin
2672 is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu.
2677 ---------------------------|-------------
2678 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
2680 #### <a id="plugin-contrib-command-iostats"></a> iostats
2682 The [check_iostats](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostats) plugin
2683 uses the `iostat` binary to monitor I/O on a Linux host. The default thresholds are rather high
2684 so you can use a grapher for baselining before setting your own.
2686 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2689 ---------------|-----------------------------------------------------------------------------------------------------------------------
2690 iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2691 iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000)
2692 iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000)
2693 iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000)
2694 iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50)
2695 iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000)
2696 iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000)
2697 iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000)
2698 iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80)
2700 #### <a id="plugin-contrib-command-iostat"></a> iostat
2702 The [check_iostat](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostat) plugin
2703 uses the `iostat` binary to monitor disk I/O on a Linux host. The default thresholds are rather high
2704 so you can use a grapher for baselining before setting your own.
2706 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2709 ---------------|-----------------------------------------------------------------------------------------------------------------------
2710 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2711 iostat\_wtps | **Required.** Warning threshold for tps (default: 100)
2712 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100)
2713 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100)
2714 iostat\_ctps | **Required.** Critical threshold for tps (default: 200)
2715 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200)
2716 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200)
2718 #### <a id="plugin-contrib-command-yum"></a> yum
2720 The [check_yum](https://github.com/calestyo/check_yum) plugin checks the YUM package
2721 management system for package updates.
2722 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
2724 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2727 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2728 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.
2729 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
2730 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.
2731 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.
2732 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.
2733 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.
2734 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.
2735 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
2736 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
2738 ### <a id="plugins-contrib-storage"></a> Storage
2740 This category includes all plugins for various storage and object storage technologies.
2742 #### <a id="plugins-contrib-command-glusterfs"></a> glusterfs
2744 The [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) plugin
2745 is used to check the GlusterFS storage health on the server.
2746 The plugin requires `sudo` permissions.
2748 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2751 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2752 glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
2753 glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
2754 glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
2755 glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
2756 glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
2757 glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
2758 glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
2761 ### <a id="plugin-contrib-virtualization"></a> Virtualization
2763 This category includes all plugins for various virtualization technologies.
2765 #### <a id="plugin-contrib-command-esxi-hardware"></a> esxi_hardware
2767 The [check_esxi_hardware.py](https://www.claudiokuenzler.com/nagios-plugins/check_esxi_hardware.php) plugin
2768 uses the [pywbem](https://pywbem.github.io/pywbem/) Python library to monitor the hardware of ESXi servers
2769 through the [VMWare API](https://www.vmware.com/support/pubs/sdk_pubs.html) and CIM service.
2771 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2774 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2775 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
2776 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.
2777 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.
2778 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
2779 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
2780 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
2781 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
2782 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
2783 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2784 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2785 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2786 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2787 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2789 #### <a id="plugin-contrib-vmware"></a> VMware
2791 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
2793 **vmware-esx-dc-volumes**
2795 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2797 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2800 ------------------------|--------------
2801 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2802 vmware_cluster | **Optional.** ESX or ESXi clustername.
2803 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2804 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2805 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2806 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2807 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2808 vmware_sessionfile | **Optional.** Session file name enhancement.
2809 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2810 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2811 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2812 vmware_password | **Optional.** The username's password. No value defined as default.
2813 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2814 vmware_subselect | **Optional.** Volume name to be checked the free space.
2815 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2816 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2817 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2818 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2819 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2820 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2821 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
2822 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2823 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2826 **vmware-esx-dc-runtime-info**
2828 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
2830 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2833 ------------------------|--------------
2834 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2835 vmware_cluster | **Optional.** ESX or ESXi clustername.
2836 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2837 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2838 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2839 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2840 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2841 vmware_sessionfile | **Optional.** Session file name enhancement.
2842 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2843 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2844 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2845 vmware_password | **Optional.** The username's password. No value defined as default.
2846 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2849 **vmware-esx-dc-runtime-listvms**
2851 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.
2853 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2856 ------------------------|--------------
2857 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2858 vmware_cluster | **Optional.** ESX or ESXi clustername.
2859 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2860 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2861 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2862 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2863 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2864 vmware_sessionfile | **Optional.** Session file name enhancement.
2865 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2866 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2867 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2868 vmware_password | **Optional.** The username's password. No value defined as default.
2869 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2870 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2871 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2872 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2873 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2874 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.
2877 **vmware-esx-dc-runtime-listhost**
2879 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
2881 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2884 ------------------------|--------------
2885 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2886 vmware_cluster | **Optional.** ESX or ESXi clustername.
2887 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2888 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2889 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2890 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2891 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2892 vmware_sessionfile | **Optional.** Session file name enhancement.
2893 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2894 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2895 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2896 vmware_password | **Optional.** The username's password. No value defined as default.
2897 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2898 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2899 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
2900 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
2901 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2902 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.
2905 **vmware-esx-dc-runtime-listcluster**
2907 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
2909 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2912 ------------------------|--------------
2913 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2914 vmware_cluster | **Optional.** ESX or ESXi clustername.
2915 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2916 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2917 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2918 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2919 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2920 vmware_sessionfile | **Optional.** Session file name enhancement.
2921 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2922 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2923 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2924 vmware_password | **Optional.** The username's password. No value defined as default.
2925 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2926 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2927 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
2928 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
2929 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2930 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.
2933 **vmware-esx-dc-runtime-issues**
2935 Check command object for the `check_vmware_esx` plugin. All issues for the host.
2937 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2940 ------------------------|--------------
2941 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2942 vmware_cluster | **Optional.** ESX or ESXi clustername.
2943 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2944 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2945 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2946 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2947 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2948 vmware_sessionfile | **Optional.** Session file name enhancement.
2949 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2950 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2951 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2952 vmware_password | **Optional.** The username's password. No value defined as default.
2953 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2954 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
2955 vmware_include | **Optional.** Whitelist issues. No value defined as default.
2956 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2957 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.
2960 **vmware-esx-dc-runtime-status**
2962 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2964 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2967 ------------------------|--------------
2968 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2969 vmware_cluster | **Optional.** ESX or ESXi clustername.
2970 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2971 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2972 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2973 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2974 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2975 vmware_sessionfile | **Optional.** Session file name enhancement.
2976 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2977 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2978 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2979 vmware_password | **Optional.** The username's password. No value defined as default.
2980 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2983 **vmware-esx-dc-runtime-tools**
2985 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
2987 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2990 ------------------------|--------------
2991 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2992 vmware_cluster | **Optional.** ESX or ESXi clustername.
2993 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2994 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2995 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2996 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2997 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2998 vmware_sessionfile | **Optional.** Session file name enhancement.
2999 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3000 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3001 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3002 vmware_password | **Optional.** The username's password. No value defined as default.
3003 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3004 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
3005 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
3006 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
3007 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
3008 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3009 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.
3010 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
3013 **vmware-esx-soap-host-check**
3015 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
3017 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3020 ------------------------|--------------
3021 vmware_host | **Required.** ESX or ESXi hostname.
3022 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3023 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3024 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3025 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3026 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3027 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3028 vmware_sessionfile | **Optional.** Session file name enhancement.
3029 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3030 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3031 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3032 vmware_password | **Optional.** The username's password. No value defined as default.
3033 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3036 **vmware-esx-soap-host-uptime**
3038 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
3040 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3043 ------------------------|--------------
3044 vmware_host | **Required.** ESX or ESXi hostname.
3045 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3046 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3047 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3048 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3049 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3050 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3051 vmware_sessionfile | **Optional.** Session file name enhancement.
3052 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3053 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3054 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3055 vmware_password | **Optional.** The username's password. No value defined as default.
3056 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3059 **vmware-esx-soap-host-cpu**
3061 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
3063 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3066 ------------------------|--------------
3067 vmware_host | **Required.** ESX or ESXi hostname.
3068 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3069 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3070 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3071 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3072 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3073 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3074 vmware_sessionfile | **Optional.** Session file name enhancement.
3075 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3076 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3077 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3078 vmware_password | **Optional.** The username's password. No value defined as default.
3079 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3080 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3081 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3084 **vmware-esx-soap-host-cpu-ready**
3086 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.
3088 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3091 ------------------------|--------------
3092 vmware_host | **Required.** ESX or ESXi hostname.
3093 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3094 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3095 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3096 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3097 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3098 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3099 vmware_sessionfile | **Optional.** Session file name enhancement.
3100 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3101 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3102 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3103 vmware_password | **Optional.** The username's password. No value defined as default.
3104 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3107 **vmware-esx-soap-host-cpu-wait**
3109 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.
3111 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3114 ------------------------|--------------
3115 vmware_host | **Required.** ESX or ESXi hostname.
3116 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3117 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3118 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3119 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3120 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3121 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3122 vmware_sessionfile | **Optional.** Session file name enhancement.
3123 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3124 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3125 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3126 vmware_password | **Optional.** The username's password. No value defined as default.
3127 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3130 **vmware-esx-soap-host-cpu-usage**
3132 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.
3134 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3137 ------------------------|--------------
3138 vmware_host | **Required.** ESX or ESXi hostname.
3139 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3140 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3141 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3142 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3143 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3144 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3145 vmware_sessionfile | **Optional.** Session file name enhancement.
3146 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3147 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3148 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3149 vmware_password | **Optional.** The username's password. No value defined as default.
3150 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3151 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3152 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3155 **vmware-esx-soap-host-mem**
3157 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3159 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3162 ------------------------|--------------
3163 vmware_host | **Required.** ESX or ESXi hostname.
3164 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3165 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3166 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3167 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3168 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3169 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3170 vmware_sessionfile | **Optional.** Session file name enhancement.
3171 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3172 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3173 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3174 vmware_password | **Optional.** The username's password. No value defined as default.
3175 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3178 **vmware-esx-soap-host-mem-usage**
3180 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3182 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3185 ------------------------|--------------
3186 vmware_host | **Required.** ESX or ESXi hostname.
3187 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3188 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3189 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3190 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3191 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3192 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3193 vmware_sessionfile | **Optional.** Session file name enhancement.
3194 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3195 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3196 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3197 vmware_password | **Optional.** The username's password. No value defined as default.
3198 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3199 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3200 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3203 **vmware-esx-soap-host-mem-consumed**
3205 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.
3207 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3210 ------------------------|--------------
3211 vmware_host | **Required.** ESX or ESXi hostname.
3212 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3213 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3214 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3215 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3216 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3217 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3218 vmware_sessionfile | **Optional.** Session file name enhancement.
3219 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3220 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3221 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3222 vmware_password | **Optional.** The username's password. No value defined as default.
3223 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3224 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3225 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3228 **vmware-esx-soap-host-mem-swapused**
3230 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.
3232 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3235 ------------------------|--------------
3236 vmware_host | **Required.** ESX or ESXi hostname.
3237 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3238 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3239 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3240 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3241 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3242 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3243 vmware_sessionfile | **Optional.** Session file name enhancement.
3244 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3245 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3246 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3247 vmware_password | **Optional.** The username's password. No value defined as default.
3248 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3249 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3250 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3251 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.
3254 **vmware-esx-soap-host-mem-overhead**
3256 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3258 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3261 ------------------------|--------------
3262 vmware_host | **Required.** ESX or ESXi hostname.
3263 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3264 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3265 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3266 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3267 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3268 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3269 vmware_sessionfile | **Optional.** Session file name enhancement.
3270 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3271 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3272 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3273 vmware_password | **Optional.** The username's password. No value defined as default.
3274 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3275 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3276 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3279 **vmware-esx-soap-host-mem-memctl**
3281 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.
3283 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3286 ------------------------|--------------
3287 vmware_host | **Required.** ESX or ESXi hostname.
3288 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3289 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3290 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3291 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3292 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3293 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3294 vmware_sessionfile | **Optional.** Session file name enhancement.
3295 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3296 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3297 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3298 vmware_password | **Optional.** The username's password. No value defined as default.
3299 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3300 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3301 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3302 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.
3305 **vmware-esx-soap-host-net**
3307 Check command object for the `check_vmware_esx` plugin. Shows net info.
3309 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3312 ------------------------|--------------
3313 vmware_host | **Required.** ESX or ESXi hostname.
3314 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3315 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3316 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3317 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3318 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3319 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3320 vmware_sessionfile | **Optional.** Session file name enhancement.
3321 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3322 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3323 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3324 vmware_password | **Optional.** The username's password. No value defined as default.
3325 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3326 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3327 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3330 **vmware-esx-soap-host-net-usage**
3332 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3334 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3337 ------------------------|--------------
3338 vmware_host | **Required.** ESX or ESXi hostname.
3339 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3340 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3341 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3342 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3343 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3344 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3345 vmware_sessionfile | **Optional.** Session file name enhancement.
3346 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3347 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3348 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3349 vmware_password | **Optional.** The username's password. No value defined as default.
3350 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3351 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3352 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3355 **vmware-esx-soap-host-net-receive**
3357 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
3359 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3362 ------------------------|--------------
3363 vmware_host | **Required.** ESX or ESXi hostname.
3364 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3365 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3366 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3367 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3368 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3369 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3370 vmware_sessionfile | **Optional.** Session file name enhancement.
3371 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3372 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3373 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3374 vmware_password | **Optional.** The username's password. No value defined as default.
3375 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3376 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3377 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3380 **vmware-esx-soap-host-net-send**
3382 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
3384 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3387 ------------------------|--------------
3388 vmware_host | **Required.** ESX or ESXi hostname.
3389 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3390 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3391 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3392 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3393 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3394 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3395 vmware_sessionfile | **Optional.** Session file name enhancement.
3396 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3397 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3398 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3399 vmware_password | **Optional.** The username's password. No value defined as default.
3400 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3401 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3402 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3405 **vmware-esx-soap-host-net-nic**
3407 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
3409 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3412 ------------------------|--------------
3413 vmware_host | **Required.** ESX or ESXi hostname.
3414 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3415 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3416 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3417 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3418 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3419 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3420 vmware_sessionfile | **Optional.** Session file name enhancement.
3421 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3422 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3423 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3424 vmware_password | **Optional.** The username's password. No value defined as default.
3425 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3426 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3427 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3430 **vmware-esx-soap-host-volumes**
3432 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
3434 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3437 ------------------------|--------------
3438 vmware_host | **Required.** ESX or ESXi hostname.
3439 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3440 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3441 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3442 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3443 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3444 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3445 vmware_sessionfile | **Optional.** Session file name enhancement.
3446 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3447 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3448 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3449 vmware_password | **Optional.** The username's password. No value defined as default.
3450 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3451 vmware_subselect | **Optional.** Volume name to be checked the free space.
3452 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3453 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3454 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3455 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3456 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3457 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3458 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3459 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3460 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
3463 **vmware-esx-soap-host-io**
3465 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.
3467 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3470 ------------------------|--------------
3471 vmware_host | **Required.** ESX or ESXi hostname.
3472 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3473 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3474 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3475 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3476 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3477 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3478 vmware_sessionfile | **Optional.** Session file name enhancement.
3479 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3480 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3481 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3482 vmware_password | **Optional.** The username's password. No value defined as default.
3483 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3486 **vmware-esx-soap-host-io-aborted**
3488 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
3490 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3493 ------------------------|--------------
3494 vmware_host | **Required.** ESX or ESXi hostname.
3495 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3496 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3497 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3498 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3499 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3500 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3501 vmware_sessionfile | **Optional.** Session file name enhancement.
3502 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3503 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3504 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3505 vmware_password | **Optional.** The username's password. No value defined as default.
3506 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3507 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3508 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3511 **vmware-esx-soap-host-io-resets**
3513 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
3515 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3518 ------------------------|--------------
3519 vmware_host | **Required.** ESX or ESXi hostname.
3520 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3521 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3522 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3523 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3524 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3525 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3526 vmware_sessionfile | **Optional.** Session file name enhancement.
3527 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3528 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3529 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3530 vmware_password | **Optional.** The username's password. No value defined as default.
3531 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3532 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3533 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3536 **vmware-esx-soap-host-io-read**
3538 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3540 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3543 ------------------------|--------------
3544 vmware_host | **Required.** ESX or ESXi hostname.
3545 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3546 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3547 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3548 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3549 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3550 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3551 vmware_sessionfile | **Optional.** Session file name enhancement.
3552 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3553 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3554 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3555 vmware_password | **Optional.** The username's password. No value defined as default.
3556 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3557 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3558 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3561 **vmware-esx-soap-host-io-read-latency**
3563 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.
3565 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3568 ------------------------|--------------
3569 vmware_host | **Required.** ESX or ESXi hostname.
3570 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3571 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3572 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3573 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3574 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3575 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3576 vmware_sessionfile | **Optional.** Session file name enhancement.
3577 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3578 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3579 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3580 vmware_password | **Optional.** The username's password. No value defined as default.
3581 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3582 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3583 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3586 **vmware-esx-soap-host-io-write**
3588 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3590 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3593 ------------------------|--------------
3594 vmware_host | **Required.** ESX or ESXi hostname.
3595 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3596 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3597 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3598 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3599 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3600 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3601 vmware_sessionfile | **Optional.** Session file name enhancement.
3602 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3603 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3604 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3605 vmware_password | **Optional.** The username's password. No value defined as default.
3606 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3607 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3608 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3611 **vmware-esx-soap-host-io-write-latency**
3613 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.
3615 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3618 ------------------------|--------------
3619 vmware_host | **Required.** ESX or ESXi hostname.
3620 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3621 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3622 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3623 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3624 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3625 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3626 vmware_sessionfile | **Optional.** Session file name enhancement.
3627 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3628 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3629 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3630 vmware_password | **Optional.** The username's password. No value defined as default.
3631 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3632 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3633 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3636 **vmware-esx-soap-host-io-usage**
3638 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.
3640 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3643 ------------------------|--------------
3644 vmware_host | **Required.** ESX or ESXi hostname.
3645 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3646 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3647 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3648 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3649 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3650 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3651 vmware_sessionfile | **Optional.** Session file name enhancement.
3652 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3653 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3654 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3655 vmware_password | **Optional.** The username's password. No value defined as default.
3656 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3657 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3658 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3661 **vmware-esx-soap-host-io-kernel-latency**
3663 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
3665 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3668 ------------------------|--------------
3669 vmware_host | **Required.** ESX or ESXi hostname.
3670 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3671 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3672 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3673 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3674 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3675 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3676 vmware_sessionfile | **Optional.** Session file name enhancement.
3677 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3678 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3679 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3680 vmware_password | **Optional.** The username's password. No value defined as default.
3681 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3682 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3683 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3686 **vmware-esx-soap-host-io-device-latency**
3688 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
3690 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3693 ------------------------|--------------
3694 vmware_host | **Required.** ESX or ESXi hostname.
3695 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3696 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3697 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3698 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3699 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3700 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3701 vmware_sessionfile | **Optional.** Session file name enhancement.
3702 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3703 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3704 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3705 vmware_password | **Optional.** The username's password. No value defined as default.
3706 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3707 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3708 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3711 **vmware-esx-soap-host-io-queue-latency**
3713 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
3715 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3718 ------------------------|--------------
3719 vmware_host | **Required.** ESX or ESXi hostname.
3720 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3721 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3722 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3723 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3724 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3725 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3726 vmware_sessionfile | **Optional.** Session file name enhancement.
3727 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3728 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3729 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3730 vmware_password | **Optional.** The username's password. No value defined as default.
3731 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3732 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3733 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3736 **vmware-esx-soap-host-io-total-latency**
3738 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.
3740 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3743 ------------------------|--------------
3744 vmware_host | **Required.** ESX or ESXi hostname.
3745 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3746 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3747 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3748 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3749 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3750 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3751 vmware_sessionfile | **Optional.** Session file name enhancement.
3752 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3753 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3754 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3755 vmware_password | **Optional.** The username's password. No value defined as default.
3756 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3757 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3758 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3761 **vmware-esx-soap-host-media**
3763 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.
3765 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3768 ------------------------|--------------
3769 vmware_host | **Required.** ESX or ESXi hostname.
3770 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3771 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3772 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3773 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3774 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3775 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3776 vmware_sessionfile | **Optional.** Session file name enhancement.
3777 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3778 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3779 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3780 vmware_password | **Optional.** The username's password. No value defined as default.
3781 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3782 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3783 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3784 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3785 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.
3788 **vmware-esx-soap-host-service**
3790 Check command object for the `check_vmware_esx` plugin. Shows host service info.
3792 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3795 ------------------------|--------------
3796 vmware_host | **Required.** ESX or ESXi hostname.
3797 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3798 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3799 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3800 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3801 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3802 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3803 vmware_sessionfile | **Optional.** Session file name enhancement.
3804 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3805 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3806 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3807 vmware_password | **Optional.** The username's password. No value defined as default.
3808 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3809 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
3810 vmware_include | **Optional.** Whitelist services name. No value defined as default.
3811 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3812 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.
3815 **vmware-esx-soap-host-runtime**
3817 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.
3819 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3822 ------------------------|--------------
3823 vmware_host | **Required.** ESX or ESXi hostname.
3824 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3825 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3826 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3827 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3828 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3829 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3830 vmware_sessionfile | **Optional.** Session file name enhancement.
3831 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3832 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3833 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3834 vmware_password | **Optional.** The username's password. No value defined as default.
3835 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3838 **vmware-esx-soap-host-runtime-con**
3840 Check command object for the `check_vmware_esx` plugin. Shows connection state.
3842 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3845 ------------------------|--------------
3846 vmware_host | **Required.** ESX or ESXi hostname.
3847 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3848 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3849 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3850 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3851 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3852 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3853 vmware_sessionfile | **Optional.** Session file name enhancement.
3854 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3855 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3856 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3857 vmware_password | **Optional.** The username's password. No value defined as default.
3858 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3861 **vmware-esx-soap-host-runtime-listvms**
3863 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
3865 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3868 ------------------------|--------------
3869 vmware_host | **Required.** ESX or ESXi hostname.
3870 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3871 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3872 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3873 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3874 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3875 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3876 vmware_sessionfile | **Optional.** Session file name enhancement.
3877 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3878 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3879 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3880 vmware_password | **Optional.** The username's password. No value defined as default.
3881 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3882 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3883 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3884 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3885 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.
3888 **vmware-esx-soap-host-runtime-status**
3890 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3892 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3895 ------------------------|--------------
3896 vmware_host | **Required.** ESX or ESXi hostname.
3897 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3898 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3899 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3900 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3901 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3902 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3903 vmware_sessionfile | **Optional.** Session file name enhancement.
3904 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3905 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3906 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3907 vmware_password | **Optional.** The username's password. No value defined as default.
3908 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3911 **vmware-esx-soap-host-runtime-health**
3913 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
3915 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3918 ------------------------|--------------
3919 vmware_host | **Required.** ESX or ESXi hostname.
3920 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3921 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3922 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3923 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3924 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3925 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3926 vmware_sessionfile | **Optional.** Session file name enhancement.
3927 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3928 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3929 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3930 vmware_password | **Optional.** The username's password. No value defined as default.
3931 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3932 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3933 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3934 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3937 **vmware-esx-soap-host-runtime-health-listsensors**
3939 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
3941 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3944 ------------------------|--------------
3945 vmware_host | **Required.** ESX or ESXi hostname.
3946 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3947 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3948 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3949 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3950 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3951 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3952 vmware_sessionfile | **Optional.** Session file name enhancement.
3953 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3954 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3955 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3956 vmware_password | **Optional.** The username's password. No value defined as default.
3957 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3958 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3959 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3960 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3963 **vmware-esx-soap-host-runtime-health-nostoragestatus**
3965 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**.
3967 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3970 ------------------------|--------------
3971 vmware_host | **Required.** ESX or ESXi hostname.
3972 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3973 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3974 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3975 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3976 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3977 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3978 vmware_sessionfile | **Optional.** Session file name enhancement.
3979 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3980 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3981 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3982 vmware_password | **Optional.** The username's password. No value defined as default.
3983 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3984 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3985 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3986 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3989 **vmware-esx-soap-host-runtime-storagehealth**
3991 Check command object for the `check_vmware_esx` plugin. Local storage status check.
3993 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3996 ------------------------|--------------
3997 vmware_host | **Required.** ESX or ESXi hostname.
3998 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3999 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4000 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4001 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4002 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4003 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4004 vmware_sessionfile | **Optional.** Session file name enhancement.
4005 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4006 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4007 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4008 vmware_password | **Optional.** The username's password. No value defined as default.
4009 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4010 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
4011 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
4012 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4013 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
4016 **vmware-esx-soap-host-runtime-temp**
4018 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
4020 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4023 ------------------------|--------------
4024 vmware_host | **Required.** ESX or ESXi hostname.
4025 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4026 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4027 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4028 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4029 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4030 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4031 vmware_sessionfile | **Optional.** Session file name enhancement.
4032 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4033 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4034 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4035 vmware_password | **Optional.** The username's password. No value defined as default.
4036 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4037 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
4038 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
4039 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4040 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.
4043 **vmware-esx-soap-host-runtime-issues**
4045 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
4047 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4050 ------------------------|--------------
4051 vmware_host | **Required.** ESX or ESXi hostname.
4052 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4053 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4054 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4055 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4056 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4057 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4058 vmware_sessionfile | **Optional.** Session file name enhancement.
4059 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4060 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4061 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4062 vmware_password | **Optional.** The username's password. No value defined as default.
4063 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4064 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
4065 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
4066 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4067 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.
4070 **vmware-esx-soap-host-storage**
4072 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
4074 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4077 ------------------------|--------------
4078 vmware_host | **Required.** ESX or ESXi hostname.
4079 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4080 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4081 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4082 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4083 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4084 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4085 vmware_sessionfile | **Optional.** Session file name enhancement.
4086 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4087 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4088 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4089 vmware_password | **Optional.** The username's password. No value defined as default.
4090 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4091 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
4092 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
4093 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4096 **vmware-esx-soap-host-storage-adapter**
4098 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
4100 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4103 ------------------------|--------------
4104 vmware_host | **Required.** ESX or ESXi hostname.
4105 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4106 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4107 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4108 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4109 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4110 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4111 vmware_sessionfile | **Optional.** Session file name enhancement.
4112 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4113 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4114 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4115 vmware_password | **Optional.** The username's password. No value defined as default.
4116 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4117 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
4118 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
4119 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4120 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.
4123 **vmware-esx-soap-host-storage-lun**
4125 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.
4127 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4130 ------------------------|--------------
4131 vmware_host | **Required.** ESX or ESXi hostname.
4132 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4133 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4134 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4135 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4136 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4137 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4138 vmware_sessionfile | **Optional.** Session file name enhancement.
4139 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4140 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4141 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4142 vmware_password | **Optional.** The username's password. No value defined as default.
4143 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4144 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
4145 vmware_include | **Optional.** Whitelist luns. No value defined as default.
4146 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4147 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.
4150 **vmware-esx-soap-host-storage-path**
4152 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
4154 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4157 ------------------------|--------------
4158 vmware_host | **Required.** ESX or ESXi hostname.
4159 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4160 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4161 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4162 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4163 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4164 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4165 vmware_sessionfile | **Optional.** Session file name enhancement.
4166 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4167 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4168 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4169 vmware_password | **Optional.** The username's password. No value defined as default.
4170 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4171 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4172 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4173 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4174 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4175 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.
4178 **vmware-esx-soap-vm-cpu**
4180 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4182 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4185 ------------------------|--------------
4186 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4187 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4188 vmware_vmname | **Required.** Virtual machine name.
4189 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4190 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4191 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4192 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4193 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4194 vmware_sessionfile | **Optional.** Session file name enhancement.
4195 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4196 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4197 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4198 vmware_password | **Optional.** The username's password. No value defined as default.
4199 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4203 **vmware-esx-soap-vm-cpu-ready**
4205 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.
4207 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4210 ------------------------|--------------
4211 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4212 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4213 vmware_vmname | **Required.** Virtual machine name.
4214 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4215 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4216 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4217 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4218 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4219 vmware_sessionfile | **Optional.** Session file name enhancement.
4220 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4221 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4222 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4223 vmware_password | **Optional.** The username's password. No value defined as default.
4224 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4225 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4226 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4229 **vmware-esx-soap-vm-cpu-wait**
4231 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.
4233 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4236 ------------------------|--------------
4237 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4238 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4239 vmware_vmname | **Required.** Virtual machine name.
4240 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4241 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4242 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4243 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4244 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4245 vmware_sessionfile | **Optional.** Session file name enhancement.
4246 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4247 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4248 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4249 vmware_password | **Optional.** The username's password. No value defined as default.
4250 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4251 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4252 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4255 **vmware-esx-soap-vm-cpu-usage**
4257 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.
4259 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4262 ------------------------|--------------
4263 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4264 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4265 vmware_vmname | **Required.** Virtual machine name.
4266 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4267 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4268 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4269 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4270 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4271 vmware_sessionfile | **Optional.** Session file name enhancement.
4272 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4273 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4274 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4275 vmware_password | **Optional.** The username's password. No value defined as default.
4276 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4277 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4278 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4281 **vmware-esx-soap-vm-mem**
4283 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4285 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4288 ------------------------|--------------
4289 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4290 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4291 vmware_vmname | **Required.** Virtual machine name.
4292 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4293 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4294 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4295 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4296 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4297 vmware_sessionfile | **Optional.** Session file name enhancement.
4298 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4299 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4300 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4301 vmware_password | **Optional.** The username's password. No value defined as default.
4302 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4305 **vmware-esx-soap-vm-mem-usage**
4307 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4309 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4312 ------------------------|--------------
4313 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4314 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4315 vmware_vmname | **Required.** Virtual machine name.
4316 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4317 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4318 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4319 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4320 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4321 vmware_sessionfile | **Optional.** Session file name enhancement.
4322 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4323 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4324 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4325 vmware_password | **Optional.** The username's password. No value defined as default.
4326 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4327 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4328 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4331 **vmware-esx-soap-vm-mem-consumed**
4333 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>
4334 **vm consumed memory = memory granted -- memory saved**
4336 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4339 ------------------------|--------------
4340 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4341 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4342 vmware_vmname | **Required.** Virtual machine name.
4343 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4344 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4345 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4346 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4347 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4348 vmware_sessionfile | **Optional.** Session file name enhancement.
4349 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4350 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4351 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4352 vmware_password | **Optional.** The username's password. No value defined as default.
4353 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4354 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4355 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4358 **vmware-esx-soap-vm-mem-memctl**
4360 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.
4362 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4365 ------------------------|--------------
4366 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4367 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4368 vmware_vmname | **Required.** Virtual machine name.
4369 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4370 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4371 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4372 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4373 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4374 vmware_sessionfile | **Optional.** Session file name enhancement.
4375 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4376 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4377 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4378 vmware_password | **Optional.** The username's password. No value defined as default.
4379 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4380 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4381 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4385 **vmware-esx-soap-vm-net**
4387 Check command object for the `check_vmware_esx` plugin. Shows net info.
4389 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4392 ------------------------|--------------
4393 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4394 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4395 vmware_vmname | **Required.** Virtual machine name.
4396 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4397 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4398 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4399 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4400 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4401 vmware_sessionfile | **Optional.** Session file name enhancement.
4402 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4403 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4404 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4405 vmware_password | **Optional.** The username's password. No value defined as default.
4406 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4409 **vmware-esx-soap-vm-net-usage**
4411 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4413 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4416 ------------------------|--------------
4417 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4418 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4419 vmware_vmname | **Required.** Virtual machine name.
4420 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4421 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4422 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4423 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4424 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4425 vmware_sessionfile | **Optional.** Session file name enhancement.
4426 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4427 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4428 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4429 vmware_password | **Optional.** The username's password. No value defined as default.
4430 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4431 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4432 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4435 **vmware-esx-soap-vm-net-receive**
4437 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
4439 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4442 ------------------------|--------------
4443 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4444 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4445 vmware_vmname | **Required.** Virtual machine name.
4446 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4447 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4448 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4449 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4450 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4451 vmware_sessionfile | **Optional.** Session file name enhancement.
4452 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4453 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4454 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4455 vmware_password | **Optional.** The username's password. No value defined as default.
4456 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4457 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4458 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4461 **vmware-esx-soap-vm-net-send**
4463 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
4465 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4468 ------------------------|--------------
4469 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4470 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4471 vmware_vmname | **Required.** Virtual machine name.
4472 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4473 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4474 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4475 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4476 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4477 vmware_sessionfile | **Optional.** Session file name enhancement.
4478 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4479 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4480 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4481 vmware_password | **Optional.** The username's password. No value defined as default.
4482 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4483 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4484 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4487 **vmware-esx-soap-vm-io**
4489 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.
4491 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4494 ------------------------|--------------
4495 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4496 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4497 vmware_vmname | **Required.** Virtual machine name.
4498 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4499 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4500 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4501 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4502 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4503 vmware_sessionfile | **Optional.** Session file name enhancement.
4504 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4505 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4506 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4507 vmware_password | **Optional.** The username's password. No value defined as default.
4508 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4511 **vmware-esx-soap-vm-io-read**
4513 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4515 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4518 ------------------------|--------------
4519 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4520 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4521 vmware_vmname | **Required.** Virtual machine name.
4522 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4523 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4524 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4525 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4526 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4527 vmware_sessionfile | **Optional.** Session file name enhancement.
4528 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4529 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4530 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4531 vmware_password | **Optional.** The username's password. No value defined as default.
4532 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4533 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4534 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4537 **vmware-esx-soap-vm-io-write**
4539 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4541 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4544 ------------------------|--------------
4545 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4546 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4547 vmware_vmname | **Required.** Virtual machine name.
4548 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4549 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4550 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4551 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4552 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4553 vmware_sessionfile | **Optional.** Session file name enhancement.
4554 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4555 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4556 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4557 vmware_password | **Optional.** The username's password. No value defined as default.
4558 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4559 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4560 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4563 **vmware-esx-soap-vm-io-usage**
4565 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
4567 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4570 ------------------------|--------------
4571 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4572 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4573 vmware_vmname | **Required.** Virtual machine name.
4574 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4575 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4576 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4577 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4578 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4579 vmware_sessionfile | **Optional.** Session file name enhancement.
4580 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4581 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4582 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4583 vmware_password | **Optional.** The username's password. No value defined as default.
4584 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4585 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4586 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4589 **vmware-esx-soap-vm-runtime**
4591 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
4593 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4596 ------------------------|--------------
4597 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4598 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4599 vmware_vmname | **Required.** Virtual machine name.
4600 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4601 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4602 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4603 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4604 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4605 vmware_sessionfile | **Optional.** Session file name enhancement.
4606 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4607 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4608 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4609 vmware_password | **Optional.** The username's password. No value defined as default.
4610 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4613 **vmware-esx-soap-vm-runtime-con**
4615 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
4617 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4620 ------------------------|--------------
4621 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4622 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4623 vmware_vmname | **Required.** Virtual machine name.
4624 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4625 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4626 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4627 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4628 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4629 vmware_sessionfile | **Optional.** Session file name enhancement.
4630 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4631 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4632 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4633 vmware_password | **Optional.** The username's password. No value defined as default.
4634 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4637 **vmware-esx-soap-vm-runtime-powerstate**
4639 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
4641 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4644 ------------------------|--------------
4645 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4646 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4647 vmware_vmname | **Required.** Virtual machine name.
4648 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4649 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4650 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4651 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4652 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4653 vmware_sessionfile | **Optional.** Session file name enhancement.
4654 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4655 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4656 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4657 vmware_password | **Optional.** The username's password. No value defined as default.
4658 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4661 **vmware-esx-soap-vm-runtime-status**
4663 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4665 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4668 ------------------------|--------------
4669 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4670 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4671 vmware_vmname | **Required.** Virtual machine name.
4672 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4673 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4674 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4675 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4676 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4677 vmware_sessionfile | **Optional.** Session file name enhancement.
4678 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4679 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4680 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4681 vmware_password | **Optional.** The username's password. No value defined as default.
4682 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4685 **vmware-esx-soap-vm-runtime-consoleconnections**
4687 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
4689 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4692 ------------------------|--------------
4693 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4694 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4695 vmware_vmname | **Required.** Virtual machine name.
4696 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4697 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4698 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4699 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4700 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4701 vmware_sessionfile | **Optional.** Session file name enhancement.
4702 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4703 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4704 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4705 vmware_password | **Optional.** The username's password. No value defined as default.
4706 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4707 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4708 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4711 **vmware-esx-soap-vm-runtime-gueststate**
4713 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
4715 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4718 ------------------------|--------------
4719 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4720 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4721 vmware_vmname | **Required.** Virtual machine name.
4722 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4723 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4724 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4725 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4726 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4727 vmware_sessionfile | **Optional.** Session file name enhancement.
4728 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4729 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4730 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4731 vmware_password | **Optional.** The username's password. No value defined as default.
4732 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4734 **vmware-esx-soap-vm-runtime-tools**
4736 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
4738 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4741 ------------------------|--------------
4742 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4743 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4744 vmware_vmname | **Required.** Virtual machine name.
4745 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4746 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4747 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4748 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4749 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4750 vmware_sessionfile | **Optional.** Session file name enhancement.
4751 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4752 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4753 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4754 vmware_password | **Optional.** The username's password. No value defined as default.
4755 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4756 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
4759 **vmware-esx-soap-vm-runtime-issues**
4761 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
4763 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4766 ------------------------|--------------
4767 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4768 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4769 vmware_vmname | **Required.** Virtual machine name.
4770 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4771 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4772 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4773 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4774 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4775 vmware_sessionfile | **Optional.** Session file name enhancement.
4776 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4777 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4778 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4779 vmware_password | **Optional.** The username's password. No value defined as default.
4780 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4781 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.
4784 ### <a id="plugin-contrib-web"></a> Web
4786 This category includes all plugins for web-based checks.
4788 #### <a id="plugin-contrib-command-webinject"></a> webinject
4790 The [check_webinject](https://labs.consol.de/de/nagios/check_webinject/index.html) plugin
4791 uses [WebInject](https://www.webinject.org/manual.html) to test web applications
4792 and web services in an automated fashion.
4793 It can be used to test individual system components that have HTTP interfaces
4794 (JSP, ASP, CGI, PHP, AJAX, Servlets, HTML Forms, XML/SOAP Web Services, REST, etc),
4795 and can be used as a test harness to create a suite of HTTP level automated functional,
4796 acceptance, and regression tests. A test harness allows you to run many test cases
4797 and collect/report your results. WebInject offers real-time results
4798 display and may also be used for monitoring system response times.
4800 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4803 ------------------------|--------------
4804 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.
4805 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.
4806 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
4807 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.
4808 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.
4809 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.
4811 #### <a id="plugin-contrib-command-jmx4perl"></a> jmx4perl
4813 The [check_jmx4perl](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl) plugin
4814 uses the HTTP API exposed by the [Jolokia](https://jolokia.org)
4815 web application and queries Java message beans on an application server. It is
4816 part of the `JMX::Jmx4Perl` Perl module which includes detailed
4817 [documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl).
4819 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4822 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
4823 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
4824 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
4825 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.
4826 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
4827 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
4828 jmx4perl_operation | **Optional.** Operation to execute.
4829 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
4830 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
4831 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
4832 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
4833 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
4834 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
4835 jmx4perl_proxy | **Optional.** Proxy to use.
4836 jmx4perl_user | **Optional.** User for HTTP authentication.
4837 jmx4perl_password | **Optional.** Password for HTTP authentication.
4838 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
4839 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
4840 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.
4841 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
4842 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
4843 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
4844 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.
4845 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
4846 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
4847 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
4848 jmx4perl_critical | **Optional.** Critical threshold for value.
4849 jmx4perl_warning | **Optional.** Warning threshold for value.
4850 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
4851 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
4852 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
4853 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
4854 jmx4perl_config | **Optional.** Path to configuration file.
4855 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
4856 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
4858 #### <a id="plugin-contrib-command-squid"></a> squid
4860 The [check_squid](https://exchange.icinga.com/exchange/check_squid) plugin
4861 uses the `squidclient` binary to monitor a [Squid proxy](http://www.squid-cache.org).
4863 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4866 ------------------------|----------------------------------------------------------------------------------
4867 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
4868 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
4869 squid_port | **Optional.** Port number (default: 3128).
4870 squid_user | **Optional.** WWW user
4871 squid_password | **Optional.** WWW password
4872 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4873 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4874 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
4875 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
4878 #### <a id="plugin-contrib-command-nginx_status"></a> nginx_status
4880 The [check_nginx_status.pl](https://github.com/regilero/check_nginx_status) plugin
4881 uses the [/nginx_status](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
4882 HTTP endpoint which provides metrics for monitoring Nginx.
4884 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4887 --------------------------------|----------------------------------------------------------------------------------
4888 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4889 nginx_status_port | **Optional.** the http port.
4890 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
4891 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
4892 nginx_status_ssl | **Optional.** set to use ssl connection
4893 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
4894 nginx_status_user | **Optional.** Username for basic auth
4895 nginx_status_pass | **Optional.** Password for basic auth
4896 nginx_status_realm | **Optional.** Realm for basic auth
4897 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
4898 nginx_status_timeout | **Optional.** timeout in seconds
4899 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
4900 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
4903 #### <a id="plugin-contrib-command-apache_status"></a> apache_status
4905 The [check_apache_status.pl](https://github.com/lbetz/check_apache_status) plugin
4906 uses the [/server-status](https://httpd.apache.org/docs/current/mod/mod_status.html)
4907 HTTP endpoint to monitor status metrics for the Apache webserver.
4909 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4912 ------------------------|----------------------------------------------------------------------------------
4913 apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4914 apache_status_port | **Optional.** the http port.
4915 apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
4916 apache_status_ssl | **Optional.** set to use ssl connection
4917 apache_status_timeout | **Optional.** timeout in seconds
4918 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
4919 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
4922 #### <a id="plugin-contrib-command-kdc"></a> kdc
4924 The [check_kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details) plugin
4925 uses the Kerberos `kinit` binary to monitor Kerberos 5 KDC by acquiring a ticket.
4927 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4930 ----------------|--------------------------------------------------------------------------
4931 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4932 kdc_port | **Optional** Port on which KDC runs (default 88).
4933 kdc_principal | **Required** Principal name to authenticate as (including realm).
4934 kdc_keytab | **Required** Keytab file containing principal's key.
4937 #### <a id="plugin-contrib-command-rbl"></a> rbl
4939 The [check_rbl](https://github.com/matteocorti/check_rbl) plugin
4940 uses the `Net::DNS` Perl library to check whether your SMTP server
4943 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4946 ----------------|--------------------------------------------------------------------------
4947 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.
4948 rbl_server | **Required** List of RBL servers as an array.
4949 rbl_warning | **Optional** Number of blacklisting servers for a warning.
4950 rbl_critical | **Optional** Number of blacklisting servers for a critical.
4951 tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
projects / icinga2 / blob