1 # Icinga Template Library <a id="icinga-template-library"></a>
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 ## Generic Templates <a id="itl-generic-templates"></a>
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 ### plugin-check-command <a id="itl-plugin-check-command"></a>
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](09-object-types.md#objecttype-checkcommand) definitions.
27 ### plugin-notification-command <a id="itl-plugin-notification-command"></a>
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 [NotificationCommand](09-object-types.md#objecttype-notificationcommand) definitions.
35 ### plugin-event-command <a id="itl-plugin-event-command"></a>
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 [EventCommand](09-object-types.md#objecttype-eventcommand) definitions.
43 ### legacy-timeperiod <a id="itl-legacy-timeperiod"></a>
45 Timeperiod template for [Timeperiod objects](09-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 [TimePeriod](09-object-types.md#objecttype-timeperiod) definitions.
51 ## Check Commands <a id="itl-check-commands"></a>
53 These check commands are embedded into Icinga 2 and do not require any external
56 ### icinga <a id="itl-icinga"></a>
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 ### cluster <a id="itl-icinga-cluster"></a>
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 ### cluster-zone <a id="itl-icinga-cluster-zone"></a>
72 Check command for the built-in `cluster-zone` check.
74 Custom attributes passed as [command parameters](03-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 ### ido <a id="itl-icinga-ido"></a>
84 Check command for the built-in `ido` check.
86 Custom attributes passed as [command parameters](03-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 ### random <a id="itl-random"></a>
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 ### exception <a id="itl-exception"></a>
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 # Plugin Check Commands <a id="plugin-check-commands"></a>
110 ## Plugin Check Commands for Monitoring Plugins <a id="plugin-check-commands-monitoring-plugins"></a>
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 ### apt <a id="plugin-check-command-apt"></a>
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](03-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 ### breeze <a id="plugin-check-command-breeze"></a>
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](03-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 ### by_ssh <a id="plugin-check-command-by-ssh"></a>
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](03-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 ### clamd <a id="plugin-check-command-clamd"></a>
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](03-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 ### dhcp <a id="plugin-check-command-dhcp"></a>
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](03-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 ### dig <a id="plugin-check-command-dig"></a>
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](03-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 ### disk <a id="plugin-check-command-disk"></a>
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](03-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 ### disk_smb <a id="plugin-check-command-disk-smb"></a>
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](03-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 ### dns <a id="plugin-check-command-dns"></a>
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](03-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_accept_cname | **Optional.** Accept cname responses as a valid result to a query.
329 dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
330 dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
331 dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
334 ### dummy <a id="plugin-check-command-dummy"></a>
336 The [check_dummy](https://www.monitoring-plugins.org/doc/man/check_dummy.html) plugin
337 will simply return the state corresponding to the numeric value of the `dummy_state`
338 argument with optional text.
340 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
343 ----------------|--------------
344 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
345 dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
348 ### file_age <a id="plugin-check-command-file-age"></a>
350 The [check_file_age](https://www.monitoring-plugins.org/doc/man/check_file_age.html) plugin
351 checks a file's size and modification time to make sure it's not empty and that it's sufficiently recent.
353 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
356 -----------------------|--------------------------------------------------------------------------------------------------------
357 file_age_file | **Required.** File to monitor.
358 file_age_warning_time | **Optional.** File must be no more than this many seconds old as warning threshold. Defaults to "240s".
359 file_age_critical_time | **Optional.** File must be no more than this many seconds old as critical threshold. Defaults to "600s".
360 file_age_warning_size | **Optional.** File must be at least this many bytes long as warning threshold. No default given.
361 file_age_critical_size | **Optional.** File must be at least this many bytes long as critical threshold. Defaults to "0B".
362 file_age_ignoremissing | **Optional.** Return OK if the file does not exist. Defaults to false.
365 ### flexlm <a id="plugin-check-command-flexlm"></a>
367 The [check_flexlm](https://www.monitoring-plugins.org/doc/man/check_flexlm.html) plugin
368 checks available flexlm license managers. Requires the `lmstat` command.
370 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
373 -------------------|----------------------------------------------------------
374 flexlm_licensefile | **Required.** Name of license file (usually license.dat).
375 flexlm_timeout | **Optional.** Plugin time out in seconds. Defaults to 15.
378 ### fping4 <a id="plugin-check-command-fping4"></a>
380 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
381 uses the `fping` command to ping the specified host for a fast check. Note that it is
382 necessary to set the suid flag on fping.
384 This CheckCommand expects an IPv4 address.
386 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
389 ----------------|--------------
390 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
391 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
392 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
393 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
394 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
395 fping_number | **Optional.** The number of packets to send. Defaults to 5.
396 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
397 fping_bytes | **Optional.** The size of ICMP packet.
398 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
399 fping_source_ip | **Optional.** The name or ip address of the source ip.
400 fping_source_interface | **Optional.** The source interface name.
403 ### fping6 <a id="plugin-check-command-fping6"></a>
405 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
406 will use the `fping` command to ping the specified host for a fast check. Note that it is
407 necessary to set the suid flag on fping.
409 This CheckCommand expects an IPv6 address.
411 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
414 ----------------|--------------
415 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
416 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
417 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
418 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
419 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
420 fping_number | **Optional.** The number of packets to send. Defaults to 5.
421 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
422 fping_bytes | **Optional.** The size of ICMP packet.
423 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
424 fping_source_ip | **Optional.** The name or ip address of the source ip.
425 fping_source_interface | **Optional.** The source interface name.
428 ### ftp <a id="plugin-check-command-ftp"></a>
430 The [check_ftp](https://www.monitoring-plugins.org/doc/man/check_ftp.html) plugin
431 tests FTP connections with the specified host (or unix socket).
433 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
436 -------------------|--------------
437 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
438 ftp_port | **Optional.** The FTP port number.
439 ftp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
440 ftp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
441 ftp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
442 ftp_send | **Optional.** String to send to the server.
443 ftp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
444 ftp_quit | **Optional.** String to send server to initiate a clean close of the connection.
445 ftp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
446 ftp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
447 ftp_jail | **Optional.** Hide output from TCP socket.
448 ftp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
449 ftp_delay | **Optional.** Seconds to wait between sending string and polling for response.
450 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.
451 ftp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
452 ftp_wtime | **Optional.** Response time to result in warning status (seconds).
453 ftp_ctime | **Optional.** Response time to result in critical status (seconds).
454 ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
455 ftp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
456 ftp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
459 ### game <a id="plugin-check-command-game"></a>
461 The [check_game](https://www.monitoring-plugins.org/doc/man/check_game.html) plugin
462 tests game server connections with the specified host.
463 This plugin uses the 'qstat' command, the popular game server status query tool.
464 If you don't have the package installed, you will need to [download](http://www.activesw.com/people/steve/qstat.html)
465 or install the package `quakestat` before you can use this plugin.
467 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
470 -------------------|-------------------
471 game_game | **Required.** Name of the game.
472 game_ipaddress | **Required.** Ipaddress of the game server to query.
473 game_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
474 game_port | **Optional.** Port to connect to.
475 game_gamefield | **Optional.** Field number in raw qstat output that contains game name.
476 game_mapfield | **Optional.** Field number in raw qstat output that contains map name.
477 game_pingfield | **Optional.** Field number in raw qstat output that contains ping time.
478 game_gametime | **Optional.** Field number in raw qstat output that contains game time.
479 game_hostname | **Optional.** Name of the host running the game.
482 ### hostalive <a id="plugin-check-command-hostalive"></a>
484 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
485 plugin with host check default values. This variant uses the host's `address` attribute
486 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
488 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
491 ----------------|--------------
492 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
493 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
494 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
495 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
496 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
497 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
498 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
501 ### hostalive4 <a id="plugin-check-command-hostalive4"></a>
503 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
504 plugin with host check default values. This variant uses the host's `address` attribute.
506 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
509 ----------------|--------------
510 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
511 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
512 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
513 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
514 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
515 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
516 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
519 ### hostalive6 <a id="plugin-check-command-hostalive6"></a>
521 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
522 plugin with host check default values. This variant uses the host's `address6` attribute.
524 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
527 ----------------|--------------
528 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
529 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
530 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
531 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
532 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
533 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
534 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
537 ### hpjd <a id="plugin-check-command-hpjd"></a>
539 The [check_hpjd](https://www.monitoring-plugins.org/doc/man/check_hpjd.html) plugin
540 tests the state of an HP printer with a JetDirect card. Net-snmp must be installed
541 on the computer running the plugin.
543 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
546 ----------------|--------------
547 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
548 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
549 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
552 ### http <a id="plugin-check-command-http"></a>
554 The [check_http](https://www.monitoring-plugins.org/doc/man/check_http.html) plugin
555 tests the HTTP service on the specified host. It can test normal (http) and secure
556 (https) servers, follow redirects, search for strings and regular expressions,
557 check connection times, and report on certificate expiration times.
559 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
562 ---------------------------------|---------------------------------
563 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
564 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
565 http_uri | **Optional.** The request URI for GET or POST. Defaults to `/`.
566 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
567 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
568 http_ssl_force_tlsv1 | **Optional.** Whether to force TLSv1.
569 http_ssl_force_tlsv1_1 | **Optional.** Whether to force TLSv1.1.
570 http_ssl_force_tlsv1_2 | **Optional.** Whether to force TLSv1.2.
571 http_ssl_force_sslv2 | **Optional.** Whether to force SSLv2.
572 http_ssl_force_sslv3 | **Optional.** Whether to force SSLv3.
573 http_ssl_force_tlsv1_or_higher | **Optional.** Whether to force TLSv1 or higher.
574 http_ssl_force_tlsv1_1_or_higher | **Optional.** Whether to force TLSv1.1 or higher.
575 http_ssl_force_tlsv1_2_or_higher | **Optional.** Whether to force TLSv1.2 or higher.
576 http_ssl_force_sslv2_or_higher | **Optional.** Whether to force SSLv2 or higher.
577 http_ssl_force_sslv3_or_higher | **Optional.** Whether to force SSLv3 or higher.
578 http_sni | **Optional.** Whether to use SNI. Defaults to false.
579 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
580 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
581 http_ignore_body | **Optional.** Don't download the body, just the headers.
582 http_linespan | **Optional.** Allow regex to span newline.
583 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
584 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
585 http_invertregex | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
586 http_warn_time | **Optional.** The warning threshold.
587 http_critical_time | **Optional.** The critical threshold.
588 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.
589 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.
590 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
591 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
592 http_headerstring | **Optional.** String to expect in the response headers.
593 http_string | **Optional.** String to expect in the content.
594 http_post | **Optional.** URL encoded http POST data.
595 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
596 http_maxage | **Optional.** Warn if document is more than seconds old.
597 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
598 http_useragent | **Optional.** String to be sent in http header as User Agent.
599 http_header | **Optional.** Any other tags to be sent in http header.
600 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
601 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)
602 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
603 http_timeout | **Optional.** Seconds before connection times out.
604 http_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
605 http_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
606 http_link | **Optional.** Wrap output in HTML link. Defaults to false.
607 http_verbose | **Optional.** Show details for command-line debugging. Defaults to false.
610 ### icmp <a id="plugin-check-command-icmp"></a>
612 The [check_icmp](https://www.monitoring-plugins.org/doc/man/check_icmp.html) plugin
613 check_icmp allows for checking multiple hosts at once compared to `check_ping`.
614 The main difference is that check_ping executes the system's ping(1) command and
615 parses its output while check_icmp talks ICMP itself. check_icmp must be installed
618 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
621 ----------------|--------------
622 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
623 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
624 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
625 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
626 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
627 icmp_source | **Optional.** The source IP address to send packets from.
628 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
629 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
630 icmp_target_interval | **Optional.** The maximum target interval.
631 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
632 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
633 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
634 icmp_ttl | **Optional.** The TTL on outgoing packets.
637 ### imap <a id="plugin-check-command-imap"></a>
639 The [check_imap](https://www.monitoring-plugins.org/doc/man/check_imap.html) plugin
640 tests IMAP connections with the specified host (or unix socket).
642 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
645 ----------------------|--------------
646 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
647 imap_port | **Optional.** The port that should be checked. Defaults to 143.
648 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.
649 imap_send | **Optional.** String to send to the server.
650 imap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
651 imap_all | **Optional.** All expect strings need to occur in server response. Default is any.
652 imap_quit | **Optional.** String to send server to initiate a clean close of the connection.
653 imap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
654 imap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
655 imap_jail | **Optional.** Hide output from TCP socket.
656 imap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
657 imap_delay | **Optional.** Seconds to wait between sending string and polling for response.
658 imap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
659 imap_ssl | **Optional.** Use SSL for the connection.
660 imap_warning | **Optional.** Response time to result in warning status (seconds).
661 imap_critical | **Optional.** Response time to result in critical status (seconds).
662 imap_timeout | **Optional.** Seconds before connection times out (default: 10).
663 imap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
664 imap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
667 ### ldap <a id="plugin-check-command-ldap"></a>
669 The [check_ldap](https://www.monitoring-plugins.org/doc/man/check_ldap.html) plugin
670 can be used to check LDAP servers.
672 The plugin can also be used for monitoring ldaps connections instead of the deprecated `check_ldaps`.
673 This can be ensured by enabling `ldap_starttls` or `ldap_ssl`.
675 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
678 ------------------------|--------------
679 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.
680 ldap_port | **Optional.** Port number. Defaults to 389.
681 ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)"
682 ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
683 ldap_bind | **Optional.** LDAP bind DN (if required).
684 ldap_pass | **Optional.** LDAP password (if required).
685 ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3.
686 ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
687 ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default).
688 ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default)
689 ldap_warning | **Optional.** Response time to result in warning status (seconds).
690 ldap_critical | **Optional.** Response time to result in critical status (seconds).
691 ldap_warning_entries | **Optional.** Number of found entries to result in warning status.
692 ldap_critical_entries | **Optional.** Number of found entries to result in critical status.
693 ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
694 ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
696 ### load <a id="plugin-check-command-load"></a>
698 The [check_load](https://www.monitoring-plugins.org/doc/man/check_load.html) plugin
699 tests the current system load average.
701 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
704 ----------------|--------------
705 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
706 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
707 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
708 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
709 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
710 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
711 load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
713 ### mailq <a id="plugin-check-command-mailq"></a>
715 The [check_mailq](https://www.monitoring-plugins.org/doc/man/check_mailq.html) plugin
716 checks the number of messages in the mail queue (supports multiple sendmail queues, qmail).
718 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
721 ------------------------|--------------
722 mailq_warning | **Required.** Min. number of messages in queue to generate warning.
723 mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ).
724 mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning
725 mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ).
726 mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15).
727 mailq_servertype | **Optional.** [ sendmail \| qmail \| postfix \| exim \| nullmailer ] (default = autodetect).
728 mailq_sudo | **Optional.** Use sudo to execute the mailq command.
730 ### mysql <a id="plugin-check-command-mysql"></a>
732 The [check_mysql](https://www.monitoring-plugins.org/doc/man/check_mysql.html) plugin
733 tests connections to a MySQL server.
735 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
738 ------------------------|---------------------------------------------------------------
739 mysql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
740 mysql_port | **Optional.** Port number (default: 3306).
741 mysql_socket | **Optional.** Use the specified socket (has no effect if `mysql_hostname` is used).
742 mysql_ignore_auth | **Optional.** Ignore authentication failure and check for mysql connectivity only.
743 mysql_database | **Optional.** Check database with indicated name.
744 mysql_file | **Optional.** Read from the specified client options file.
745 mysql_group | **Optional.** Use a client options group.
746 mysql_username | **Optional.** Connect using the indicated username.
747 mysql_password | **Optional.** Use the indicated password to authenticate the connection.
748 mysql_check_slave | **Optional.** Check if the slave thread is running properly.
749 mysql_warning | **Optional.** Exit with WARNING status if slave server is more than INTEGER seconds behind master.
750 mysql_critical | **Optional.** Exit with CRITICAL status if slave server is more then INTEGER seconds behind master.
751 mysql_ssl | **Optional.** Use ssl encryptation.
752 mysql_cacert | **Optional.** Path to CA signing the cert.
753 mysql_cert | **Optional.** Path to SSL certificate.
754 mysql_key | **Optional.** Path to private SSL key.
755 mysql_cadir | **Optional.** Path to CA directory.
756 mysql_ciphers | **Optional.** List of valid SSL ciphers.
759 ### mysql_query <a id="plugin-check-command-mysql-query"></a>
761 The [check_mysql_query](https://www.monitoring-plugins.org/doc/man/check_mysql_query.html) plugin
762 checks a query result against threshold levels.
763 The result from the query should be numeric. For extra security, create a user with minimal access.
765 **Note**: You must specify `mysql_query_password` with an empty string to force an empty password,
766 overriding any my.cnf settings.
768 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
771 ------------------------|---------------------------------------------------------------
772 mysql_query_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
773 mysql_query_port | **Optional.** Port number (default: 3306).
774 mysql_query_database | **Optional.** Check database with indicated name.
775 mysql_query_file | **Optional.** Read from the specified client options file.
776 mysql_query_group | **Optional.** Use a client options group.
777 mysql_query_username | **Optional.** Connect using the indicated username.
778 mysql_query_password | **Optional.** Use the indicated password to authenticate the connection.
779 mysql_query_execute | **Required.** SQL Query to run on the MySQL Server.
780 mysql_query_warning | **Optional.** Exit with WARNING status if query is outside of the range (format: start:end).
781 mysql_query_critical | **Optional.** Exit with CRITICAL status if query is outside of the range.
784 ### negate <a id="plugin-check-command-negate"></a>
786 The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin
787 negates the status of a plugin (returns OK for CRITICAL and vice-versa).
788 Additional switches can be used to control which state becomes what.
790 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
793 ------------------------|---------------------------------------------------------------
794 negate_timeout | **Optional.** Seconds before plugin times out (default: 11).
795 negate_timeout_result | **Optional.** Custom result on Negate timeouts, default to UNKNOWN.
796 negate_ok | **Optional.** OK, WARNING, CRITICAL or UNKNOWN.
797 negate_warning | Numeric values are accepted.
798 negate_critical | If nothing is specified, permutes OK and CRITICAL.
799 negate_substitute | **Optional.** Substitute output text as well. Will only substitute text in CAPITALS.
800 negate_command | **Required.** Command to be negated.
801 negate_arguments | **Optional.** Arguments for the negated command.
803 ### nrpe <a id="plugin-check-command-nrpe"></a>
805 The `check_nrpe` plugin can be used to query an [NRPE](https://docs.icinga.com/latest/en/nrpe.html)
806 server or [NSClient++](https://www.nsclient.org). **Note**: This plugin
807 is considered insecure/deprecated.
809 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
812 ----------------|--------------
813 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
814 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
815 nrpe_command | **Optional.** The command that should be executed.
816 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
817 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
818 nrpe_timeout | **Optional.** The timeout in seconds.
819 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
820 nrpe_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
821 nrpe_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
822 nrpe_version_2 | **Optional.** Use this if you want to connect using NRPE v2 protocol. Defaults to false.
825 ### nscp <a id="plugin-check-command-nscp"></a>
827 The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin
828 collects data from the [NSClient++](https://www.nsclient.org) service.
830 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
833 ----------------|--------------
834 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
835 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
836 nscp_password | **Optional.** The NSClient++ password.
837 nscp_variable | **Required.** The variable that should be checked.
838 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
839 nscp_warn | **Optional.** The warning threshold.
840 nscp_crit | **Optional.** The critical threshold.
841 nscp_timeout | **Optional.** The query timeout in seconds.
842 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
845 ### ntp_time <a id="plugin-check-command-ntp-time"></a>
847 The [check_ntp_time](https://www.monitoring-plugins.org/doc/man/check_ntp_time.html) plugin
848 checks the clock offset between the local host and a remote NTP server.
850 **Note**: If you want to monitor an NTP server, please use `ntp_peer`.
852 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
855 ----------------|--------------
856 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
857 ntp_port | **Optional.** Port number (default: 123).
858 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
859 ntp_warning | **Optional.** Offset to result in warning status (seconds).
860 ntp_critical | **Optional.** Offset to result in critical status (seconds).
861 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
862 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
863 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
864 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
867 ### ntp_peer <a id="plugin-check-command-ntp-peer"></a>
869 The [check_ntp_peer](https://www.monitoring-plugins.org/doc/man/check_ntp_peer.html) plugin
870 checks the health of an NTP server. It supports checking the offset with the sync peer, the
871 jitter and stratum. This plugin will not check the clock offset between the local host and NTP
872 server; please use `ntp_time` for that purpose.
874 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
877 ----------------|--------------
878 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
879 ntp_port | **Optional.** The port to use. Default to 123.
880 ntp_warning | **Optional.** Offset to result in warning status (seconds).
881 ntp_critical | **Optional.** Offset to result in critical status (seconds).
882 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
883 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
884 ntp_wjitter | **Optional.** Warning threshold for jitter.
885 ntp_cjitter | **Optional.** Critical threshold for jitter.
886 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
887 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
888 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
889 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
890 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
893 ### passive <a id="plugin-check-command-passive"></a>
895 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
897 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
900 ----------------|--------------
901 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
902 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
904 ### pgsql <a id="plugin-check-command-pgsql"></a>
906 The [check_pgsql](https://www.monitoring-plugins.org/doc/man/check_pgsql.html) plugin
907 tests a PostgreSQL DBMS to determine whether it is active and accepting queries.
908 If a query is specified using the `pgsql_query` attribute, it will be executed after
909 connecting to the server. The result from the query has to be numeric in order
910 to compare it against the query thresholds if set.
912 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
915 ------------------------|---------------------------------------------------------------
916 pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
917 pgsql_port | **Optional.** Port number (default: 5432).
918 pgsql_database | **Optional.** Database to check (default: template1).
919 pgsql_username | **Optional.** Login name of user.
920 pgsql_password | **Optional.** Password (BIG SECURITY ISSUE).
921 pgsql_options | **Optional.** Connection parameters (keyword = value), see below.
922 pgsql_warning | **Optional.** Response time to result in warning status (seconds).
923 pgsql_critical | **Optional.** Response time to result in critical status (seconds).
924 pgsql_timeout | **Optional.** Seconds before connection times out (default: 10).
925 pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read.
926 pgsql_query_warning | **Optional.** SQL query value to result in warning status (double).
927 pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
929 ### ping <a id="plugin-check-command-ping"></a>
931 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
932 uses the ping command to probe the specified host for packet loss (percentage) and
933 round trip average (milliseconds).
935 This command uses the host's `address` attribute if available and falls back to using
936 the `address6` attribute if the `address` attribute is not set.
938 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
941 ----------------|--------------
942 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
943 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
944 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
945 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
946 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
947 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
948 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
951 ### ping4 <a id="plugin-check-command-ping4"></a>
953 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
954 uses the ping command to probe the specified host for packet loss (percentage) and
955 round trip average (milliseconds).
957 This command uses the host's `address` attribute if not explicitely specified using
958 the `ping_address` attribute.
960 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
963 ----------------|--------------
964 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
965 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
966 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
967 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
968 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
969 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
970 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
972 ### ping6 <a id="plugin-check-command-ping6"></a>
974 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
975 uses the ping command to probe the specified host for packet loss (percentage) and
976 round trip average (milliseconds).
978 This command uses the host's `address6` attribute if not explicitely specified using
979 the `ping_address` attribute.
981 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
984 ----------------|--------------
985 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
986 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
987 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
988 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
989 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
990 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
991 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
994 ### pop <a id="plugin-check-command-pop"></a>
996 The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin
997 tests POP connections with the specified host (or unix socket).
999 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1002 ---------------------|--------------
1003 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1004 pop_port | **Optional.** The port that should be checked. Defaults to 110.
1005 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.
1006 pop_send | **Optional.** String to send to the server.
1007 pop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1008 pop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1009 pop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1010 pop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1011 pop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1012 pop_jail | **Optional.** Hide output from TCP socket.
1013 pop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1014 pop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1015 pop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1016 pop_ssl | **Optional.** Use SSL for the connection.
1017 pop_warning | **Optional.** Response time to result in warning status (seconds).
1018 pop_critical | **Optional.** Response time to result in critical status (seconds).
1019 pop_timeout | **Optional.** Seconds before connection times out (default: 10).
1020 pop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1021 pop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1024 ### procs <a id="plugin-check-command-processes"></a>
1026 The [check_procs](https://www.monitoring-plugins.org/doc/man/check_procs.html) plugin
1027 checks all processes and generates WARNING or CRITICAL states if the specified
1028 metric is outside the required threshold ranges. The metric defaults to number
1029 of processes. Search filters can be applied to limit the processes to check.
1031 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1034 ---------------------|--------------
1035 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
1036 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
1037 procs_metric | **Optional.** Check thresholds against metric.
1038 procs_timeout | **Optional.** Seconds before plugin times out.
1039 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
1040 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
1041 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
1042 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
1043 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
1044 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
1045 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
1046 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
1047 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
1048 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
1049 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
1052 ### radius <a id="plugin-check-command-radius"></a>
1054 The [check_radius](https://www.monitoring-plugins.org/doc/man/check_radius.html) plugin
1055 checks a RADIUS server to see if it is accepting connections. The server to test
1056 must be specified in the invocation, as well as a user name and password. A configuration
1057 file may also be present. The format of the configuration file is described in the
1058 radiusclient library sources. The password option presents a substantial security
1059 issue because the password can possibly be determined by careful watching of the
1060 command line in a process listing. This risk is exacerbated because the plugin will
1061 typically be executed at regular predictable intervals. Please be sure that the
1062 password used does not allow access to sensitive system resources.
1065 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1068 -------------------|--------------
1069 radius_address | **Optional.** The radius server's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1070 radius_config_file | **Required.** The radius configuration file.
1071 radius_username | **Required.** The radius username to test.
1072 radius_password | **Required.** The radius password to test.
1073 radius_port | **Optional.** The radius port number (default 1645).
1074 radius_nas_id | **Optional.** The NAS identifier.
1075 radius_nas_address | **Optional.** The NAS IP address.
1076 radius_expect | **Optional.** The response string to expect from the server.
1077 radius_retries | **Optional.** The number of times to retry a failed connection.
1078 radius_timeout | **Optional.** The number of seconds before connection times out (default: 10).
1081 ### simap <a id="plugin-check-command-simap"></a>
1083 The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
1084 tests SIMAP connections with the specified host (or unix socket).
1086 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1089 -----------------------|--------------
1090 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1091 simap_port | **Optional.** The port that should be checked. Defaults to 993.
1092 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.
1093 simap_send | **Optional.** String to send to the server.
1094 simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1095 simap_all | **Optional.** All expect strings need to occur in server response. Default is any.
1096 simap_quit | **Optional.** String to send server to initiate a clean close of the connection.
1097 simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1098 simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1099 simap_jail | **Optional.** Hide output from TCP socket.
1100 simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1101 simap_delay | **Optional.** Seconds to wait between sending string and polling for response.
1102 simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1103 simap_ssl | **Optional.** Use SSL for the connection.
1104 simap_warning | **Optional.** Response time to result in warning status (seconds).
1105 simap_critical | **Optional.** Response time to result in critical status (seconds).
1106 simap_timeout | **Optional.** Seconds before connection times out (default: 10).
1107 simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1108 simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1110 ### smart <a id="plugin-check-command-smart"></a>
1112 The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
1113 checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
1115 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1118 ----------------|--------------
1119 smart_device | **Required.** The name of a local hard drive to monitor.
1122 ### smtp <a id="plugin-check-command-smtp"></a>
1124 The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
1125 will attempt to open an SMTP connection with the host.
1127 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1130 ----------------------|--------------
1131 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1132 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
1133 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
1134 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
1135 smtp_command | **Optional.** SMTP command (may be used repeatedly).
1136 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
1137 smtp_helo_fqdn | **Optional.** FQDN used for HELO
1138 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1139 smtp_starttls | **Optional.** Use STARTTLS for the connection.
1140 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
1141 smtp_authuser | **Optional.** SMTP AUTH username.
1142 smtp_authpass | **Optional.** SMTP AUTH password.
1143 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
1144 smtp_warning | **Optional.** Response time to result in warning status (seconds).
1145 smtp_critical | **Optional.** Response time to result in critical status (seconds).
1146 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1147 smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1148 smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1151 ### snmp <a id="plugin-check-command-snmp"></a>
1153 The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin
1154 checks the status of remote machines and obtains system information via SNMP.
1156 **Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
1158 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1161 --------------------|--------------
1162 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1163 snmp_oid | **Required.** The SNMP OID.
1164 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1165 snmp_port | **Optional.** The SNMP port. Defaults to "161".
1166 snmp_retries | **Optional.** Number of retries to be used in the SNMP requests.
1167 snmp_warn | **Optional.** The warning threshold.
1168 snmp_crit | **Optional.** The critical threshold.
1169 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
1170 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
1171 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
1172 snmp_label | **Optional.** Prefix label for output value
1173 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
1174 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1175 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
1176 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
1177 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1178 snmp_rate | **Optional.** Boolean. Enable rate calculation.
1179 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
1180 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1182 ### snmpv3 <a id="plugin-check-command-snmpv3"></a>
1184 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1185 plugin, using SNMPv3 authentication and encryption options.
1187 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1190 ---------------------|--------------
1191 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1192 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
1193 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
1194 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
1195 snmpv3_user | **Required.** The username to log in with.
1196 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
1197 snmpv3_priv_key | **Required.** The encryption key.
1198 snmpv3_oid | **Required.** The SNMP OID.
1199 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
1200 snmpv3_warn | **Optional.** The warning threshold.
1201 snmpv3_crit | **Optional.** The critical threshold.
1202 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
1203 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
1204 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
1205 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
1206 snmpv3_label | **Optional.** Prefix label for output value.
1207 snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1208 snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1209 snmpv3_rate | **Optional.** Boolean. Enable rate calculation.
1210 snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1212 ### snmp-uptime <a id="plugin-check-command-snmp-uptime"></a>
1214 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1215 plugin, using the uptime OID by default.
1217 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1220 ----------------|--------------
1221 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1222 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
1223 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1226 ### spop <a id="plugin-check-command-spop"></a>
1228 The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
1229 tests SPOP connections with the specified host (or unix socket).
1231 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1234 ----------------------|--------------
1235 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1236 spop_port | **Optional.** The port that should be checked. Defaults to 995.
1237 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.
1238 spop_send | **Optional.** String to send to the server.
1239 spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1240 spop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1241 spop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1242 spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1243 spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1244 spop_jail | **Optional.** Hide output from TCP socket.
1245 spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1246 spop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1247 spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1248 spop_ssl | **Optional.** Use SSL for the connection.
1249 spop_warning | **Optional.** Response time to result in warning status (seconds).
1250 spop_critical | **Optional.** Response time to result in critical status (seconds).
1251 spop_timeout | **Optional.** Seconds before connection times out (default: 10).
1252 spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1253 spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1256 ### ssh <a id="plugin-check-command-ssh"></a>
1258 The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
1259 connects to an SSH server at a specified host and port.
1261 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1264 ----------------|--------------
1265 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1266 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
1267 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1268 ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1269 ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1272 ### ssl <a id="plugin-check-command-ssl"></a>
1274 Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
1275 using ssl-related options.
1277 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1280 ------------------------------|--------------
1281 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1282 ssl_port | **Optional.** The port that should be checked. Defaults to 443.
1283 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
1284 ssl_cert_valid_days_warn | **Optional.** Warning threshold for days before the certificate will expire. When used, the default for ssl_cert_valid_days_critical is 0.
1285 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.
1286 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$".
1289 ### ssmtp <a id="plugin-check-command-ssmtp"></a>
1291 The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
1292 tests SSMTP connections with the specified host (or unix socket).
1294 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1297 -----------------------|--------------
1298 ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1299 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
1300 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.
1301 ssmtp_send | **Optional.** String to send to the server.
1302 ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1303 ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any.
1304 ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1305 ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1306 ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1307 ssmtp_jail | **Optional.** Hide output from TCP socket.
1308 ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1309 ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1310 ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1311 ssmtp_ssl | **Optional.** Use SSL for the connection.
1312 ssmtp_warning | **Optional.** Response time to result in warning status (seconds).
1313 ssmtp_critical | **Optional.** Response time to result in critical status (seconds).
1314 ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1315 ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1316 ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1319 ### swap <a id="plugin-check-command-swap"></a>
1321 The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
1322 checks the swap space on a local machine.
1324 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1327 ----------------|--------------
1328 swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`.
1329 swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`.
1330 swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
1331 swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false.
1332 swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".
1335 ### tcp <a id="plugin-check-command-tcp"></a>
1337 The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
1338 tests TCP connections with the specified host (or unix socket).
1340 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1343 ----------------|--------------
1344 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1345 tcp_port | **Required.** The port that should be checked.
1346 tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1347 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
1348 tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
1349 tcp_send | **Optional.** String to send to the server.
1350 tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
1351 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1352 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
1353 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
1354 tcp_jail | **Optional.** Hide output from TCP socket.
1355 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1356 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1357 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.
1358 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
1359 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
1360 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
1361 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1362 tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1363 tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1366 ### udp <a id="plugin-check-command-udp"></a>
1368 The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
1369 tests UDP connections with the specified host (or unix socket).
1371 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1374 ----------------|--------------
1375 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1376 udp_port | **Required.** The port that should be checked.
1377 udp_send | **Required.** The payload to send in the UDP datagram.
1378 udp_expect | **Required.** The payload to expect in the response datagram.
1379 udp_quit | **Optional.** The payload to send to 'close' the session.
1380 udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1381 udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1384 ### ups <a id="plugin-check-command-ups"></a>
1386 The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin
1387 tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
1388 must be running for this plugin to work.
1390 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1393 ----------------|--------------
1394 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1395 ups_name | **Required.** The UPS name. Defaults to `ups`.
1396 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
1397 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`.
1398 ups_warning | **Optional.** The warning threshold for the selected variable.
1399 ups_critical | **Optional.** The critical threshold for the selected variable.
1400 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
1401 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
1404 ### users <a id="plugin-check-command-users"></a>
1406 The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin
1407 checks the number of users currently logged in on the local system and generates an
1408 error if the number exceeds the thresholds specified.
1410 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1413 ----------------|--------------
1414 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
1415 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
1417 ## Windows Plugins for Icinga 2 <a id="windows-plugins"></a>
1419 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.
1421 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:
1423 include <windows-plugins>
1425 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.
1428 ### Threshold syntax <a id="windows-plugins-thresholds"></a>
1430 So not specified differently the thresholds for the plugins all follow the same pattern
1433 :------------|:----------
1434 "29" | The threshold is 29.
1435 "!29" | The threshold is 29, but the negative of the result is returned.
1436 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
1437 "![10-40]" | Same as above, but the result is inverted.
1440 ### disk-windows <a id="windows-plugins-disk-windows"></a>
1442 Check command object for the `check_disk.exe` plugin.
1443 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 The data collection is instant and free disk space is used for threshold computation.
1448 > Percentage based thresholds can be used by adding a '%' to the threshold
1454 :-------------------|:------------
1455 disk\_win\_warn | **Optional**. The warning threshold.
1456 disk\_win\_crit | **Optional**. The critical threshold.
1457 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1458 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.
1459 disk\_win\_exclude | **Optional**. Exclude these drives from check.
1461 ### load-windows <a id="windows-plugins-load-windows"></a>
1463 Check command object for the `check_load.exe` plugin.
1464 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).
1469 :---------------|:------------
1470 load\_win\_warn | **Optional**. The warning threshold.
1471 load\_win\_crit | **Optional**. The critical threshold.
1474 ### memory-windows <a id="windows-plugins-memory-windows"></a>
1476 Check command object for the `check_memory.exe` plugin.
1477 The memory collection is instant and free memory is used for threshold computation.
1481 > Percentage based thresholds can be used by adding a '%' to the threshold
1482 > value. Keep in mind that memory\_win\_unit is applied before the
1483 > value is calculated.
1488 :-----------------|:------------
1489 memory\_win\_warn | **Optional**. The warning threshold.
1490 memory\_win\_crit | **Optional**. The critical threshold.
1491 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.
1494 ### network-windows <a id="windows-plugins-network-windows"></a>
1496 Check command object for the `check_network.exe` plugin.
1497 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).
1502 :-------------------|:------------
1503 network\_win\_warn | **Optional**. The warning threshold.
1504 network\_win\_crit | **Optional**. The critical threshold.
1505 network\_no\_isatap | **Optional**. Do not print ISATAP interfaces.
1508 ### perfmon-windows <a id="windows-plugins-perfmon-windows"></a>
1510 Check command object for the `check_perfmon.exe` plugin.
1511 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`.
1513 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"`
1518 :---------------------|:------------
1519 perfmon\_win\_warn | **Optional**. The warning threshold.
1520 perfmon\_win\_crit | **Optional**. The critical threshold.
1521 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1522 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1523 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
1524 perfmon\_win\_syntax | **Optional**. Use this in the performance output instead of `perfmon\_win\_counter`. Exists for graphice compatibility reasons.
1527 ### ping-windows <a id="windows-plugins-ping-windows"></a>
1529 Check command object for the `check_ping.exe` plugin.
1530 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.
1535 :------------------|:------------
1536 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma.
1537 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma.
1538 ping\_win\_address | **Required**. An IPv4 or IPv6 address
1539 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1540 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1543 ### procs-windows <a id="windows-plugins-procs-windows"></a>
1545 Check command object for `check_procs.exe` plugin.
1546 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.
1551 :----------------|:------------
1552 procs\_win\_warn | **Optional**. The warning threshold.
1553 procs\_win\_crit | **Optional**. The critical threshold.
1554 procs\_win\_user | **Optional**. Count this useres processes.
1557 ### service-windows <a id="windows-plugins-service-windows"></a>
1559 Check command object for `check_service.exe` plugin.
1560 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.
1565 :---------------------|:------------
1566 service\_win\_warn | **Optional**. Warn when service is not running.
1567 service\_win\_service | **Required**. The critical threshold.
1570 ### swap-windows <a id="windows-plugins-swap-windows"></a>
1572 Check command object for `check_swap.exe` plugin.
1573 The data collection is instant.
1578 :---------------|:------------
1579 swap\_win\_warn | **Optional**. The warning threshold.
1580 swap\_win\_crit | **Optional**. The critical threshold.
1581 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1584 ### update-windows <a id="windows-plugins-update-windows"></a>
1586 Check command object for `check_update.exe` plugin.
1587 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.
1591 > The Network Services Account which runs Icinga 2 by default does not have the required
1592 > permissions to run this check.
1597 :-------------------|:------------
1598 update\_win\_warn | **Optional**. If set, returns warning when important updates are available.
1599 update\_win\_crit | **Optional**. If set, return critical when important updates that require a reboot are available.
1600 update\_win\_reboot | **Optional**. Set to treat 'may need update' as 'definitely needs update'. Please Note that this is true for almost every update and is therefore not recommended.
1603 In contrast to most other plugins, the values of check_update's custom attributes do not set thresholds, but just enable/disable the behaviour described in the table above.
1604 It can be enabled/disabled for example by setting them to "true" or "false", "1" or "0" would also work.
1605 Thresholds will always be "1".
1609 > If they are enabled, performance data will be shown in the webinterface.
1610 > If run without the optional parameters, the plugin will output critical if any important updates are available.
1613 ### uptime-windows <a id="windows-plugins-uptime-windows"></a>
1615 Check command opject for `check_uptime.exe` plugin.
1616 Uses GetTickCount64 to get the uptime, so boot time is not included.
1621 :-----------------|:------------
1622 uptime\_win\_warn | **Optional**. The warning threshold.
1623 uptime\_win\_crit | **Optional**. The critical threshold.
1624 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).
1627 ### users-windows <a id="windows-plugins-users-windows"></a>
1629 Check command object for `check_users.exe` plugin.
1634 :----------------|:------------
1635 users\_win\_warn | **Optional**. The warning threshold.
1636 users\_win\_crit | **Optional**. The critical threshold.
1639 ## Plugin Check Commands for NSClient++ <a id="nscp-plugin-check-commands"></a>
1641 There are two methods available for querying NSClient++:
1643 * Query the [HTTP API](10-icinga-template-library.md#nscp-check-api) locally or remotely (requires a running NSClient++ service)
1644 * Run a [local CLI check](10-icinga-template-library.md#nscp-check-local) (does not require NSClient++ as a service)
1646 Both methods have their advantages and disadvantages. One thing to
1647 note: If you rely on performance counter delta calculations such as
1648 CPU utilization, please use the HTTP API instead of the CLI sample call.
1650 ### nscp_api <a id="nscp-check-api"></a>
1652 `check_nscp_api` is part of the Icinga 2 plugins. This plugin is available for
1653 both, Windows and Linux/Unix.
1655 Verify that the ITL CheckCommand is included:
1657 vim /etc/icinga2/icinga2.conf
1661 `check_nscp_api` runs queries against the NSClient++ API. Therefore NSClient++ needs to have
1662 the `webserver` module enabled, configured and loaded.
1664 You can install the webserver using the following CLI commands:
1666 ./nscp.exe web install
1667 ./nscp.exe web password — –set icinga
1669 Now you can define specific [queries](https://docs.nsclient.org/reference/check/CheckHelpers.html#queries)
1670 and integrate them into Icinga 2.
1672 The check plugin `check_nscp_api` can be integrated with the `nscp_api` CheckCommand object:
1677 :----------------------|:----------------------
1678 nscp\_api\_host | **Required**. NSCP API host address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1679 nscp\_api\_port | **Optional**. NSCP API port. Defaults to `8443`.
1680 nscp\_api\_passwd | **Required**. NSCP API password. Please check the NSCP documentation for setup details.
1681 nscp\_api\_query | **Required**. NSCP API query endpoint. Refer to the NSCP documentation for possible values.
1682 nscp\_api\_arguments | **Optional**. NSCP API arguments dictionary either as single strings or key-value pairs using `=`. Refer to the NSCP documentation.
1684 `nscp_api_arguments` can be used to pass required thresholds to the executed check. The example below
1685 checks the CPU utilization and specifies warning and critical thresholds.
1688 check_nscp_api --host 10.0.10.148 --password icinga --query check_cpu --arguments show-all warning='load>40' critical='load>30'
1689 check_cpu CRITICAL: critical(5m: 48%, 1m: 36%), 5s: 0% | 'total 5m'=48%;40;30 'total 1m'=36%;40;30 'total 5s'=0%;40;30
1693 ### nscp-local <a id="nscp-check-local"></a>
1695 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks locally on the client.
1697 You can enable these check commands by adding the following the include directive in your
1698 [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf) configuration file:
1702 You can also optionally specify an alternative installation directory for NSClient++ by adding
1703 the NscpPath constant in your [constants.conf](04-configuring-icinga-2.md#constants-conf) configuration
1706 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1708 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1709 not be necessary to manually set this constant.
1711 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1713 The check command object for NSClient++ is available as `nscp-local`.
1715 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1718 ----------------|--------------
1719 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1720 nscp_load_all | **Optional.** Whether to load all modules. Defaults to false.
1721 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`.
1722 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1723 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1724 nscp_arguments | **Optional.** An array of query arguments.
1725 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1727 ### nscp-local-cpu <a id="nscp-check-local-cpu"></a>
1729 Check command object for the `check_cpu` NSClient++ plugin.
1732 --------------------|------------------
1733 nscp_cpu_time | **Optional.** Calculate avarage usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1734 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1735 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1736 nscp_cpu_arguments | **Optional.** Additional arguments.
1737 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1739 ### nscp-local-memory <a id="nscp-check-local-memory"></a>
1741 Check command object for the `check_memory` NSClient++ plugin.
1744 ----------------------|------------------
1745 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1746 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1747 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1748 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolut (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1749 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolut (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1750 nscp_memory_arguments | **Optional.** Additional arguments.
1751 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1753 ### nscp-local-os-version <a id="nscp-check-local-os-version"></a>
1755 Check command object for the `check_os_version` NSClient++ plugin.
1757 This command has the same custom attributes like the `nscp-local` check command.
1759 ### nscp-local-pagefile <a id="nscp-check-local-pagefile"></a>
1761 Check command object for the `check_pagefile` NSClient++ plugin.
1763 This command has the same custom attributes like the `nscp-local` check command.
1765 ### nscp-local-process <a id="nscp-check-local-process"></a>
1767 Check command object for the `check_process` NSClient++ plugin.
1769 This command has the same custom attributes like the `nscp-local` check command.
1771 ### nscp-local-service <a id="nscp-check-local-service"></a>
1773 Check command object for the `check_service` NSClient++ plugin.
1776 -----------------------|------------------
1777 nscp_service_name | **Required.** Name of service to check.
1778 nscp_service_type | **Optional.** Type to check, default to state.
1779 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1780 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1781 nscp_service_warning | **Optional.** State for return an WARNING.
1782 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1783 nscp_service_critical | **Optional.** State for return an CRITICAL.
1784 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1785 nscp_service_arguments | **Optional.** Additional arguments.
1786 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1788 ### nscp-local-uptime <a id="nscp-check-local-uptime"></a>
1790 Check command object for the `check_uptime` NSClient++ plugin.
1792 This command has the same custom attributes like the `nscp-local` check command.
1794 ### nscp-local-version <a id="nscp-check-local-version"></a>
1796 Check command object for the `check_version` NSClient++ plugin.
1798 This command has the same custom attributes like the `nscp-local` check command.
1799 In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
1801 ### nscp-local-disk <a id="nscp-check-local-disk"></a>
1803 Check command object for the `check_drivesize` NSClient++ plugin.
1806 -----------------------|------------------
1807 nscp_disk_drive | **Optional.** Drive character, default to all drives.
1808 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1809 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolut (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1810 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolut (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1811 nscp_disk_arguments | **Optional.** Additional arguments.
1812 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1813 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`.
1815 ### nscp-local-counter <a id="nscp-check-local-counter"></a>
1817 Check command object for the `check_pdh` NSClient++ plugin.
1820 -----------------------|------------------
1821 nscp_counter_name | **Required.** Performance counter name.
1822 nscp_counter_warning | **Optional.** WARNING Threshold.
1823 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1824 nscp_counter_arguments | **Optional.** Additional arguments.
1825 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1826 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1830 ## Plugin Check Commands for Manubulon SNMP <a id="snmp-manubulon-plugin-check-commands"></a>
1832 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1833 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1835 **Note:** Some plugin parameters are only available in Debian packages or in a
1836 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1838 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1839 is set to the path where the Manubublon SNMP plugins are installed.
1841 You can enable these plugin check commands by adding the following the include directive in your
1842 [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf) configuration file:
1846 ### Checks by Host Type
1848 **N/A** : Not available for this type.
1850 **SNMP** : Available for simple SNMP query.
1854 **Specific** : Script name for platform specific checks.
1857 Host type | Interface | storage | load/cpu | mem | process | env | specific
1858 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1859 Linux | Yes | Yes | Yes | Yes | Yes | No |
1860 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1861 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1862 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1863 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1864 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1865 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1866 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1867 AS400 | Yes | Yes | Yes | Yes | No | No |
1868 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1869 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1870 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1871 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1874 ### snmp-load <a id="plugin-check-command-snmp-load"></a>
1876 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1878 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1882 ------------------------|--------------
1883 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1884 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1885 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1886 snmp_port | **Optional.** The SNMP port connection.
1887 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1888 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1889 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1890 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1891 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1892 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1893 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1894 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1895 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1896 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1897 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.
1898 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1899 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1901 ### snmp-memory <a id="plugin-check-command-snmp-memory"></a>
1903 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1905 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1908 ------------------------|--------------
1909 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1910 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1911 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1912 snmp_port | **Optional.** The SNMP port connection.
1913 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1914 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1915 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1916 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1917 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1918 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1919 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1920 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1921 snmp_warn | **Optional.** The warning threshold.
1922 snmp_crit | **Optional.** The critical threshold.
1923 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1924 snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
1925 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1926 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1928 ### snmp-storage <a id="plugin-check-command-snmp-storage"></a>
1930 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1932 Custom attributes passed as [command parameters](03-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_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1951 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1952 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1954 ### snmp-interface <a id="plugin-check-command-snmp-interface"></a>
1956 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1958 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1961 ----------------------------|--------------
1962 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1963 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1964 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1965 snmp_port | **Optional.** The SNMP port connection.
1966 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1967 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1968 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1969 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1970 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1971 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1972 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1973 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1974 snmp_warn | **Optional.** The warning threshold.
1975 snmp_crit | **Optional.** The critical threshold.
1976 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1977 snmp_interface_inverse | **Optional.** Inverse Interface check, down is ok. Defaults to false as it is missing.
1978 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1979 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
1980 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.
1981 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1982 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1983 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.
1984 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1985 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1986 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1987 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1988 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.
1989 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name.
1990 snmp_interface_ifalias | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name.
1991 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1992 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1994 ### snmp-process <a id="plugin-check-command-snmp-process"></a>
1996 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1998 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2001 ---------------------------|--------------
2002 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2003 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
2004 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2005 snmp_port | **Optional.** The SNMP port connection.
2006 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2007 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2008 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2009 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2010 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2011 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2012 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2013 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
2014 snmp_warn | **Optional.** The warning threshold.
2015 snmp_crit | **Optional.** The critical threshold.
2016 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
2017 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2018 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2019 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.
2020 snmp_process_mem_usage | **Optional.** Define to check memory usage for the process. Defaults to false.
2021 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".
2022 snmp_process_cpu_usage | **Optional.** Define to check CPU usage for the process. Defaults to false.
2023 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".
2026 ## Contributed Plugin Check Commands <a id="plugin-contrib"></a>
2028 The contributed Plugin Check Commands provides various additional command definitions
2029 contributed by community members.
2031 These check commands assume that the global constant named `PluginContribDir`
2032 is set to the path where the user installs custom plugins and can be enabled by
2033 uncommenting the corresponding line in [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf):
2036 vim /etc/icinga2/icinga2.conf
2038 include <plugin-contrib>
2041 This is enabled by default since Icinga 2 2.5.0.
2043 ### Databases <a id="plugin-contrib-databases"></a>
2045 This category contains plugins for various database servers.
2047 #### db2_health <a id="plugin-contrib-command-db2_health"></a>
2049 The [check_db2_health](https://labs.consol.de/nagios/check_db2_health/) plugin
2050 uses the `DBD::DB2` Perl library to monitor a [DB2](https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/)
2053 The Git repository is located on [GitHub](https://github.com/lausser/check_db2_health).
2055 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2058 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2059 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)
2060 db2_health_username | **Optional.** The username for the database connection.
2061 db2_health_password | **Optional.** The password for the database connection.
2062 db2_health_port | **Optional.** The port where DB2 is listening.
2063 db2_health_warning | **Optional.** The warning threshold depending on the mode.
2064 db2_health_critical | **Optional.** The critical threshold depending on the mode.
2065 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
2066 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).
2067 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.
2068 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.
2069 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
2070 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".
2071 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
2072 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
2073 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
2074 db2_health_report | **Optional.** Report can be used to output only the bad news. Possible values are "short", "long", "html". Defaults to `short`.
2075 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".
2076 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
2078 #### mssql_health <a id="plugin-contrib-command-mssql_health"></a>
2080 The [check_mssql_health](https://labs.consol.de/nagios/check_mssql_health/index.html) plugin
2081 uses the `DBD::Sybase` Perl library based on [FreeTDS](http://www.freetds.org/) to monitor a
2082 [MS SQL](https://www.microsoft.com/en-us/sql-server/) server.
2084 The Git repository is located on [GitHub](https://github.com/lausser/check_mssql_health).
2086 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2089 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2090 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
2091 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
2092 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
2093 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
2094 mssql_health_username | **Optional.** The username for the database connection.
2095 mssql_health_password | **Optional.** The password for the database connection.
2096 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
2097 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
2098 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
2099 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).
2100 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
2101 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.
2102 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
2103 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".
2104 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
2105 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
2106 mssql_health_notemp | **Optional.** Set this to true to ignore temporary databases/tablespaces. Defaults to false.
2107 mssql_health_nooffline | **Optional.** Set this to true to ignore offline databases. Defaults to false.
2108 mssql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates.
2109 mssql_health_report | **Optional.** Report can be used to output only the bad news. Possible values are "short", "long", "html". Defaults to `short`.
2111 #### mysql_health <a id="plugin-contrib-command-mysql_health"></a>
2113 The [check_mysql_health](https://labs.consol.de/nagios/check_mysql_health/index.html) plugin
2114 uses the `DBD::MySQL` Perl library to monitor a
2115 [MySQL](https://dev.mysql.com/downloads/mysql/) or [MariaDB](https://mariadb.org/about/) database.
2117 The Git repository is located on [GitHub](https://github.com/lausser/check_mysql_health).
2119 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2122 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2123 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
2124 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
2125 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
2126 mysql_health_username | **Optional.** The username for the database connection.
2127 mysql_health_password | **Optional.** The password for the database connection.
2128 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
2129 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
2130 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
2131 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
2132 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
2133 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
2134 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
2135 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::* module.
2136 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
2137 mysql_health_nooffline | **Optional.** Skip the offline databases.
2138 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
2139 mysql_health_name | **Optional.** The name of a specific component to check.
2140 mysql_health_name2 | **Optional.** The secondary name of a component.
2141 mysql_health_name3 | **Optional.** The tertiary name of a component.
2142 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".
2143 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2144 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2145 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components"
2146 mysql_health_mitigation | **Optional.** "The parameter allows you to change a critical error to a warning."
2147 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates."
2148 mysql_health_environment | **Optional.** Add a variable to the plugin's environment."
2149 mysql_health_morphmessage | **Optional.** Modify the final output message."
2150 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels."
2151 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data."
2152 mysql_health_report | **Optional.** Can be used to shorten the output."
2153 mysql_health_multiline | **Optional.** Multiline output."
2154 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical."
2155 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory."
2156 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files."
2157 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time."
2158 mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2160 #### oracle_health <a id="plugin-contrib-command-oracle_health"></a>
2162 The [check_oracle_health](https://labs.consol.de/nagios/check_oracle_health/index.html) plugin
2163 uses the `DBD::Oracle` Perl library to monitor an [Oracle](https://www.oracle.com/database/) database.
2165 The Git repository is located on [GitHub](https://github.com/lausser/check_oracle_health).
2167 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2170 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2171 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2172 oracle_health_username | **Optional.** The username for the database connection.
2173 oracle_health_password | **Optional.** The password for the database connection.
2174 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2175 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2176 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2177 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2178 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.
2179 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.
2180 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2181 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".
2182 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2183 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2184 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2185 oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2186 oracle_health_report | **Optional.** Select the plugin output format. Can be short or long. Default to long.
2191 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2192 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".
2193 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".
2195 #### postgres <a id="plugin-contrib-command-postgres"></a>
2197 The [check_postgres](https://bucardo.org/wiki/Check_postgres) plugin
2198 uses the `psql` binary to monitor a [PostgreSQL](https://www.postgresql.org/about/) database.
2200 The Git repository is located on [GitHub](https://github.com/bucardo/check_postgres).
2202 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2205 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2206 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.
2207 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2208 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2209 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2210 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2211 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2212 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2213 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2214 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2215 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2216 postgres_includeuser | **Optional.** Include objects owned by certain users.
2217 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2218 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
2219 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2220 postgres_action | **Required.** Determines the test executed.
2221 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2222 postgres_query | **Optional.** Query for "custom_query" action.
2223 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2224 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2225 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).
2227 #### mongodb <a id="plugin-contrib-command-mongodb"></a>
2229 The [check_mongodb.py](https://github.com/mzupan/nagios-plugin-mongodb) plugin
2230 uses the `pymongo` Python library to monitor a [MongoDB](https://docs.mongodb.com/manual/) instance.
2232 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2235 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2236 mongodb_host | **Required.** Specifies the hostname or address.
2237 mongodb_port | **Required.** The port mongodb is runnung on.
2238 mongodb_user | **Optional.** The username you want to login as
2239 mongodb_passwd | **Optional.** The password you want to use for that user
2240 mongodb_warning | **Optional.** The warning threshold we want to set
2241 mongodb_critical | **Optional.** The critical threshold we want to set
2242 mongodb_action | **Required.** The action you want to take
2243 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
2244 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
2245 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
2246 mongodb_database | **Optional.** Specify the database to check
2247 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
2248 mongodb_ssl | **Optional.** Connect using SSL
2249 mongodb_replicaset | **Optional.** Connect to replicaset
2250 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check
2251 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second
2252 mongodb_collection | **Optional.** Specify the collection to check
2253 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
2255 #### elasticsearch <a id="plugin-contrib-command-elasticsearch"></a>
2257 The [check_elasticsearch](https://github.com/anchor/nagios-plugin-elasticsearch) plugin
2258 uses the HTTP API to monitor an [Elasticsearch](https://www.elastic.co/products/elasticsearch) node.
2260 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2263 -----------------------------|-------------------------------------------------------------------------------------------------------
2264 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2265 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
2266 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.
2267 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2268 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2269 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2271 #### redis <a id="plugin-contrib-command-redis"></a>
2273 The [check_redis.pl](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl) plugin
2274 uses the `Redis` Perl library to monitor a [Redis](https://redis.io/) instance. The plugin can
2275 measure response time, hitrate, memory utilization, check replication synchronization, etc. It is
2276 also possible to test data in a specified key and calculate averages or summaries on ranges.
2278 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2281 -------------------------|--------------------------------------------------------------------------------------------------------------
2282 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
2283 redis_port | **Optional.** Port number to query. Default to "6379".
2284 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2285 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2286 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2287 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2288 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2289 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.
2290 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.
2291 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.
2292 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2293 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.
2294 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".
2295 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2296 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2297 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.
2298 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2299 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.
2300 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2301 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2304 ### Hardware <a id="plugin-contrib-hardware"></a>
2306 This category includes all plugin check commands for various hardware checks.
2308 #### hpasm <a id="plugin-contrib-command-hpasm"></a>
2310 The [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) plugin
2311 monitors the hardware health of HP Proliant Servers, provided that the `hpasm`
2312 (HP Advanced Server Management) software is installed. It is also able to monitor
2313 the system health of HP Bladesystems and storage systems.
2315 The plugin can run in two different ways:
2317 1. Local execution using the `hpasmcli` command line tool.
2318 2. Remote SNMP query which invokes the HP Insight Tools on the remote node.
2320 You can either set or omit `hpasm_hostname` custom attribute and select the corresponding node.
2322 The `hpasm_remote` attribute enables the plugin to execute remote SNMP queries if set to `true`.
2323 For compatibility reasons this attribute uses `true` as default value, and ensures that
2324 specifying the `hpasm_hostname` always enables remote checks.
2326 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2329 --------------------------------|-----------------------------------------------------------------------
2330 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2331 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2332 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2333 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2334 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2335 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2336 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2337 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2338 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.
2339 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.
2340 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2341 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2342 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2343 hpasm_privpassword | **Optional.** The password for authPriv security level.
2344 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2345 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2346 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.
2347 hpasm_remote | **Optional.** Run remote SNMP checks if enabled. Otherwise checks are executed locally using the `hpasmcli` binary. Defaults to `true`.
2349 #### adaptec-raid <a id="plugin-contrib-command-adaptec-raid"></a>
2351 The [check_adaptec_raid](https://github.com/thomas-krenn/check_adaptec_raid) plugin
2352 uses the `arcconf` binary to monitor Adaptec RAID controllers.
2354 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2357 --------------------------------|-----------------------------------------------------------------------
2358 adaptec_controller_number | **Required.** Controller number to monitor.
2359 arcconf_path | **Required.** Path to the `arcconf` binary, e.g. "/sbin/arcconf".
2361 #### lsi-raid <a id="plugin-contrib-command-lsi-raid"></a>
2363 The [check_lsi_raid](https://github.com/thomas-krenn/check_lsi_raid) plugin
2364 uses the `storcli` binary to monitor MegaRAID RAID controllers.
2366 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2369 --------------------------------|-----------------------------------------------------------------------
2370 lsi_controller_number | **Required.** Controller number to monitor.
2371 storcli_path | **Required.** Path to the `storcli` binary, e.g. "/usr/sbin/storcli".
2373 #### smart-attributes <a id="plugin-contrib-command-smart-attributes"></a>
2375 The [check_smart_attributes](https://github.com/thomas-krenn/check_smart_attributes) plugin
2376 uses the `smartctl` binary to monitor SMART values of SSDs and HDDs.
2378 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2381 --------------------------------|-----------------------------------------------------------------------
2382 smart_attributes_config_path | **Required.** Path to the smart attributes config file (e.g. check_smartdb.json).
2383 smart_attributes_device | **Required.** Device name (e.g. /dev/sda) to monitor.
2386 ### IcingaCLI <a id="plugin-contrib-icingacli"></a>
2388 This category includes all plugins using the icingacli provided by Icinga Web 2.
2390 #### Business Process <a id="plugin-contrib-icingacli-businessprocess"></a>
2392 This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process)
2393 and executed as `icingacli businessprocess` CLI command.
2395 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2398 ------------------------------------------|-----------------------------------------------------------------------------------------
2399 icingacli_businessprocess_process | **Required.** Business process to monitor.
2400 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2401 icingacli_businessprocess_details | **Optional.** Get details for root cause analysis. Defaults to false.
2402 icingacli_businessprocess_statetype | **Optional.** Define which state type to look at, `soft` or `hard`. Overrides the default value inside the businessprocess module, if configured.
2405 ### IPMI Devices <a id="plugin-contrib-ipmi"></a>
2407 This category includes all plugins for IPMI devices.
2409 #### ipmi-sensor <a id="plugin-contrib-command-ipmi-sensor"></a>
2411 The [check_ipmi_sensor](https://github.com/thomas-krenn/check_ipmi_sensor_v3) plugin
2412 uses the `ipmimonitoring` binary to monitor sensor data for IPMI devices. Please
2413 read the [documentation](https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin)
2414 for installation and configuration details.
2416 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2419 ---------------------------------|-----------------------------------------------------------------------------------------------------
2420 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2421 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2422 ipmi_username | **Optional.** The IPMI username.
2423 ipmi_password | **Optional.** The IPMI password.
2424 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2425 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2426 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2427 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.
2428 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2429 ipmi_exclude_sensor | **Optional.** Exclude sensor based on IPMI sensor type. (Comma-separated)
2430 ipmi_exclude_sel | **Optional.** Exclude SEL entries of specific sensor types. (comma-separated list).
2431 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2432 ipmi_protocol_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2433 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2434 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2435 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2436 ipmi_verbose | **Optional.** Be Verbose multi line output, also with additional details for warnings.
2437 ipmi_debug | **Optional.** Be Verbose debugging output, followed by normal multi line output.
2439 #### ipmi-alive <a id="plugin-contrib-command-ipmi-alive"></a>
2441 The `ipmi-alive` check commands allows you to create a ping check for the IPMI Interface.
2443 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2446 ---------------------------------|-----------------------------------------------------------------------------------------------------
2447 ping_address | **Optional.** The address of the IPMI interface. Defaults to "$address$" if the IPMI interface's `address` attribute is set, "$address6$" otherwise.
2448 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 5000.
2449 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 100.
2450 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
2451 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
2452 ping_packets | **Optional.** The number of packets to send. Defaults to 1.
2453 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
2456 ### Log Management <a id="plugins-contrib-log-management"></a>
2458 This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
2460 #### logstash <a id="plugins-contrib-command-logstash"></a>
2462 The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
2463 the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
2465 The Node API is not activated by default. You have to configure your Logstash
2466 installation in order to allow plugin connections.
2469 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2470 logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
2471 logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
2472 logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
2473 logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
2474 logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
2475 logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
2476 logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
2477 logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
2478 logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
2479 logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
2482 ### Metrics <a id="plugin-contrib-metrics"></a>
2484 This category includes all plugins for metric-based checks.
2486 #### graphite <a id="plugin-contrib-command-graphite"></a>
2488 The [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin
2489 uses the `rest-client` Ruby library to monitor a [Graphite](https://graphiteapp.org) instance.
2491 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2494 ------------------------------------|-----------------------------------------------------------------------------------------------------
2495 graphite_url | **Required.** Target url.
2496 graphite_metric | **Required.** Metric path string.
2497 graphite_shortname | **Optional.** Metric short name (used for performance data).
2498 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2499 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2500 graphite_warning | **Required.** Warning threshold.
2501 graphite_critical | **Required.** Critical threshold.
2502 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.
2503 graphite_message | **Optional.** Text message to output (default: "metric count:").
2504 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2505 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2507 ### Network Components <a id="plugin-contrib-network-components"></a>
2509 This category includes all plugins for various network components like routers, switches and firewalls.
2511 #### interfacetable <a id="plugin-contrib-command-interfacetable"></a>
2513 The [check_interfacetable_v3t](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) plugin
2514 generates a html page containing information about the monitored node and all of its interfaces.
2516 The Git repository is located on [GitHub](https://github.com/Tontonitch/interfacetable_v3t).
2518 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2521 ------------------------------------|-----------------------------------------------------------------------------------------------------
2522 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2523 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2524 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2525 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2526 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2527 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2528 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2529 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2530 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2531 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2532 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2533 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2534 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.
2535 interfacetable_trackproperty | **Optional.** List of tracked properties.
2536 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2537 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2538 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
2539 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
2540 interfacetable_login | **Optional.** Login for snmpv3 authentication.
2541 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
2542 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
2543 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
2544 interfacetable_domain | **Optional.** SNMP transport domain.
2545 interfacetable_contextname | **Optional.** Context name for the snmp requests.
2546 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
2547 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
2548 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
2549 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
2550 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
2551 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.
2552 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
2553 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
2554 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
2555 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
2556 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
2557 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
2558 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
2559 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
2560 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
2561 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".
2562 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
2563 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
2564 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"
2565 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
2566 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
2567 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.
2568 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.
2569 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
2570 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
2571 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
2572 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
2573 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
2574 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
2575 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
2576 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
2577 interfacetable_config | **Optional.** Specify a config file to load.
2578 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
2579 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
2580 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
2581 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
2582 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
2584 #### iftraffic <a id="plugin-contrib-command-iftraffic"></a>
2586 The [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic) plugin
2587 checks the utilization of a given interface name using the SNMP protocol.
2589 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2592 ------------------------|---------------------------------------------------------
2593 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
2594 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2595 iftraffic_interface | **Required.** Queried interface name.
2596 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2597 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2598 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2599 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2600 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2602 #### iftraffic64 <a id="plugin-contrib-command-iftraffic64"></a>
2604 The [check_iftraffic64](https://exchange.icinga.com/exchange/iftraffic64) plugin
2605 checks the utilization of a given interface name using the SNMP protocol.
2607 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2610 ------------------------|---------------------------------------------------------
2611 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
2612 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2613 iftraffic64_interface | **Required.** Queried interface name.
2614 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2615 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2616 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2617 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2618 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2620 #### interfaces <a id="plugin-contrib-command-interfaces"></a>
2622 The [check_interfaces](https://git.netways.org/plugins/check_interfaces) plugin
2623 uses SNMP to monitor network interfaces and their utilization.
2625 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2628 --------------------------|---------------------------------------------------------
2629 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2630 interfaces_regex | **Optional.** Interface list regexp.
2631 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
2632 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
2633 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
2634 interfaces_perfdata | **Optional.** perfdata from last check result.
2635 interfaces_prefix | **Optional.** Prefix interface names with this label.
2636 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
2637 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
2638 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
2639 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
2640 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
2641 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
2642 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
2643 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
2644 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
2645 interfaces_user | **Optional.** SNMPv3 User
2646 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
2647 interfaces_aliases | **Optional.** Retrieves the interface description.
2648 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
2649 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
2650 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
2651 interfaces_names | **Optional.** If set to true, use ifName instead of ifDescr.
2653 #### nwc_health <a id="plugin-contrib-command-nwc_health"></a>
2655 The [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html) plugin
2656 uses SNMP to monitor network components. The plugin is able to generate interface statistics,
2657 check hardware (CPU, memory, fan, power, etc.), monitor firewall policies, HRSP, load-balancer
2658 pools, processor and memory usage.
2660 Currently the following network components are supported: Cisco IOS, Cisco Nexus, Cisco ASA,
2661 Cisco PIX, F5 BIG-IP, CheckPoint Firewall1, Juniper NetScreen, HP Procurve, Nortel, Brocade 4100/4900,
2662 EMC DS 4700, EMC DS 24, Allied Telesyn. Blue Coat SG600, Cisco Wireless Lan Controller 5500,
2663 Brocade ICX6610-24-HPOE, Cisco UC Telefonzeugs, FOUNDRY-SN-AGENT-MIB, FRITZ!BOX 7390, FRITZ!DECT 200,
2664 Juniper IVE, Pulse-Gateway MAG4610, Cisco IronPort AsyncOS, Foundry, etc. A complete list can be
2665 found in the plugin [documentation](https://labs.consol.de/nagios/check_nwc_health/index.html).
2667 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2670 --------------------------------|---------------------------------------------------------
2671 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2672 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).
2673 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
2674 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
2675 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
2676 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).
2677 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2678 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2679 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2680 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
2681 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2682 nwc_health_privpassword | **Optional.** The password for authPriv security level.
2683 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2684 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
2685 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
2686 nwc_health_name | **Optional.** The name of an interface (ifDescr).
2687 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
2688 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
2689 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
2690 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
2691 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
2692 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
2693 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
2694 nwc_health_name2 | **Optional.** The secondary name of a component.
2695 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
2696 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)
2697 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.
2698 nwc_health_warning | **Optional.** The warning threshold
2699 nwc_health_critical | **Optional.** The critical threshold
2700 nwc_health_warningx | **Optional.** The extended warning thresholds
2701 nwc_health_criticalx | **Optional.** The extended critical thresholds
2702 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning (1) or ok (0).
2703 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.
2704 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'
2705 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
2706 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
2707 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
2708 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2709 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
2710 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
2711 nwc_health_multiline | **Optional.** Multiline output
2714 ### Operating System <a id="plugin-contrib-operating-system"></a>
2716 This category contains plugins which receive details about your operating system
2717 or the guest system.
2719 #### mem <a id="plugin-contrib-command-mem"></a>
2721 The [check_mem.pl](https://github.com/justintime/nagios-plugins) plugin checks the
2722 memory usage on linux and unix hosts. It is able to count cache memory as free when
2723 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).
2725 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2728 -------------|-----------------------------------------------------------------------------------------------------------------------
2729 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
2730 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
2731 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
2732 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
2733 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
2735 #### running_kernel <a id="plugin-contrib-command-running_kernel"></a>
2737 The [check_running_kernel](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin
2738 is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu.
2743 ---------------------------|-------------
2744 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
2746 #### iostats <a id="plugin-contrib-command-iostats"></a>
2748 The [check_iostats](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostats) plugin
2749 uses the `iostat` binary to monitor I/O on a Linux host. The default thresholds are rather high
2750 so you can use a grapher for baselining before setting your own.
2752 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2755 ---------------|-----------------------------------------------------------------------------------------------------------------------
2756 iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2757 iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000)
2758 iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000)
2759 iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000)
2760 iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50)
2761 iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000)
2762 iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000)
2763 iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000)
2764 iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80)
2766 #### iostat <a id="plugin-contrib-command-iostat"></a>
2768 The [check_iostat](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostat) plugin
2769 uses the `iostat` binary to monitor disk I/O on a Linux host. The default thresholds are rather high
2770 so you can use a grapher for baselining before setting your own.
2772 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2775 ---------------|-----------------------------------------------------------------------------------------------------------------------
2776 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2777 iostat\_wtps | **Required.** Warning threshold for tps (default: 100)
2778 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100)
2779 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100)
2780 iostat\_ctps | **Required.** Critical threshold for tps (default: 200)
2781 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200)
2782 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200)
2784 #### yum <a id="plugin-contrib-command-yum"></a>
2786 The [check_yum](https://github.com/calestyo/check_yum) plugin checks the YUM package
2787 management system for package updates.
2788 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
2790 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2793 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2794 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.
2795 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
2796 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.
2797 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.
2798 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.
2799 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.
2800 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.
2801 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
2802 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
2804 ### Storage <a id="plugins-contrib-storage"></a>
2806 This category includes all plugins for various storage and object storage technologies.
2808 #### glusterfs <a id="plugins-contrib-command-glusterfs"></a>
2810 The [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) plugin
2811 is used to check the GlusterFS storage health on the server.
2812 The plugin requires `sudo` permissions.
2814 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2817 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2818 glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
2819 glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
2820 glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
2821 glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
2822 glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
2823 glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
2824 glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
2827 ### Virtualization <a id="plugin-contrib-virtualization"></a>
2829 This category includes all plugins for various virtualization technologies.
2831 #### esxi_hardware <a id="plugin-contrib-command-esxi-hardware"></a>
2833 The [check_esxi_hardware.py](https://www.claudiokuenzler.com/nagios-plugins/check_esxi_hardware.php) plugin
2834 uses the [pywbem](https://pywbem.github.io/pywbem/) Python library to monitor the hardware of ESXi servers
2835 through the [VMWare API](https://www.vmware.com/support/pubs/sdk_pubs.html) and CIM service.
2837 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2840 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2841 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
2842 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.
2843 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.
2844 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
2845 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
2846 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
2847 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
2848 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
2849 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2850 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2851 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2852 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2853 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2855 #### VMware <a id="plugin-contrib-vmware"></a>
2857 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
2859 **vmware-esx-dc-volumes**
2861 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2863 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2866 ------------------------|--------------
2867 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2868 vmware_cluster | **Optional.** ESX or ESXi clustername.
2869 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2870 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2871 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2872 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2873 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2874 vmware_sessionfile | **Optional.** Session file name enhancement.
2875 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2876 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2877 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2878 vmware_password | **Optional.** The username's password. No value defined as default.
2879 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2880 vmware_subselect | **Optional.** Volume name to be checked the free space.
2881 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2882 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2883 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2884 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2885 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2886 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2887 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
2888 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2889 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2892 **vmware-esx-dc-runtime-info**
2894 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
2896 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2899 ------------------------|--------------
2900 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2901 vmware_cluster | **Optional.** ESX or ESXi clustername.
2902 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2903 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2904 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2905 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2906 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2907 vmware_sessionfile | **Optional.** Session file name enhancement.
2908 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2909 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2910 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2911 vmware_password | **Optional.** The username's password. No value defined as default.
2912 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2915 **vmware-esx-dc-runtime-listvms**
2917 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.
2919 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2922 ------------------------|--------------
2923 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2924 vmware_cluster | **Optional.** ESX or ESXi clustername.
2925 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2926 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2927 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2928 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2929 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2930 vmware_sessionfile | **Optional.** Session file name enhancement.
2931 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2932 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2933 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2934 vmware_password | **Optional.** The username's password. No value defined as default.
2935 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2936 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2937 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2938 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2939 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2940 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
2943 **vmware-esx-dc-runtime-listhost**
2945 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
2947 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2950 ------------------------|--------------
2951 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2952 vmware_cluster | **Optional.** ESX or ESXi clustername.
2953 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2954 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2955 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2956 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2957 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2958 vmware_sessionfile | **Optional.** Session file name enhancement.
2959 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2960 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2961 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2962 vmware_password | **Optional.** The username's password. No value defined as default.
2963 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2964 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2965 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
2966 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
2967 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2968 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.
2971 **vmware-esx-dc-runtime-listcluster**
2973 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
2975 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2978 ------------------------|--------------
2979 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2980 vmware_cluster | **Optional.** ESX or ESXi clustername.
2981 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2982 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2983 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2984 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2985 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2986 vmware_sessionfile | **Optional.** Session file name enhancement.
2987 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2988 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2989 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2990 vmware_password | **Optional.** The username's password. No value defined as default.
2991 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2992 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2993 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
2994 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
2995 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2996 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
2999 **vmware-esx-dc-runtime-issues**
3001 Check command object for the `check_vmware_esx` plugin. All issues for the host.
3003 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3006 ------------------------|--------------
3007 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3008 vmware_cluster | **Optional.** ESX or ESXi clustername.
3009 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3010 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3011 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3012 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3013 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3014 vmware_sessionfile | **Optional.** Session file name enhancement.
3015 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3016 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3017 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3018 vmware_password | **Optional.** The username's password. No value defined as default.
3019 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3020 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
3021 vmware_include | **Optional.** Whitelist issues. No value defined as default.
3022 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3023 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.
3026 **vmware-esx-dc-runtime-status**
3028 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3030 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3033 ------------------------|--------------
3034 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3035 vmware_cluster | **Optional.** ESX or ESXi clustername.
3036 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3037 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3038 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3039 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3040 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3041 vmware_sessionfile | **Optional.** Session file name enhancement.
3042 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3043 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3044 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3045 vmware_password | **Optional.** The username's password. No value defined as default.
3046 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3049 **vmware-esx-dc-runtime-tools**
3051 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
3053 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3056 ------------------------|--------------
3057 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3058 vmware_cluster | **Optional.** ESX or ESXi clustername.
3059 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3060 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3061 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3062 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3063 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3064 vmware_sessionfile | **Optional.** Session file name enhancement.
3065 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3066 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3067 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3068 vmware_password | **Optional.** The username's password. No value defined as default.
3069 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3070 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
3071 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
3072 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
3073 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
3074 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3075 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.
3076 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
3079 **vmware-esx-soap-host-check**
3081 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
3083 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3086 ------------------------|--------------
3087 vmware_host | **Required.** ESX or ESXi hostname.
3088 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3089 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3090 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3091 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3092 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3093 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3094 vmware_sessionfile | **Optional.** Session file name enhancement.
3095 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3096 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3097 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3098 vmware_password | **Optional.** The username's password. No value defined as default.
3099 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3102 **vmware-esx-soap-host-uptime**
3104 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
3106 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3109 ------------------------|--------------
3110 vmware_host | **Required.** ESX or ESXi hostname.
3111 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3112 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3113 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3114 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3115 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3116 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3117 vmware_sessionfile | **Optional.** Session file name enhancement.
3118 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3119 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3120 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3121 vmware_password | **Optional.** The username's password. No value defined as default.
3122 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3125 **vmware-esx-soap-host-cpu**
3127 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
3129 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3132 ------------------------|--------------
3133 vmware_host | **Required.** ESX or ESXi hostname.
3134 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3135 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3136 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3137 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3138 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3139 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3140 vmware_sessionfile | **Optional.** Session file name enhancement.
3141 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3142 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3143 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3144 vmware_password | **Optional.** The username's password. No value defined as default.
3145 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3146 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3147 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3150 **vmware-esx-soap-host-cpu-ready**
3152 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.
3154 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3157 ------------------------|--------------
3158 vmware_host | **Required.** ESX or ESXi hostname.
3159 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3160 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3161 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3162 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3163 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3164 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3165 vmware_sessionfile | **Optional.** Session file name enhancement.
3166 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3167 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3168 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3169 vmware_password | **Optional.** The username's password. No value defined as default.
3170 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3173 **vmware-esx-soap-host-cpu-wait**
3175 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.
3177 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3180 ------------------------|--------------
3181 vmware_host | **Required.** ESX or ESXi hostname.
3182 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3183 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3184 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3185 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3186 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3187 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3188 vmware_sessionfile | **Optional.** Session file name enhancement.
3189 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3190 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3191 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3192 vmware_password | **Optional.** The username's password. No value defined as default.
3193 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3196 **vmware-esx-soap-host-cpu-usage**
3198 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.
3200 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3203 ------------------------|--------------
3204 vmware_host | **Required.** ESX or ESXi hostname.
3205 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3206 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3207 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3208 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3209 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3210 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3211 vmware_sessionfile | **Optional.** Session file name enhancement.
3212 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3213 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3214 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3215 vmware_password | **Optional.** The username's password. No value defined as default.
3216 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3217 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3218 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3221 **vmware-esx-soap-host-mem**
3223 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3225 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3228 ------------------------|--------------
3229 vmware_host | **Required.** ESX or ESXi hostname.
3230 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3231 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3232 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3233 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3234 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3235 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3236 vmware_sessionfile | **Optional.** Session file name enhancement.
3237 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3238 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3239 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3240 vmware_password | **Optional.** The username's password. No value defined as default.
3241 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3244 **vmware-esx-soap-host-mem-usage**
3246 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3248 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3251 ------------------------|--------------
3252 vmware_host | **Required.** ESX or ESXi hostname.
3253 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3254 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3255 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3256 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3257 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3258 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3259 vmware_sessionfile | **Optional.** Session file name enhancement.
3260 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3261 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3262 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3263 vmware_password | **Optional.** The username's password. No value defined as default.
3264 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3265 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3266 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3269 **vmware-esx-soap-host-mem-consumed**
3271 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.
3273 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3276 ------------------------|--------------
3277 vmware_host | **Required.** ESX or ESXi hostname.
3278 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3279 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3280 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3281 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3282 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3283 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3284 vmware_sessionfile | **Optional.** Session file name enhancement.
3285 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3286 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3287 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3288 vmware_password | **Optional.** The username's password. No value defined as default.
3289 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3290 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3291 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3294 **vmware-esx-soap-host-mem-swapused**
3296 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.
3298 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3301 ------------------------|--------------
3302 vmware_host | **Required.** ESX or ESXi hostname.
3303 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3304 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3305 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3306 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3307 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3308 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3309 vmware_sessionfile | **Optional.** Session file name enhancement.
3310 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3311 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3312 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3313 vmware_password | **Optional.** The username's password. No value defined as default.
3314 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3315 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3316 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3317 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.
3320 **vmware-esx-soap-host-mem-overhead**
3322 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3324 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3327 ------------------------|--------------
3328 vmware_host | **Required.** ESX or ESXi hostname.
3329 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3330 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3331 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3332 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3333 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3334 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3335 vmware_sessionfile | **Optional.** Session file name enhancement.
3336 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3337 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3338 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3339 vmware_password | **Optional.** The username's password. No value defined as default.
3340 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3341 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3342 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3345 **vmware-esx-soap-host-mem-memctl**
3347 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.
3349 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3352 ------------------------|--------------
3353 vmware_host | **Required.** ESX or ESXi hostname.
3354 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3355 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3356 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3357 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3358 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3359 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3360 vmware_sessionfile | **Optional.** Session file name enhancement.
3361 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3362 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3363 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3364 vmware_password | **Optional.** The username's password. No value defined as default.
3365 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3366 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3367 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3368 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.
3371 **vmware-esx-soap-host-net**
3373 Check command object for the `check_vmware_esx` plugin. Shows net info.
3375 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3378 ------------------------|--------------
3379 vmware_host | **Required.** ESX or ESXi hostname.
3380 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3381 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3382 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3383 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3384 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3385 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3386 vmware_sessionfile | **Optional.** Session file name enhancement.
3387 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3388 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3389 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3390 vmware_password | **Optional.** The username's password. No value defined as default.
3391 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3392 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3393 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3396 **vmware-esx-soap-host-net-usage**
3398 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3400 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3403 ------------------------|--------------
3404 vmware_host | **Required.** ESX or ESXi hostname.
3405 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3406 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3407 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3408 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3409 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3410 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3411 vmware_sessionfile | **Optional.** Session file name enhancement.
3412 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3413 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3414 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3415 vmware_password | **Optional.** The username's password. No value defined as default.
3416 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3417 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3418 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3421 **vmware-esx-soap-host-net-receive**
3423 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
3425 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3428 ------------------------|--------------
3429 vmware_host | **Required.** ESX or ESXi hostname.
3430 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3431 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3432 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3433 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3434 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3435 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3436 vmware_sessionfile | **Optional.** Session file name enhancement.
3437 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3438 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3439 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3440 vmware_password | **Optional.** The username's password. No value defined as default.
3441 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3442 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3443 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3446 **vmware-esx-soap-host-net-send**
3448 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
3450 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3453 ------------------------|--------------
3454 vmware_host | **Required.** ESX or ESXi hostname.
3455 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3456 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3457 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3458 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3459 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3460 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3461 vmware_sessionfile | **Optional.** Session file name enhancement.
3462 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3463 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3464 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3465 vmware_password | **Optional.** The username's password. No value defined as default.
3466 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3467 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3468 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3471 **vmware-esx-soap-host-net-nic**
3473 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
3475 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3478 ------------------------|--------------
3479 vmware_host | **Required.** ESX or ESXi hostname.
3480 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3481 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3482 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3483 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3484 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3485 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3486 vmware_sessionfile | **Optional.** Session file name enhancement.
3487 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3488 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3489 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3490 vmware_password | **Optional.** The username's password. No value defined as default.
3491 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3492 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3493 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3496 **vmware-esx-soap-host-volumes**
3498 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
3500 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3503 ------------------------|--------------
3504 vmware_host | **Required.** ESX or ESXi hostname.
3505 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3506 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3507 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3508 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3509 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3510 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3511 vmware_sessionfile | **Optional.** Session file name enhancement.
3512 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3513 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3514 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3515 vmware_password | **Optional.** The username's password. No value defined as default.
3516 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3517 vmware_subselect | **Optional.** Volume name to be checked the free space.
3518 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3519 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3520 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3521 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3522 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3523 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3524 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3525 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3526 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
3529 **vmware-esx-soap-host-io**
3531 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.
3533 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3536 ------------------------|--------------
3537 vmware_host | **Required.** ESX or ESXi hostname.
3538 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3539 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3540 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3541 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3542 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3543 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3544 vmware_sessionfile | **Optional.** Session file name enhancement.
3545 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3546 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3547 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3548 vmware_password | **Optional.** The username's password. No value defined as default.
3549 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3552 **vmware-esx-soap-host-io-aborted**
3554 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
3556 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3559 ------------------------|--------------
3560 vmware_host | **Required.** ESX or ESXi hostname.
3561 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3562 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3563 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3564 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3565 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3566 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3567 vmware_sessionfile | **Optional.** Session file name enhancement.
3568 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3569 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3570 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3571 vmware_password | **Optional.** The username's password. No value defined as default.
3572 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3573 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3574 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3577 **vmware-esx-soap-host-io-resets**
3579 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
3581 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3584 ------------------------|--------------
3585 vmware_host | **Required.** ESX or ESXi hostname.
3586 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3587 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3588 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3589 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3590 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3591 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3592 vmware_sessionfile | **Optional.** Session file name enhancement.
3593 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3594 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3595 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3596 vmware_password | **Optional.** The username's password. No value defined as default.
3597 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3598 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3599 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3602 **vmware-esx-soap-host-io-read**
3604 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3606 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3609 ------------------------|--------------
3610 vmware_host | **Required.** ESX or ESXi hostname.
3611 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3612 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3613 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3614 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3615 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3616 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3617 vmware_sessionfile | **Optional.** Session file name enhancement.
3618 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3619 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3620 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3621 vmware_password | **Optional.** The username's password. No value defined as default.
3622 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3623 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3624 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3627 **vmware-esx-soap-host-io-read-latency**
3629 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.
3631 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3634 ------------------------|--------------
3635 vmware_host | **Required.** ESX or ESXi hostname.
3636 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3637 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3638 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3639 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3640 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3641 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3642 vmware_sessionfile | **Optional.** Session file name enhancement.
3643 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3644 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3645 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3646 vmware_password | **Optional.** The username's password. No value defined as default.
3647 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3648 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3649 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3652 **vmware-esx-soap-host-io-write**
3654 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3656 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3659 ------------------------|--------------
3660 vmware_host | **Required.** ESX or ESXi hostname.
3661 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3662 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3663 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3664 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3665 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3666 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3667 vmware_sessionfile | **Optional.** Session file name enhancement.
3668 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3669 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3670 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3671 vmware_password | **Optional.** The username's password. No value defined as default.
3672 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3673 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3674 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3677 **vmware-esx-soap-host-io-write-latency**
3679 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.
3681 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3684 ------------------------|--------------
3685 vmware_host | **Required.** ESX or ESXi hostname.
3686 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3687 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3688 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3689 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3690 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3691 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3692 vmware_sessionfile | **Optional.** Session file name enhancement.
3693 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3694 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3695 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3696 vmware_password | **Optional.** The username's password. No value defined as default.
3697 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3698 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3699 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3702 **vmware-esx-soap-host-io-usage**
3704 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.
3706 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3709 ------------------------|--------------
3710 vmware_host | **Required.** ESX or ESXi hostname.
3711 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3712 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3713 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3714 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3715 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3716 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3717 vmware_sessionfile | **Optional.** Session file name enhancement.
3718 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3719 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3720 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3721 vmware_password | **Optional.** The username's password. No value defined as default.
3722 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3723 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3724 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3727 **vmware-esx-soap-host-io-kernel-latency**
3729 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
3731 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3734 ------------------------|--------------
3735 vmware_host | **Required.** ESX or ESXi hostname.
3736 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3737 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3738 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3739 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3740 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3741 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3742 vmware_sessionfile | **Optional.** Session file name enhancement.
3743 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3744 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3745 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3746 vmware_password | **Optional.** The username's password. No value defined as default.
3747 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3748 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3749 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3752 **vmware-esx-soap-host-io-device-latency**
3754 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
3756 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3759 ------------------------|--------------
3760 vmware_host | **Required.** ESX or ESXi hostname.
3761 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3762 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3763 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3764 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3765 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3766 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3767 vmware_sessionfile | **Optional.** Session file name enhancement.
3768 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3769 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3770 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3771 vmware_password | **Optional.** The username's password. No value defined as default.
3772 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3773 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3774 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3777 **vmware-esx-soap-host-io-queue-latency**
3779 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
3781 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3784 ------------------------|--------------
3785 vmware_host | **Required.** ESX or ESXi hostname.
3786 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3787 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3788 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3789 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3790 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3791 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3792 vmware_sessionfile | **Optional.** Session file name enhancement.
3793 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3794 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3795 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3796 vmware_password | **Optional.** The username's password. No value defined as default.
3797 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3798 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3799 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3802 **vmware-esx-soap-host-io-total-latency**
3804 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.
3806 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3809 ------------------------|--------------
3810 vmware_host | **Required.** ESX or ESXi hostname.
3811 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3812 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3813 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3814 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3815 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3816 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3817 vmware_sessionfile | **Optional.** Session file name enhancement.
3818 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3819 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3820 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3821 vmware_password | **Optional.** The username's password. No value defined as default.
3822 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3823 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3824 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3827 **vmware-esx-soap-host-media**
3829 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.
3831 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3834 ------------------------|--------------
3835 vmware_host | **Required.** ESX or ESXi hostname.
3836 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3837 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3838 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3839 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3840 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3841 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3842 vmware_sessionfile | **Optional.** Session file name enhancement.
3843 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3844 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3845 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3846 vmware_password | **Optional.** The username's password. No value defined as default.
3847 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3848 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3849 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3850 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3851 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.
3854 **vmware-esx-soap-host-service**
3856 Check command object for the `check_vmware_esx` plugin. Shows host service info.
3858 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3861 ------------------------|--------------
3862 vmware_host | **Required.** ESX or ESXi hostname.
3863 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3864 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3865 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3866 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3867 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3868 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3869 vmware_sessionfile | **Optional.** Session file name enhancement.
3870 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3871 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3872 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3873 vmware_password | **Optional.** The username's password. No value defined as default.
3874 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3875 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
3876 vmware_include | **Optional.** Whitelist services name. No value defined as default.
3877 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3878 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.
3881 **vmware-esx-soap-host-runtime**
3883 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.
3885 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3888 ------------------------|--------------
3889 vmware_host | **Required.** ESX or ESXi hostname.
3890 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3891 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3892 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3893 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3894 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3895 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3896 vmware_sessionfile | **Optional.** Session file name enhancement.
3897 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3898 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3899 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3900 vmware_password | **Optional.** The username's password. No value defined as default.
3901 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3904 **vmware-esx-soap-host-runtime-con**
3906 Check command object for the `check_vmware_esx` plugin. Shows connection state.
3908 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3911 ------------------------|--------------
3912 vmware_host | **Required.** ESX or ESXi hostname.
3913 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3914 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3915 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3916 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3917 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3918 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3919 vmware_sessionfile | **Optional.** Session file name enhancement.
3920 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3921 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3922 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3923 vmware_password | **Optional.** The username's password. No value defined as default.
3924 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3927 **vmware-esx-soap-host-runtime-listvms**
3929 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
3931 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3934 ------------------------|--------------
3935 vmware_host | **Required.** ESX or ESXi hostname.
3936 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3937 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3938 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3939 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3940 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3941 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3942 vmware_sessionfile | **Optional.** Session file name enhancement.
3943 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3944 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3945 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3946 vmware_password | **Optional.** The username's password. No value defined as default.
3947 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3948 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3949 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3950 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3951 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.
3954 **vmware-esx-soap-host-runtime-status**
3956 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3958 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3961 ------------------------|--------------
3962 vmware_host | **Required.** ESX or ESXi hostname.
3963 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3964 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3965 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3966 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3967 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3968 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3969 vmware_sessionfile | **Optional.** Session file name enhancement.
3970 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3971 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3972 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3973 vmware_password | **Optional.** The username's password. No value defined as default.
3974 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3977 **vmware-esx-soap-host-runtime-health**
3979 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
3981 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3984 ------------------------|--------------
3985 vmware_host | **Required.** ESX or ESXi hostname.
3986 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3987 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3988 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3989 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3990 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3991 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3992 vmware_sessionfile | **Optional.** Session file name enhancement.
3993 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3994 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3995 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3996 vmware_password | **Optional.** The username's password. No value defined as default.
3997 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3998 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3999 vmware_include | **Optional.** Whitelist status name. No value defined as default.
4000 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4003 **vmware-esx-soap-host-runtime-health-listsensors**
4005 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
4007 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4010 ------------------------|--------------
4011 vmware_host | **Required.** ESX or ESXi hostname.
4012 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4013 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4014 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4015 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4016 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4017 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4018 vmware_sessionfile | **Optional.** Session file name enhancement.
4019 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4020 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4021 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4022 vmware_password | **Optional.** The username's password. No value defined as default.
4023 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4024 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
4025 vmware_include | **Optional.** Whitelist status name. No value defined as default.
4026 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4029 **vmware-esx-soap-host-runtime-health-nostoragestatus**
4031 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**.
4033 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4036 ------------------------|--------------
4037 vmware_host | **Required.** ESX or ESXi hostname.
4038 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4039 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4040 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4041 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4042 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4043 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4044 vmware_sessionfile | **Optional.** Session file name enhancement.
4045 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4046 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4047 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4048 vmware_password | **Optional.** The username's password. No value defined as default.
4049 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4050 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
4051 vmware_include | **Optional.** Whitelist status name. No value defined as default.
4052 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4055 **vmware-esx-soap-host-runtime-storagehealth**
4057 Check command object for the `check_vmware_esx` plugin. Local storage status check.
4059 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4062 ------------------------|--------------
4063 vmware_host | **Required.** ESX or ESXi hostname.
4064 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4065 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4066 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4067 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4068 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4069 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4070 vmware_sessionfile | **Optional.** Session file name enhancement.
4071 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4072 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4073 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4074 vmware_password | **Optional.** The username's password. No value defined as default.
4075 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4076 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
4077 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
4078 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4079 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.
4082 **vmware-esx-soap-host-runtime-temp**
4084 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
4086 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4089 ------------------------|--------------
4090 vmware_host | **Required.** ESX or ESXi hostname.
4091 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4092 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4093 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4094 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4095 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4096 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4097 vmware_sessionfile | **Optional.** Session file name enhancement.
4098 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4099 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4100 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4101 vmware_password | **Optional.** The username's password. No value defined as default.
4102 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4103 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
4104 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
4105 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4106 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.
4109 **vmware-esx-soap-host-runtime-issues**
4111 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
4113 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4116 ------------------------|--------------
4117 vmware_host | **Required.** ESX or ESXi hostname.
4118 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4119 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4120 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4121 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4122 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4123 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4124 vmware_sessionfile | **Optional.** Session file name enhancement.
4125 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4126 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4127 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4128 vmware_password | **Optional.** The username's password. No value defined as default.
4129 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4130 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
4131 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
4132 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4133 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.
4136 **vmware-esx-soap-host-storage**
4138 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
4140 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4143 ------------------------|--------------
4144 vmware_host | **Required.** ESX or ESXi hostname.
4145 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4146 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4147 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4148 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4149 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4150 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4151 vmware_sessionfile | **Optional.** Session file name enhancement.
4152 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4153 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4154 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4155 vmware_password | **Optional.** The username's password. No value defined as default.
4156 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4157 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
4158 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
4159 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4162 **vmware-esx-soap-host-storage-adapter**
4164 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
4166 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4169 ------------------------|--------------
4170 vmware_host | **Required.** ESX or ESXi hostname.
4171 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4172 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4173 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4174 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4175 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4176 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4177 vmware_sessionfile | **Optional.** Session file name enhancement.
4178 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4179 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4180 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4181 vmware_password | **Optional.** The username's password. No value defined as default.
4182 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4183 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
4184 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
4185 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4186 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.
4189 **vmware-esx-soap-host-storage-lun**
4191 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.
4193 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4196 ------------------------|--------------
4197 vmware_host | **Required.** ESX or ESXi hostname.
4198 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4199 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4200 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4201 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4202 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4203 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4204 vmware_sessionfile | **Optional.** Session file name enhancement.
4205 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4206 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4207 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4208 vmware_password | **Optional.** The username's password. No value defined as default.
4209 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4210 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
4211 vmware_include | **Optional.** Whitelist luns. No value defined as default.
4212 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4213 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.
4216 **vmware-esx-soap-host-storage-path**
4218 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
4220 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4223 ------------------------|--------------
4224 vmware_host | **Required.** ESX or ESXi hostname.
4225 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4226 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4227 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4228 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4229 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4230 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4231 vmware_sessionfile | **Optional.** Session file name enhancement.
4232 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4233 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4234 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4235 vmware_password | **Optional.** The username's password. No value defined as default.
4236 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4237 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4238 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4239 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4240 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4241 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.
4242 vmware_standbyok | **Optional.** For storage systems where a standby multipath is ok and not a warning. Defaults to false.
4245 **vmware-esx-soap-vm-cpu**
4247 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4249 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4252 ------------------------|--------------
4253 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4254 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4255 vmware_vmname | **Required.** Virtual machine name.
4256 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4257 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4258 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4259 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4260 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4261 vmware_sessionfile | **Optional.** Session file name enhancement.
4262 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4263 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4264 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4265 vmware_password | **Optional.** The username's password. No value defined as default.
4266 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4270 **vmware-esx-soap-vm-cpu-ready**
4272 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.
4274 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4277 ------------------------|--------------
4278 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4279 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4280 vmware_vmname | **Required.** Virtual machine name.
4281 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4282 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4283 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4284 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4285 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4286 vmware_sessionfile | **Optional.** Session file name enhancement.
4287 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4288 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4289 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4290 vmware_password | **Optional.** The username's password. No value defined as default.
4291 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4292 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4293 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4296 **vmware-esx-soap-vm-cpu-wait**
4298 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.
4300 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4303 ------------------------|--------------
4304 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4305 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4306 vmware_vmname | **Required.** Virtual machine name.
4307 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4308 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4309 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4310 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4311 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4312 vmware_sessionfile | **Optional.** Session file name enhancement.
4313 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4314 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4315 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4316 vmware_password | **Optional.** The username's password. No value defined as default.
4317 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4318 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4319 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4322 **vmware-esx-soap-vm-cpu-usage**
4324 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.
4326 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4329 ------------------------|--------------
4330 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4331 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4332 vmware_vmname | **Required.** Virtual machine name.
4333 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4334 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4335 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4336 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4337 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4338 vmware_sessionfile | **Optional.** Session file name enhancement.
4339 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4340 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4341 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4342 vmware_password | **Optional.** The username's password. No value defined as default.
4343 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4344 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4345 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4348 **vmware-esx-soap-vm-mem**
4350 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4352 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4355 ------------------------|--------------
4356 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4357 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4358 vmware_vmname | **Required.** Virtual machine name.
4359 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4360 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4361 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4362 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4363 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4364 vmware_sessionfile | **Optional.** Session file name enhancement.
4365 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4366 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4367 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4368 vmware_password | **Optional.** The username's password. No value defined as default.
4369 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4372 **vmware-esx-soap-vm-mem-usage**
4374 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4376 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4379 ------------------------|--------------
4380 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4381 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4382 vmware_vmname | **Required.** Virtual machine name.
4383 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4384 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4385 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4386 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4387 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4388 vmware_sessionfile | **Optional.** Session file name enhancement.
4389 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4390 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4391 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4392 vmware_password | **Optional.** The username's password. No value defined as default.
4393 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4394 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4395 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4398 **vmware-esx-soap-vm-mem-consumed**
4400 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>
4401 **vm consumed memory = memory granted -- memory saved**
4403 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4406 ------------------------|--------------
4407 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4408 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4409 vmware_vmname | **Required.** Virtual machine name.
4410 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4411 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4412 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4413 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4414 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4415 vmware_sessionfile | **Optional.** Session file name enhancement.
4416 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4417 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4418 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4419 vmware_password | **Optional.** The username's password. No value defined as default.
4420 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4421 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4422 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4425 **vmware-esx-soap-vm-mem-memctl**
4427 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.
4429 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4432 ------------------------|--------------
4433 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4434 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4435 vmware_vmname | **Required.** Virtual machine name.
4436 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4437 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4438 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4439 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4440 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4441 vmware_sessionfile | **Optional.** Session file name enhancement.
4442 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4443 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4444 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4445 vmware_password | **Optional.** The username's password. No value defined as default.
4446 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4447 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4448 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4452 **vmware-esx-soap-vm-net**
4454 Check command object for the `check_vmware_esx` plugin. Shows net info.
4456 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4459 ------------------------|--------------
4460 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4461 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4462 vmware_vmname | **Required.** Virtual machine name.
4463 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4464 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4465 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4466 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4467 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4468 vmware_sessionfile | **Optional.** Session file name enhancement.
4469 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4470 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4471 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4472 vmware_password | **Optional.** The username's password. No value defined as default.
4473 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4476 **vmware-esx-soap-vm-net-usage**
4478 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4480 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4483 ------------------------|--------------
4484 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4485 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4486 vmware_vmname | **Required.** Virtual machine name.
4487 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4488 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4489 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4490 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4491 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4492 vmware_sessionfile | **Optional.** Session file name enhancement.
4493 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4494 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4495 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4496 vmware_password | **Optional.** The username's password. No value defined as default.
4497 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4498 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4499 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4502 **vmware-esx-soap-vm-net-receive**
4504 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
4506 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4509 ------------------------|--------------
4510 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4511 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4512 vmware_vmname | **Required.** Virtual machine name.
4513 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4514 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4515 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4516 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4517 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4518 vmware_sessionfile | **Optional.** Session file name enhancement.
4519 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4520 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4521 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4522 vmware_password | **Optional.** The username's password. No value defined as default.
4523 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4524 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4525 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4528 **vmware-esx-soap-vm-net-send**
4530 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
4532 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4535 ------------------------|--------------
4536 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4537 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4538 vmware_vmname | **Required.** Virtual machine name.
4539 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4540 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4541 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4542 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4543 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4544 vmware_sessionfile | **Optional.** Session file name enhancement.
4545 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4546 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4547 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4548 vmware_password | **Optional.** The username's password. No value defined as default.
4549 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4550 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4551 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4554 **vmware-esx-soap-vm-io**
4556 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.
4558 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4561 ------------------------|--------------
4562 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4563 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4564 vmware_vmname | **Required.** Virtual machine name.
4565 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4566 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4567 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4568 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4569 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4570 vmware_sessionfile | **Optional.** Session file name enhancement.
4571 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4572 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4573 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4574 vmware_password | **Optional.** The username's password. No value defined as default.
4575 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4578 **vmware-esx-soap-vm-io-read**
4580 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4582 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4585 ------------------------|--------------
4586 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4587 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4588 vmware_vmname | **Required.** Virtual machine name.
4589 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4590 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4591 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4592 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4593 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4594 vmware_sessionfile | **Optional.** Session file name enhancement.
4595 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4596 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4597 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4598 vmware_password | **Optional.** The username's password. No value defined as default.
4599 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4600 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4601 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4604 **vmware-esx-soap-vm-io-write**
4606 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4608 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4611 ------------------------|--------------
4612 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4613 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4614 vmware_vmname | **Required.** Virtual machine name.
4615 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4616 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4617 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4618 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4619 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4620 vmware_sessionfile | **Optional.** Session file name enhancement.
4621 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4622 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4623 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4624 vmware_password | **Optional.** The username's password. No value defined as default.
4625 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4626 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4627 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4630 **vmware-esx-soap-vm-io-usage**
4632 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
4634 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4637 ------------------------|--------------
4638 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4639 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4640 vmware_vmname | **Required.** Virtual machine name.
4641 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4642 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4643 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4644 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4645 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4646 vmware_sessionfile | **Optional.** Session file name enhancement.
4647 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4648 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4649 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4650 vmware_password | **Optional.** The username's password. No value defined as default.
4651 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4652 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4653 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4656 **vmware-esx-soap-vm-runtime**
4658 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
4660 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4663 ------------------------|--------------
4664 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4665 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4666 vmware_vmname | **Required.** Virtual machine name.
4667 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4668 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4669 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4670 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4671 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4672 vmware_sessionfile | **Optional.** Session file name enhancement.
4673 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4674 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4675 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4676 vmware_password | **Optional.** The username's password. No value defined as default.
4677 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4680 **vmware-esx-soap-vm-runtime-con**
4682 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
4684 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4687 ------------------------|--------------
4688 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4689 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4690 vmware_vmname | **Required.** Virtual machine name.
4691 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4692 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4693 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4694 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4695 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4696 vmware_sessionfile | **Optional.** Session file name enhancement.
4697 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4698 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4699 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4700 vmware_password | **Optional.** The username's password. No value defined as default.
4701 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4704 **vmware-esx-soap-vm-runtime-powerstate**
4706 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
4708 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4711 ------------------------|--------------
4712 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4713 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4714 vmware_vmname | **Required.** Virtual machine name.
4715 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4716 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4717 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4718 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4719 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4720 vmware_sessionfile | **Optional.** Session file name enhancement.
4721 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4722 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4723 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4724 vmware_password | **Optional.** The username's password. No value defined as default.
4725 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4728 **vmware-esx-soap-vm-runtime-status**
4730 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4732 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4735 ------------------------|--------------
4736 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4737 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4738 vmware_vmname | **Required.** Virtual machine name.
4739 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4740 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4741 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4742 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4743 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4744 vmware_sessionfile | **Optional.** Session file name enhancement.
4745 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4746 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4747 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4748 vmware_password | **Optional.** The username's password. No value defined as default.
4749 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4752 **vmware-esx-soap-vm-runtime-consoleconnections**
4754 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
4756 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4759 ------------------------|--------------
4760 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4761 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4762 vmware_vmname | **Required.** Virtual machine name.
4763 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4764 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4765 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4766 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4767 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4768 vmware_sessionfile | **Optional.** Session file name enhancement.
4769 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4770 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4771 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4772 vmware_password | **Optional.** The username's password. No value defined as default.
4773 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4774 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4775 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4778 **vmware-esx-soap-vm-runtime-gueststate**
4780 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
4782 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4785 ------------------------|--------------
4786 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4787 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4788 vmware_vmname | **Required.** Virtual machine name.
4789 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4790 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4791 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4792 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4793 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4794 vmware_sessionfile | **Optional.** Session file name enhancement.
4795 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4796 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4797 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4798 vmware_password | **Optional.** The username's password. No value defined as default.
4799 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4801 **vmware-esx-soap-vm-runtime-tools**
4803 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
4805 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4808 ------------------------|--------------
4809 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4810 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4811 vmware_vmname | **Required.** Virtual machine name.
4812 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4813 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4814 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4815 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4816 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4817 vmware_sessionfile | **Optional.** Session file name enhancement.
4818 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4819 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4820 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4821 vmware_password | **Optional.** The username's password. No value defined as default.
4822 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4823 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
4826 **vmware-esx-soap-vm-runtime-issues**
4828 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
4830 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4833 ------------------------|--------------
4834 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4835 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4836 vmware_vmname | **Required.** Virtual machine name.
4837 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4838 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4839 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4840 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4841 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4842 vmware_sessionfile | **Optional.** Session file name enhancement.
4843 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4844 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4845 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4846 vmware_password | **Optional.** The username's password. No value defined as default.
4847 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4848 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.
4851 ### Web <a id="plugin-contrib-web"></a>
4853 This category includes all plugins for web-based checks.
4855 #### apache_status <a id="plugin-contrib-command-apache_status"></a>
4857 The [check_apache_status.pl](https://github.com/lbetz/check_apache_status) plugin
4858 uses the [/server-status](https://httpd.apache.org/docs/current/mod/mod_status.html)
4859 HTTP endpoint to monitor status metrics for the Apache webserver.
4861 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4864 ------------------------|----------------------------------------------------------------------------------
4865 apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4866 apache_status_port | **Optional.** the http port.
4867 apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
4868 apache_status_ssl | **Optional.** set to use ssl connection
4869 apache_status_timeout | **Optional.** timeout in seconds
4870 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
4871 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
4874 ### cert <a id="plugin-check-command-ssl_cert"></a>
4876 The [check_ssl_cert](https://github.com/matteocorti/check_ssl_cert) plugin
4877 uses the openssl binary (and optional curl) to check a X.509 certificate.
4879 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4882 --------------------------|--------------
4883 ssl_cert_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
4884 ssl_cert_port | **Optional.** TCP port number (default: 443).
4885 ssl_cert_file | **Optional.** Local file path. Works only if `ssl_cert_address` is set to "localhost".
4886 ssl_cert_warn | **Optional.** Minimum number of days a certificate has to be valid.
4887 ssl_cert_critical | **Optional.** Minimum number of days a certificate has to be valid to issue a critical status.
4888 ssl_cert_cn | **Optional.** Pattern to match the CN of the certificate.
4889 ssl_cert_altnames | **Optional.** Matches the pattern specified in -n with alternate
4890 ssl_cert_issuer | **Optional.** Pattern to match the issuer of the certificate.
4891 ssl_cert_org | **Optional.** Pattern to match the organization of the certificate.
4892 ssl_cert_email | **Optional.** Pattern to match the email address contained in the certificate.
4893 ssl_cert_serial | **Optional.** Pattern to match the serial number.
4894 ssl_cert_noauth | **Optional.** Ignore authority warnings (expiration only)
4895 ssl_cert_match_host | **Optional.** Match CN with the host name.
4896 ssl_cert_selfsigned | **Optional.** Allow self-signed certificate.
4897 ssl_cert_sni | **Optional.** Sets the TLS SNI (Server Name Indication) extension.
4898 ssl_cert_timeout | **Optional.** Seconds before connection times out (default: 15)
4899 ssl_cert_protocol | **Optional.** Use the specific protocol {http,smtp,pop3,imap,ftp,xmpp,irc,ldap} (default: http).
4900 ssl_cert_clientcert | **Optional.** Use client certificate to authenticate.
4901 ssl_cert_clientpass | **Optional.** Set passphrase for client certificate.
4902 ssl_cert_ssllabs | **Optional.** SSL Labs assestment
4903 ssl_cert_ssllabs_nocache | **Optional.** Forces a new check by SSL Labs
4904 ssl_cert_rootcert | **Optional.** Root certificate or directory to be used for certficate validation.
4905 ssl_cert_ignore_signature | **Optional.** Do not check if the certificate was signed with SHA1 od MD5.
4906 ssl_cert_ssl_version | **Optional.** Force specific SSL version out of {ssl2,ssl3,tls1,tls1_1,tls1_2}.
4907 ssl_cert_disable_ssl_versions | **Optional.** Disable specific SSL versions out of {ssl2,ssl3,tls1,tls1_1,tls1_2}. Multiple versions can be given as array.
4908 ssl_cert_cipher | **Optional.** Cipher selection: force {ecdsa,rsa} authentication.
4909 ssl_cert_ignore_expiration | **Optional.** Ignore expiration date.
4910 ssl_cert_ignore_ocsp | **Optional.** Do not check revocation with OCSP.
4913 #### jmx4perl <a id="plugin-contrib-command-jmx4perl"></a>
4915 The [check_jmx4perl](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl) plugin
4916 uses the HTTP API exposed by the [Jolokia](https://jolokia.org)
4917 web application and queries Java message beans on an application server. It is
4918 part of the `JMX::Jmx4Perl` Perl module which includes detailed
4919 [documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl).
4921 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4924 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
4925 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
4926 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
4927 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.
4928 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
4929 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
4930 jmx4perl_operation | **Optional.** Operation to execute.
4931 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
4932 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
4933 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
4934 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
4935 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
4936 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
4937 jmx4perl_proxy | **Optional.** Proxy to use.
4938 jmx4perl_user | **Optional.** User for HTTP authentication.
4939 jmx4perl_password | **Optional.** Password for HTTP authentication.
4940 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
4941 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
4942 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.
4943 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
4944 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
4945 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
4946 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.
4947 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
4948 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
4949 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
4950 jmx4perl_critical | **Optional.** Critical threshold for value.
4951 jmx4perl_warning | **Optional.** Warning threshold for value.
4952 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
4953 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
4954 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
4955 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
4956 jmx4perl_config | **Optional.** Path to configuration file.
4957 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
4958 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
4961 #### kdc <a id="plugin-contrib-command-kdc"></a>
4963 The [check_kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details) plugin
4964 uses the Kerberos `kinit` binary to monitor Kerberos 5 KDC by acquiring a ticket.
4966 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4969 ----------------|--------------------------------------------------------------------------
4970 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4971 kdc_port | **Optional** Port on which KDC runs (default 88).
4972 kdc_principal | **Required** Principal name to authenticate as (including realm).
4973 kdc_keytab | **Required** Keytab file containing principal's key.
4976 #### nginx_status <a id="plugin-contrib-command-nginx_status"></a>
4978 The [check_nginx_status.pl](https://github.com/regilero/check_nginx_status) plugin
4979 uses the [/nginx_status](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
4980 HTTP endpoint which provides metrics for monitoring Nginx.
4982 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4985 --------------------------------|----------------------------------------------------------------------------------
4986 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4987 nginx_status_port | **Optional.** the http port.
4988 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
4989 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
4990 nginx_status_ssl | **Optional.** set to use ssl connection
4991 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
4992 nginx_status_user | **Optional.** Username for basic auth
4993 nginx_status_pass | **Optional.** Password for basic auth
4994 nginx_status_realm | **Optional.** Realm for basic auth
4995 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
4996 nginx_status_timeout | **Optional.** timeout in seconds
4997 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
4998 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
5001 #### rbl <a id="plugin-contrib-command-rbl"></a>
5003 The [check_rbl](https://github.com/matteocorti/check_rbl) plugin
5004 uses the `Net::DNS` Perl library to check whether your SMTP server
5007 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5010 ----------------|--------------------------------------------------------------------------
5011 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.
5012 rbl_server | **Required** List of RBL servers as an array.
5013 rbl_warning | **Optional** Number of blacklisting servers for a warning.
5014 rbl_critical | **Optional** Number of blacklisting servers for a critical.
5015 tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
5018 #### squid <a id="plugin-contrib-command-squid"></a>
5020 The [check_squid](https://exchange.icinga.com/exchange/check_squid) plugin
5021 uses the `squidclient` binary to monitor a [Squid proxy](http://www.squid-cache.org).
5023 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5026 ------------------------|----------------------------------------------------------------------------------
5027 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
5028 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
5029 squid_port | **Optional.** Port number (default: 3128).
5030 squid_user | **Optional.** WWW user
5031 squid_password | **Optional.** WWW password
5032 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
5033 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
5034 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
5035 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
5038 #### webinject <a id="plugin-contrib-command-webinject"></a>
5040 The [check_webinject](https://labs.consol.de/de/nagios/check_webinject/index.html) plugin
5041 uses [WebInject](http://www.webinject.org/manual.html) to test web applications
5042 and web services in an automated fashion.
5043 It can be used to test individual system components that have HTTP interfaces
5044 (JSP, ASP, CGI, PHP, AJAX, Servlets, HTML Forms, XML/SOAP Web Services, REST, etc),
5045 and can be used as a test harness to create a suite of HTTP level automated functional,
5046 acceptance, and regression tests. A test harness allows you to run many test cases
5047 and collect/report your results. WebInject offers real-time results
5048 display and may also be used for monitoring system response times.
5050 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5053 ------------------------|--------------
5054 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.
5055 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.
5056 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
5057 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.
5058 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.
5059 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.
projects / icinga2 / blob