1 # <a id="icinga-template-library"></a> Icinga Template Library
3 The Icinga Template Library (ITL) implements standard templates and object
4 definitions for commonly used services.
6 By default the ITL is included in the `icinga2.conf` configuration file:
10 ## <a id="itl-generic-templates"></a> Generic Templates
12 These templates are imported by the provided example configuration.
16 > These templates are built into the binaries. By convention
17 > all command and timeperiod objects should import these templates.
19 ### <a id="itl-plugin-check-command"></a> plugin-check-command
21 Command template for check plugins executed by Icinga 2.
23 The `plugin-check-command` command does not support any vars.
25 By default this template is automatically imported into all CheckCommand definitions.
27 ### <a id="itl-plugin-notification-command"></a> plugin-notification-command
29 Command template for notification scripts executed by Icinga 2.
31 The `plugin-notification-command` command does not support any vars.
33 By default this template is automatically imported into all CheckCommand definitions.
35 ### <a id="itl-plugin-event-command"></a> plugin-event-command
37 Command template for event handler scripts executed by Icinga 2.
39 The `plugin-event-command` command does not support any vars.
41 By default this template is automatically imported into all CheckCommand definitions.
43 ### <a id="itl-legacy-timeperiod"></a> legacy-timeperiod
45 Timeperiod template for [Timeperiod objects](9-object-types.md#objecttype-timeperiod).
47 The `legacy-timeperiod` timeperiod does not support any vars.
49 By default this template is automatically imported into all CheckCommand definitions.
51 ## <a id="itl-check-commands"></a> Check Commands
53 These check commands are embedded into Icinga 2 and do not require any external
56 ### <a id="itl-icinga"></a> icinga
58 Check command for the built-in `icinga` check. This check returns performance
59 data for the current Icinga instance.
61 The `icinga` check command does not support any vars.
63 ### <a id="itl-icinga-cluster"></a> cluster
65 Check command for the built-in `cluster` check. This check returns performance
66 data for the current Icinga instance and connected endpoints.
68 The `cluster` check command does not support any vars.
70 ### <a id="itl-icinga-cluster-zone"></a> cluster-zone
72 Check command for the built-in `cluster-zone` check.
74 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
77 ---------------------|---------------
78 cluster_zone | **Required.** The zone name.
79 cluster_lag_warning | **Optional.** Warning threshold for log lag in seconds. Applies if the log lag is greater than the threshold.
80 cluster_lag_critical | **Optional.** Critical threshold for log lag in seconds. Applies if the log lag is greater than the threshold.
82 ### <a id="itl-icinga-ido"></a> ido
84 Check command for the built-in `ido` check.
86 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
89 -------------|---------------
90 ido_type | **Required.** The type of the IDO connection object. Can be either "IdoMysqlConnection" or "IdoPgsqlConnection".
91 ido_name | **Required.** The name of the IDO connection object.
93 ### <a id="itl-random"></a> random
95 Check command for the built-in `random` check. This check returns random states
96 and adds the check source to the check output.
98 For test and demo purposes only. The `random` check command does not support
101 ### <a id="itl-exception"></a> exception
103 Check command for the built-in `exception` check. This check throws an exception.
105 For test and demo purposes only. The `exception` check command does not support
108 # <a id="plugin-check-commands"></a> Plugin Check Commands
110 ## <a id="plugin-check-commands-monitoring-plugins"></a> Plugin Check Commands for Monitoring Plugins
112 The Plugin Check Commands provides example configuration for plugin check commands
113 provided by the [Monitoring Plugins](https://www.monitoring-plugins.org) project.
115 By default the Plugin Check Commands are included in the `icinga2.conf` configuration
120 The plugin check commands assume that there's a global constant named `PluginDir`
121 which contains the path of the plugins from the Monitoring Plugins project.
123 **Note**: If there are command parameters missing for the provided CheckCommand
124 definitions please kindly send a patch upstream. This should include an update
125 for the ITL CheckCommand itself and this documentation section.
127 ### <a id="plugin-check-command-apt"></a> apt
129 The plugin [apt](https://www.monitoring-plugins.org/doc/index.html) checks for software updates on systems that use
130 package management systems based on the apt-get(8) command found in Debian based systems.
132 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
135 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
136 apt_extra_opts | **Optional.** Read options from an ini file.
137 apt_upgrade | **Optional.** [Default] Perform an upgrade. If an optional OPTS argument is provided, apt-get will be run with these command line options instead of the default.
138 apt_dist_upgrade | **Optional.** Perform a dist-upgrade instead of normal upgrade. Like with -U OPTS can be provided to override the default options.
139 apt_include | **Optional.** Include only packages matching REGEXP. Can be specified multiple times the values will be combined together.
140 apt_exclude | **Optional.** Exclude packages matching REGEXP from the list of packages that would otherwise be included. Can be specified multiple times.
141 apt_critical | **Optional.** If the full package information of any of the upgradable packages match this REGEXP, the plugin will return CRITICAL status. Can be specified multiple times.
142 apt_timeout | **Optional.** Seconds before plugin times out (default: 10).
143 apt_only_critical | **Optional.** Only warn about critical upgrades.
146 ### <a id="plugin-check-command-breeze"></a> breeze
148 The [check_breeze](https://www.monitoring-plugins.org/doc/man/check_breeze.html) plugin reports the signal
149 strength of a Breezecom wireless equipment.
151 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
154 -----------------|---------------------------------
155 breeze_hostname | **Required.** Name or IP address of host to check. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
156 breeze_community | **Optional.** SNMPv1 community. Defaults to "public".
157 breeze_warning | **Required.** Percentage strength below which a WARNING status will result. Defaults to 50.
158 breeze_critical | **Required.** Percentage strength below which a WARNING status will result. Defaults to 20.
161 ### <a id="plugin-check-command-by-ssh"></a> by_ssh
163 The [check_by_ssh](https://www.monitoring-plugins.org/doc/man/check_by_ssh.html) plugin uses SSH to execute
164 commands on a remote host.
166 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
169 ----------------|--------------
170 by_ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
171 by_ssh_port | **Optional.** The SSH port. Defaults to 22.
172 by_ssh_command | **Required.** The command that should be executed. Can be an array if multiple arguments should be passed to `check_by_ssh`.
173 by_ssh_arguments| **Optional.** A dictionary with arguments for the command. This works exactly like the 'arguments' dictionary for ordinary CheckCommands.
174 by_ssh_logname | **Optional.** The SSH username.
175 by_ssh_identity | **Optional.** The SSH identity.
176 by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false.
177 by_ssh_warn | **Optional.** The warning threshold.
178 by_ssh_crit | **Optional.** The critical threshold.
179 by_ssh_timeout | **Optional.** The timeout in seconds.
180 by_ssh_options | **Optional.** Call ssh with '-o OPTION' (multiple options may be specified as an array).
181 by_ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
182 by_ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
185 ### <a id="plugin-check-command-clamd"></a> clamd
187 The [check_clamd](https://www.monitoring-plugins.org/doc/man/check_clamd.html) plugin tests CLAMD
188 connections with the specified host (or unix socket).
190 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
193 -------------------|--------------
194 clamd_address | **Required.** The host's address or unix socket (must be an absolute path).
195 clamd_port | **Optional.** Port number (default: none).
196 clamd_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
197 clamd_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
198 clamd_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
199 clamd_send | **Optional.** String to send to the server.
200 clamd_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
201 clamd_quit | **Optional.** String to send server to initiate a clean close of the connection.
202 clamd_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
203 clamd_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
204 clamd_jail | **Optional.** Hide output from TCP socket.
205 clamd_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
206 clamd_delay | **Optional.** Seconds to wait between sending string and polling for response.
207 clamd_certificate | **Optional.** Minimum number of days a certificate has to be valid. 1st value is number of days for warning, 2nd is critical (if not specified: 0) -- separated by comma.
208 clamd_ssl | **Optional.** Use SSL for the connection. Defaults to false.
209 clamd_wtime | **Optional.** Response time to result in warning status (seconds).
210 clamd_ctime | **Optional.** Response time to result in critical status (seconds).
211 clamd_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
212 clamd_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
213 clamd_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
216 ### <a id="plugin-check-command-dhcp"></a> dhcp
218 The [check_dhcp](https://www.monitoring-plugins.org/doc/man/check_dhcp.html) plugin
219 tests the availability of DHCP servers on a network.
221 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
224 ----------------|--------------
225 dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from.
226 dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server.
227 dhcp_timeout | **Optional.** The timeout in seconds.
228 dhcp_interface | **Optional.** The interface to use.
229 dhcp_mac | **Optional.** The MAC address to use in the DHCP request.
230 dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false.
233 ### <a id="plugin-check-command-dig"></a> dig
235 The [check_dig](https://www.monitoring-plugins.org/doc/man/check_dig.html) plugin
236 test the DNS service on the specified host using dig.
238 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
241 ---------------------|--------------
242 dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1".
243 dig_port | **Optional.** Port number (default: 53).
244 dig_lookup | **Required.** The address that should be looked up.
245 dig_record_type | **Optional.** Record type to lookup (default: A).
246 dig_expected_address | **Optional.** An address expected to be in the answer section. If not set, uses whatever was in -l.
247 dig_arguments | **Optional.** Pass STRING as argument(s) to dig.
248 dig_retries | **Optional.** Number of retries passed to dig, timeout is divided by this value (Default: 3).
249 dig_warning | **Optional.** Response time to result in warning status (seconds).
250 dig_critical | **Optional.** Response time to result in critical status (seconds).
251 dig_timeout | **Optional.** Seconds before connection times out (default: 10).
252 dig_ipv4 | **Optional.** Force dig to only use IPv4 query transport. Defaults to false.
253 dig_ipv6 | **Optional.** Force dig to only use IPv6 query transport. Defaults to false.
256 ### <a id="plugin-check-command-disk"></a> disk
258 The [check_disk](https://www.monitoring-plugins.org/doc/man/check_disk.html) plugin
259 checks the amount of used disk space on a mounted file system and generates an alert
260 if free space is less than one of the threshold values.
262 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
265 --------------------|------------------------
266 disk\_wfree | **Optional.** The free space warning threshold. Defaults to "20%". If the percent sign is omitted, units from `disk_units` are used.
267 disk\_cfree | **Optional.** The free space critical threshold. Defaults to "10%". If the percent sign is omitted, units from `disk_units` are used.
268 disk\_inode\_wfree | **Optional.** The free inode warning threshold.
269 disk\_inode\_cfree | **Optional.** The free inode critical threshold.
270 disk\_partition | **Optional.** The partition. **Deprecated in 2.3.**
271 disk\_partition\_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.**
272 disk\_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array.
273 disk\_partitions\_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array.
274 disk\_clear | **Optional.** Clear thresholds. May be true or false.
275 disk\_exact\_match | **Optional.** For paths or partitions specified with -p, only check for exact paths. May be true or false.
276 disk\_errors\_only | **Optional.** Display only devices/mountpoints with errors. May be true or false.
277 disk\_ignore\_reserved | **Optional.** If set, account root-reserved blocks are not accounted for freespace in perfdata. May be true or false.
278 disk\_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together.
279 disk\_kilobytes | **Optional.** Same as --units kB. May be true or false.
280 disk\_local | **Optional.** Only check local filesystems. May be true or false.
281 disk\_stat\_remote\_fs | **Optional.** Only check local filesystems against thresholds. Yet call stat on remote filesystems to test if they are accessible (e.g. to detect Stale NFS Handles). May be true or false.
282 disk\_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false.
283 disk\_megabytes | **Optional.** Same as --units MB. May be true or false.
284 disk\_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.\*'. May be true or false.
285 disk\_eregi\_path | **Optional.** Case insensitive regular expression for path/partition. Multiple regular expression strings must be defined as array.
286 disk\_ereg\_path | **Optional.** Regular expression for path or partition. Multiple regular expression strings must be defined as array.
287 disk\_ignore\_eregi\_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive). Multiple regular expression strings must be defined as array.
288 disk\_ignore\_ereg\_path | **Optional.** Regular expression to ignore selected path or partition. Multiple regular expression strings must be defined as array.
289 disk\_timeout | **Optional.** Seconds before connection times out (default: 10).
290 disk\_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB).
291 disk\_exclude\_type | **Optional.** Ignore all filesystems of indicated type. Multiple regular expression strings must be defined as array. Defaults to "none", "tmpfs", "sysfs", "proc", "devtmpfs", "devfs", "mtmfs", "tracefs", "cgroup", "fuse.gvfsd-fuse", "fuse.gvfs-fuse-daemon", "fdescfs".
293 ### <a id="plugin-check-command-disk-smb"></a> disk_smb
295 The [check_disk_smb](https://www.monitoring-plugins.org/doc/man/check_disk_smb.html) plugin
296 uses the `smbclient` binary to check SMB shares.
298 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
301 ------------------------|------------------------
302 disk_smb_hostname | **Required.** NetBIOS name of the server.
303 disk_smb_share | **Required.** Share name being queried.
304 disk_smb_workgroup | **Optional.** Workgroup or Domain used (defaults to 'WORKGROUP' if omitted).
305 disk_smb_address | **Optional.** IP address of the host (only necessary if host belongs to another network).
306 disk_smb_username | **Optional.** Username for server log-in (defaults to 'guest' if omitted).
307 disk_smb_password | **Optional.** Password for server log-in (defaults to an empty password if omitted).
308 disk_smb_wused | **Optional.** The used space warning threshold. Defaults to "85%". If the percent sign is omitted, use optional disk units.
309 disk_smb_cused | **Optional.** The used space critical threshold. Defaults to "95%". If the percent sign is omitted, use optional disk units.
310 disk_smb_port | **Optional.** Connection port, e.g. `139` or `445`. Defaults to `smbclient` default if omitted.
312 ### <a id="plugin-check-command-dns"></a> dns
314 The [check_dns](https://www.monitoring-plugins.org/doc/man/check_dns.html) plugin
315 uses the nslookup program to obtain the IP address for the given host/domain query.
316 An optional DNS server to use may be specified. If no DNS server is specified, the
317 default server(s) specified in `/etc/resolv.conf` will be used.
319 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
322 ---------------------|--------------
323 dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$".
324 dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
325 dns_query_type | **Optional.** The DNS record query type where TYPE =(A, AAAA, SRV, TXT, MX, ANY). The default query type is 'A' (IPv4 host entry)
326 dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
327 dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
328 dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
329 dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
330 dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
333 ### <a id="plugin-check-command-dummy"></a> dummy
335 The [check_dummy](https://www.monitoring-plugins.org/doc/man/check_dummy.html) plugin
336 will simply return the state corresponding to the numeric value of the `dummy_state`
337 argument with optional text.
339 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
342 ----------------|--------------
343 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
344 dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
347 ### <a id="plugin-check-command-file-age"></a> file_age
349 The [check_file_age](https://www.monitoring-plugins.org/doc/man/check_file_age.html) plugin
350 checks a file's size and modification time to make sure it's not empty and that it's sufficiently recent.
352 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
355 -----------------------|--------------------------------------------------------------------------------------------------------
356 file_age_file | **Required.** File to monitor.
357 file_age_warning_time | **Optional.** File must be no more than this many seconds old as warning threshold. Defaults to "240s".
358 file_age_critical_time | **Optional.** File must be no more than this many seconds old as critical threshold. Defaults to "600s".
359 file_age_warning_size | **Optional.** File must be at least this many bytes long as warning threshold. No default given.
360 file_age_critical_size | **Optional.** File must be at least this many bytes long as critical threshold. Defaults to "0B".
361 file_age_ignoremissing | **Optional.** Return OK if the file does not exist. Defaults to false.
364 ### <a id="plugin-check-command-flexlm"></a> flexlm
366 The [check_flexlm](https://www.monitoring-plugins.org/doc/man/check_flexlm.html) plugin
367 checks available flexlm license managers. Requires the `lmstat` command.
369 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
372 -------------------|----------------------------------------------------------
373 flexlm_licensefile | **Required.** Name of license file (usually license.dat).
374 flexlm_timeout | **Optional.** Plugin time out in seconds. Defaults to 15.
377 ### <a id="plugin-check-command-fping4"></a> fping4
379 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
380 uses the `fping` command to ping the specified host for a fast check. Note that it is
381 necessary to set the suid flag on fping.
383 This CheckCommand expects an IPv4 address.
385 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
388 ----------------|--------------
389 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
390 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
391 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
392 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
393 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
394 fping_number | **Optional.** The number of packets to send. Defaults to 5.
395 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
396 fping_bytes | **Optional.** The size of ICMP packet.
397 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
398 fping_source_ip | **Optional.** The name or ip address of the source ip.
399 fping_source_interface | **Optional.** The source interface name.
402 ### <a id="plugin-check-command-fping6"></a> fping6
404 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
405 will use the `fping` command to ping the specified host for a fast check. Note that it is
406 necessary to set the suid flag on fping.
408 This CheckCommand expects an IPv6 address.
410 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
413 ----------------|--------------
414 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
415 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
416 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
417 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
418 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
419 fping_number | **Optional.** The number of packets to send. Defaults to 5.
420 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
421 fping_bytes | **Optional.** The size of ICMP packet.
422 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
423 fping_source_ip | **Optional.** The name or ip address of the source ip.
424 fping_source_interface | **Optional.** The source interface name.
427 ### <a id="plugin-check-command-ftp"></a> ftp
429 The [check_ftp](https://www.monitoring-plugins.org/doc/man/check_ftp.html) plugin
430 tests FTP connections with the specified host (or unix socket).
432 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
435 -------------------|--------------
436 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
437 ftp_port | **Optional.** The FTP port number.
438 ftp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
439 ftp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
440 ftp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
441 ftp_send | **Optional.** String to send to the server.
442 ftp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
443 ftp_quit | **Optional.** String to send server to initiate a clean close of the connection.
444 ftp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
445 ftp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
446 ftp_jail | **Optional.** Hide output from TCP socket.
447 ftp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
448 ftp_delay | **Optional.** Seconds to wait between sending string and polling for response.
449 ftp_certificate | **Optional.** Minimum number of days a certificate has to be valid. 1st value is number of days for warning, 2nd is critical (if not specified: 0) -- separated by comma.
450 ftp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
451 ftp_wtime | **Optional.** Response time to result in warning status (seconds).
452 ftp_ctime | **Optional.** Response time to result in critical status (seconds).
453 ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
454 ftp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
455 ftp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
458 ### <a id="plugin-check-command-game"></a> game
460 The [check_game](https://www.monitoring-plugins.org/doc/man/check_game.html) plugin
461 tests game server connections with the specified host.
462 This plugin uses the 'qstat' command, the popular game server status query tool.
463 If you don't have the package installed, you will need to [download](http://www.activesw.com/people/steve/qstat.html)
464 or install the package `quakestat` before you can use this plugin.
466 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
469 -------------------|-------------------
470 game_game | **Required.** Name of the game.
471 game_ipaddress | **Required.** Ipaddress of the game server to query.
472 game_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
473 game_port | **Optional.** Port to connect to.
474 game_gamefield | **Optional.** Field number in raw qstat output that contains game name.
475 game_mapfield | **Optional.** Field number in raw qstat output that contains map name.
476 game_pingfield | **Optional.** Field number in raw qstat output that contains ping time.
477 game_gametime | **Optional.** Field number in raw qstat output that contains game time.
478 game_hostname | **Optional.** Name of the host running the game.
481 ### <a id="plugin-check-command-hostalive"></a> hostalive
483 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
484 plugin with host check default values. This variant uses the host's `address` attribute
485 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
487 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
490 ----------------|--------------
491 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
492 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
493 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
494 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
495 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
496 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
497 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
500 ### <a id="plugin-check-command-hostalive4"></a> hostalive4
502 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
503 plugin with host check default values. This variant uses the host's `address` attribute.
505 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
508 ----------------|--------------
509 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
510 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
511 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
512 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
513 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
514 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
515 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
518 ### <a id="plugin-check-command-hostalive6"></a> hostalive6
520 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
521 plugin with host check default values. This variant uses the host's `address6` attribute.
523 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
526 ----------------|--------------
527 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
528 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
529 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
530 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
531 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
532 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
533 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
536 ### <a id="plugin-check-command-hpjd"></a> hpjd
538 The [check_hpjd](https://www.monitoring-plugins.org/doc/man/check_hpjd.html) plugin
539 tests the state of an HP printer with a JetDirect card. Net-snmp must be installed
540 on the computer running the plugin.
542 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
545 ----------------|--------------
546 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
547 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
548 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
551 ### <a id="plugin-check-command-http"></a> http
553 The [check_http](https://www.monitoring-plugins.org/doc/man/check_http.html) plugin
554 tests the HTTP service on the specified host. It can test normal (http) and secure
555 (https) servers, follow redirects, search for strings and regular expressions,
556 check connection times, and report on certificate expiration times.
558 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
561 ---------------------------------|---------------------------------
562 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
563 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
564 http_uri | **Optional.** The request URI for GET or POST. Defaults to `/`.
565 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
566 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
567 http_ssl_force_tlsv1 | **Optional.** Whether to force TLSv1.
568 http_ssl_force_tlsv1_1 | **Optional.** Whether to force TLSv1.1.
569 http_ssl_force_tlsv1_2 | **Optional.** Whether to force TLSv1.2.
570 http_ssl_force_sslv2 | **Optional.** Whether to force SSLv2.
571 http_ssl_force_sslv3 | **Optional.** Whether to force SSLv3.
572 http_ssl_force_tlsv1_or_higher | **Optional.** Whether to force TLSv1 or higher.
573 http_ssl_force_tlsv1_1_or_higher | **Optional.** Whether to force TLSv1.1 or higher.
574 http_ssl_force_tlsv1_2_or_higher | **Optional.** Whether to force TLSv1.2 or higher.
575 http_ssl_force_sslv2_or_higher | **Optional.** Whether to force SSLv2 or higher.
576 http_ssl_force_sslv3_or_higher | **Optional.** Whether to force SSLv3 or higher.
577 http_sni | **Optional.** Whether to use SNI. Defaults to false.
578 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
579 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
580 http_ignore_body | **Optional.** Don't download the body, just the headers.
581 http_linespan | **Optional.** Allow regex to span newline.
582 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
583 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
584 http_invertregex | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
585 http_warn_time | **Optional.** The warning threshold.
586 http_critical_time | **Optional.** The critical threshold.
587 http_expect | **Optional.** Comma-delimited list of strings, at least one of them is expected in the first (status) line of the server response. Default: HTTP/1.
588 http_certificate | **Optional.** Minimum number of days a certificate has to be valid. This parameter explicitely sets the port to 443 and ignores the URL if passed.
589 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
590 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
591 http_headerstring | **Optional.** String to expect in the response headers.
592 http_string | **Optional.** String to expect in the content.
593 http_post | **Optional.** URL encoded http POST data.
594 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
595 http_maxage | **Optional.** Warn if document is more than seconds old.
596 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
597 http_useragent | **Optional.** String to be sent in http header as User Agent.
598 http_header | **Optional.** Any other tags to be sent in http header.
599 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
600 http_onredirect | **Optional.** How to handle redirect pages. Possible values: "ok" (default), "warning", "critical", "follow", "sticky" (like follow but stick to address), "stickyport" (like sticky but also to port)
601 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
602 http_timeout | **Optional.** Seconds before connection times out.
603 http_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
604 http_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
605 http_link | **Optional.** Wrap output in HTML link. Defaults to false.
606 http_verbose | **Optional.** Show details for command-line debugging. Defaults to false.
609 ### <a id="plugin-check-command-icmp"></a> icmp
611 The [check_icmp](https://www.monitoring-plugins.org/doc/man/check_icmp.html) plugin
612 check_icmp allows for checking multiple hosts at once compared to `check_ping`.
613 The main difference is that check_ping executes the system's ping(1) command and
614 parses its output while check_icmp talks ICMP itself. check_icmp must be installed
617 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
620 ----------------|--------------
621 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
622 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
623 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
624 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
625 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
626 icmp_source | **Optional.** The source IP address to send packets from.
627 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
628 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
629 icmp_target_interval | **Optional.** The maximum target interval.
630 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
631 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
632 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
633 icmp_ttl | **Optional.** The TTL on outgoing packets.
636 ### <a id="plugin-check-command-imap"></a> imap
638 The [check_imap](https://www.monitoring-plugins.org/doc/man/check_imap.html) plugin
639 tests IMAP connections with the specified host (or unix socket).
641 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
644 ----------------------|--------------
645 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
646 imap_port | **Optional.** The port that should be checked. Defaults to 143.
647 imap_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
648 imap_send | **Optional.** String to send to the server.
649 imap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
650 imap_all | **Optional.** All expect strings need to occur in server response. Default is any.
651 imap_quit | **Optional.** String to send server to initiate a clean close of the connection.
652 imap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
653 imap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
654 imap_jail | **Optional.** Hide output from TCP socket.
655 imap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
656 imap_delay | **Optional.** Seconds to wait between sending string and polling for response.
657 imap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
658 imap_ssl | **Optional.** Use SSL for the connection.
659 imap_warning | **Optional.** Response time to result in warning status (seconds).
660 imap_critical | **Optional.** Response time to result in critical status (seconds).
661 imap_timeout | **Optional.** Seconds before connection times out (default: 10).
662 imap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
663 imap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
666 ### <a id="plugin-check-command-ldap"></a> ldap
668 The [check_ldap](https://www.monitoring-plugins.org/doc/man/check_ldap.html) plugin
669 can be used to check LDAP servers.
671 The plugin can also be used for monitoring ldaps connections instead of the deprecated `check_ldaps`.
672 This can be ensured by enabling `ldap_starttls` or `ldap_ssl`.
674 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
677 ----------------|--------------
678 ldap_address | **Optional.** Host name, IP Address, or unix socket (must be an absolute path). Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
679 ldap_port | **Optional.** Port number. Defaults to 389.
680 ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)"
681 ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
682 ldap_bind | **Optional.** LDAP bind DN (if required).
683 ldap_pass | **Optional.** LDAP password (if required).
684 ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3.
685 ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
686 ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default).
687 ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default)
688 ldap_warning | **Optional.** Response time to result in warning status (seconds).
689 ldap_critical | **Optional.** Response time to result in critical status (seconds).
690 ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
691 ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
693 ### <a id="plugin-check-command-load"></a> load
695 The [check_load](https://www.monitoring-plugins.org/doc/man/check_load.html) plugin
696 tests the current system load average.
698 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
701 ----------------|--------------
702 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
703 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
704 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
705 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
706 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
707 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
708 load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
710 ### <a id="plugin-check-command-mailq"></a> mailq
712 The [check_mailq](https://www.monitoring-plugins.org/doc/man/check_mailq.html) plugin
713 checks the number of messages in the mail queue (supports multiple sendmail queues, qmail).
715 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
718 ------------------------|--------------
719 mailq_warning | **Required.** Min. number of messages in queue to generate warning.
720 mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ).
721 mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning
722 mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ).
723 mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15).
724 mailq_servertype | **Optional.** [ sendmail \| qmail \| postfix \| exim \| nullmailer ] (default = autodetect).
725 mailq_sudo | **Optional.** Use sudo to execute the mailq command.
727 ### <a id="plugin-check-command-mysql"></a> mysql
729 The [check_mysql](https://www.monitoring-plugins.org/doc/man/check_mysql.html) plugin
730 tests connections to a MySQL server.
732 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
735 ------------------------|---------------------------------------------------------------
736 mysql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
737 mysql_port | **Optional.** Port number (default: 3306).
738 mysql_socket | **Optional.** Use the specified socket (has no effect if `mysql_hostname` is used).
739 mysql_ignore_auth | **Optional.** Ignore authentication failure and check for mysql connectivity only.
740 mysql_database | **Optional.** Check database with indicated name.
741 mysql_file | **Optional.** Read from the specified client options file.
742 mysql_group | **Optional.** Use a client options group.
743 mysql_username | **Optional.** Connect using the indicated username.
744 mysql_password | **Optional.** Use the indicated password to authenticate the connection.
745 mysql_check_slave | **Optional.** Check if the slave thread is running properly.
746 mysql_warning | **Optional.** Exit with WARNING status if slave server is more than INTEGER seconds behind master.
747 mysql_critical | **Optional.** Exit with CRITICAL status if slave server is more then INTEGER seconds behind master.
748 mysql_ssl | **Optional.** Use ssl encryptation.
749 mysql_cacert | **Optional.** Path to CA signing the cert.
750 mysql_cert | **Optional.** Path to SSL certificate.
751 mysql_key | **Optional.** Path to private SSL key.
752 mysql_cadir | **Optional.** Path to CA directory.
753 mysql_ciphers | **Optional.** List of valid SSL ciphers.
756 ### <a id="plugin-check-command-mysql-query"></a> mysql_query
758 The [check_mysql_query](https://www.monitoring-plugins.org/doc/man/check_mysql_query.html) plugin
759 checks a query result against threshold levels.
760 The result from the query should be numeric. For extra security, create a user with minimal access.
762 **Note**: You must specify `mysql_query_password` with an empty string to force an empty password,
763 overriding any my.cnf settings.
765 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
768 ------------------------|---------------------------------------------------------------
769 mysql_query_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
770 mysql_query_port | **Optional.** Port number (default: 3306).
771 mysql_query_database | **Optional.** Check database with indicated name.
772 mysql_query_file | **Optional.** Read from the specified client options file.
773 mysql_query_group | **Optional.** Use a client options group.
774 mysql_query_username | **Optional.** Connect using the indicated username.
775 mysql_query_password | **Optional.** Use the indicated password to authenticate the connection.
776 mysql_query_execute | **Required.** SQL Query to run on the MySQL Server.
777 mysql_query_warning | **Optional.** Exit with WARNING status if query is outside of the range (format: start:end).
778 mysql_query_critical | **Optional.** Exit with CRITICAL status if query is outside of the range.
781 ### <a id="plugin-check-command-negate"></a> negate
783 The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin
784 negates the status of a plugin (returns OK for CRITICAL and vice-versa).
785 Additional switches can be used to control which state becomes what.
787 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
790 ------------------------|---------------------------------------------------------------
791 negate_timeout | **Optional.** Seconds before plugin times out (default: 11).
792 negate_timeout_result | **Optional.** Custom result on Negate timeouts, default to UNKNOWN.
793 negate_ok | **Optional.** OK, WARNING, CRITICAL or UNKNOWN.
794 negate_warning | Numeric values are accepted.
795 negate_critical | If nothing is specified, permutes OK and CRITICAL.
796 negate_substitute | **Optional.** Substitute output text as well. Will only substitute text in CAPITALS.
797 negate_command | **Required.** Command to be negated.
798 negate_arguments | **Optional.** Arguments for the negated command.
800 ### <a id="plugin-check-command-nrpe"></a> nrpe
802 The `check_nrpe` plugin can be used to query an [NRPE](https://docs.icinga.com/latest/en/nrpe.html)
803 server or [NSClient++](https://www.nsclient.org). **Note**: This plugin
804 is considered insecure/deprecated.
806 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
809 ----------------|--------------
810 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
811 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
812 nrpe_command | **Optional.** The command that should be executed.
813 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
814 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
815 nrpe_timeout | **Optional.** The timeout in seconds.
816 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
817 nrpe_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
818 nrpe_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
819 nrpe_version_2 | **Optional.** Use this if you want to connect using NRPE v2 protocol. Defaults to false.
822 ### <a id="plugin-check-command-nscp"></a> nscp
824 The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin
825 collects data from the [NSClient++](https://www.nsclient.org) service.
827 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
830 ----------------|--------------
831 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
832 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
833 nscp_password | **Optional.** The NSClient++ password.
834 nscp_variable | **Required.** The variable that should be checked.
835 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
836 nscp_warn | **Optional.** The warning threshold.
837 nscp_crit | **Optional.** The critical threshold.
838 nscp_timeout | **Optional.** The query timeout in seconds.
839 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
842 ### <a id="plugin-check-command-ntp-time"></a> ntp_time
844 The [check_ntp_time](https://www.monitoring-plugins.org/doc/man/check_ntp_time.html) plugin
845 checks the clock offset between the local host and a remote NTP server.
847 **Note**: If you want to monitor an NTP server, please use `ntp_peer`.
849 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
852 ----------------|--------------
853 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
854 ntp_port | **Optional.** Port number (default: 123).
855 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
856 ntp_warning | **Optional.** Offset to result in warning status (seconds).
857 ntp_critical | **Optional.** Offset to result in critical status (seconds).
858 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
859 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
860 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
861 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
864 ### <a id="plugin-check-command-ntp-peer"></a> ntp_peer
866 The [check_ntp_peer](https://www.monitoring-plugins.org/doc/man/check_ntp_peer.html) plugin
867 checks the health of an NTP server. It supports checking the offset with the sync peer, the
868 jitter and stratum. This plugin will not check the clock offset between the local host and NTP
869 server; please use `ntp_time` for that purpose.
871 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
874 ----------------|--------------
875 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
876 ntp_port | **Optional.** The port to use. Default to 123.
877 ntp_warning | **Optional.** Offset to result in warning status (seconds).
878 ntp_critical | **Optional.** Offset to result in critical status (seconds).
879 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
880 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
881 ntp_wjitter | **Optional.** Warning threshold for jitter.
882 ntp_cjitter | **Optional.** Critical threshold for jitter.
883 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
884 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
885 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
886 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
887 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
890 ### <a id="plugin-check-command-passive"></a> passive
892 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
894 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
897 ----------------|--------------
898 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
899 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
901 ### <a id="plugin-check-command-pgsql"></a> pgsql
903 The [check_pgsql](https://www.monitoring-plugins.org/doc/man/check_pgsql.html) plugin
904 tests a PostgreSQL DBMS to determine whether it is active and accepting queries.
905 If a query is specified using the `pgsql_query` attribute, it will be executed after
906 connecting to the server. The result from the query has to be numeric in order
907 to compare it against the query thresholds if set.
909 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
912 ------------------------|---------------------------------------------------------------
913 pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
914 pgsql_port | **Optional.** Port number (default: 5432).
915 pgsql_database | **Optional.** Database to check (default: template1).
916 pgsql_username | **Optional.** Login name of user.
917 pgsql_password | **Optional.** Password (BIG SECURITY ISSUE).
918 pgsql_options | **Optional.** Connection parameters (keyword = value), see below.
919 pgsql_warning | **Optional.** Response time to result in warning status (seconds).
920 pgsql_critical | **Optional.** Response time to result in critical status (seconds).
921 pgsql_timeout | **Optional.** Seconds before connection times out (default: 10).
922 pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read.
923 pgsql_query_warning | **Optional.** SQL query value to result in warning status (double).
924 pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
926 ### <a id="plugin-check-command-ping"></a> ping
928 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
929 uses the ping command to probe the specified host for packet loss (percentage) and
930 round trip average (milliseconds).
932 This command uses the host's `address` attribute if available and falls back to using
933 the `address6` attribute if the `address` attribute is not set.
935 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
938 ----------------|--------------
939 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
940 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
941 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
942 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
943 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
944 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
945 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
948 ### <a id="plugin-check-command-ping4"></a> ping4
950 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
951 uses the ping command to probe the specified host for packet loss (percentage) and
952 round trip average (milliseconds).
954 This command uses the host's `address` attribute if not explicitely specified using
955 the `ping_address` attribute.
957 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
960 ----------------|--------------
961 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
962 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
963 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
964 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
965 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
966 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
967 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
969 ### <a id="plugin-check-command-ping6"></a> ping6
971 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
972 uses the ping command to probe the specified host for packet loss (percentage) and
973 round trip average (milliseconds).
975 This command uses the host's `address6` attribute if not explicitely specified using
976 the `ping_address` attribute.
978 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
981 ----------------|--------------
982 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
983 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
984 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
985 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
986 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
987 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
988 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
991 ### <a id="plugin-check-command-pop"></a> pop
993 The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin
994 tests POP connections with the specified host (or unix socket).
996 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
999 ---------------------|--------------
1000 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1001 pop_port | **Optional.** The port that should be checked. Defaults to 110.
1002 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.
1003 pop_send | **Optional.** String to send to the server.
1004 pop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1005 pop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1006 pop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1007 pop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1008 pop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1009 pop_jail | **Optional.** Hide output from TCP socket.
1010 pop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1011 pop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1012 pop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1013 pop_ssl | **Optional.** Use SSL for the connection.
1014 pop_warning | **Optional.** Response time to result in warning status (seconds).
1015 pop_critical | **Optional.** Response time to result in critical status (seconds).
1016 pop_timeout | **Optional.** Seconds before connection times out (default: 10).
1017 pop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1018 pop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1021 ### <a id="plugin-check-command-processes"></a> procs
1023 The [check_procs](https://www.monitoring-plugins.org/doc/man/check_procs.html) plugin
1024 checks all processes and generates WARNING or CRITICAL states if the specified
1025 metric is outside the required threshold ranges. The metric defaults to number
1026 of processes. Search filters can be applied to limit the processes to check.
1028 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1031 ---------------------|--------------
1032 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
1033 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
1034 procs_metric | **Optional.** Check thresholds against metric.
1035 procs_timeout | **Optional.** Seconds before plugin times out.
1036 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
1037 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
1038 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
1039 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
1040 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
1041 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
1042 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
1043 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
1044 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
1045 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
1046 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
1049 ### <a id="plugin-check-command-radius"></a> radius
1051 The [check_radius](https://www.monitoring-plugins.org/doc/man/check_radius.html) plugin
1052 checks a RADIUS server to see if it is accepting connections. The server to test
1053 must be specified in the invocation, as well as a user name and password. A configuration
1054 file may also be present. The format of the configuration file is described in the
1055 radiusclient library sources. The password option presents a substantial security
1056 issue because the password can possibly be determined by careful watching of the
1057 command line in a process listing. This risk is exacerbated because the plugin will
1058 typically be executed at regular predictable intervals. Please be sure that the
1059 password used does not allow access to sensitive system resources.
1062 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1065 -------------------|--------------
1066 radius_address | **Optional.** The radius server's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1067 radius_config_file | **Required.** The radius configuration file.
1068 radius_username | **Required.** The radius username to test.
1069 radius_password | **Required.** The radius password to test.
1070 radius_port | **Optional.** The radius port number (default 1645).
1071 radius_nas_id | **Optional.** The NAS identifier.
1072 radius_nas_address | **Optional.** The NAS IP address.
1073 radius_expect | **Optional.** The response string to expect from the server.
1074 radius_retries | **Optional.** The number of times to retry a failed connection.
1075 radius_timeout | **Optional.** The number of seconds before connection times out (default: 10).
1078 ### <a id="plugin-check-command-simap"></a> simap
1080 The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
1081 tests SIMAP connections with the specified host (or unix socket).
1083 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1086 -----------------------|--------------
1087 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1088 simap_port | **Optional.** The port that should be checked. Defaults to 993.
1089 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.
1090 simap_send | **Optional.** String to send to the server.
1091 simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1092 simap_all | **Optional.** All expect strings need to occur in server response. Default is any.
1093 simap_quit | **Optional.** String to send server to initiate a clean close of the connection.
1094 simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1095 simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1096 simap_jail | **Optional.** Hide output from TCP socket.
1097 simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1098 simap_delay | **Optional.** Seconds to wait between sending string and polling for response.
1099 simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1100 simap_ssl | **Optional.** Use SSL for the connection.
1101 simap_warning | **Optional.** Response time to result in warning status (seconds).
1102 simap_critical | **Optional.** Response time to result in critical status (seconds).
1103 simap_timeout | **Optional.** Seconds before connection times out (default: 10).
1104 simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1105 simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1107 ### <a id="plugin-check-command-smart"></a> smart
1109 The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
1110 checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
1112 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1115 ----------------|--------------
1116 smart_device | **Required.** The name of a local hard drive to monitor.
1119 ### <a id="plugin-check-command-smtp"></a> smtp
1121 The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
1122 will attempt to open an SMTP connection with the host.
1124 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1127 ----------------------|--------------
1128 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1129 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
1130 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
1131 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
1132 smtp_command | **Optional.** SMTP command (may be used repeatedly).
1133 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
1134 smtp_helo_fqdn | **Optional.** FQDN used for HELO
1135 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1136 smtp_starttls | **Optional.** Use STARTTLS for the connection.
1137 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
1138 smtp_authuser | **Optional.** SMTP AUTH username.
1139 smtp_authpass | **Optional.** SMTP AUTH password.
1140 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
1141 smtp_warning | **Optional.** Response time to result in warning status (seconds).
1142 smtp_critical | **Optional.** Response time to result in critical status (seconds).
1143 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1144 smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1145 smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1148 ### <a id="plugin-check-command-snmp"></a> snmp
1150 The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin
1151 checks the status of remote machines and obtains system information via SNMP.
1153 **Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
1155 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1158 --------------------|--------------
1159 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1160 snmp_oid | **Required.** The SNMP OID.
1161 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1162 snmp_port | **Optional.** The SNMP port. Defaults to "161".
1163 snmp_retries | **Optional.** Number of retries to be used in the SNMP requests.
1164 snmp_warn | **Optional.** The warning threshold.
1165 snmp_crit | **Optional.** The critical threshold.
1166 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
1167 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
1168 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
1169 snmp_label | **Optional.** Prefix label for output value
1170 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
1171 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1172 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
1173 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
1174 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1175 snmp_rate | **Optional.** Boolean. Enable rate calculation.
1176 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
1177 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1179 ### <a id="plugin-check-command-snmpv3"></a> snmpv3
1181 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1182 plugin, using SNMPv3 authentication and encryption options.
1184 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1187 ---------------------|--------------
1188 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1189 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
1190 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
1191 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
1192 snmpv3_user | **Required.** The username to log in with.
1193 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
1194 snmpv3_priv_key | **Required.** The encryption key.
1195 snmpv3_oid | **Required.** The SNMP OID.
1196 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
1197 snmpv3_warn | **Optional.** The warning threshold.
1198 snmpv3_crit | **Optional.** The critical threshold.
1199 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
1200 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
1201 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
1202 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
1203 snmpv3_label | **Optional.** Prefix label for output value.
1204 snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1205 snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1206 snmpv3_rate | **Optional.** Boolean. Enable rate calculation.
1207 snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1209 ### <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
1211 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1212 plugin, using the uptime OID by default.
1214 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1217 ----------------|--------------
1218 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1219 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
1220 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1223 ### <a id="plugin-check-command-spop"></a> spop
1225 The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
1226 tests SPOP connections with the specified host (or unix socket).
1228 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1231 ----------------------|--------------
1232 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1233 spop_port | **Optional.** The port that should be checked. Defaults to 995.
1234 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.
1235 spop_send | **Optional.** String to send to the server.
1236 spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1237 spop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1238 spop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1239 spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1240 spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1241 spop_jail | **Optional.** Hide output from TCP socket.
1242 spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1243 spop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1244 spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1245 spop_ssl | **Optional.** Use SSL for the connection.
1246 spop_warning | **Optional.** Response time to result in warning status (seconds).
1247 spop_critical | **Optional.** Response time to result in critical status (seconds).
1248 spop_timeout | **Optional.** Seconds before connection times out (default: 10).
1249 spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1250 spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1253 ### <a id="plugin-check-command-ssh"></a> ssh
1255 The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
1256 connects to an SSH server at a specified host and port.
1258 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1261 ----------------|--------------
1262 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1263 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
1264 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1265 ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1266 ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1269 ### <a id="plugin-check-command-ssl"></a> ssl
1271 Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
1272 using ssl-related options.
1274 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1277 ------------------------------|--------------
1278 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1279 ssl_port | **Required.** The port that should be checked.
1280 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
1281 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.
1282 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.
1283 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$".
1286 ### <a id="plugin-check-command-ssmtp"></a> ssmtp
1288 The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
1289 tests SSMTP connections with the specified host (or unix socket).
1291 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1294 -----------------------|--------------
1295 ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1296 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
1297 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.
1298 ssmtp_send | **Optional.** String to send to the server.
1299 ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1300 ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any.
1301 ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1302 ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1303 ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1304 ssmtp_jail | **Optional.** Hide output from TCP socket.
1305 ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1306 ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1307 ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1308 ssmtp_ssl | **Optional.** Use SSL for the connection.
1309 ssmtp_warning | **Optional.** Response time to result in warning status (seconds).
1310 ssmtp_critical | **Optional.** Response time to result in critical status (seconds).
1311 ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1312 ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1313 ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1316 ### <a id="plugin-check-command-swap"></a> swap
1318 The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
1319 checks the swap space on a local machine.
1321 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1324 ----------------|--------------
1325 swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`.
1326 swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`.
1327 swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
1328 swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false.
1329 swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".
1332 ### <a id="plugin-check-command-tcp"></a> tcp
1334 The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
1335 tests TCP connections with the specified host (or unix socket).
1337 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1340 ----------------|--------------
1341 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1342 tcp_port | **Required.** The port that should be checked.
1343 tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1344 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
1345 tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
1346 tcp_send | **Optional.** String to send to the server.
1347 tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
1348 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1349 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
1350 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
1351 tcp_jail | **Optional.** Hide output from TCP socket.
1352 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1353 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1354 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.
1355 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
1356 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
1357 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
1358 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1359 tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1360 tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1363 ### <a id="plugin-check-command-udp"></a> udp
1365 The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
1366 tests UDP connections with the specified host (or unix socket).
1368 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1371 ----------------|--------------
1372 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1373 udp_port | **Required.** The port that should be checked.
1374 udp_send | **Required.** The payload to send in the UDP datagram.
1375 udp_expect | **Required.** The payload to expect in the response datagram.
1376 udp_quit | **Optional.** The payload to send to 'close' the session.
1377 udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1378 udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1381 ### <a id="plugin-check-command-ups"></a> ups
1383 The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin
1384 tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
1385 must be running for this plugin to work.
1387 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1390 ----------------|--------------
1391 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1392 ups_name | **Required.** The UPS name. Defaults to `ups`.
1393 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
1394 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`.
1395 ups_warning | **Optional.** The warning threshold for the selected variable.
1396 ups_critical | **Optional.** The critical threshold for the selected variable.
1397 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
1398 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
1401 ### <a id="plugin-check-command-users"></a> users
1403 The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin
1404 checks the number of users currently logged in on the local system and generates an
1405 error if the number exceeds the thresholds specified.
1407 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1410 ----------------|--------------
1411 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
1412 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
1414 ## <a id="windows-plugins"></a> Windows Plugins for Icinga 2
1416 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.
1418 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:
1420 include <windows-plugins>
1422 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.
1425 ### <a id="windows-plugins-thresholds"></a> Threshold syntax
1427 So not specified differently the thresholds for the plugins all follow the same pattern
1430 :------------|:----------
1431 "29" | The threshold is 29.
1432 "!29" | The threshold is 29, but the negative of the result is returned.
1433 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
1434 "![10-40]" | Same as above, but the result is inverted.
1437 ### <a id="windows-plugins-disk-windows"></a> disk-windows
1439 Check command object for the `check_disk.exe` plugin.
1440 Aggregates the free disk space of all volumes and mount points it can find, or the ones defined in `disk_win_path`. Ignores removable storage like fash drives and discs (CD, DVD etc.).
1444 > Percentage based thresholds can be used by adding a '%' to the threshold
1450 :-------------------|:------------
1451 disk\_win\_warn | **Optional**. The warning threshold.
1452 disk\_win\_crit | **Optional**. The critical threshold.
1453 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1454 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.
1455 disk\_win\_exclude | **Optional**. Exclude these drives from check.
1457 ### <a id="windows-plugins-load-windows"></a> load-windows
1459 Check command object for the `check_load.exe` plugin.
1460 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).
1465 :---------------|:------------
1466 load\_win\_warn | **Optional**. The warning threshold.
1467 load\_win\_crit | **Optional**. The critical threshold.
1470 ### <a id="windows-plugins-memory-windows"></a> memory-windows
1472 Check command object for the `check_memory.exe` plugin.
1473 The memory collection is instant.
1477 > Percentage based thresholds can be used by adding a '%' to the threshold
1478 > value. Keep in mind that memory\_win\_unit is applied before the
1479 > value is calculated.
1484 :-----------------|:------------
1485 memory\_win\_warn | **Optional**. The warning threshold.
1486 memory\_win\_crit | **Optional**. The critical threshold.
1487 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.
1490 ### <a id="windows-plugins-network-windows"></a> network-windows
1492 Check command object for the `check_network.exe` plugin.
1493 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).
1498 :-------------------|:------------
1499 network\_win\_warn | **Optional**. The warning threshold.
1500 network\_win\_crit | **Optional**. The critical threshold.
1501 network\_no\_isatap | **Optional**. Do not print ISATAP interfaces.
1504 ### <a id="windows-plugins-perfmon-windows"></a> perfmon-windows
1506 Check command object for the `check_perfmon.exe` plugin.
1507 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`.
1509 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"`
1514 :---------------------|:------------
1515 perfmon\_win\_warn | **Optional**. The warning threshold.
1516 perfmon\_win\_crit | **Optional**. The critical threshold.
1517 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1518 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1519 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
1520 perfmon\_win\_syntax | **Optional**. Use this in the performance output instead of `perfmon\_win\_counter`. Exists for graphice compatibility reasons.
1523 ### <a id="windows-plugins-ping-windows"></a> ping-windows
1525 Check command object for the `check_ping.exe` plugin.
1526 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.
1531 :------------------|:------------
1532 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma.
1533 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma.
1534 ping\_win\_address | **Required**. An IPv4 or IPv6 address
1535 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1536 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1539 ### <a id="windows-plugins-procs-windows"></a> procs-windows
1541 Check command object for `check_procs.exe` plugin.
1542 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.
1547 :----------------|:------------
1548 procs\_win\_warn | **Optional**. The warning threshold.
1549 procs\_win\_crit | **Optional**. The critical threshold.
1550 procs\_win\_user | **Optional**. Count this useres processes.
1553 ### <a id="windows-plugins-service-windows"></a> service-windows
1555 Check command object for `check_service.exe` plugin.
1556 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.
1561 :---------------------|:------------
1562 service\_win\_warn | **Optional**. Warn when service is not running.
1563 service\_win\_service | **Required**. The critical threshold.
1566 ### <a id="windows-plugins-swap-windows"></a> swap-windows
1568 Check command object for `check_swap.exe` plugin.
1569 The data collection is instant.
1574 :---------------|:------------
1575 swap\_win\_warn | **Optional**. The warning threshold.
1576 swap\_win\_crit | **Optional**. The critical threshold.
1577 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1580 ### <a id="windows-plugins-update-windows"></a> update-windows
1582 Check command object for `check_update.exe` plugin.
1583 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.
1587 > The Network Services Account which runs Icinga 2 by default does not have the required
1588 > permissions to run this check.
1593 :-------------------|:------------
1594 update\_win\_warn | If set, returns warning when important updates are available
1595 update\_win\_crit | If set, return critical when important updates that require a reboot are available.
1596 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1599 ### <a id="windows-plugins-uptime-windows"></a> uptime-windows
1601 Check command opject for `check_uptime.exe` plugin.
1602 Uses GetTickCount64 to get the uptime, so boot time is not included.
1607 :-----------------|:------------
1608 uptime\_win\_warn | **Optional**. The warning threshold.
1609 uptime\_win\_crit | **Optional**. The critical threshold.
1610 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).
1613 ### <a id="windows-plugins-users-windows"></a> users-windows
1615 Check command object for `check_users.exe` plugin.
1620 :----------------|:------------
1621 users\_win\_warn | **Optional**. The warning threshold.
1622 users\_win\_crit | **Optional**. The critical threshold.
1625 ## <a id="nscp-plugin-check-commands"></a> Plugin Check Commands for NSClient++
1627 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1629 You can enable these check commands by adding the following the include directive in your
1630 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1634 You can also optionally specify an alternative installation directory for NSClient++ by adding
1635 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1638 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1640 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1641 not be necessary to manually set this constant.
1643 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1645 ### <a id="nscp-check-local"></a> nscp-local
1647 Check command object for NSClient++
1649 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1652 ----------------|--------------
1653 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1654 nscp_load_all | **Optional.** Whether to load all modules. Defaults to false.
1655 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`.
1656 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1657 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1658 nscp_arguments | **Optional.** An array of query arguments.
1659 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1661 ### <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1663 Check command object for the `check_cpu` NSClient++ plugin.
1666 --------------------|------------------
1667 nscp_cpu_time | **Optional.** Calculate avarage usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1668 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1669 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1670 nscp_cpu_arguments | **Optional.** Additional arguments.
1671 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1673 ### <a id="nscp-check-local-memory"></a> nscp-local-memory
1675 Check command object for the `check_memory` NSClient++ plugin.
1678 ----------------------|------------------
1679 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1680 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1681 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1682 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolut (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1683 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolut (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1684 nscp_memory_arguments | **Optional.** Additional arguments.
1685 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1687 ### <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1689 Check command object for the `check_os_version` NSClient++ plugin.
1691 This command has the same custom attributes like the `nscp-local` check command.
1693 ### <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1695 Check command object for the `check_pagefile` NSClient++ plugin.
1697 This command has the same custom attributes like the `nscp-local` check command.
1699 ### <a id="nscp-check-local-process"></a> nscp-local-process
1701 Check command object for the `check_process` NSClient++ plugin.
1703 This command has the same custom attributes like the `nscp-local` check command.
1705 ### <a id="nscp-check-local-service"></a> nscp-local-service
1707 Check command object for the `check_service` NSClient++ plugin.
1710 -----------------------|------------------
1711 nscp_service_name | **Required.** Name of service to check.
1712 nscp_service_type | **Optional.** Type to check, default to state.
1713 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1714 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1715 nscp_service_warning | **Optional.** State for return an WARNING.
1716 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1717 nscp_service_critical | **Optional.** State for return an CRITICAL.
1718 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1719 nscp_service_arguments | **Optional.** Additional arguments.
1720 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1722 ### <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1724 Check command object for the `check_uptime` NSClient++ plugin.
1726 This command has the same custom attributes like the `nscp-local` check command.
1728 ### <a id="nscp-check-local-version"></a> nscp-local-version
1730 Check command object for the `check_version` NSClient++ plugin.
1732 This command has the same custom attributes like the `nscp-local` check command.
1733 In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
1735 ### <a id="nscp-check-local-disk"></a> nscp-local-disk
1737 Check command object for the `check_drivesize` NSClient++ plugin.
1740 -----------------------|------------------
1741 nscp_disk_drive | **Optional.** Drive character, default to all drives.
1742 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1743 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolut (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1744 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolut (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1745 nscp_disk_arguments | **Optional.** Additional arguments.
1746 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1747 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`.
1749 ### <a id="nscp-check-local-counter"></a> nscp-local-counter
1751 Check command object for the `check_pdh` NSClient++ plugin.
1754 -----------------------|------------------
1755 nscp_counter_name | **Required.** Performance counter name.
1756 nscp_counter_warning | **Optional.** WARNING Threshold.
1757 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1758 nscp_counter_arguments | **Optional.** Additional arguments.
1759 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1760 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1764 ## <a id="snmp-manubulon-plugin-check-commands"></a> Plugin Check Commands for Manubulon SNMP
1766 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1767 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1769 **Note:** Some plugin parameters are only available in Debian packages or in a
1770 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1772 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1773 is set to the path where the Manubublon SNMP plugins are installed.
1775 You can enable these plugin check commands by adding the following the include directive in your
1776 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1780 ### Checks by Host Type
1782 **N/A** : Not available for this type.
1784 **SNMP** : Available for simple SNMP query.
1788 **Specific** : Script name for platform specific checks.
1791 Host type | Interface | storage | load/cpu | mem | process | env | specific
1792 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1793 Linux | Yes | Yes | Yes | Yes | Yes | No |
1794 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1795 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1796 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1797 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1798 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1799 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1800 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1801 AS400 | Yes | Yes | Yes | Yes | No | No |
1802 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1803 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1804 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1805 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1808 ### <a id="plugin-check-command-snmp-load"></a> snmp-load
1810 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1812 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1816 ------------------------|--------------
1817 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1818 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1819 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1820 snmp_port | **Optional.** The SNMP port connection.
1821 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1822 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1823 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1824 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1825 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1826 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1827 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1828 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1829 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1830 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1831 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.
1832 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1833 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1835 ### <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1837 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1839 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1842 ------------------------|--------------
1843 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1844 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1845 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1846 snmp_port | **Optional.** The SNMP port connection.
1847 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1848 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1849 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1850 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1851 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1852 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1853 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1854 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1855 snmp_warn | **Optional.** The warning threshold.
1856 snmp_crit | **Optional.** The critical threshold.
1857 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1858 snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
1859 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1860 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1862 ### <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1864 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1866 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1869 ------------------------|--------------
1870 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1871 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1872 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1873 snmp_port | **Optional.** The SNMP port connection.
1874 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1875 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1876 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1877 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1878 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1879 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1880 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1881 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1882 snmp_warn | **Optional.** The warning threshold.
1883 snmp_crit | **Optional.** The critical threshold.
1884 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1885 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1886 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1888 ### <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1890 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1892 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1895 ----------------------------|--------------
1896 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1897 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1898 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1899 snmp_port | **Optional.** The SNMP port connection.
1900 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1901 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1902 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1903 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1904 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1905 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1906 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1907 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1908 snmp_warn | **Optional.** The warning threshold.
1909 snmp_crit | **Optional.** The critical threshold.
1910 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1911 snmp_interface_inverse | **Optional.** Inverse Interface check, down is ok. Defaults to false as it is missing.
1912 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1913 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
1914 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.
1915 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1916 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1917 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.
1918 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1919 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1920 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1921 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1922 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.
1923 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name.
1924 snmp_interface_ifalias | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name.
1925 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1926 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1928 ### <a id="plugin-check-command-snmp-process"></a> snmp-process
1930 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1932 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1935 ---------------------------|--------------
1936 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1937 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1938 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1939 snmp_port | **Optional.** The SNMP port connection.
1940 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1941 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1942 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1943 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1944 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1945 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1946 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1947 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1948 snmp_warn | **Optional.** The warning threshold.
1949 snmp_crit | **Optional.** The critical threshold.
1950 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1951 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1952 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1953 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.
1954 snmp_process_mem_usage | **Optional.** Define to check memory usage for the process. Defaults to false.
1955 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".
1956 snmp_process_cpu_usage | **Optional.** Define to check CPU usage for the process. Defaults to false.
1957 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".
1960 ## <a id="plugin-contrib"></a> Contributed Plugin Check Commands
1962 The contributed Plugin Check Commands provides various additional command definitions
1963 contributed by community members.
1965 These check commands assume that the global constant named `PluginContribDir`
1966 is set to the path where the user installs custom plugins and can be enabled by
1967 uncommenting the corresponding line in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf):
1970 vim /etc/icinga2/icinga2.conf
1972 include <plugin-contrib>
1975 This is enabled by default since Icinga 2 2.5.0.
1977 ### <a id="plugin-contrib-databases"></a> Databases
1979 This category contains plugins for various database servers.
1981 #### <a id="plugin-contrib-command-db2_health"></a> db2_health
1983 The [check_db2_health](https://labs.consol.de/nagios/check_db2_health/) plugin
1984 uses the `DBD::DB2` Perl library to monitor a [DB2](https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/)
1987 The Git repository is located on [GitHub](https://github.com/lausser/check_db2_health).
1989 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1992 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1993 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)
1994 db2_health_username | **Optional.** The username for the database connection.
1995 db2_health_password | **Optional.** The password for the database connection.
1996 db2_health_port | **Optional.** The port where DB2 is listening.
1997 db2_health_warning | **Optional.** The warning threshold depending on the mode.
1998 db2_health_critical | **Optional.** The critical threshold depending on the mode.
1999 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
2000 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).
2001 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.
2002 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.
2003 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
2004 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".
2005 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
2006 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
2007 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
2008 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".
2009 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
2011 #### <a id="plugin-contrib-command-mssql_health"></a> mssql_health
2013 The [check_mssql_health](https://labs.consol.de/nagios/check_mssql_health/index.html) plugin
2014 uses the `DBD::Sybase` Perl library based on [FreeTDS](http://www.freetds.org/) to monitor a
2015 [MS SQL](https://www.microsoft.com/en-us/sql-server/) server.
2017 The Git repository is located on [GitHub](https://github.com/lausser/check_mssql_health).
2019 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2022 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2023 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
2024 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
2025 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
2026 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
2027 mssql_health_username | **Optional.** The username for the database connection.
2028 mssql_health_password | **Optional.** The password for the database connection.
2029 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
2030 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
2031 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
2032 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).
2033 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
2034 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.
2035 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
2036 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".
2037 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
2038 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
2039 mssql_health_notemp | **Optional.** Set this to true to ignore temporary databases/tablespaces. Defaults to false.
2040 mssql_health_nooffline | **Optional.** Set this to true to ignore offline databases. Defaults to false.
2041 mssql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates.
2043 #### <a id="plugin-contrib-command-mysql_health"></a> mysql_health
2045 The [check_mysql_health](https://labs.consol.de/nagios/check_mysql_health/index.html) plugin
2046 uses the `DBD::MySQL` Perl library to monitor a
2047 [MySQL](https://dev.mysql.com/downloads/mysql/) or [MariaDB](https://mariadb.org/about/) database.
2049 The Git repository is located on [GitHub](https://github.com/lausser/check_mysql_health).
2051 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2054 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2055 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
2056 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
2057 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
2058 mysql_health_username | **Optional.** The username for the database connection.
2059 mysql_health_password | **Optional.** The password for the database connection.
2060 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
2061 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
2062 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
2063 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
2064 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
2065 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
2066 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
2067 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::* module.
2068 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
2069 mysql_health_nooffline | **Optional.** Skip the offline databases.
2070 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
2071 mysql_health_name | **Optional.** The name of a specific component to check.
2072 mysql_health_name2 | **Optional.** The secondary name of a component.
2073 mysql_health_name3 | **Optional.** The tertiary name of a component.
2074 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".
2075 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2076 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2077 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components"
2078 mysql_health_mitigation | **Optional.** "The parameter allows you to change a critical error to a warning."
2079 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates."
2080 mysql_health_environment | **Optional.** Add a variable to the plugin's environment."
2081 mysql_health_morphmessage | **Optional.** Modify the final output message."
2082 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels."
2083 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data."
2084 mysql_health_report | **Optional.** Can be used to shorten the output."
2085 mysql_health_multiline | **Optional.** Multiline output."
2086 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical."
2087 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory."
2088 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files."
2089 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time."
2090 mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2092 #### <a id="plugin-contrib-command-oracle_health"></a> oracle_health
2094 The [check_oracle_health](https://labs.consol.de/nagios/check_oracle_health/index.html) plugin
2095 uses the `DBD::Oracle` Perl library to monitor an [Oracle](https://www.oracle.com/database/) database.
2097 The Git repository is located on [GitHub](https://github.com/lausser/check_oracle_health).
2099 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2102 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2103 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2104 oracle_health_username | **Optional.** The username for the database connection.
2105 oracle_health_password | **Optional.** The password for the database connection.
2106 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2107 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2108 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2109 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2110 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.
2111 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.
2112 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2113 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".
2114 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2115 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2116 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2117 oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2118 oracle_health_report | **Optional.** Select the plugin output format. Can be short or long. Default to long.
2123 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2124 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".
2125 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".
2127 #### <a id="plugin-contrib-command-postgres"></a> postgres
2129 The [check_postgres](https://bucardo.org/wiki/Check_postgres) plugin
2130 uses the `psql` binary to monitor a [PostgreSQL](https://www.postgresql.org/about/) database.
2132 The Git repository is located on [GitHub](https://github.com/bucardo/check_postgres).
2134 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2137 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2138 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.
2139 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2140 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2141 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2142 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2143 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2144 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2145 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2146 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2147 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2148 postgres_includeuser | **Optional.** Include objects owned by certain users.
2149 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2150 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
2151 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2152 postgres_action | **Required.** Determines the test executed.
2153 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2154 postgres_query | **Optional.** Query for "custom_query" action.
2155 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2156 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2157 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).
2159 #### <a id="plugin-contrib-command-mongodb"></a> mongodb
2161 The [check_mongodb.py](https://github.com/mzupan/nagios-plugin-mongodb) plugin
2162 uses the `pymongo` Python library to monitor a [MongoDB](https://docs.mongodb.com/manual/) instance.
2164 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2167 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2168 mongodb_host | **Required.** Specifies the hostname or address.
2169 mongodb_port | **Required.** The port mongodb is runnung on.
2170 mongodb_user | **Optional.** The username you want to login as
2171 mongodb_passwd | **Optional.** The password you want to use for that user
2172 mongodb_warning | **Optional.** The warning threshold we want to set
2173 mongodb_critical | **Optional.** The critical threshold we want to set
2174 mongodb_action | **Required.** The action you want to take
2175 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
2176 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
2177 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
2178 mongodb_database | **Optional.** Specify the database to check
2179 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
2180 mongodb_ssl | **Optional.** Connect using SSL
2181 mongodb_replicaset | **Optional.** Connect to replicaset
2182 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check
2183 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second
2184 mongodb_collection | **Optional.** Specify the collection to check
2185 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
2187 #### <a id="plugin-contrib-command-elasticsearch"></a> elasticsearch
2189 The [check_elasticsearch](https://github.com/anchor/nagios-plugin-elasticsearch) plugin
2190 uses the HTTP API to monitor an [Elasticsearch](https://www.elastic.co/products/elasticsearch) node.
2192 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2195 -----------------------------|-------------------------------------------------------------------------------------------------------
2196 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2197 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
2198 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.
2199 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2200 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2201 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2203 #### <a id="plugin-contrib-command-redis"></a> redis
2205 The [check_redis.pl](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl) plugin
2206 uses the `Redis` Perl library to monitor a [Redis](https://redis.io/) instance. The plugin can
2207 measure response time, hitrate, memory utilization, check replication synchronization, etc. It is
2208 also possible to test data in a specified key and calculate averages or summaries on ranges.
2210 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2213 -------------------------|--------------------------------------------------------------------------------------------------------------
2214 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
2215 redis_port | **Optional.** Port number to query. Default to "6379".
2216 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2217 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2218 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2219 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2220 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2221 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.
2222 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.
2223 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.
2224 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2225 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.
2226 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".
2227 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2228 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2229 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.
2230 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2231 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.
2232 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2233 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2236 ### <a id="plugin-contrib-hardware"></a> Hardware
2238 This category includes all plugin check commands for various hardware checks.
2240 #### <a id="plugin-contrib-command-hpasm"></a> hpasm
2242 The [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) plugin
2243 monitors the hardware health of HP Proliant Servers, provided that the `hpasm`
2244 (HP Advanced Server Management) software is installed. It is also able to monitor
2245 the system health of HP Bladesystems and storage systems.
2247 The plugin can run in two different ways:
2249 1. Local execution using the `hpasmcli` command line tool.
2250 2. Remote SNMP query which invokes the HP Insight Tools on the remote node.
2252 You can either set or omit `hpasm_hostname` custom attribute and select the corresponding node.
2254 The `hpasm_remote` attribute enables the plugin to execute remote SNMP queries if set to `true`.
2255 For compatibility reasons this attribute uses `true` as default value, and ensures that
2256 specifying the `hpasm_hostname` always enables remote checks.
2258 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2261 --------------------------------|-----------------------------------------------------------------------
2262 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2263 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2264 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2265 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2266 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2267 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2268 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2269 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2270 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.
2271 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.
2272 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2273 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2274 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2275 hpasm_privpassword | **Optional.** The password for authPriv security level.
2276 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2277 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2278 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.
2279 hpasm_remote | **Optional.** Run remote SNMP checks if enabled. Otherwise checks are executed locally using the `hpasmcli` binary. Defaults to `true`.
2281 #### <a id="plugin-contrib-command-adaptec-raid"></a> adaptec-raid
2283 The [check_adaptec_raid](https://github.com/thomas-krenn/check_adaptec_raid) plugin
2284 uses the `arcconf` binary to monitor Adaptec RAID controllers.
2286 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2289 --------------------------------|-----------------------------------------------------------------------
2290 adaptec_controller_number | **Required.** Controller number to monitor.
2291 arcconf_path | **Required.** Path to the `arcconf` binary, e.g. "/sbin/arcconf".
2293 #### <a id="plugin-contrib-command-lsi-raid"></a> lsi-raid
2295 The [check_lsi_raid](https://github.com/thomas-krenn/check_lsi_raid) plugin
2296 uses the `storcli` binary to monitor MegaRAID RAID controllers.
2298 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2301 --------------------------------|-----------------------------------------------------------------------
2302 lsi_controller_number | **Required.** Controller number to monitor.
2303 storcli_path | **Required.** Path to the `storcli` binary, e.g. "/usr/sbin/storcli".
2305 #### <a id="plugin-contrib-command-smart-attributes"></a> smart-attributes
2307 The [check_smart_attributes](https://github.com/thomas-krenn/check_smart_attributes) plugin
2308 uses the `smartctl` binary to monitor SMART values of SSDs and HDDs.
2310 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2313 --------------------------------|-----------------------------------------------------------------------
2314 smart_attributes_config_path | **Required.** Path to the smart attributes config file (e.g. check_smartdb.json).
2315 smart_attributes_device | **Required.** Device name (e.g. /dev/sda) to monitor.
2318 ### <a id="plugin-contrib-icingacli"></a> IcingaCLI
2320 This category includes all plugins using the icingacli provided by Icinga Web 2.
2322 #### <a id="plugin-contrib-icingacli-businessprocess"></a> Business Process
2324 This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process)
2325 and executed as `icingacli businessprocess` CLI command.
2327 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2330 ------------------------------------------|-----------------------------------------------------------------------------------------
2331 icingacli_businessprocess_process | **Required.** Business process to monitor.
2332 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2333 icingacli_businessprocess_details | **Optional.** Get details for root cause analysis. Defaults to false.
2334 icingacli_businessprocess_statetype | **Optional.** Define which state type to look at, `soft` or `hard`. Overrides the default value inside the businessprocess module, if configured.
2337 ### <a id="plugin-contrib-ipmi"></a> IPMI Devices
2339 This category includes all plugins for IPMI devices.
2341 #### <a id="plugin-contrib-command-ipmi-sensor"></a> ipmi-sensor
2343 The [check_ipmi_sensor](https://github.com/thomas-krenn/check_ipmi_sensor_v3) plugin
2344 uses the `ipmimonitoring` binary to monitor sensor data for IPMI devices. Please
2345 read the [documentation](https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin)
2346 for installation and configuration details.
2348 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2351 ---------------------------------|-----------------------------------------------------------------------------------------------------
2352 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2353 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2354 ipmi_username | **Optional.** The IPMI username.
2355 ipmi_password | **Optional.** The IPMI password.
2356 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2357 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2358 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2359 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.
2360 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2361 ipmi_exclude_sensor | **Optional.** Exclude sensor based on IPMI sensor type. (Comma-separated)
2362 ipmi_exclude_sel | **Optional.** Exclude SEL entries of specific sensor types. (comma-separated list).
2363 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2364 ipmi_protocol_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2365 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2366 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2367 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2368 ipmi_verbose | **Optional.** Be Verbose multi line output, also with additional details for warnings.
2369 ipmi_debug | **Optional.** Be Verbose debugging output, followed by normal multi line output.
2371 #### <a id="plugin-contrib-command-ipmi-alive"></a> ipmi-alive
2373 The `ipmi-alive` check commands allows you to create a ping check for the IPMI Interface.
2375 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2378 ---------------------------------|-----------------------------------------------------------------------------------------------------
2379 ping_address | **Optional.** The address of the IPMI interface. Defaults to "$address$" if the IPMI interface's `address` attribute is set, "$address6$" otherwise.
2380 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 5000.
2381 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 100.
2382 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
2383 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
2384 ping_packets | **Optional.** The number of packets to send. Defaults to 1.
2385 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
2388 ### <a id="plugins-contrib-log-management"></a> Log Management
2390 This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
2392 #### <a id="plugins-contrib-command-logstash"></a> logstash
2394 The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
2395 the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
2397 The Node API is not activated by default. You have to configure your Logstash
2398 installation in order to allow plugin connections.
2401 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2402 logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
2403 logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
2404 logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
2405 logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
2406 logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
2407 logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
2408 logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
2409 logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
2410 logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
2411 logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
2414 ### <a id="plugin-contrib-metrics"></a> Metrics
2416 This category includes all plugins for metric-based checks.
2418 #### <a id="plugin-contrib-command-graphite"></a> graphite
2420 The [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin
2421 uses the `rest-client` Ruby library to monitor a [Graphite](https://graphiteapp.org) instance.
2423 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2426 ------------------------------------|-----------------------------------------------------------------------------------------------------
2427 graphite_url | **Required.** Target url.
2428 graphite_metric | **Required.** Metric path string.
2429 graphite_shortname | **Optional.** Metric short name (used for performance data).
2430 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2431 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2432 graphite_warning | **Required.** Warning threshold.
2433 graphite_critical | **Required.** Critical threshold.
2434 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.
2435 graphite_message | **Optional.** Text message to output (default: "metric count:").
2436 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2437 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2439 ### <a id="plugin-contrib-network-components"></a> Network Components
2441 This category includes all plugins for various network components like routers, switches and firewalls.
2443 #### <a id="plugin-contrib-command-interfacetable"></a> interfacetable
2445 The [check_interfacetable_v3t](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) plugin
2446 generates a html page containing information about the monitored node and all of its interfaces.
2448 The Git repository is located on [GitHub](https://github.com/Tontonitch/interfacetable_v3t).
2450 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2453 ------------------------------------|-----------------------------------------------------------------------------------------------------
2454 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2455 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2456 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2457 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2458 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2459 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2460 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2461 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2462 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2463 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2464 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2465 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2466 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.
2467 interfacetable_trackproperty | **Optional.** List of tracked properties.
2468 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2469 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2470 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
2471 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
2472 interfacetable_login | **Optional.** Login for snmpv3 authentication.
2473 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
2474 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
2475 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
2476 interfacetable_domain | **Optional.** SNMP transport domain.
2477 interfacetable_contextname | **Optional.** Context name for the snmp requests.
2478 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
2479 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
2480 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
2481 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
2482 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
2483 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.
2484 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
2485 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
2486 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
2487 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
2488 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
2489 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
2490 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
2491 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
2492 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
2493 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".
2494 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
2495 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
2496 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"
2497 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
2498 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
2499 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.
2500 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.
2501 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
2502 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
2503 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
2504 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
2505 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
2506 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
2507 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
2508 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
2509 interfacetable_config | **Optional.** Specify a config file to load.
2510 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
2511 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
2512 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
2513 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
2514 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
2516 #### <a id="plugin-contrib-command-iftraffic"></a> iftraffic
2518 The [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic) plugin
2519 checks the utilization of a given interface name using the SNMP protocol.
2521 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2524 ------------------------|---------------------------------------------------------
2525 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
2526 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2527 iftraffic_interface | **Required.** Queried interface name.
2528 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2529 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2530 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2531 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2532 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2534 #### <a id="plugin-contrib-command-iftraffic64"></a> iftraffic64
2536 The [check_iftraffic64](https://exchange.icinga.com/exchange/iftraffic64) plugin
2537 checks the utilization of a given interface name using the SNMP protocol.
2539 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2542 ------------------------|---------------------------------------------------------
2543 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
2544 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2545 iftraffic64_interface | **Required.** Queried interface name.
2546 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2547 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2548 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2549 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2550 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2552 #### <a id="plugin-contrib-command-interfaces"></a> interfaces
2554 The [check_interfaces](https://git.netways.org/plugins/check_interfaces) plugin
2555 uses SNMP to monitor network interfaces and their utilization.
2557 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2560 --------------------------|---------------------------------------------------------
2561 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2562 interfaces_regex | **Optional.** Interface list regexp.
2563 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
2564 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
2565 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
2566 interfaces_perfdata | **Optional.** perfdata from last check result.
2567 interfaces_prefix | **Optional.** Prefix interface names with this label.
2568 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
2569 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
2570 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
2571 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
2572 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
2573 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
2574 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
2575 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
2576 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
2577 interfaces_user | **Optional.** SNMPv3 User
2578 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
2579 interfaces_aliases | **Optional.** Retrieves the interface description.
2580 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
2581 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
2582 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
2583 interfaces_names | **Optional.** If set to true, use ifName instead of ifDescr.
2585 #### <a id="plugin-contrib-command-nwc_health"></a> nwc_health
2587 The [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html) plugin
2588 uses SNMP to monitor network components. The plugin is able to generate interface statistics,
2589 check hardware (CPU, memory, fan, power, etc.), monitor firewall policies, HRSP, load-balancer
2590 pools, processor and memory usage.
2592 Currently the following network components are supported: Cisco IOS, Cisco Nexus, Cisco ASA,
2593 Cisco PIX, F5 BIG-IP, CheckPoint Firewall1, Juniper NetScreen, HP Procurve, Nortel, Brocade 4100/4900,
2594 EMC DS 4700, EMC DS 24, Allied Telesyn. Blue Coat SG600, Cisco Wireless Lan Controller 5500,
2595 Brocade ICX6610-24-HPOE, Cisco UC Telefonzeugs, FOUNDRY-SN-AGENT-MIB, FRITZ!BOX 7390, FRITZ!DECT 200,
2596 Juniper IVE, Pulse-Gateway MAG4610, Cisco IronPort AsyncOS, Foundry, etc. A complete list can be
2597 found in the plugin [documentation](https://labs.consol.de/nagios/check_nwc_health/index.html).
2599 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2602 --------------------------------|---------------------------------------------------------
2603 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2604 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).
2605 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
2606 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
2607 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
2608 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).
2609 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2610 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2611 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2612 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
2613 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2614 nwc_health_privpassword | **Optional.** The password for authPriv security level.
2615 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2616 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
2617 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
2618 nwc_health_name | **Optional.** The name of an interface (ifDescr).
2619 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
2620 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
2621 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
2622 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
2623 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
2624 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
2625 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
2626 nwc_health_name2 | **Optional.** The secondary name of a component.
2627 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
2628 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)
2629 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.
2630 nwc_health_warning | **Optional.** The warning threshold
2631 nwc_health_critical | **Optional.** The critical threshold
2632 nwc_health_warningx | **Optional.** The extended warning thresholds
2633 nwc_health_criticalx | **Optional.** The extended critical thresholds
2634 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning (1) or ok (0).
2635 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.
2636 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'
2637 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
2638 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
2639 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
2640 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2641 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
2642 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
2643 nwc_health_multiline | **Optional.** Multiline output
2646 ### <a id="plugin-contrib-operating-system"></a> Operating System
2648 This category contains plugins which receive details about your operating system
2649 or the guest system.
2651 #### <a id="plugin-contrib-command-mem"></a> mem
2653 The [check_mem.pl](https://github.com/justintime/nagios-plugins) plugin checks the
2654 memory usage on linux and unix hosts. It is able to count cache memory as free when
2655 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).
2657 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2660 -------------|-----------------------------------------------------------------------------------------------------------------------
2661 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
2662 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
2663 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
2664 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
2665 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
2667 #### <a id="plugin-contrib-command-running_kernel"></a> running_kernel
2669 The [check_running_kernel](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin
2670 is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu.
2675 ---------------------------|-------------
2676 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
2678 #### <a id="plugin-contrib-command-iostats"></a> iostats
2680 The [check_iostats](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostats) plugin
2681 uses the `iostat` binary to monitor I/O on a Linux host. The default thresholds are rather high
2682 so you can use a grapher for baselining before setting your own.
2684 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2687 ---------------|-----------------------------------------------------------------------------------------------------------------------
2688 iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2689 iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000)
2690 iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000)
2691 iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000)
2692 iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50)
2693 iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000)
2694 iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000)
2695 iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000)
2696 iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80)
2698 #### <a id="plugin-contrib-command-iostat"></a> iostat
2700 The [check_iostat](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostat) plugin
2701 uses the `iostat` binary to monitor disk I/O on a Linux host. The default thresholds are rather high
2702 so you can use a grapher for baselining before setting your own.
2704 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2707 ---------------|-----------------------------------------------------------------------------------------------------------------------
2708 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2709 iostat\_wtps | **Required.** Warning threshold for tps (default: 100)
2710 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100)
2711 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100)
2712 iostat\_ctps | **Required.** Critical threshold for tps (default: 200)
2713 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200)
2714 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200)
2716 #### <a id="plugin-contrib-command-yum"></a> yum
2718 The [check_yum](https://github.com/calestyo/check_yum) plugin checks the YUM package
2719 management system for package updates.
2720 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
2722 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2725 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2726 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.
2727 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
2728 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.
2729 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.
2730 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.
2731 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.
2732 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.
2733 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
2734 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
2736 ### <a id="plugins-contrib-storage"></a> Storage
2738 This category includes all plugins for various storage and object storage technologies.
2740 #### <a id="plugins-contrib-command-glusterfs"></a> glusterfs
2742 The [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) plugin
2743 is used to check the GlusterFS storage health on the server.
2744 The plugin requires `sudo` permissions.
2746 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2749 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2750 glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
2751 glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
2752 glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
2753 glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
2754 glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
2755 glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
2756 glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
2759 ### <a id="plugin-contrib-virtualization"></a> Virtualization
2761 This category includes all plugins for various virtualization technologies.
2763 #### <a id="plugin-contrib-command-esxi-hardware"></a> esxi_hardware
2765 The [check_esxi_hardware.py](https://www.claudiokuenzler.com/nagios-plugins/check_esxi_hardware.php) plugin
2766 uses the [pywbem](https://pywbem.github.io/pywbem/) Python library to monitor the hardware of ESXi servers
2767 through the [VMWare API](https://www.vmware.com/support/pubs/sdk_pubs.html) and CIM service.
2769 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2772 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2773 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
2774 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.
2775 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.
2776 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
2777 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
2778 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
2779 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
2780 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
2781 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2782 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2783 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2784 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2785 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2787 #### <a id="plugin-contrib-vmware"></a> VMware
2789 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
2791 **vmware-esx-dc-volumes**
2793 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2795 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2798 ------------------------|--------------
2799 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2800 vmware_cluster | **Optional.** ESX or ESXi clustername.
2801 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2802 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2803 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2804 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2805 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2806 vmware_sessionfile | **Optional.** Session file name enhancement.
2807 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2808 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2809 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2810 vmware_password | **Optional.** The username's password. No value defined as default.
2811 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2812 vmware_subselect | **Optional.** Volume name to be checked the free space.
2813 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2814 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2815 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2816 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2817 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2818 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2819 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
2820 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2821 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2824 **vmware-esx-dc-runtime-info**
2826 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
2828 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2831 ------------------------|--------------
2832 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2833 vmware_cluster | **Optional.** ESX or ESXi clustername.
2834 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2835 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2836 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2837 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2838 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2839 vmware_sessionfile | **Optional.** Session file name enhancement.
2840 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2841 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2842 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2843 vmware_password | **Optional.** The username's password. No value defined as default.
2844 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2847 **vmware-esx-dc-runtime-listvms**
2849 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.
2851 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2854 ------------------------|--------------
2855 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2856 vmware_cluster | **Optional.** ESX or ESXi clustername.
2857 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2858 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2859 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2860 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2861 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2862 vmware_sessionfile | **Optional.** Session file name enhancement.
2863 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2864 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2865 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2866 vmware_password | **Optional.** The username's password. No value defined as default.
2867 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2868 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2869 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2870 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2871 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2872 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.
2875 **vmware-esx-dc-runtime-listhost**
2877 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
2879 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2882 ------------------------|--------------
2883 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2884 vmware_cluster | **Optional.** ESX or ESXi clustername.
2885 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2886 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2887 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2888 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2889 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2890 vmware_sessionfile | **Optional.** Session file name enhancement.
2891 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2892 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2893 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2894 vmware_password | **Optional.** The username's password. No value defined as default.
2895 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2896 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2897 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
2898 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
2899 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2900 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.
2903 **vmware-esx-dc-runtime-listcluster**
2905 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
2907 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2910 ------------------------|--------------
2911 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2912 vmware_cluster | **Optional.** ESX or ESXi clustername.
2913 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2914 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2915 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2916 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2917 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2918 vmware_sessionfile | **Optional.** Session file name enhancement.
2919 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2920 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2921 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2922 vmware_password | **Optional.** The username's password. No value defined as default.
2923 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2924 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2925 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
2926 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
2927 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2928 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.
2931 **vmware-esx-dc-runtime-issues**
2933 Check command object for the `check_vmware_esx` plugin. All issues for the host.
2935 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2938 ------------------------|--------------
2939 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2940 vmware_cluster | **Optional.** ESX or ESXi clustername.
2941 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2942 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2943 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2944 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2945 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2946 vmware_sessionfile | **Optional.** Session file name enhancement.
2947 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2948 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2949 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2950 vmware_password | **Optional.** The username's password. No value defined as default.
2951 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2952 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
2953 vmware_include | **Optional.** Whitelist issues. No value defined as default.
2954 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2955 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.
2958 **vmware-esx-dc-runtime-status**
2960 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2962 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2965 ------------------------|--------------
2966 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2967 vmware_cluster | **Optional.** ESX or ESXi clustername.
2968 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2969 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2970 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2971 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2972 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2973 vmware_sessionfile | **Optional.** Session file name enhancement.
2974 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2975 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2976 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2977 vmware_password | **Optional.** The username's password. No value defined as default.
2978 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2981 **vmware-esx-dc-runtime-tools**
2983 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
2985 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2988 ------------------------|--------------
2989 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2990 vmware_cluster | **Optional.** ESX or ESXi clustername.
2991 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2992 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2993 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2994 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2995 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2996 vmware_sessionfile | **Optional.** Session file name enhancement.
2997 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2998 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2999 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3000 vmware_password | **Optional.** The username's password. No value defined as default.
3001 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3002 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
3003 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
3004 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
3005 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
3006 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3007 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.
3008 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
3011 **vmware-esx-soap-host-check**
3013 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
3015 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3018 ------------------------|--------------
3019 vmware_host | **Required.** ESX or ESXi hostname.
3020 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3021 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3022 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3023 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3024 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3025 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3026 vmware_sessionfile | **Optional.** Session file name enhancement.
3027 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3028 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3029 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3030 vmware_password | **Optional.** The username's password. No value defined as default.
3031 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3034 **vmware-esx-soap-host-uptime**
3036 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
3038 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3041 ------------------------|--------------
3042 vmware_host | **Required.** ESX or ESXi hostname.
3043 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3044 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3045 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3046 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3047 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3048 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3049 vmware_sessionfile | **Optional.** Session file name enhancement.
3050 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3051 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3052 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3053 vmware_password | **Optional.** The username's password. No value defined as default.
3054 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3057 **vmware-esx-soap-host-cpu**
3059 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
3061 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3064 ------------------------|--------------
3065 vmware_host | **Required.** ESX or ESXi hostname.
3066 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3067 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3068 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3069 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3070 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3071 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3072 vmware_sessionfile | **Optional.** Session file name enhancement.
3073 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3074 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3075 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3076 vmware_password | **Optional.** The username's password. No value defined as default.
3077 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3078 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3079 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3082 **vmware-esx-soap-host-cpu-ready**
3084 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.
3086 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3089 ------------------------|--------------
3090 vmware_host | **Required.** ESX or ESXi hostname.
3091 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3092 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3093 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3094 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3095 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3096 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3097 vmware_sessionfile | **Optional.** Session file name enhancement.
3098 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3099 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3100 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3101 vmware_password | **Optional.** The username's password. No value defined as default.
3102 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3105 **vmware-esx-soap-host-cpu-wait**
3107 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.
3109 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3112 ------------------------|--------------
3113 vmware_host | **Required.** ESX or ESXi hostname.
3114 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3115 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3116 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3117 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3118 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3119 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3120 vmware_sessionfile | **Optional.** Session file name enhancement.
3121 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3122 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3123 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3124 vmware_password | **Optional.** The username's password. No value defined as default.
3125 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3128 **vmware-esx-soap-host-cpu-usage**
3130 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.
3132 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3135 ------------------------|--------------
3136 vmware_host | **Required.** ESX or ESXi hostname.
3137 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3138 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3139 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3140 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3141 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3142 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3143 vmware_sessionfile | **Optional.** Session file name enhancement.
3144 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3145 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3146 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3147 vmware_password | **Optional.** The username's password. No value defined as default.
3148 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3149 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3150 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3153 **vmware-esx-soap-host-mem**
3155 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3157 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3160 ------------------------|--------------
3161 vmware_host | **Required.** ESX or ESXi hostname.
3162 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3163 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3164 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3165 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3166 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3167 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3168 vmware_sessionfile | **Optional.** Session file name enhancement.
3169 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3170 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3171 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3172 vmware_password | **Optional.** The username's password. No value defined as default.
3173 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3176 **vmware-esx-soap-host-mem-usage**
3178 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3180 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3183 ------------------------|--------------
3184 vmware_host | **Required.** ESX or ESXi hostname.
3185 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3186 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3187 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3188 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3189 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3190 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3191 vmware_sessionfile | **Optional.** Session file name enhancement.
3192 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3193 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3194 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3195 vmware_password | **Optional.** The username's password. No value defined as default.
3196 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3197 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3198 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3201 **vmware-esx-soap-host-mem-consumed**
3203 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.
3205 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3208 ------------------------|--------------
3209 vmware_host | **Required.** ESX or ESXi hostname.
3210 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3211 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3212 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3213 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3214 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3215 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3216 vmware_sessionfile | **Optional.** Session file name enhancement.
3217 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3218 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3219 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3220 vmware_password | **Optional.** The username's password. No value defined as default.
3221 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3222 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3223 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3226 **vmware-esx-soap-host-mem-swapused**
3228 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.
3230 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3233 ------------------------|--------------
3234 vmware_host | **Required.** ESX or ESXi hostname.
3235 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3236 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3237 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3238 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3239 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3240 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3241 vmware_sessionfile | **Optional.** Session file name enhancement.
3242 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3243 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3244 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3245 vmware_password | **Optional.** The username's password. No value defined as default.
3246 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3247 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3248 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3249 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.
3252 **vmware-esx-soap-host-mem-overhead**
3254 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3256 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3259 ------------------------|--------------
3260 vmware_host | **Required.** ESX or ESXi hostname.
3261 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3262 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3263 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3264 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3265 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3266 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3267 vmware_sessionfile | **Optional.** Session file name enhancement.
3268 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3269 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3270 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3271 vmware_password | **Optional.** The username's password. No value defined as default.
3272 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3273 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3274 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3277 **vmware-esx-soap-host-mem-memctl**
3279 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.
3281 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3284 ------------------------|--------------
3285 vmware_host | **Required.** ESX or ESXi hostname.
3286 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3287 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3288 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3289 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3290 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3291 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3292 vmware_sessionfile | **Optional.** Session file name enhancement.
3293 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3294 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3295 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3296 vmware_password | **Optional.** The username's password. No value defined as default.
3297 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3298 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3299 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3300 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.
3303 **vmware-esx-soap-host-net**
3305 Check command object for the `check_vmware_esx` plugin. Shows net info.
3307 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3310 ------------------------|--------------
3311 vmware_host | **Required.** ESX or ESXi hostname.
3312 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3313 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3314 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3315 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3316 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3317 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3318 vmware_sessionfile | **Optional.** Session file name enhancement.
3319 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3320 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3321 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3322 vmware_password | **Optional.** The username's password. No value defined as default.
3323 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3324 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3325 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3328 **vmware-esx-soap-host-net-usage**
3330 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3332 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3335 ------------------------|--------------
3336 vmware_host | **Required.** ESX or ESXi hostname.
3337 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3338 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3339 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3340 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3341 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3342 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3343 vmware_sessionfile | **Optional.** Session file name enhancement.
3344 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3345 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3346 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3347 vmware_password | **Optional.** The username's password. No value defined as default.
3348 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3349 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3350 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3353 **vmware-esx-soap-host-net-receive**
3355 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
3357 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3360 ------------------------|--------------
3361 vmware_host | **Required.** ESX or ESXi hostname.
3362 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3363 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3364 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3365 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3366 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3367 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3368 vmware_sessionfile | **Optional.** Session file name enhancement.
3369 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3370 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3371 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3372 vmware_password | **Optional.** The username's password. No value defined as default.
3373 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3374 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3375 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3378 **vmware-esx-soap-host-net-send**
3380 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
3382 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3385 ------------------------|--------------
3386 vmware_host | **Required.** ESX or ESXi hostname.
3387 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3388 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3389 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3390 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3391 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3392 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3393 vmware_sessionfile | **Optional.** Session file name enhancement.
3394 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3395 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3396 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3397 vmware_password | **Optional.** The username's password. No value defined as default.
3398 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3399 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3400 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3403 **vmware-esx-soap-host-net-nic**
3405 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
3407 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3410 ------------------------|--------------
3411 vmware_host | **Required.** ESX or ESXi hostname.
3412 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3413 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3414 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3415 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3416 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3417 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3418 vmware_sessionfile | **Optional.** Session file name enhancement.
3419 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3420 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3421 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3422 vmware_password | **Optional.** The username's password. No value defined as default.
3423 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3424 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3425 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3428 **vmware-esx-soap-host-volumes**
3430 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
3432 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3435 ------------------------|--------------
3436 vmware_host | **Required.** ESX or ESXi hostname.
3437 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3438 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3439 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3440 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3441 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3442 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3443 vmware_sessionfile | **Optional.** Session file name enhancement.
3444 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3445 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3446 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3447 vmware_password | **Optional.** The username's password. No value defined as default.
3448 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3449 vmware_subselect | **Optional.** Volume name to be checked the free space.
3450 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3451 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3452 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3453 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3454 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3455 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3456 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3457 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3458 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
3461 **vmware-esx-soap-host-io**
3463 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.
3465 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3468 ------------------------|--------------
3469 vmware_host | **Required.** ESX or ESXi hostname.
3470 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3471 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3472 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3473 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3474 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3475 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3476 vmware_sessionfile | **Optional.** Session file name enhancement.
3477 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3478 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3479 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3480 vmware_password | **Optional.** The username's password. No value defined as default.
3481 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3484 **vmware-esx-soap-host-io-aborted**
3486 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
3488 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3491 ------------------------|--------------
3492 vmware_host | **Required.** ESX or ESXi hostname.
3493 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3494 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3495 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3496 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3497 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3498 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3499 vmware_sessionfile | **Optional.** Session file name enhancement.
3500 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3501 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3502 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3503 vmware_password | **Optional.** The username's password. No value defined as default.
3504 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3505 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3506 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3509 **vmware-esx-soap-host-io-resets**
3511 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
3513 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3516 ------------------------|--------------
3517 vmware_host | **Required.** ESX or ESXi hostname.
3518 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3519 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3520 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3521 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3522 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3523 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3524 vmware_sessionfile | **Optional.** Session file name enhancement.
3525 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3526 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3527 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3528 vmware_password | **Optional.** The username's password. No value defined as default.
3529 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3530 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3531 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3534 **vmware-esx-soap-host-io-read**
3536 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3538 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3541 ------------------------|--------------
3542 vmware_host | **Required.** ESX or ESXi hostname.
3543 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3544 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3545 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3546 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3547 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3548 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3549 vmware_sessionfile | **Optional.** Session file name enhancement.
3550 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3551 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3552 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3553 vmware_password | **Optional.** The username's password. No value defined as default.
3554 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3555 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3556 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3559 **vmware-esx-soap-host-io-read-latency**
3561 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.
3563 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3566 ------------------------|--------------
3567 vmware_host | **Required.** ESX or ESXi hostname.
3568 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3569 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3570 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3571 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3572 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3573 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3574 vmware_sessionfile | **Optional.** Session file name enhancement.
3575 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3576 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3577 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3578 vmware_password | **Optional.** The username's password. No value defined as default.
3579 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3580 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3581 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3584 **vmware-esx-soap-host-io-write**
3586 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3588 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3591 ------------------------|--------------
3592 vmware_host | **Required.** ESX or ESXi hostname.
3593 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3594 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3595 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3596 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3597 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3598 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3599 vmware_sessionfile | **Optional.** Session file name enhancement.
3600 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3601 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3602 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3603 vmware_password | **Optional.** The username's password. No value defined as default.
3604 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3605 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3606 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3609 **vmware-esx-soap-host-io-write-latency**
3611 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.
3613 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3616 ------------------------|--------------
3617 vmware_host | **Required.** ESX or ESXi hostname.
3618 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3619 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3620 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3621 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3622 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3623 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3624 vmware_sessionfile | **Optional.** Session file name enhancement.
3625 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3626 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3627 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3628 vmware_password | **Optional.** The username's password. No value defined as default.
3629 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3630 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3631 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3634 **vmware-esx-soap-host-io-usage**
3636 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.
3638 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3641 ------------------------|--------------
3642 vmware_host | **Required.** ESX or ESXi hostname.
3643 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3644 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3645 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3646 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3647 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3648 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3649 vmware_sessionfile | **Optional.** Session file name enhancement.
3650 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3651 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3652 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3653 vmware_password | **Optional.** The username's password. No value defined as default.
3654 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3655 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3656 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3659 **vmware-esx-soap-host-io-kernel-latency**
3661 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
3663 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3666 ------------------------|--------------
3667 vmware_host | **Required.** ESX or ESXi hostname.
3668 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3669 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3670 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3671 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3672 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3673 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3674 vmware_sessionfile | **Optional.** Session file name enhancement.
3675 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3676 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3677 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3678 vmware_password | **Optional.** The username's password. No value defined as default.
3679 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3680 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3681 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3684 **vmware-esx-soap-host-io-device-latency**
3686 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
3688 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3691 ------------------------|--------------
3692 vmware_host | **Required.** ESX or ESXi hostname.
3693 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3694 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3695 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3696 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3697 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3698 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3699 vmware_sessionfile | **Optional.** Session file name enhancement.
3700 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3701 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3702 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3703 vmware_password | **Optional.** The username's password. No value defined as default.
3704 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3705 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3706 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3709 **vmware-esx-soap-host-io-queue-latency**
3711 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
3713 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3716 ------------------------|--------------
3717 vmware_host | **Required.** ESX or ESXi hostname.
3718 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3719 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3720 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3721 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3722 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3723 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3724 vmware_sessionfile | **Optional.** Session file name enhancement.
3725 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3726 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3727 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3728 vmware_password | **Optional.** The username's password. No value defined as default.
3729 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3730 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3731 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3734 **vmware-esx-soap-host-io-total-latency**
3736 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.
3738 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3741 ------------------------|--------------
3742 vmware_host | **Required.** ESX or ESXi hostname.
3743 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3744 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3745 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3746 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3747 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3748 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3749 vmware_sessionfile | **Optional.** Session file name enhancement.
3750 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3751 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3752 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3753 vmware_password | **Optional.** The username's password. No value defined as default.
3754 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3755 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3756 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3759 **vmware-esx-soap-host-media**
3761 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.
3763 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3766 ------------------------|--------------
3767 vmware_host | **Required.** ESX or ESXi hostname.
3768 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3769 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3770 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3771 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3772 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3773 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3774 vmware_sessionfile | **Optional.** Session file name enhancement.
3775 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3776 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3777 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3778 vmware_password | **Optional.** The username's password. No value defined as default.
3779 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3780 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3781 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3782 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3783 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.
3786 **vmware-esx-soap-host-service**
3788 Check command object for the `check_vmware_esx` plugin. Shows host service info.
3790 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3793 ------------------------|--------------
3794 vmware_host | **Required.** ESX or ESXi hostname.
3795 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3796 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3797 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3798 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3799 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3800 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3801 vmware_sessionfile | **Optional.** Session file name enhancement.
3802 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3803 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3804 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3805 vmware_password | **Optional.** The username's password. No value defined as default.
3806 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3807 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
3808 vmware_include | **Optional.** Whitelist services name. No value defined as default.
3809 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3810 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.
3813 **vmware-esx-soap-host-runtime**
3815 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.
3817 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3820 ------------------------|--------------
3821 vmware_host | **Required.** ESX or ESXi hostname.
3822 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3823 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3824 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3825 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3826 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3827 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3828 vmware_sessionfile | **Optional.** Session file name enhancement.
3829 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3830 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3831 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3832 vmware_password | **Optional.** The username's password. No value defined as default.
3833 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3836 **vmware-esx-soap-host-runtime-con**
3838 Check command object for the `check_vmware_esx` plugin. Shows connection state.
3840 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3843 ------------------------|--------------
3844 vmware_host | **Required.** ESX or ESXi hostname.
3845 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3846 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3847 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3848 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3849 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3850 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3851 vmware_sessionfile | **Optional.** Session file name enhancement.
3852 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3853 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3854 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3855 vmware_password | **Optional.** The username's password. No value defined as default.
3856 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3859 **vmware-esx-soap-host-runtime-listvms**
3861 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
3863 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3866 ------------------------|--------------
3867 vmware_host | **Required.** ESX or ESXi hostname.
3868 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3869 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3870 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3871 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3872 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3873 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3874 vmware_sessionfile | **Optional.** Session file name enhancement.
3875 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3876 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3877 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3878 vmware_password | **Optional.** The username's password. No value defined as default.
3879 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3880 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3881 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3882 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3883 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.
3886 **vmware-esx-soap-host-runtime-status**
3888 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3890 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3893 ------------------------|--------------
3894 vmware_host | **Required.** ESX or ESXi hostname.
3895 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3896 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3897 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3898 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3899 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3900 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3901 vmware_sessionfile | **Optional.** Session file name enhancement.
3902 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3903 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3904 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3905 vmware_password | **Optional.** The username's password. No value defined as default.
3906 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3909 **vmware-esx-soap-host-runtime-health**
3911 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
3913 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3916 ------------------------|--------------
3917 vmware_host | **Required.** ESX or ESXi hostname.
3918 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3919 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3920 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3921 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3922 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3923 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3924 vmware_sessionfile | **Optional.** Session file name enhancement.
3925 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3926 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3927 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3928 vmware_password | **Optional.** The username's password. No value defined as default.
3929 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3930 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3931 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3932 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3935 **vmware-esx-soap-host-runtime-health-listsensors**
3937 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
3939 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3942 ------------------------|--------------
3943 vmware_host | **Required.** ESX or ESXi hostname.
3944 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3945 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3946 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3947 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3948 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3949 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3950 vmware_sessionfile | **Optional.** Session file name enhancement.
3951 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3952 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3953 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3954 vmware_password | **Optional.** The username's password. No value defined as default.
3955 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3956 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3957 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3958 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3961 **vmware-esx-soap-host-runtime-health-nostoragestatus**
3963 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**.
3965 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3968 ------------------------|--------------
3969 vmware_host | **Required.** ESX or ESXi hostname.
3970 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3971 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3972 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3973 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3974 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3975 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3976 vmware_sessionfile | **Optional.** Session file name enhancement.
3977 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3978 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3979 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3980 vmware_password | **Optional.** The username's password. No value defined as default.
3981 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3982 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3983 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3984 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3987 **vmware-esx-soap-host-runtime-storagehealth**
3989 Check command object for the `check_vmware_esx` plugin. Local storage status check.
3991 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3994 ------------------------|--------------
3995 vmware_host | **Required.** ESX or ESXi hostname.
3996 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3997 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3998 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3999 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4000 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4001 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4002 vmware_sessionfile | **Optional.** Session file name enhancement.
4003 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4004 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4005 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4006 vmware_password | **Optional.** The username's password. No value defined as default.
4007 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4008 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
4009 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
4010 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4011 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.
4014 **vmware-esx-soap-host-runtime-temp**
4016 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
4018 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4021 ------------------------|--------------
4022 vmware_host | **Required.** ESX or ESXi hostname.
4023 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4024 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4025 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4026 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4027 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4028 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4029 vmware_sessionfile | **Optional.** Session file name enhancement.
4030 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4031 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4032 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4033 vmware_password | **Optional.** The username's password. No value defined as default.
4034 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4035 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
4036 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
4037 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4038 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.
4041 **vmware-esx-soap-host-runtime-issues**
4043 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
4045 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4048 ------------------------|--------------
4049 vmware_host | **Required.** ESX or ESXi hostname.
4050 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4051 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4052 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4053 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4054 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4055 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4056 vmware_sessionfile | **Optional.** Session file name enhancement.
4057 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4058 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4059 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4060 vmware_password | **Optional.** The username's password. No value defined as default.
4061 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4062 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
4063 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
4064 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4065 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.
4068 **vmware-esx-soap-host-storage**
4070 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
4072 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4075 ------------------------|--------------
4076 vmware_host | **Required.** ESX or ESXi hostname.
4077 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4078 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4079 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4080 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4081 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4082 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4083 vmware_sessionfile | **Optional.** Session file name enhancement.
4084 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4085 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4086 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4087 vmware_password | **Optional.** The username's password. No value defined as default.
4088 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4089 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
4090 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
4091 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4094 **vmware-esx-soap-host-storage-adapter**
4096 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
4098 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4101 ------------------------|--------------
4102 vmware_host | **Required.** ESX or ESXi hostname.
4103 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4104 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4105 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4106 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4107 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4108 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4109 vmware_sessionfile | **Optional.** Session file name enhancement.
4110 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4111 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4112 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4113 vmware_password | **Optional.** The username's password. No value defined as default.
4114 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4115 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
4116 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
4117 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4118 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.
4121 **vmware-esx-soap-host-storage-lun**
4123 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.
4125 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4128 ------------------------|--------------
4129 vmware_host | **Required.** ESX or ESXi hostname.
4130 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4131 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4132 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4133 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4134 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4135 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4136 vmware_sessionfile | **Optional.** Session file name enhancement.
4137 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4138 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4139 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4140 vmware_password | **Optional.** The username's password. No value defined as default.
4141 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4142 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
4143 vmware_include | **Optional.** Whitelist luns. No value defined as default.
4144 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4145 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.
4148 **vmware-esx-soap-host-storage-path**
4150 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
4152 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4155 ------------------------|--------------
4156 vmware_host | **Required.** ESX or ESXi hostname.
4157 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4158 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4159 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4160 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4161 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4162 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4163 vmware_sessionfile | **Optional.** Session file name enhancement.
4164 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4165 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4166 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4167 vmware_password | **Optional.** The username's password. No value defined as default.
4168 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4169 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4170 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4171 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4172 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4173 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.
4176 **vmware-esx-soap-vm-cpu**
4178 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4180 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4183 ------------------------|--------------
4184 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4185 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4186 vmware_vmname | **Required.** Virtual machine name.
4187 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4188 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4189 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4190 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4191 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4192 vmware_sessionfile | **Optional.** Session file name enhancement.
4193 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4194 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4195 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4196 vmware_password | **Optional.** The username's password. No value defined as default.
4197 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4201 **vmware-esx-soap-vm-cpu-ready**
4203 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.
4205 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4208 ------------------------|--------------
4209 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4210 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4211 vmware_vmname | **Required.** Virtual machine name.
4212 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4213 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4214 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4215 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4216 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4217 vmware_sessionfile | **Optional.** Session file name enhancement.
4218 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4219 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4220 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4221 vmware_password | **Optional.** The username's password. No value defined as default.
4222 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4223 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4224 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4227 **vmware-esx-soap-vm-cpu-wait**
4229 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.
4231 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4234 ------------------------|--------------
4235 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4236 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4237 vmware_vmname | **Required.** Virtual machine name.
4238 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4239 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4240 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4241 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4242 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4243 vmware_sessionfile | **Optional.** Session file name enhancement.
4244 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4245 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4246 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4247 vmware_password | **Optional.** The username's password. No value defined as default.
4248 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4249 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4250 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4253 **vmware-esx-soap-vm-cpu-usage**
4255 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.
4257 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4260 ------------------------|--------------
4261 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4262 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4263 vmware_vmname | **Required.** Virtual machine name.
4264 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4265 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4266 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4267 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4268 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4269 vmware_sessionfile | **Optional.** Session file name enhancement.
4270 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4271 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4272 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4273 vmware_password | **Optional.** The username's password. No value defined as default.
4274 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4275 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4276 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4279 **vmware-esx-soap-vm-mem**
4281 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4283 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4286 ------------------------|--------------
4287 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4288 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4289 vmware_vmname | **Required.** Virtual machine name.
4290 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4291 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4292 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4293 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4294 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4295 vmware_sessionfile | **Optional.** Session file name enhancement.
4296 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4297 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4298 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4299 vmware_password | **Optional.** The username's password. No value defined as default.
4300 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4303 **vmware-esx-soap-vm-mem-usage**
4305 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4307 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4310 ------------------------|--------------
4311 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4312 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4313 vmware_vmname | **Required.** Virtual machine name.
4314 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4315 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4316 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4317 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4318 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4319 vmware_sessionfile | **Optional.** Session file name enhancement.
4320 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4321 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4322 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4323 vmware_password | **Optional.** The username's password. No value defined as default.
4324 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4325 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4326 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4329 **vmware-esx-soap-vm-mem-consumed**
4331 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>
4332 **vm consumed memory = memory granted -- memory saved**
4334 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4337 ------------------------|--------------
4338 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4339 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4340 vmware_vmname | **Required.** Virtual machine name.
4341 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4342 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4343 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4344 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4345 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4346 vmware_sessionfile | **Optional.** Session file name enhancement.
4347 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4348 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4349 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4350 vmware_password | **Optional.** The username's password. No value defined as default.
4351 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4352 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4353 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4356 **vmware-esx-soap-vm-mem-memctl**
4358 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.
4360 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4363 ------------------------|--------------
4364 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4365 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4366 vmware_vmname | **Required.** Virtual machine name.
4367 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4368 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4369 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4370 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4371 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4372 vmware_sessionfile | **Optional.** Session file name enhancement.
4373 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4374 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4375 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4376 vmware_password | **Optional.** The username's password. No value defined as default.
4377 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4378 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4379 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4383 **vmware-esx-soap-vm-net**
4385 Check command object for the `check_vmware_esx` plugin. Shows net info.
4387 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4390 ------------------------|--------------
4391 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4392 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4393 vmware_vmname | **Required.** Virtual machine name.
4394 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4395 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4396 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4397 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4398 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4399 vmware_sessionfile | **Optional.** Session file name enhancement.
4400 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4401 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4402 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4403 vmware_password | **Optional.** The username's password. No value defined as default.
4404 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4407 **vmware-esx-soap-vm-net-usage**
4409 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4411 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4414 ------------------------|--------------
4415 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4416 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4417 vmware_vmname | **Required.** Virtual machine name.
4418 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4419 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4420 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4421 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4422 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4423 vmware_sessionfile | **Optional.** Session file name enhancement.
4424 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4425 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4426 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4427 vmware_password | **Optional.** The username's password. No value defined as default.
4428 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4429 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4430 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4433 **vmware-esx-soap-vm-net-receive**
4435 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
4437 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4440 ------------------------|--------------
4441 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4442 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4443 vmware_vmname | **Required.** Virtual machine name.
4444 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4445 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4446 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4447 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4448 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4449 vmware_sessionfile | **Optional.** Session file name enhancement.
4450 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4451 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4452 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4453 vmware_password | **Optional.** The username's password. No value defined as default.
4454 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4455 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4456 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4459 **vmware-esx-soap-vm-net-send**
4461 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
4463 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4466 ------------------------|--------------
4467 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4468 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4469 vmware_vmname | **Required.** Virtual machine name.
4470 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4471 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4472 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4473 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4474 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4475 vmware_sessionfile | **Optional.** Session file name enhancement.
4476 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4477 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4478 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4479 vmware_password | **Optional.** The username's password. No value defined as default.
4480 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4481 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4482 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4485 **vmware-esx-soap-vm-io**
4487 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.
4489 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4492 ------------------------|--------------
4493 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4494 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4495 vmware_vmname | **Required.** Virtual machine name.
4496 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4497 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4498 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4499 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4500 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4501 vmware_sessionfile | **Optional.** Session file name enhancement.
4502 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4503 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4504 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4505 vmware_password | **Optional.** The username's password. No value defined as default.
4506 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4509 **vmware-esx-soap-vm-io-read**
4511 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4513 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4516 ------------------------|--------------
4517 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4518 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4519 vmware_vmname | **Required.** Virtual machine name.
4520 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4521 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4522 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4523 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4524 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4525 vmware_sessionfile | **Optional.** Session file name enhancement.
4526 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4527 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4528 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4529 vmware_password | **Optional.** The username's password. No value defined as default.
4530 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4531 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4532 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4535 **vmware-esx-soap-vm-io-write**
4537 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4539 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4542 ------------------------|--------------
4543 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4544 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4545 vmware_vmname | **Required.** Virtual machine name.
4546 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4547 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4548 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4549 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4550 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4551 vmware_sessionfile | **Optional.** Session file name enhancement.
4552 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4553 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4554 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4555 vmware_password | **Optional.** The username's password. No value defined as default.
4556 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4557 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4558 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4561 **vmware-esx-soap-vm-io-usage**
4563 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
4565 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4568 ------------------------|--------------
4569 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4570 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4571 vmware_vmname | **Required.** Virtual machine name.
4572 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4573 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4574 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4575 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4576 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4577 vmware_sessionfile | **Optional.** Session file name enhancement.
4578 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4579 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4580 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4581 vmware_password | **Optional.** The username's password. No value defined as default.
4582 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4583 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4584 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4587 **vmware-esx-soap-vm-runtime**
4589 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
4591 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4594 ------------------------|--------------
4595 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4596 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4597 vmware_vmname | **Required.** Virtual machine name.
4598 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4599 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4600 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4601 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4602 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4603 vmware_sessionfile | **Optional.** Session file name enhancement.
4604 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4605 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4606 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4607 vmware_password | **Optional.** The username's password. No value defined as default.
4608 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4611 **vmware-esx-soap-vm-runtime-con**
4613 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
4615 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4618 ------------------------|--------------
4619 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4620 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4621 vmware_vmname | **Required.** Virtual machine name.
4622 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4623 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4624 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4625 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4626 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4627 vmware_sessionfile | **Optional.** Session file name enhancement.
4628 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4629 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4630 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4631 vmware_password | **Optional.** The username's password. No value defined as default.
4632 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4635 **vmware-esx-soap-vm-runtime-powerstate**
4637 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
4639 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4642 ------------------------|--------------
4643 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4644 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4645 vmware_vmname | **Required.** Virtual machine name.
4646 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4647 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4648 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4649 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4650 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4651 vmware_sessionfile | **Optional.** Session file name enhancement.
4652 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4653 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4654 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4655 vmware_password | **Optional.** The username's password. No value defined as default.
4656 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4659 **vmware-esx-soap-vm-runtime-status**
4661 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4663 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4666 ------------------------|--------------
4667 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4668 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4669 vmware_vmname | **Required.** Virtual machine name.
4670 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4671 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4672 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4673 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4674 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4675 vmware_sessionfile | **Optional.** Session file name enhancement.
4676 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4677 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4678 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4679 vmware_password | **Optional.** The username's password. No value defined as default.
4680 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4683 **vmware-esx-soap-vm-runtime-consoleconnections**
4685 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
4687 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4690 ------------------------|--------------
4691 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4692 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4693 vmware_vmname | **Required.** Virtual machine name.
4694 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4695 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4696 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4697 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4698 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4699 vmware_sessionfile | **Optional.** Session file name enhancement.
4700 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4701 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4702 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4703 vmware_password | **Optional.** The username's password. No value defined as default.
4704 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4705 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4706 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4709 **vmware-esx-soap-vm-runtime-gueststate**
4711 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
4713 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4716 ------------------------|--------------
4717 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4718 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4719 vmware_vmname | **Required.** Virtual machine name.
4720 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4721 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4722 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4723 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4724 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4725 vmware_sessionfile | **Optional.** Session file name enhancement.
4726 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4727 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4728 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4729 vmware_password | **Optional.** The username's password. No value defined as default.
4730 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4732 **vmware-esx-soap-vm-runtime-tools**
4734 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
4736 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4739 ------------------------|--------------
4740 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4741 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4742 vmware_vmname | **Required.** Virtual machine name.
4743 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4744 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4745 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4746 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4747 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4748 vmware_sessionfile | **Optional.** Session file name enhancement.
4749 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4750 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4751 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4752 vmware_password | **Optional.** The username's password. No value defined as default.
4753 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4754 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
4757 **vmware-esx-soap-vm-runtime-issues**
4759 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
4761 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4764 ------------------------|--------------
4765 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4766 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4767 vmware_vmname | **Required.** Virtual machine name.
4768 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4769 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4770 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4771 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4772 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4773 vmware_sessionfile | **Optional.** Session file name enhancement.
4774 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4775 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4776 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4777 vmware_password | **Optional.** The username's password. No value defined as default.
4778 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4779 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.
4782 ### <a id="plugin-contrib-web"></a> Web
4784 This category includes all plugins for web-based checks.
4786 #### <a id="plugin-contrib-command-webinject"></a> webinject
4788 The [check_webinject](https://labs.consol.de/de/nagios/check_webinject/index.html) plugin
4789 uses [WebInject](https://www.webinject.org/manual.html) to test web applications
4790 and web services in an automated fashion.
4791 It can be used to test individual system components that have HTTP interfaces
4792 (JSP, ASP, CGI, PHP, AJAX, Servlets, HTML Forms, XML/SOAP Web Services, REST, etc),
4793 and can be used as a test harness to create a suite of HTTP level automated functional,
4794 acceptance, and regression tests. A test harness allows you to run many test cases
4795 and collect/report your results. WebInject offers real-time results
4796 display and may also be used for monitoring system response times.
4798 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4801 ------------------------|--------------
4802 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.
4803 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.
4804 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
4805 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.
4806 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.
4807 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.
4809 #### <a id="plugin-contrib-command-jmx4perl"></a> jmx4perl
4811 The [check_jmx4perl](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl) plugin
4812 uses the HTTP API exposed by the [Jolokia](https://jolokia.org)
4813 web application and queries Java message beans on an application server. It is
4814 part of the `JMX::Jmx4Perl` Perl module which includes detailed
4815 [documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl).
4817 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4820 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
4821 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
4822 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
4823 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.
4824 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
4825 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
4826 jmx4perl_operation | **Optional.** Operation to execute.
4827 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
4828 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
4829 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
4830 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
4831 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
4832 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
4833 jmx4perl_proxy | **Optional.** Proxy to use.
4834 jmx4perl_user | **Optional.** User for HTTP authentication.
4835 jmx4perl_password | **Optional.** Password for HTTP authentication.
4836 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
4837 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
4838 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.
4839 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
4840 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
4841 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
4842 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.
4843 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
4844 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
4845 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
4846 jmx4perl_critical | **Optional.** Critical threshold for value.
4847 jmx4perl_warning | **Optional.** Warning threshold for value.
4848 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
4849 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
4850 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
4851 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
4852 jmx4perl_config | **Optional.** Path to configuration file.
4853 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
4854 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
4856 #### <a id="plugin-contrib-command-squid"></a> squid
4858 The [check_squid](https://exchange.icinga.com/exchange/check_squid) plugin
4859 uses the `squidclient` binary to monitor a [Squid proxy](http://www.squid-cache.org).
4861 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4864 ------------------------|----------------------------------------------------------------------------------
4865 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
4866 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
4867 squid_port | **Optional.** Port number (default: 3128).
4868 squid_user | **Optional.** WWW user
4869 squid_password | **Optional.** WWW password
4870 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4871 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4872 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
4873 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
4876 #### <a id="plugin-contrib-command-nginx_status"></a> nginx_status
4878 The [check_nginx_status.pl](https://github.com/regilero/check_nginx_status) plugin
4879 uses the [/nginx_status](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
4880 HTTP endpoint which provides metrics for monitoring Nginx.
4882 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4885 --------------------------------|----------------------------------------------------------------------------------
4886 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4887 nginx_status_port | **Optional.** the http port.
4888 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
4889 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
4890 nginx_status_ssl | **Optional.** set to use ssl connection
4891 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
4892 nginx_status_user | **Optional.** Username for basic auth
4893 nginx_status_pass | **Optional.** Password for basic auth
4894 nginx_status_realm | **Optional.** Realm for basic auth
4895 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
4896 nginx_status_timeout | **Optional.** timeout in seconds
4897 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
4898 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
4901 #### <a id="plugin-contrib-command-apache_status"></a> apache_status
4903 The [check_apache_status.pl](https://github.com/lbetz/check_apache_status) plugin
4904 uses the [/server-status](https://httpd.apache.org/docs/current/mod/mod_status.html)
4905 HTTP endpoint to monitor status metrics for the Apache webserver.
4907 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4910 ------------------------|----------------------------------------------------------------------------------
4911 apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4912 apache_status_port | **Optional.** the http port.
4913 apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
4914 apache_status_ssl | **Optional.** set to use ssl connection
4915 apache_status_timeout | **Optional.** timeout in seconds
4916 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
4917 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
4920 #### <a id="plugin-contrib-command-kdc"></a> kdc
4922 The [check_kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details) plugin
4923 uses the Kerberos `kinit` binary to monitor Kerberos 5 KDC by acquiring a ticket.
4925 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4928 ----------------|--------------------------------------------------------------------------
4929 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4930 kdc_port | **Optional** Port on which KDC runs (default 88).
4931 kdc_principal | **Required** Principal name to authenticate as (including realm).
4932 kdc_keytab | **Required** Keytab file containing principal's key.
4935 #### <a id="plugin-contrib-command-rbl"></a> rbl
4937 The [check_rbl](https://github.com/matteocorti/check_rbl) plugin
4938 uses the `Net::DNS` Perl library to check whether your SMTP server
4941 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4944 ----------------|--------------------------------------------------------------------------
4945 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.
4946 rbl_server | **Required** List of RBL servers as an array.
4947 rbl_warning | **Optional** Number of blacklisting servers for a warning.
4948 rbl_critical | **Optional** Number of blacklisting servers for a critical.
4949 tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
projects / icinga2 / blob