1 # Icinga Template Library <a id="icinga-template-library"></a>
3 The Icinga Template Library (ITL) implements standard templates
4 and object definitions.
6 There is a subset of templates and object definitions available:
8 * [Generic ITL templates](10-icinga-template-library.md#itl-generic-templates)
9 * [CheckCommand definitions for Icinga 2](10-icinga-template-library.md#itl-check-commands) (this includes [icinga](10-icinga-template-library.md#itl-icinga),
10 [cluster](10-icinga-template-library.md#itl-icinga-cluster), [cluster-zone](10-icinga-template-library.md#itl-icinga-cluster-zone), [ido](10-icinga-template-library.md#itl-icinga-ido), etc.)
11 * [CheckCommand definitions for Monitoring Plugins](10-icinga-template-library.md#plugin-check-commands-monitoring-plugins)
12 * [CheckCommand definitions for Icinga 2 Windows Plugins](10-icinga-template-library.md#windows-plugins)
13 * [CheckCommand definitions for NSClient++](10-icinga-template-library.md#nscp-plugin-check-commands)
14 * [CheckCommand definitions for Manubulon SNMP](10-icinga-template-library.md#snmp-manubulon-plugin-check-commands)
15 * [Contributed CheckCommand definitions](10-icinga-template-library.md#plugin-contrib)
17 The ITL content is updated with new releases. Please do not modify
18 templates and/or objects as changes will be overridden without
21 You are advised to create your own CheckCommand definitions in
24 ## Generic Templates <a id="itl-generic-templates"></a>
26 By default the generic templates are included in the [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf) configuration file:
30 These templates are imported by the provided example configuration.
34 > These templates are built into the binaries. By convention
35 > all command and timeperiod objects should import these templates.
37 ### plugin-check-command <a id="itl-plugin-check-command"></a>
39 Command template for check plugins executed by Icinga 2.
41 The `plugin-check-command` command does not support any vars.
43 By default this template is automatically imported into all [CheckCommand](09-object-types.md#objecttype-checkcommand) definitions.
45 ### plugin-notification-command <a id="itl-plugin-notification-command"></a>
47 Command template for notification scripts executed by Icinga 2.
49 The `plugin-notification-command` command does not support any vars.
51 By default this template is automatically imported into all [NotificationCommand](09-object-types.md#objecttype-notificationcommand) definitions.
53 ### plugin-event-command <a id="itl-plugin-event-command"></a>
55 Command template for event handler scripts executed by Icinga 2.
57 The `plugin-event-command` command does not support any vars.
59 By default this template is automatically imported into all [EventCommand](09-object-types.md#objecttype-eventcommand) definitions.
61 ### legacy-timeperiod <a id="itl-legacy-timeperiod"></a>
63 Timeperiod template for [Timeperiod objects](09-object-types.md#objecttype-timeperiod).
65 The `legacy-timeperiod` timeperiod does not support any vars.
67 By default this template is automatically imported into all [TimePeriod](09-object-types.md#objecttype-timeperiod) definitions.
69 ## Check Commands <a id="itl-check-commands"></a>
71 These check commands are embedded into Icinga 2 and do not require any external
74 ### icinga <a id="itl-icinga"></a>
76 Check command for the built-in `icinga` check. This check returns performance
77 data for the current Icinga instance and optionally allows for minimum version checks.
79 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
82 -----------------------|---------------
83 icinga\_min\_version | **Optional.** Required minimum Icinga 2 version, e.g. `2.8.0`. If not satisfied, the state changes to `Critical`. Release packages only.
85 ### cluster <a id="itl-icinga-cluster"></a>
87 Check command for the built-in `cluster` check. This check returns performance
88 data for the current Icinga instance and connected endpoints.
90 The `cluster` check command does not support any vars.
92 ### cluster-zone <a id="itl-icinga-cluster-zone"></a>
94 Check command for the built-in `cluster-zone` check.
96 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
99 -----------------------|---------------
100 cluster\_zone | **Required.** The zone name. Defaults to `$host.name$`.
101 cluster\_lag\_warning | **Optional.** Warning threshold for log lag in seconds. Applies if the log lag is greater than the threshold.
102 cluster\_lag\_critical | **Optional.** Critical threshold for log lag in seconds. Applies if the log lag is greater than the threshold.
104 ### ido <a id="itl-icinga-ido"></a>
106 Check command for the built-in `ido` check.
108 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
111 -------------|---------------
112 ido\_type | **Required.** The type of the IDO connection object. Can be either "IdoMysqlConnection" or "IdoPgsqlConnection".
113 ido\_name | **Required.** The name of the IDO connection object.
115 ### dummy <a id="itl-dummy"></a>
117 Check command for the built-in `dummy` check. This allows to set
118 a check result state and output and can be used in [freshness checks](08-advanced-topics.md#check-result-freshness)
119 or [runtime object checks](08-advanced-topics.md#access-object-attributes-at-runtime).
120 In contrast to the [check_dummy](https://www.monitoring-plugins.org/doc/man/check_dummy.html)
121 plugin, Icinga 2 implements a light-weight in memory check with 2.9+.
123 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
126 ----------------|--------------
127 dummy\_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
128 dummy\_text | **Optional.** Plugin output. Defaults to "Check was successful.".
130 ### random <a id="itl-random"></a>
132 Check command for the built-in `random` check. This check returns random states
133 and adds the check source to the check output.
135 For test and demo purposes only. The `random` check command does not support
138 ### exception <a id="itl-exception"></a>
140 Check command for the built-in `exception` check. This check throws an exception.
142 For test and demo purposes only. The `exception` check command does not support
145 <!-- keep this anchor for URL link history only -->
146 <a id="plugin-check-commands"></a>
148 ## Plugin Check Commands for Monitoring Plugins <a id="plugin-check-commands-monitoring-plugins"></a>
150 The Plugin Check Commands provides example configuration for plugin check commands
151 provided by the [Monitoring Plugins](https://www.monitoring-plugins.org) project.
153 By default the Plugin Check Commands are included in the [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf) configuration
158 The plugin check commands assume that there's a global constant named `PluginDir`
159 which contains the path of the plugins from the Monitoring Plugins project.
161 **Note**: If there are command parameters missing for the provided CheckCommand
162 definitions please kindly send a patch upstream. This should include an update
163 for the ITL CheckCommand itself and this documentation section.
165 ### apt <a id="plugin-check-command-apt"></a>
167 The plugin [apt](https://www.monitoring-plugins.org/doc/index.html) checks for software updates on systems that use
168 package management systems based on the apt-get(8) command found in Debian based systems.
170 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
173 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
174 apt_extra_opts | **Optional.** Read options from an ini file.
175 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.
176 apt_dist_upgrade | **Optional.** Perform a dist-upgrade instead of normal upgrade. Like with -U OPTS can be provided to override the default options.
177 apt_include | **Optional.** Include only packages matching REGEXP. Can be specified multiple times the values will be combined together.
178 apt_exclude | **Optional.** Exclude packages matching REGEXP from the list of packages that would otherwise be included. Can be specified multiple times.
179 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.
180 apt_timeout | **Optional.** Seconds before plugin times out (default: 10).
181 apt_only_critical | **Optional.** Only warn about critical upgrades.
184 ### breeze <a id="plugin-check-command-breeze"></a>
186 The [check_breeze](https://www.monitoring-plugins.org/doc/man/check_breeze.html) plugin reports the signal
187 strength of a Breezecom wireless equipment.
189 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
192 -----------------|---------------------------------
193 breeze_hostname | **Required.** Name or IP address of host to check. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
194 breeze_community | **Optional.** SNMPv1 community. Defaults to "public".
195 breeze_warning | **Required.** Percentage strength below which a WARNING status will result. Defaults to 50.
196 breeze_critical | **Required.** Percentage strength below which a WARNING status will result. Defaults to 20.
199 ### by_ssh <a id="plugin-check-command-by-ssh"></a>
201 The [check_by_ssh](https://www.monitoring-plugins.org/doc/man/check_by_ssh.html) plugin uses SSH to execute
202 commands on a remote host.
204 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
207 ----------------|--------------
208 by_ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
209 by_ssh_port | **Optional.** The SSH port. Defaults to 22.
210 by_ssh_command | **Required.** The command that should be executed. Can be an array if multiple arguments should be passed to `check_by_ssh`.
211 by_ssh_arguments| **Optional.** A dictionary with arguments for the command. This works exactly like the 'arguments' dictionary for ordinary CheckCommands.
212 by_ssh_logname | **Optional.** The SSH username.
213 by_ssh_identity | **Optional.** The SSH identity.
214 by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false.
215 by_ssh_warn | **Optional.** The warning threshold.
216 by_ssh_crit | **Optional.** The critical threshold.
217 by_ssh_timeout | **Optional.** The timeout in seconds.
218 by_ssh_options | **Optional.** Call ssh with '-o OPTION' (multiple options may be specified as an array).
219 by_ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
220 by_ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
223 ### clamd <a id="plugin-check-command-clamd"></a>
225 The [check_clamd](https://www.monitoring-plugins.org/doc/man/check_clamd.html) plugin tests CLAMD
226 connections with the specified host (or unix socket).
228 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
231 -------------------|--------------
232 clamd_address | **Required.** The host's address or unix socket (must be an absolute path).
233 clamd_port | **Optional.** Port number (default: none).
234 clamd_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
235 clamd_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
236 clamd_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
237 clamd_send | **Optional.** String to send to the server.
238 clamd_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
239 clamd_quit | **Optional.** String to send server to initiate a clean close of the connection.
240 clamd_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
241 clamd_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
242 clamd_jail | **Optional.** Hide output from TCP socket.
243 clamd_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
244 clamd_delay | **Optional.** Seconds to wait between sending string and polling for response.
245 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.
246 clamd_ssl | **Optional.** Use SSL for the connection. Defaults to false.
247 clamd_wtime | **Optional.** Response time to result in warning status (seconds).
248 clamd_ctime | **Optional.** Response time to result in critical status (seconds).
249 clamd_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
250 clamd_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
251 clamd_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
254 ### dhcp <a id="plugin-check-command-dhcp"></a>
256 The [check_dhcp](https://www.monitoring-plugins.org/doc/man/check_dhcp.html) plugin
257 tests the availability of DHCP servers on a network.
259 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
262 ----------------|--------------
263 dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from.
264 dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server.
265 dhcp_timeout | **Optional.** The timeout in seconds.
266 dhcp_interface | **Optional.** The interface to use.
267 dhcp_mac | **Optional.** The MAC address to use in the DHCP request.
268 dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false.
271 ### dig <a id="plugin-check-command-dig"></a>
273 The [check_dig](https://www.monitoring-plugins.org/doc/man/check_dig.html) plugin
274 test the DNS service on the specified host using dig.
276 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
279 ---------------------|--------------
280 dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1".
281 dig_port | **Optional.** Port number (default: 53).
282 dig_lookup | **Required.** The address that should be looked up.
283 dig_record_type | **Optional.** Record type to lookup (default: A).
284 dig_expected_address | **Optional.** An address expected to be in the answer section. If not set, uses whatever was in -l.
285 dig_arguments | **Optional.** Pass STRING as argument(s) to dig.
286 dig_retries | **Optional.** Number of retries passed to dig, timeout is divided by this value (Default: 3).
287 dig_warning | **Optional.** Response time to result in warning status (seconds).
288 dig_critical | **Optional.** Response time to result in critical status (seconds).
289 dig_timeout | **Optional.** Seconds before connection times out (default: 10).
290 dig_ipv4 | **Optional.** Force dig to only use IPv4 query transport. Defaults to false.
291 dig_ipv6 | **Optional.** Force dig to only use IPv6 query transport. Defaults to false.
294 ### disk <a id="plugin-check-command-disk"></a>
296 The [check_disk](https://www.monitoring-plugins.org/doc/man/check_disk.html) plugin
297 checks the amount of used disk space on a mounted file system and generates an alert
298 if free space is less than one of the threshold values.
300 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
303 --------------------|------------------------
304 disk\_wfree | **Optional.** The free space warning threshold. Defaults to "20%". If the percent sign is omitted, units from `disk_units` are used.
305 disk\_cfree | **Optional.** The free space critical threshold. Defaults to "10%". If the percent sign is omitted, units from `disk_units` are used.
306 disk\_inode\_wfree | **Optional.** The free inode warning threshold.
307 disk\_inode\_cfree | **Optional.** The free inode critical threshold.
308 disk\_partition | **Optional.** The partition. **Deprecated in 2.3.**
309 disk\_partition\_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.**
310 disk\_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array.
311 disk\_partitions\_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array.
312 disk\_clear | **Optional.** Clear thresholds. May be true or false.
313 disk\_exact\_match | **Optional.** For paths or partitions specified with -p, only check for exact paths. May be true or false.
314 disk\_errors\_only | **Optional.** Display only devices/mountpoints with errors. May be true or false.
315 disk\_ignore\_reserved | **Optional.** If set, account root-reserved blocks are not accounted for freespace in perfdata. May be true or false.
316 disk\_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together.
317 disk\_kilobytes | **Optional.** Same as --units kB. May be true or false.
318 disk\_local | **Optional.** Only check local filesystems. May be true or false.
319 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.
320 disk\_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false.
321 disk\_megabytes | **Optional.** Same as --units MB. May be true or false.
322 disk\_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.\*'. May be true or false.
323 disk\_eregi\_path | **Optional.** Case insensitive regular expression for path/partition. Multiple regular expression strings must be defined as array.
324 disk\_ereg\_path | **Optional.** Regular expression for path or partition. Multiple regular expression strings must be defined as array.
325 disk\_ignore\_eregi\_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive). Multiple regular expression strings must be defined as array.
326 disk\_ignore\_ereg\_path | **Optional.** Regular expression to ignore selected path or partition. Multiple regular expression strings must be defined as array.
327 disk\_timeout | **Optional.** Seconds before connection times out (default: 10).
328 disk\_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB).
329 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", "configfs", "devtmpfs", "devfs", "mtmfs", "tracefs", "cgroup", "fuse.gvfsd-fuse", "fuse.gvfs-fuse-daemon", "fdescfs".
331 ### disk_smb <a id="plugin-check-command-disk-smb"></a>
333 The [check_disk_smb](https://www.monitoring-plugins.org/doc/man/check_disk_smb.html) plugin
334 uses the `smbclient` binary to check SMB shares.
336 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
339 ------------------------|------------------------
340 disk_smb_hostname | **Required.** NetBIOS name of the server.
341 disk_smb_share | **Required.** Share name being queried.
342 disk_smb_workgroup | **Optional.** Workgroup or Domain used (defaults to 'WORKGROUP' if omitted).
343 disk_smb_address | **Optional.** IP address of the host (only necessary if host belongs to another network).
344 disk_smb_username | **Optional.** Username for server log-in (defaults to 'guest' if omitted).
345 disk_smb_password | **Optional.** Password for server log-in (defaults to an empty password if omitted).
346 disk_smb_wused | **Optional.** The used space warning threshold. Defaults to "85%". If the percent sign is omitted, use optional disk units.
347 disk_smb_cused | **Optional.** The used space critical threshold. Defaults to "95%". If the percent sign is omitted, use optional disk units.
348 disk_smb_port | **Optional.** Connection port, e.g. `139` or `445`. Defaults to `smbclient` default if omitted.
350 ### dns <a id="plugin-check-command-dns"></a>
352 The [check_dns](https://www.monitoring-plugins.org/doc/man/check_dns.html) plugin
353 uses the nslookup program to obtain the IP address for the given host/domain query.
354 An optional DNS server to use may be specified. If no DNS server is specified, the
355 default server(s) specified in `/etc/resolv.conf` will be used.
357 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
360 ---------------------|--------------
361 dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$".
362 dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
363 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)
364 dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
365 dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
366 dns_accept_cname | **Optional.** Accept cname responses as a valid result to a query.
367 dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
368 dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
369 dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
373 ### file_age <a id="plugin-check-command-file-age"></a>
375 The [check_file_age](https://www.monitoring-plugins.org/doc/man/check_file_age.html) plugin
376 checks a file's size and modification time to make sure it's not empty and that it's sufficiently recent.
378 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
381 -----------------------|--------------------------------------------------------------------------------------------------------
382 file_age_file | **Required.** File to monitor.
383 file_age_warning_time | **Optional.** File must be no more than this many seconds old as warning threshold. Defaults to "240s".
384 file_age_critical_time | **Optional.** File must be no more than this many seconds old as critical threshold. Defaults to "600s".
385 file_age_warning_size | **Optional.** File must be at least this many bytes long as warning threshold. No default given.
386 file_age_critical_size | **Optional.** File must be at least this many bytes long as critical threshold. Defaults to "0B".
387 file_age_ignoremissing | **Optional.** Return OK if the file does not exist. Defaults to false.
390 ### flexlm <a id="plugin-check-command-flexlm"></a>
392 The [check_flexlm](https://www.monitoring-plugins.org/doc/man/check_flexlm.html) plugin
393 checks available flexlm license managers. Requires the `lmstat` command.
395 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
398 -------------------|----------------------------------------------------------
399 flexlm_licensefile | **Required.** Name of license file (usually license.dat).
400 flexlm_timeout | **Optional.** Plugin time out in seconds. Defaults to 15.
403 ### fping4 <a id="plugin-check-command-fping4"></a>
405 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
406 uses 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 IPv4 address.
411 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
414 ----------------|--------------
415 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
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 ### fping6 <a id="plugin-check-command-fping6"></a>
430 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
431 will use the `fping` command to ping the specified host for a fast check. Note that it is
432 necessary to set the `suid` flag on `fping`.
434 This CheckCommand expects an IPv6 address.
436 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
439 ----------------|--------------
440 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
441 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
442 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
443 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
444 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
445 fping_number | **Optional.** The number of packets to send. Defaults to 5.
446 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
447 fping_bytes | **Optional.** The size of ICMP packet.
448 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
449 fping_source_ip | **Optional.** The name or ip address of the source ip.
450 fping_source_interface | **Optional.** The source interface name.
453 ### ftp <a id="plugin-check-command-ftp"></a>
455 The [check_ftp](https://www.monitoring-plugins.org/doc/man/check_ftp.html) plugin
456 tests FTP connections with the specified host (or unix socket).
458 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
461 -------------------|--------------
462 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
463 ftp_port | **Optional.** The FTP port number.
464 ftp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
465 ftp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
466 ftp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
467 ftp_send | **Optional.** String to send to the server.
468 ftp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
469 ftp_quit | **Optional.** String to send server to initiate a clean close of the connection.
470 ftp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
471 ftp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
472 ftp_jail | **Optional.** Hide output from TCP socket.
473 ftp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
474 ftp_delay | **Optional.** Seconds to wait between sending string and polling for response.
475 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.
476 ftp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
477 ftp_wtime | **Optional.** Response time to result in warning status (seconds).
478 ftp_ctime | **Optional.** Response time to result in critical status (seconds).
479 ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
480 ftp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
481 ftp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
484 ### game <a id="plugin-check-command-game"></a>
486 The [check_game](https://www.monitoring-plugins.org/doc/man/check_game.html) plugin
487 tests game server connections with the specified host.
488 This plugin uses the 'qstat' command, the popular game server status query tool.
489 If you don't have the package installed, you will need to [download](http://www.activesw.com/people/steve/qstat.html)
490 or install the package `quakestat` before you can use this plugin.
492 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
495 -------------------|-------------------
496 game_game | **Required.** Name of the game.
497 game_ipaddress | **Required.** Ipaddress of the game server to query.
498 game_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
499 game_port | **Optional.** Port to connect to.
500 game_gamefield | **Optional.** Field number in raw qstat output that contains game name.
501 game_mapfield | **Optional.** Field number in raw qstat output that contains map name.
502 game_pingfield | **Optional.** Field number in raw qstat output that contains ping time.
503 game_gametime | **Optional.** Field number in raw qstat output that contains game time.
504 game_hostname | **Optional.** Name of the host running the game.
507 ### hostalive <a id="plugin-check-command-hostalive"></a>
509 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
510 plugin with host check default values. This variant uses the host's `address` attribute
511 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
513 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
516 ----------------|--------------
517 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
518 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
519 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
520 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
521 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
522 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
523 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
526 ### hostalive4 <a id="plugin-check-command-hostalive4"></a>
528 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
529 plugin with host check default values. This variant uses the host's `address` attribute.
531 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
534 ----------------|--------------
535 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
536 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
537 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
538 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
539 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
540 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
541 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
544 ### hostalive6 <a id="plugin-check-command-hostalive6"></a>
546 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
547 plugin with host check default values. This variant uses the host's `address6` attribute.
549 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
552 ----------------|--------------
553 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
554 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
555 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
556 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
557 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
558 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
559 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
562 ### hpjd <a id="plugin-check-command-hpjd"></a>
564 The [check_hpjd](https://www.monitoring-plugins.org/doc/man/check_hpjd.html) plugin
565 tests the state of an HP printer with a JetDirect card. Net-snmp must be installed
566 on the computer running the plugin.
568 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
571 ----------------|--------------
572 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
573 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
574 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
577 ### http <a id="plugin-check-command-http"></a>
579 The [check_http](https://www.monitoring-plugins.org/doc/man/check_http.html) plugin
580 tests the HTTP service on the specified host. It can test normal (http) and secure
581 (https) servers, follow redirects, search for strings and regular expressions,
582 check connection times, and report on certificate expiration times.
584 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
587 ---------------------------------|---------------------------------
588 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
589 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
590 http_uri | **Optional.** The request URI for GET or POST. Defaults to `/`.
591 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
592 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
593 http_ssl_force_tlsv1 | **Optional.** Whether to force TLSv1.
594 http_ssl_force_tlsv1_1 | **Optional.** Whether to force TLSv1.1.
595 http_ssl_force_tlsv1_2 | **Optional.** Whether to force TLSv1.2.
596 http_ssl_force_sslv2 | **Optional.** Whether to force SSLv2.
597 http_ssl_force_sslv3 | **Optional.** Whether to force SSLv3.
598 http_ssl_force_tlsv1_or_higher | **Optional.** Whether to force TLSv1 or higher.
599 http_ssl_force_tlsv1_1_or_higher | **Optional.** Whether to force TLSv1.1 or higher.
600 http_ssl_force_tlsv1_2_or_higher | **Optional.** Whether to force TLSv1.2 or higher.
601 http_ssl_force_sslv2_or_higher | **Optional.** Whether to force SSLv2 or higher.
602 http_ssl_force_sslv3_or_higher | **Optional.** Whether to force SSLv3 or higher.
603 http_sni | **Optional.** Whether to use SNI. Defaults to false.
604 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
605 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
606 http_ignore_body | **Optional.** Don't download the body, just the headers.
607 http_linespan | **Optional.** Allow regex to span newline.
608 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
609 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
610 http_invertregex | **Optional.** Changes behavior of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
611 http_warn_time | **Optional.** The warning threshold.
612 http_critical_time | **Optional.** The critical threshold.
613 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.
614 http_certificate | **Optional.** Minimum number of days a certificate has to be valid. Port defaults to 443. When this option is used the URL is not checked. The first parameter defines the warning threshold (in days), the second parameter the critical threshold (in days). (Example `http_certificate = "30,20"`).
615 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
616 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
617 http_headerstring | **Optional.** String to expect in the response headers.
618 http_string | **Optional.** String to expect in the content.
619 http_post | **Optional.** URL encoded http POST data.
620 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
621 http_maxage | **Optional.** Warn if document is more than seconds old.
622 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
623 http_useragent | **Optional.** String to be sent in http header as User Agent.
624 http_header | **Optional.** Any other tags to be sent in http header.
625 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
626 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)
627 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
628 http_timeout | **Optional.** Seconds before connection times out.
629 http_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
630 http_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
631 http_link | **Optional.** Wrap output in HTML link. Defaults to false.
632 http_verbose | **Optional.** Show details for command-line debugging. Defaults to false.
635 ### icmp <a id="plugin-check-command-icmp"></a>
637 The [check_icmp](https://www.monitoring-plugins.org/doc/man/check_icmp.html) plugin
638 check_icmp allows for checking multiple hosts at once compared to `check_ping`.
639 The main difference is that check_ping executes the system's ping(1) command and
640 parses its output while `check_icmp` talks ICMP itself. `check_icmp` must be installed with
643 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
646 ----------------|--------------
647 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
648 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
649 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
650 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
651 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
652 icmp_source | **Optional.** The source IP address to send packets from.
653 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
654 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
655 icmp_target_interval | **Optional.** The maximum target interval.
656 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
657 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
658 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
659 icmp_ttl | **Optional.** The TTL on outgoing packets.
662 ### imap <a id="plugin-check-command-imap"></a>
664 The [check_imap](https://www.monitoring-plugins.org/doc/man/check_imap.html) plugin
665 tests IMAP connections with the specified host (or unix socket).
667 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
670 ----------------------|--------------
671 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
672 imap_port | **Optional.** The port that should be checked. Defaults to 143.
673 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.
674 imap_send | **Optional.** String to send to the server.
675 imap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
676 imap_all | **Optional.** All expect strings need to occur in server response. Default is any.
677 imap_quit | **Optional.** String to send server to initiate a clean close of the connection.
678 imap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
679 imap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
680 imap_jail | **Optional.** Hide output from TCP socket.
681 imap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
682 imap_delay | **Optional.** Seconds to wait between sending string and polling for response.
683 imap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
684 imap_ssl | **Optional.** Use SSL for the connection.
685 imap_warning | **Optional.** Response time to result in warning status (seconds).
686 imap_critical | **Optional.** Response time to result in critical status (seconds).
687 imap_timeout | **Optional.** Seconds before connection times out (default: 10).
688 imap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
689 imap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
692 ### ldap <a id="plugin-check-command-ldap"></a>
694 The [check_ldap](https://www.monitoring-plugins.org/doc/man/check_ldap.html) plugin
695 can be used to check LDAP servers.
697 The plugin can also be used for monitoring ldaps connections instead of the deprecated `check_ldaps`.
698 This can be ensured by enabling `ldap_starttls` or `ldap_ssl`.
700 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
703 ------------------------|--------------
704 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.
705 ldap_port | **Optional.** Port number. Defaults to 389.
706 ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)")
707 ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
708 ldap_bind | **Optional.** LDAP bind DN (if required).
709 ldap_pass | **Optional.** LDAP password (if required).
710 ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3.
711 ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
712 ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default).
713 ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default)
714 ldap_warning | **Optional.** Response time to result in warning status (seconds).
715 ldap_critical | **Optional.** Response time to result in critical status (seconds).
716 ldap_warning_entries | **Optional.** Number of found entries to result in warning status.
717 ldap_critical_entries | **Optional.** Number of found entries to result in critical status.
718 ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
719 ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
721 ### load <a id="plugin-check-command-load"></a>
723 The [check_load](https://www.monitoring-plugins.org/doc/man/check_load.html) plugin
724 tests the current system load average.
726 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
729 ----------------|--------------
730 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
731 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
732 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
733 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
734 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
735 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
736 load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
738 ### mailq <a id="plugin-check-command-mailq"></a>
740 The [check_mailq](https://www.monitoring-plugins.org/doc/man/check_mailq.html) plugin
741 checks the number of messages in the mail queue (supports multiple sendmail queues, qmail).
743 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
746 ------------------------|--------------
747 mailq_warning | **Required.** Min. number of messages in queue to generate warning.
748 mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ).
749 mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning
750 mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ).
751 mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15).
752 mailq_servertype | **Optional.** [ sendmail \| qmail \| postfix \| exim \| nullmailer ] (default = autodetect).
753 mailq_sudo | **Optional.** Use sudo to execute the mailq command.
755 ### mysql <a id="plugin-check-command-mysql"></a>
757 The [check_mysql](https://www.monitoring-plugins.org/doc/man/check_mysql.html) plugin
758 tests connections to a MySQL server.
760 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
763 ------------------------|---------------------------------------------------------------
764 mysql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
765 mysql_port | **Optional.** Port number (default: 3306).
766 mysql_socket | **Optional.** Use the specified socket (has no effect if `mysql_hostname` is used).
767 mysql_ignore_auth | **Optional.** Ignore authentication failure and check for mysql connectivity only.
768 mysql_database | **Optional.** Check database with indicated name.
769 mysql_file | **Optional.** Read from the specified client options file.
770 mysql_group | **Optional.** Use a client options group.
771 mysql_username | **Optional.** Connect using the indicated username.
772 mysql_password | **Optional.** Use the indicated password to authenticate the connection.
773 mysql_check_slave | **Optional.** Check if the slave thread is running properly.
774 mysql_warning | **Optional.** Exit with WARNING status if slave server is more than INTEGER seconds behind master.
775 mysql_critical | **Optional.** Exit with CRITICAL status if slave server is more then INTEGER seconds behind master.
776 mysql_ssl | **Optional.** Use ssl encryption.
777 mysql_cacert | **Optional.** Path to CA signing the cert.
778 mysql_cert | **Optional.** Path to SSL certificate.
779 mysql_key | **Optional.** Path to private SSL key.
780 mysql_cadir | **Optional.** Path to CA directory.
781 mysql_ciphers | **Optional.** List of valid SSL ciphers.
784 ### mysql_query <a id="plugin-check-command-mysql-query"></a>
786 The [check_mysql_query](https://www.monitoring-plugins.org/doc/man/check_mysql_query.html) plugin
787 checks a query result against threshold levels.
788 The result from the query should be numeric. For extra security, create a user with minimal access.
790 **Note**: You must specify `mysql_query_password` with an empty string to force an empty password,
791 overriding any my.cnf settings.
793 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
796 ------------------------|---------------------------------------------------------------
797 mysql_query_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
798 mysql_query_port | **Optional.** Port number (default: 3306).
799 mysql_query_database | **Optional.** Check database with indicated name.
800 mysql_query_file | **Optional.** Read from the specified client options file.
801 mysql_query_group | **Optional.** Use a client options group.
802 mysql_query_username | **Optional.** Connect using the indicated username.
803 mysql_query_password | **Optional.** Use the indicated password to authenticate the connection.
804 mysql_query_execute | **Required.** SQL Query to run on the MySQL Server.
805 mysql_query_warning | **Optional.** Exit with WARNING status if query is outside of the range (format: start:end).
806 mysql_query_critical | **Optional.** Exit with CRITICAL status if query is outside of the range.
809 ### negate <a id="plugin-check-command-negate"></a>
811 The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin
812 negates the status of a plugin (returns OK for CRITICAL and vice-versa).
813 Additional switches can be used to control which state becomes what.
815 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
818 ----------------------|---------------------------------------------------------------
819 negate_timeout | **Optional.** Seconds before plugin times out (default: 11).
820 negate_timeout_result | **Optional.** Custom result on Negate timeouts, default to UNKNOWN.
821 negate_ok | **Optional.** OK, WARNING, CRITICAL or UNKNOWN.
822 negate_warning | Numeric values are accepted.
823 negate_critical | If nothing is specified,
824 negate_unknown | permutes OK and CRITICAL.
825 negate_substitute | **Optional.** Substitute output text as well. Will only substitute text in CAPITALS.
826 negate_command | **Required.** Command to be negated.
827 negate_arguments | **Optional.** Arguments for the negated command.
829 ### nrpe <a id="plugin-check-command-nrpe"></a>
831 The `check_nrpe` plugin can be used to query an [NRPE](https://docs.icinga.com/latest/en/nrpe.html)
832 server or [NSClient++](https://www.nsclient.org). **Note**: This plugin
833 is considered insecure/deprecated.
835 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
838 ----------------|--------------
839 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
840 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
841 nrpe_command | **Optional.** The command that should be executed.
842 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
843 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
844 nrpe_timeout | **Optional.** The timeout in seconds.
845 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
846 nrpe_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
847 nrpe_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
848 nrpe_version_2 | **Optional.** Use this if you want to connect using NRPE v2 protocol. Defaults to false.
851 ### nscp <a id="plugin-check-command-nscp"></a>
853 The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin
854 collects data from the [NSClient++](https://www.nsclient.org) service.
856 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
859 ----------------|--------------
860 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
861 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
862 nscp_password | **Optional.** The NSClient++ password.
863 nscp_variable | **Required.** The variable that should be checked.
864 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
865 nscp_warn | **Optional.** The warning threshold.
866 nscp_crit | **Optional.** The critical threshold.
867 nscp_timeout | **Optional.** The query timeout in seconds.
868 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
871 ### ntp_time <a id="plugin-check-command-ntp-time"></a>
873 The [check_ntp_time](https://www.monitoring-plugins.org/doc/man/check_ntp_time.html) plugin
874 checks the clock offset between the local host and a remote NTP server.
876 **Note**: If you want to monitor an NTP server, please use `ntp_peer`.
878 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
881 ----------------|--------------
882 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
883 ntp_port | **Optional.** Port number (default: 123).
884 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
885 ntp_warning | **Optional.** Offset to result in warning status (seconds).
886 ntp_critical | **Optional.** Offset to result in critical status (seconds).
887 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
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 ### ntp_peer <a id="plugin-check-command-ntp-peer"></a>
895 The [check_ntp_peer](https://www.monitoring-plugins.org/doc/man/check_ntp_peer.html) plugin
896 checks the health of an NTP server. It supports checking the offset with the sync peer, the
897 jitter and stratum. This plugin will not check the clock offset between the local host and NTP
898 server; please use `ntp_time` for that purpose.
900 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
903 ----------------|--------------
904 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
905 ntp_port | **Optional.** The port to use. Default to 123.
906 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL or WARNING if server isn't synchronized.
907 ntp_warning | **Optional.** Offset to result in warning status (seconds).
908 ntp_critical | **Optional.** Offset to result in critical status (seconds).
909 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
910 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
911 ntp_wjitter | **Optional.** Warning threshold for jitter.
912 ntp_cjitter | **Optional.** Critical threshold for jitter.
913 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
914 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
915 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
916 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
917 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
920 ### passive <a id="plugin-check-command-passive"></a>
922 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
924 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
927 ----------------|--------------
928 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
929 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
931 ### pgsql <a id="plugin-check-command-pgsql"></a>
933 The [check_pgsql](https://www.monitoring-plugins.org/doc/man/check_pgsql.html) plugin
934 tests a PostgreSQL DBMS to determine whether it is active and accepting queries.
935 If a query is specified using the `pgsql_query` attribute, it will be executed after
936 connecting to the server. The result from the query has to be numeric in order
937 to compare it against the query thresholds if set.
939 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
942 ------------------------|---------------------------------------------------------------
943 pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
944 pgsql_port | **Optional.** Port number (default: 5432).
945 pgsql_database | **Optional.** Database to check (default: template1).
946 pgsql_username | **Optional.** Login name of user.
947 pgsql_password | **Optional.** Password (BIG SECURITY ISSUE).
948 pgsql_options | **Optional.** Connection parameters (keyword = value), see below.
949 pgsql_warning | **Optional.** Response time to result in warning status (seconds).
950 pgsql_critical | **Optional.** Response time to result in critical status (seconds).
951 pgsql_timeout | **Optional.** Seconds before connection times out (default: 10).
952 pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read.
953 pgsql_query_warning | **Optional.** SQL query value to result in warning status (double).
954 pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
956 ### ping <a id="plugin-check-command-ping"></a>
958 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
959 uses the ping command to probe the specified host for packet loss (percentage) and
960 round trip average (milliseconds).
962 This command uses the host's `address` attribute if available and falls back to using
963 the `address6` attribute if the `address` attribute is not set.
965 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
968 ----------------|--------------
969 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
970 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
971 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
972 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
973 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
974 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
975 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
978 ### ping4 <a id="plugin-check-command-ping4"></a>
980 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
981 uses the ping command to probe the specified host for packet loss (percentage) and
982 round trip average (milliseconds).
984 This command uses the host's `address` attribute if not explicitly specified using
985 the `ping_address` attribute.
987 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
990 ----------------|--------------
991 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
992 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
993 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
994 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
995 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
996 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
997 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
999 ### ping6 <a id="plugin-check-command-ping6"></a>
1001 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
1002 uses the ping command to probe the specified host for packet loss (percentage) and
1003 round trip average (milliseconds).
1005 This command uses the host's `address6` attribute if not explicitly specified using
1006 the `ping_address` attribute.
1008 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1011 ----------------|--------------
1012 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
1013 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
1014 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
1015 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
1016 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
1017 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
1018 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
1021 ### pop <a id="plugin-check-command-pop"></a>
1023 The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin
1024 tests POP connections with the specified host (or unix socket).
1026 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1029 ---------------------|--------------
1030 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1031 pop_port | **Optional.** The port that should be checked. Defaults to 110.
1032 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.
1033 pop_send | **Optional.** String to send to the server.
1034 pop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1035 pop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1036 pop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1037 pop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1038 pop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1039 pop_jail | **Optional.** Hide output from TCP socket.
1040 pop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1041 pop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1042 pop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1043 pop_ssl | **Optional.** Use SSL for the connection.
1044 pop_warning | **Optional.** Response time to result in warning status (seconds).
1045 pop_critical | **Optional.** Response time to result in critical status (seconds).
1046 pop_timeout | **Optional.** Seconds before connection times out (default: 10).
1047 pop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1048 pop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1051 ### procs <a id="plugin-check-command-processes"></a>
1053 The [check_procs](https://www.monitoring-plugins.org/doc/man/check_procs.html) plugin
1054 checks all processes and generates WARNING or CRITICAL states if the specified
1055 metric is outside the required threshold ranges. The metric defaults to number
1056 of processes. Search filters can be applied to limit the processes to check.
1058 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1061 ---------------------|--------------
1062 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
1063 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
1064 procs_metric | **Optional.** Check thresholds against metric.
1065 procs_timeout | **Optional.** Seconds before plugin times out.
1066 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
1067 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
1068 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
1069 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
1070 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
1071 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
1072 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
1073 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
1074 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
1075 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
1076 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
1079 ### radius <a id="plugin-check-command-radius"></a>
1081 The [check_radius](https://www.monitoring-plugins.org/doc/man/check_radius.html) plugin
1082 checks a RADIUS server to see if it is accepting connections. The server to test
1083 must be specified in the invocation, as well as a user name and password. A configuration
1084 file may also be present. The format of the configuration file is described in the
1085 radiusclient library sources. The password option presents a substantial security
1086 issue because the password can possibly be determined by careful watching of the
1087 command line in a process listing. This risk is exacerbated because the plugin will
1088 typically be executed at regular predictable intervals. Please be sure that the
1089 password used does not allow access to sensitive system resources.
1092 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1095 -------------------|--------------
1096 radius_address | **Optional.** The radius server's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1097 radius_config_file | **Required.** The radius configuration file.
1098 radius_username | **Required.** The radius username to test.
1099 radius_password | **Required.** The radius password to test.
1100 radius_port | **Optional.** The radius port number (default 1645).
1101 radius_nas_id | **Optional.** The NAS identifier.
1102 radius_nas_address | **Optional.** The NAS IP address.
1103 radius_expect | **Optional.** The response string to expect from the server.
1104 radius_retries | **Optional.** The number of times to retry a failed connection.
1105 radius_timeout | **Optional.** The number of seconds before connection times out (default: 10).
1107 ### rpc <a id="plugin-check-command-rpc"></a>
1109 The [check_rpc](https://www.monitoring-plugins.org/doc/man/check_rpc.html)
1110 plugin tests if a service is registered and running using `rpcinfo -H host -C rpc_command`.
1112 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1116 rpc_address | **Optional.** The rpc host address. Defaults to "$address$ if the host `address` attribute is set, "$address6$" otherwise.
1117 rpc_command | **Required.** The programm name (or number).
1118 rpc_port | **Optional.** The port that should be checked.
1119 rpc_version | **Optional.** The version you want to check for (one or more).
1120 rpc_udp | **Optional.** Use UDP test. Defaults to false.
1121 rpc_tcp | **Optional.** Use TCP test. Defaults to false.
1122 rpc_verbose | **Optional.** Show verbose output. Defaults to false.
1124 ### simap <a id="plugin-check-command-simap"></a>
1126 The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
1127 tests SIMAP connections with the specified host (or unix socket).
1129 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1132 -----------------------|--------------
1133 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1134 simap_port | **Optional.** The port that should be checked. Defaults to 993.
1135 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.
1136 simap_send | **Optional.** String to send to the server.
1137 simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1138 simap_all | **Optional.** All expect strings need to occur in server response. Default is any.
1139 simap_quit | **Optional.** String to send server to initiate a clean close of the connection.
1140 simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1141 simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1142 simap_jail | **Optional.** Hide output from TCP socket.
1143 simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1144 simap_delay | **Optional.** Seconds to wait between sending string and polling for response.
1145 simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1146 simap_ssl | **Optional.** Use SSL for the connection.
1147 simap_warning | **Optional.** Response time to result in warning status (seconds).
1148 simap_critical | **Optional.** Response time to result in critical status (seconds).
1149 simap_timeout | **Optional.** Seconds before connection times out (default: 10).
1150 simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1151 simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1153 ### smart <a id="plugin-check-command-smart"></a>
1155 The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
1156 checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
1158 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1161 ----------------|--------------
1162 smart_device | **Required.** The name of a local hard drive to monitor.
1165 ### smtp <a id="plugin-check-command-smtp"></a>
1167 The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
1168 will attempt to open an SMTP connection with the host.
1170 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1173 ----------------------|--------------
1174 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1175 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
1176 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
1177 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
1178 smtp_command | **Optional.** SMTP command (may be used repeatedly).
1179 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
1180 smtp_helo_fqdn | **Optional.** FQDN used for HELO
1181 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1182 smtp_starttls | **Optional.** Use STARTTLS for the connection.
1183 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
1184 smtp_authuser | **Optional.** SMTP AUTH username.
1185 smtp_authpass | **Optional.** SMTP AUTH password.
1186 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
1187 smtp_warning | **Optional.** Response time to result in warning status (seconds).
1188 smtp_critical | **Optional.** Response time to result in critical status (seconds).
1189 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1190 smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1191 smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1194 ### snmp <a id="plugin-check-command-snmp"></a>
1196 The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin
1197 checks the status of remote machines and obtains system information via SNMP.
1199 **Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
1201 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1204 --------------------|--------------
1205 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1206 snmp_oid | **Required.** The SNMP OID.
1207 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1208 snmp_port | **Optional.** The SNMP port. Defaults to "161".
1209 snmp_retries | **Optional.** Number of retries to be used in the SNMP requests.
1210 snmp_warn | **Optional.** The warning threshold.
1211 snmp_crit | **Optional.** The critical threshold.
1212 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
1213 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
1214 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
1215 snmp_label | **Optional.** Prefix label for output value
1216 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
1217 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1218 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
1219 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
1220 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1221 snmp_rate | **Optional.** Boolean. Enable rate calculation.
1222 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
1223 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1224 snmp_offset | **Optional.** Add/subtract the specified OFFSET to numeric sensor data.
1225 snmp_output_delimiter | **Optional.** Separates output on multiple OID requests.
1226 snmp_perf_oids | **Optional.** Label performance data with OIDs instead of --label's.
1228 ### snmpv3 <a id="plugin-check-command-snmpv3"></a>
1230 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1231 plugin, using SNMPv3 authentication and encryption options.
1233 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1236 ---------------------|--------------
1237 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1238 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
1239 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
1240 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
1241 snmpv3_user | **Required.** The username to log in with.
1242 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
1243 snmpv3_priv_key | **Required.** The encryption key.
1244 snmpv3_oid | **Required.** The SNMP OID.
1245 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
1246 snmpv3_warn | **Optional.** The warning threshold.
1247 snmpv3_crit | **Optional.** The critical threshold.
1248 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
1249 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
1250 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
1251 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
1252 snmpv3_label | **Optional.** Prefix label for output value.
1253 snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1254 snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1255 snmpv3_rate | **Optional.** Boolean. Enable rate calculation.
1256 snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1258 ### snmp-uptime <a id="plugin-check-command-snmp-uptime"></a>
1260 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1261 plugin, using the uptime OID by default.
1263 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1266 ----------------|--------------
1267 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1268 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
1269 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1272 ### spop <a id="plugin-check-command-spop"></a>
1274 The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
1275 tests SPOP connections with the specified host (or unix socket).
1277 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1280 ----------------------|--------------
1281 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1282 spop_port | **Optional.** The port that should be checked. Defaults to 995.
1283 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.
1284 spop_send | **Optional.** String to send to the server.
1285 spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1286 spop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1287 spop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1288 spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1289 spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1290 spop_jail | **Optional.** Hide output from TCP socket.
1291 spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1292 spop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1293 spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1294 spop_ssl | **Optional.** Use SSL for the connection.
1295 spop_warning | **Optional.** Response time to result in warning status (seconds).
1296 spop_critical | **Optional.** Response time to result in critical status (seconds).
1297 spop_timeout | **Optional.** Seconds before connection times out (default: 10).
1298 spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1299 spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1302 ### ssh <a id="plugin-check-command-ssh"></a>
1304 The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
1305 connects to an SSH server at a specified host and port.
1307 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1310 ----------------|--------------
1311 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1312 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
1313 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1314 ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1315 ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1318 ### ssl <a id="plugin-check-command-ssl"></a>
1320 Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
1321 using ssl-related options.
1323 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1326 ------------------------------|--------------
1327 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1328 ssl_port | **Optional.** The port that should be checked. Defaults to 443.
1329 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
1330 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.
1331 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.
1332 ssl_sni | **Optional.** The `server_name` that is send to select the SSL certificate to check. Important if SNI is used.
1335 ### ssmtp <a id="plugin-check-command-ssmtp"></a>
1337 The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
1338 tests SSMTP connections with the specified host (or unix socket).
1340 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1343 -----------------------|--------------
1344 ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1345 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
1346 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.
1347 ssmtp_send | **Optional.** String to send to the server.
1348 ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1349 ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any.
1350 ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1351 ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1352 ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1353 ssmtp_jail | **Optional.** Hide output from TCP socket.
1354 ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1355 ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1356 ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1357 ssmtp_ssl | **Optional.** Use SSL for the connection.
1358 ssmtp_warning | **Optional.** Response time to result in warning status (seconds).
1359 ssmtp_critical | **Optional.** Response time to result in critical status (seconds).
1360 ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1361 ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1362 ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1365 ### swap <a id="plugin-check-command-swap"></a>
1367 The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
1368 checks the swap space on a local machine.
1370 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1373 ----------------|--------------
1374 swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`.
1375 swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`.
1376 swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
1377 swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false.
1378 swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".
1381 ### tcp <a id="plugin-check-command-tcp"></a>
1383 The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
1384 tests TCP connections with the specified host (or unix socket).
1386 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1389 ----------------|--------------
1390 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1391 tcp_port | **Required.** The port that should be checked.
1392 tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1393 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
1394 tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
1395 tcp_send | **Optional.** String to send to the server.
1396 tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
1397 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1398 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
1399 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
1400 tcp_jail | **Optional.** Hide output from TCP socket.
1401 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1402 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1403 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.
1404 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
1405 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
1406 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
1407 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1408 tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1409 tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1412 ### udp <a id="plugin-check-command-udp"></a>
1414 The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
1415 tests UDP connections with the specified host (or unix socket).
1417 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1420 ----------------|--------------
1421 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1422 udp_port | **Required.** The port that should be checked.
1423 udp_send | **Required.** The payload to send in the UDP datagram.
1424 udp_expect | **Required.** The payload to expect in the response datagram.
1425 udp_quit | **Optional.** The payload to send to 'close' the session.
1426 udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1427 udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1430 ### ups <a id="plugin-check-command-ups"></a>
1432 The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin
1433 tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
1434 must be running for this plugin to work.
1436 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1439 ----------------|--------------
1440 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1441 ups_name | **Required.** The UPS name. Defaults to `ups`.
1442 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
1443 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`.
1444 ups_warning | **Optional.** The warning threshold for the selected variable.
1445 ups_critical | **Optional.** The critical threshold for the selected variable.
1446 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
1447 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
1450 ### users <a id="plugin-check-command-users"></a>
1452 The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin
1453 checks the number of users currently logged in on the local system and generates an
1454 error if the number exceeds the thresholds specified.
1456 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1459 ----------------|--------------
1460 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
1461 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
1465 ## Windows Plugins for Icinga 2 <a id="windows-plugins"></a>
1467 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.
1469 A check-commands-windows.conf comes with Icinga 2, it assumes 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:
1471 include <windows-plugins>
1473 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.
1476 ### Threshold syntax <a id="windows-plugins-thresholds"></a>
1478 So not specified differently the thresholds for the plugins all follow the same pattern
1481 :------------|:----------
1482 "29" | The threshold is 29.
1483 "!29" | The threshold is 29, but the negative of the result is returned.
1484 "[10-40]" | The threshold is a range from (including) 10 to 40, a value inside means the threshold has been exceeded.
1485 "![10-40]" | Same as above, but the result is inverted.
1488 ### disk-windows <a id="windows-plugins-disk-windows"></a>
1490 Check command object for the `check_disk.exe` plugin.
1491 Aggregates the disk space of all volumes and mount points it can find, or the ones defined in `disk_win_path`. Ignores removable storage like flash drives and discs (CD, DVD etc.).
1492 The data collection is instant and free disk space (default, see `disk_win_show_used`) is used for threshold computation.
1496 > Percentage based thresholds can be used by adding a '%' to the threshold
1502 :---------------------|:------------
1503 disk\_win\_warn | **Optional**. The warning threshold.
1504 disk\_win\_crit | **Optional**. The critical threshold.
1505 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1506 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.
1507 disk\_win\_exclude | **Optional**. Exclude these drives from check.
1508 disk\_win\_show\_used | **Optional**. Use used instead of free space.
1510 ### load-windows <a id="windows-plugins-load-windows"></a>
1512 Check command object for the `check_load.exe` plugin.
1513 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).
1518 :---------------|:------------
1519 load\_win\_warn | **Optional**. The warning threshold.
1520 load\_win\_crit | **Optional**. The critical threshold.
1523 ### memory-windows <a id="windows-plugins-memory-windows"></a>
1525 Check command object for the `check_memory.exe` plugin.
1526 The memory collection is instant and free memory is used for threshold computation.
1530 > Percentage based thresholds can be used by adding a '%' to the threshold
1531 > value. Keep in mind that memory\_win\_unit is applied before the
1532 > value is calculated.
1537 :-----------------|:------------
1538 memory\_win\_warn | **Optional**. The warning threshold.
1539 memory\_win\_crit | **Optional**. The critical threshold.
1540 memory\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte), possible values are: b, kb, mb, gb and tb.
1543 ### network-windows <a id="windows-plugins-network-windows"></a>
1545 Check command object for the `check_network.exe` plugin.
1546 Collects the total Bytes inbound 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).
1551 :-------------------|:------------
1552 network\_win\_warn | **Optional**. The warning threshold.
1553 network\_win\_crit | **Optional**. The critical threshold.
1554 network\_no\_isatap | **Optional**. Do not print ISATAP interfaces.
1557 ### perfmon-windows <a id="windows-plugins-perfmon-windows"></a>
1559 Check command object for the `check_perfmon.exe` plugin.
1560 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`.
1562 To receive 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"`
1567 :---------------------|:------------
1568 perfmon\_win\_warn | **Optional**. The warning threshold.
1569 perfmon\_win\_crit | **Optional**. The critical threshold.
1570 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1571 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1572 perfmon\_win\_type | **Optional**. Format in which to expect performance values. Possible are: long, int64 and double (default).
1573 perfmon\_win\_syntax | **Optional**. Use this in the performance output instead of `perfmon\_win\_counter`. Exists for graphics compatibility reasons.
1576 ### ping-windows <a id="windows-plugins-ping-windows"></a>
1578 Check command object for the `check_ping.exe` plugin.
1579 ping-windows should automatically 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.
1584 :------------------|:------------
1585 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma.
1586 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma.
1587 ping\_win\_address | **Required**. An IPv4 or IPv6 address.
1588 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1589 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1592 ### procs-windows <a id="windows-plugins-procs-windows"></a>
1594 Check command object for `check_procs.exe` plugin.
1595 When using `procs_win_user` this plugins needs administrative privileges to access the processes of other users, to just enumerate them no additional privileges are required.
1600 :----------------|:------------
1601 procs\_win\_warn | **Optional**. The warning threshold.
1602 procs\_win\_crit | **Optional**. The critical threshold.
1603 procs\_win\_user | **Optional**. Count this users processes.
1606 ### service-windows <a id="windows-plugins-service-windows"></a>
1608 Check command object for `check_service.exe` plugin.
1609 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.
1614 :-------------------------|:------------
1615 service\_win\_warn | **Optional**. Warn when service is not running.
1616 service\_win\_description | **Optional**. If this is set, `service\_win\_service` looks at the service description.
1617 service\_win\_service | **Required**. Name of the service to check.
1620 ### swap-windows <a id="windows-plugins-swap-windows"></a>
1622 Check command object for `check_swap.exe` plugin.
1623 The data collection is instant.
1628 :---------------|:------------
1629 swap\_win\_warn | **Optional**. The warning threshold.
1630 swap\_win\_crit | **Optional**. The critical threshold.
1631 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1634 ### update-windows <a id="windows-plugins-update-windows"></a>
1636 Check command object for `check_update.exe` plugin.
1637 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.
1641 > The Network Services Account which runs Icinga 2 by default does not have the required
1642 > permissions to run this check.
1647 :-------------------|:------------
1648 update\_win\_warn | **Optional**. If set, returns warning when important updates are available.
1649 update\_win\_crit | **Optional**. If set, return critical when important updates that require a reboot are available.
1650 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.
1653 In contrast to most other plugins, the values of check_update's custom attributes do not set thresholds, but just enable/disable the behavior described in the table above.
1654 It can be enabled/disabled for example by setting them to "true" or "false", "1" or "0" would also work.
1655 Thresholds will always be "1".
1659 > If they are enabled, performance data will be shown in the web interface.
1660 > If run without the optional parameters, the plugin will output critical if any important updates are available.
1663 ### uptime-windows <a id="windows-plugins-uptime-windows"></a>
1665 Check command object for `check_uptime.exe` plugin.
1666 Uses GetTickCount64 to get the uptime, so boot time is not included.
1671 :-----------------|:------------
1672 uptime\_win\_warn | **Optional**. The warning threshold.
1673 uptime\_win\_crit | **Optional**. The critical threshold.
1674 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).
1677 ### users-windows <a id="windows-plugins-users-windows"></a>
1679 Check command object for `check_users.exe` plugin.
1684 :----------------|:------------
1685 users\_win\_warn | **Optional**. The warning threshold.
1686 users\_win\_crit | **Optional**. The critical threshold.
1689 ## Plugin Check Commands for NSClient++ <a id="nscp-plugin-check-commands"></a>
1691 There are two methods available for querying NSClient++:
1693 * Query the [HTTP API](10-icinga-template-library.md#nscp-check-api) locally or remotely (requires a running NSClient++ service)
1694 * Run a [local CLI check](10-icinga-template-library.md#nscp-check-local) (does not require NSClient++ as a service)
1696 Both methods have their advantages and disadvantages. One thing to
1697 note: If you rely on performance counter delta calculations such as
1698 CPU utilization, please use the HTTP API instead of the CLI sample call.
1700 ### nscp_api <a id="nscp-check-api"></a>
1702 `check_nscp_api` is part of the Icinga 2 plugins. This plugin is available for
1703 both, Windows and Linux/Unix.
1705 Verify that the ITL CheckCommand is included in the [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf) configuration file:
1707 vim /etc/icinga2/icinga2.conf
1711 `check_nscp_api` runs queries against the NSClient++ API. Therefore NSClient++ needs to have
1712 the `webserver` module enabled, configured and loaded.
1714 You can install the webserver using the following CLI commands:
1716 ./nscp.exe web install
1717 ./nscp.exe web password — –set icinga
1719 Now you can define specific [queries](https://docs.nsclient.org/reference/check/CheckHelpers.html#queries)
1720 and integrate them into Icinga 2.
1722 The check plugin `check_nscp_api` can be integrated with the `nscp_api` CheckCommand object:
1727 :----------------------|:----------------------
1728 nscp\_api\_host | **Required**. NSCP API host address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1729 nscp\_api\_port | **Optional**. NSCP API port. Defaults to `8443`.
1730 nscp\_api\_password | **Required**. NSCP API password. Please check the NSCP documentation for setup details.
1731 nscp\_api\_query | **Required**. NSCP API query endpoint. Refer to the NSCP documentation for possible values.
1732 nscp\_api\_arguments | **Optional**. NSCP API arguments dictionary either as single strings or key-value pairs using `=`. Refer to the NSCP documentation.
1734 `nscp_api_arguments` can be used to pass required thresholds to the executed check. The example below
1735 checks the CPU utilization and specifies warning and critical thresholds.
1738 check_nscp_api --host 10.0.10.148 --password icinga --query check_cpu --arguments show-all warning='load>40' critical='load>30'
1739 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
1743 ### nscp-local <a id="nscp-check-local"></a>
1745 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks locally on the client.
1747 You can enable these check commands by adding the following the include directive in your
1748 [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf) configuration file:
1752 You can also optionally specify an alternative installation directory for NSClient++ by adding
1753 the NscpPath constant in your [constants.conf](04-configuring-icinga-2.md#constants-conf) configuration
1756 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1758 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1759 not be necessary to manually set this constant.
1761 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1763 The check command object for NSClient++ is available as `nscp-local`.
1765 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1768 ----------------|--------------
1769 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1770 nscp_load_all | **Optional.** Whether to load all modules. Defaults to false.
1771 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`.
1772 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1773 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1774 nscp_arguments | **Optional.** An array of query arguments.
1775 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1777 ### nscp-local-cpu <a id="nscp-check-local-cpu"></a>
1779 Check command object for the `check_cpu` NSClient++ plugin.
1782 --------------------|------------------
1783 nscp_cpu_time | **Optional.** Calculate average usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1784 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1785 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1786 nscp_cpu_arguments | **Optional.** Additional arguments.
1787 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1789 ### nscp-local-memory <a id="nscp-check-local-memory"></a>
1791 Check command object for the `check_memory` NSClient++ plugin.
1794 ----------------------|------------------
1795 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1796 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1797 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1798 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolute (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1799 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolute (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1800 nscp_memory_arguments | **Optional.** Additional arguments.
1801 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1803 ### nscp-local-os-version <a id="nscp-check-local-os-version"></a>
1805 Check command object for the `check_os_version` NSClient++ plugin.
1807 This command has the same custom attributes like the `nscp-local` check command.
1809 ### nscp-local-pagefile <a id="nscp-check-local-pagefile"></a>
1811 Check command object for the `check_pagefile` NSClient++ plugin.
1813 This command has the same custom attributes like the `nscp-local` check command.
1815 ### nscp-local-process <a id="nscp-check-local-process"></a>
1817 Check command object for the `check_process` NSClient++ plugin.
1819 This command has the same custom attributes like the `nscp-local` check command.
1821 ### nscp-local-service <a id="nscp-check-local-service"></a>
1823 Check command object for the `check_service` NSClient++ plugin.
1826 -----------------------|------------------
1827 nscp_service_name | **Required.** Name of service to check.
1828 nscp_service_type | **Optional.** Type to check, default to state.
1829 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1830 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1831 nscp_service_warning | **Optional.** State for return an WARNING.
1832 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1833 nscp_service_critical | **Optional.** State for return an CRITICAL.
1834 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1835 nscp_service_arguments | **Optional.** Additional arguments.
1836 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1838 ### nscp-local-uptime <a id="nscp-check-local-uptime"></a>
1840 Check command object for the `check_uptime` NSClient++ plugin.
1842 This command has the same custom attributes like the `nscp-local` check command.
1844 ### nscp-local-version <a id="nscp-check-local-version"></a>
1846 Check command object for the `check_version` NSClient++ plugin.
1848 This command has the same custom attributes like the `nscp-local` check command.
1849 In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
1851 ### nscp-local-disk <a id="nscp-check-local-disk"></a>
1853 Check command object for the `check_drivesize` NSClient++ plugin.
1856 -----------------------|------------------
1857 nscp_disk_drive | **Optional.** Drive character, default to all drives.
1858 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1859 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolute (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1860 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolute (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1861 nscp_disk_arguments | **Optional.** Additional arguments.
1862 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1863 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`.
1865 ### nscp-local-counter <a id="nscp-check-local-counter"></a>
1867 Check command object for the `check_pdh` NSClient++ plugin.
1870 -----------------------|------------------
1871 nscp_counter_name | **Required.** Performance counter name.
1872 nscp_counter_warning | **Optional.** WARNING Threshold.
1873 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1874 nscp_counter_arguments | **Optional.** Additional arguments.
1875 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1876 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1880 ## Plugin Check Commands for Manubulon SNMP <a id="snmp-manubulon-plugin-check-commands"></a>
1882 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1883 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1885 **Note:** Some plugin parameters are only available in Debian packages or in a
1886 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1888 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1889 is set to the path where the Manubublon SNMP plugins are installed.
1891 You can enable these plugin check commands by adding the following the include directive in your
1892 [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf) configuration file:
1896 ### Checks by Host Type
1898 **N/A** : Not available for this type.
1900 **SNMP** : Available for simple SNMP query.
1904 **Specific** : Script name for platform specific checks.
1907 Host type | Interface | storage | load/cpu | mem | process | env | specific
1908 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1909 Linux | Yes | Yes | Yes | Yes | Yes | No |
1910 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1911 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1912 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1913 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1914 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1915 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1916 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1917 AS400 | Yes | Yes | Yes | Yes | No | No |
1918 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1919 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1920 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1921 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1924 ### snmp-env <a id="plugin-check-command-snmp-env"></a>
1926 Check command object for the [check_snmp_env.pl](http://nagios.manubulon.com/snmp_env.html) plugin.
1928 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1932 ------------------------|--------------
1933 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1934 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
1935 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1936 snmp_port | **Optional.** The SNMP port connection.
1937 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1938 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1939 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1940 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1941 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1942 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1943 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1944 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1945 snmp_env_type | **Optional.** Environment Type [cisco|nokia|bc|iron|foundry|linux]. Defaults to "cisco".
1946 snmp_env_fan | **Optional.** Minimum fan rpm value (only needed for 'iron' & 'linux')
1947 snmp_env_celsius | **Optional.** Maximum temp in degrees celsius (only needed for 'iron' & 'linux')
1948 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1949 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1951 ### snmp-load <a id="plugin-check-command-snmp-load"></a>
1953 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1955 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1959 ------------------------|--------------
1960 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1961 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
1962 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1963 snmp_port | **Optional.** The SNMP port connection.
1964 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1965 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1966 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1967 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1968 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1969 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1970 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1971 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1972 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1973 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1974 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.
1975 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1976 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1978 ### snmp-memory <a id="plugin-check-command-snmp-memory"></a>
1980 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1982 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1985 ------------------------|--------------
1986 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1987 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
1988 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1989 snmp_port | **Optional.** The SNMP port connection.
1990 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1991 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1992 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1993 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1994 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1995 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1996 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1997 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1998 snmp_warn | **Optional.** The warning threshold.
1999 snmp_crit | **Optional.** The critical threshold.
2000 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
2001 snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
2002 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2003 snmp_memcached | **Optional.** Include cached memory in used memory, Defaults to false.
2004 snmp_membuffer | **Optional.** Exclude buffered memory in used memory, Defaults to false.
2005 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2007 ### snmp-storage <a id="plugin-check-command-snmp-storage"></a>
2009 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
2011 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2014 ------------------------|--------------
2015 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2016 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
2017 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2018 snmp_port | **Optional.** The SNMP port connection.
2019 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2020 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2021 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2022 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2023 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2024 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2025 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2026 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
2027 snmp_warn | **Optional.** The warning threshold.
2028 snmp_crit | **Optional.** The critical threshold.
2029 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
2030 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2031 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2032 snmp_storage_olength | **Optional.** Max-size of the SNMP message, usefull in case of Too Long responses.
2034 ### snmp-interface <a id="plugin-check-command-snmp-interface"></a>
2036 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
2038 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2041 ----------------------------|--------------
2042 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2043 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
2044 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2045 snmp_port | **Optional.** The SNMP port connection.
2046 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2047 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2048 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2049 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2050 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2051 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2052 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2053 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
2054 snmp_warn | **Optional.** The warning threshold.
2055 snmp_crit | **Optional.** The critical threshold.
2056 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
2057 snmp_interface_inverse | **Optional.** Inverse Interface check, down is ok. Defaults to false as it is missing.
2058 snmp_interface_perf | **Optional.** Check the input/output bandwidth of the interface. Defaults to true.
2059 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
2060 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.
2061 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
2062 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
2063 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.
2064 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
2065 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
2066 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
2067 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
2068 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.
2069 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name.
2070 snmp_interface_ifalias | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name.
2071 snmp_interface_weathermap | **Optional.** Output data for ["weathermap" lines](http://docs.nagvis.org/1.9/en_US/lines_weathermap_style.html) in NagVis. **Depends** on `snmp_interface_perf` set to true. Defaults to `false`. **Note**: Available in `check_snmp_int.pl v2.1.0`.
2072 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2073 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2075 ### snmp-process <a id="plugin-check-command-snmp-process"></a>
2077 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
2079 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2082 ---------------------------|--------------
2083 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2084 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
2085 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2086 snmp_port | **Optional.** The SNMP port connection.
2087 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2088 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2089 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2090 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2091 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2092 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2093 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2094 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
2095 snmp_warn | **Optional.** The warning threshold.
2096 snmp_crit | **Optional.** The critical threshold.
2097 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
2098 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2099 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2100 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.
2101 snmp_process_mem_usage | **Optional.** Define to check memory usage for the process. Defaults to false.
2102 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".
2103 snmp_process_cpu_usage | **Optional.** Define to check CPU usage for the process. Defaults to false.
2104 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".
2106 ### snmp-service <a id="plugin-check-command-snmp-service"></a>
2108 Check command object for the [check_snmp_win.pl](http://nagios.manubulon.com/snmp_windows.html) plugin.
2110 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2113 ---------------------------|--------------
2114 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2115 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
2116 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2117 snmp_port | **Optional.** The SNMP port connection.
2118 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2119 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2120 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2121 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2122 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2123 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2124 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2125 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
2126 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2127 snmp_service_name | **Optional.** Comma separated names of services (perl regular expressions can be used for every one). By default, it is not case sensitive. eg. ^dns$. Defaults to ".*".
2128 snmp_service_count | **Optional.** Compare matching services with a specified number instead of the number of names provided.
2129 snmp_service_showall | **Optional.** Show all services in the output, instead of only the non-active ones. Defaults to false.
2130 snmp_service_noregexp | **Optional.** Do not use regexp to match NAME in service description. Defaults to false.
2133 ## Contributed Plugin Check Commands <a id="plugin-contrib"></a>
2135 The contributed Plugin Check Commands provides various additional command definitions
2136 contributed by community members.
2138 These check commands assume that the global constant named `PluginContribDir`
2139 is set to the path where the user installs custom plugins and can be enabled by
2140 uncommenting the corresponding line in [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf):
2143 vim /etc/icinga2/icinga2.conf
2145 include <plugin-contrib>
2148 This is enabled by default since Icinga 2 2.5.0.
2150 ### Databases <a id="plugin-contrib-databases"></a>
2152 This category contains plugins for various database servers.
2154 #### db2_health <a id="plugin-contrib-command-db2_health"></a>
2156 The [check_db2_health](https://labs.consol.de/nagios/check_db2_health/) plugin
2157 uses the `DBD::DB2` Perl library to monitor a [DB2](https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/)
2160 The Git repository is located on [GitHub](https://github.com/lausser/check_db2_health).
2162 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2165 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2166 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)
2167 db2_health_username | **Optional.** The username for the database connection.
2168 db2_health_password | **Optional.** The password for the database connection.
2169 db2_health_port | **Optional.** The port where DB2 is listening.
2170 db2_health_warning | **Optional.** The warning threshold depending on the mode.
2171 db2_health_critical | **Optional.** The critical threshold depending on the mode.
2172 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
2173 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).
2174 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.
2175 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.
2176 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
2177 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".
2178 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
2179 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
2180 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
2181 db2_health_report | **Optional.** Report can be used to output only the bad news. Possible values are "short", "long", "html". Defaults to `short`.
2182 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".
2183 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
2185 #### mssql_health <a id="plugin-contrib-command-mssql_health"></a>
2187 The [check_mssql_health](https://labs.consol.de/nagios/check_mssql_health/index.html) plugin
2188 uses the `DBD::Sybase` Perl library based on [FreeTDS](http://www.freetds.org/) to monitor a
2189 [MS SQL](https://www.microsoft.com/en-us/sql-server/) server.
2191 The Git repository is located on [GitHub](https://github.com/lausser/check_mssql_health).
2193 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2196 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2197 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
2198 mssql_health_username | **Optional.** The username for the database connection.
2199 mssql_health_password | **Optional.** The password for the database connection.
2200 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
2201 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
2202 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
2203 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
2204 mssql_health_nooffline | **Optional.** Set this to true to ignore offline databases. Defaults to false.
2205 mssql_health_dbthresholds | **Optional.** With this parameter thresholds are read from the database table check_mssql_health_thresholds.
2206 mssql_health_notemp | **Optional.** Set this to true to ignore temporary databases/tablespaces. Defaults to false.
2207 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
2208 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).
2209 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
2210 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
2211 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
2212 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
2213 mssql_health_warningx | **Optional.** A possible override for the warning threshold.
2214 mssql_health_criticalx | **Optional.** A possible override for the critical threshold.
2215 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".
2216 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
2217 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.
2218 mssql_health_name3 | **Optional.** Additional argument used for 'database-file-free' mode for example.
2219 mssql_health_extraopts | **Optional.** Read command line arguments from an external file.
2220 mssql_health_blacklist | **Optional.** Blacklist some (missing/failed) components
2221 mssql_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning.
2222 mssql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates.
2223 mssql_health_environment | **Optional.** Add a variable to the plugin's environment.
2224 mssql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical.
2225 mssql_health_morphmessage | **Optional.** Modify the final output message.
2226 mssql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels.
2227 mssql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data.
2228 mssql_health_report | **Optional.** Report can be used to output only the bad news. Possible values are "short", "long", "html". Defaults to `short`.
2229 mssql_health_multiline | **Optional.** Multiline output.
2230 mssql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory.
2231 mssql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2232 mssql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time.
2233 mssql_health_timeout | **Optional.** Plugin timeout. Defaults to 15s.
2235 #### mysql_health <a id="plugin-contrib-command-mysql_health"></a>
2237 The [check_mysql_health](https://labs.consol.de/nagios/check_mysql_health/index.html) plugin
2238 uses the `DBD::MySQL` Perl library to monitor a
2239 [MySQL](https://dev.mysql.com/downloads/mysql/) or [MariaDB](https://mariadb.org/about/) database.
2241 The Git repository is located on [GitHub](https://github.com/lausser/check_mysql_health).
2243 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2246 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2247 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
2248 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
2249 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
2250 mysql_health_username | **Optional.** The username for the database connection.
2251 mysql_health_password | **Optional.** The password for the database connection.
2252 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
2253 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
2254 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
2255 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
2256 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
2257 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
2258 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
2259 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::\* module.
2260 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
2261 mysql_health_nooffline | **Optional.** Skip the offline databases.
2262 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
2263 mysql_health_name | **Optional.** The name of a specific component to check.
2264 mysql_health_name2 | **Optional.** The secondary name of a component.
2265 mysql_health_name3 | **Optional.** The tertiary name of a component.
2266 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".
2267 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2268 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2269 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components
2270 mysql_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning.
2271 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates.
2272 mysql_health_environment | **Optional.** Add a variable to the plugin's environment.
2273 mysql_health_morphmessage | **Optional.** Modify the final output message.
2274 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels.
2275 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data.
2276 mysql_health_report | **Optional.** Can be used to shorten the output.
2277 mysql_health_multiline | **Optional.** Multiline output.
2278 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical.
2279 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory.
2280 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2281 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time.
2282 mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2284 #### oracle_health <a id="plugin-contrib-command-oracle_health"></a>
2286 The [check_oracle_health](https://labs.consol.de/nagios/check_oracle_health/index.html) plugin
2287 uses the `DBD::Oracle` Perl library to monitor an [Oracle](https://www.oracle.com/database/) database.
2289 The Git repository is located on [GitHub](https://github.com/lausser/check_oracle_health).
2291 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2294 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2295 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2296 oracle_health_username | **Optional.** The username for the database connection.
2297 oracle_health_password | **Optional.** The password for the database connection.
2298 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2299 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2300 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2301 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2302 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.
2303 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.
2304 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2305 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".
2306 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2307 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2308 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2309 oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2310 oracle_health_report | **Optional.** Select the plugin output format. Can be short or long. Default to long.
2315 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2316 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 the custom attribute `oracle_home`.
2317 LD\_LIBRARY\_PATH | **Required.** Specifies the location of the oracle instant client libraries for the run-time shared library loader. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting the custom attribute `oracle_ld_library_path`.
2318 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 the custom attribute `oracle_tns_admin`.
2320 #### postgres <a id="plugin-contrib-command-postgres"></a>
2322 The [check_postgres](https://bucardo.org/wiki/Check_postgres) plugin
2323 uses the `psql` binary to monitor a [PostgreSQL](https://www.postgresql.org/about/) database.
2325 The Git repository is located on [GitHub](https://github.com/bucardo/check_postgres).
2327 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2330 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2331 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.
2332 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2333 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2334 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2335 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2336 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2337 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2338 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2339 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2340 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2341 postgres_includeuser | **Optional.** Include objects owned by certain users.
2342 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2343 postgres_standby | **Optional.** Assume that the server is in continuous WAL recovery mode if set to true. Defaults to false.
2344 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2345 postgres_action | **Required.** Determines the test executed.
2346 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2347 postgres_query | **Optional.** Query for "custom_query" action.
2348 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2349 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2350 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).
2352 #### mongodb <a id="plugin-contrib-command-mongodb"></a>
2354 The [check_mongodb.py](https://github.com/mzupan/nagios-plugin-mongodb) plugin
2355 uses the `pymongo` Python library to monitor a [MongoDB](https://docs.mongodb.com/manual/) instance.
2357 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2360 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2361 mongodb_host | **Required.** Specifies the hostname or address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2362 mongodb_port | **Required.** The port mongodb is running on.
2363 mongodb_user | **Optional.** The username you want to login as.
2364 mongodb_passwd | **Optional.** The password you want to use for that user.
2365 mongodb_authdb | **Optional.** The database you want to authenticate against.
2366 mongodb_warning | **Optional.** The warning threshold we want to set.
2367 mongodb_critical | **Optional.** The critical threshold we want to set.
2368 mongodb_action | **Required.** The action you want to take.
2369 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only).
2370 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read).
2371 mongodb_perfdata | **Optional.** Enable output of Nagios performance data.
2372 mongodb_database | **Optional.** Specify the database to check.
2373 mongodb_alldatabases | **Optional.** Check all databases (action database_size).
2374 mongodb_ssl | **Optional.** Connect using SSL.
2375 mongodb_replicaset | **Optional.** Connect to replicaset.
2376 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check.
2377 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second.
2378 mongodb_collection | **Optional.** Specify the collection to check.
2379 mongodb_sampletime | **Optional.** Time used to sample number of pages faults.
2381 #### elasticsearch <a id="plugin-contrib-command-elasticsearch"></a>
2383 The [check_elasticsearch](https://github.com/anchor/nagios-plugin-elasticsearch) plugin
2384 uses the HTTP API to monitor an [Elasticsearch](https://www.elastic.co/products/elasticsearch) node.
2386 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2389 -----------------------------|-------------------------------------------------------------------------------------------------------
2390 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2391 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2392 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.
2393 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2394 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2395 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2397 #### redis <a id="plugin-contrib-command-redis"></a>
2399 The [check_redis.pl](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl) plugin
2400 uses the `Redis` Perl library to monitor a [Redis](https://redis.io/) instance. The plugin can
2401 measure response time, hitrate, memory utilization, check replication synchronization, etc. It is
2402 also possible to test data in a specified key and calculate averages or summaries on ranges.
2404 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2407 -------------------------|--------------------------------------------------------------------------------------------------------------
2408 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2409 redis_port | **Optional.** Port number to query. Default to "6379".
2410 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2411 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2412 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2413 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2414 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2415 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.
2416 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.
2417 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.
2418 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2419 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.
2420 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".
2421 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2422 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2423 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.
2424 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2425 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.
2426 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2427 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2430 ### Hardware <a id="plugin-contrib-hardware"></a>
2432 This category includes all plugin check commands for various hardware checks.
2434 #### hpasm <a id="plugin-contrib-command-hpasm"></a>
2436 The [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) plugin
2437 monitors the hardware health of HP Proliant Servers, provided that the `hpasm`
2438 (HP Advanced Server Management) software is installed. It is also able to monitor
2439 the system health of HP Bladesystems and storage systems.
2441 The plugin can run in two different ways:
2443 1. Local execution using the `hpasmcli` command line tool.
2444 2. Remote SNMP query which invokes the HP Insight Tools on the remote node.
2446 You can either set or omit `hpasm_hostname` custom attribute and select the corresponding node.
2448 The `hpasm_remote` attribute enables the plugin to execute remote SNMP queries if set to `true`.
2449 For compatibility reasons this attribute uses `true` as default value, and ensures that
2450 specifying the `hpasm_hostname` always enables remote checks.
2452 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2455 --------------------------------|-----------------------------------------------------------------------
2456 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2457 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2458 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2459 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2460 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2461 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2462 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2463 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2464 hpasm_eventrange | **Optional.** Period of time before critical IML events respectively become warnings or vanish. A range is described as a number and a unit (s, m, h, d), e.g. --eventrange 1h/20m.
2465 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.
2466 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2467 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2468 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2469 hpasm_privpassword | **Optional.** The password for authPriv security level.
2470 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2471 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2472 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. (always 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.
2473 hpasm_remote | **Optional.** Run remote SNMP checks if enabled. Otherwise checks are executed locally using the `hpasmcli` binary. Defaults to `true`.
2475 #### openmanage <a id="plugin-contrib-command-openmanage"></a>
2477 The [check_openmanage](http://folk.uio.no/trondham/software/check_openmanage.html) plugin
2478 checks the hardware health of Dell PowerEdge (and some PowerVault) servers.
2479 It uses the Dell OpenManage Server Administrator (OMSA) software, which must be running on
2480 the monitored system. check_openmanage can be used remotely with SNMP or locally with icinga2 agent,
2481 check_by_ssh or similar, whichever suits your needs and particular taste.
2483 The plugin checks the health of the storage subsystem, power supplies, memory modules,
2484 temperature probes etc., and gives an alert if any of the components are faulty or operate outside normal parameters.
2486 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2489 --------------------------------|-----------------------------------------------------------------------
2490 openmanage_all | **Optional.** Check everything, even log content
2491 openmanage_blacklist | **Optional.** Blacklist missing and/or failed components
2492 openmanage_check | **Optional.** Fine-tune which components are checked
2493 openmanage_community | **Optional.** SNMP community string [default=public]
2494 openmanage_config | **Optional.** Specify configuration file
2495 openmanage_critical | **Optional.** Custom temperature critical limits
2496 openmanage_extinfo | **Optional.** Append system info to alerts
2497 openmanage_fahrenheit | **Optional.** Use Fahrenheit as temperature unit
2498 openmanage_hostname | **Optional.** Hostname or IP (required for SNMP)
2499 openmanage_htmlinfo | **Optional.** HTML output with clickable links
2500 openmanage_info | **Optional.** Prefix any alerts with the service tag
2501 openmanage_ipv6 | **Optional.** Use IPv6 instead of IPv4 [default=no]
2502 openmanage_legacy_perfdata | **Optional.** Legacy performance data output
2503 openmanage_no_storage | **Optional.** Don't check storage
2504 openmanage_only | **Optional.** Only check a certain component or alert type
2505 openmanage_perfdata | **Optional.** Output performance data [default=no]
2506 openmanage_port | **Optional.** SNMP port number [default=161]
2507 openmanage_protocol | **Optional.** SNMP protocol version [default=2c]
2508 openmanage_short_state | **Optional.** Prefix alerts with alert state abbreviated
2509 openmanage_show_blacklist | **Optional.** Show blacklistings in OK output
2510 openmanage_state | **Optional.** Prefix alerts with alert state
2511 openmanage_tcp | **Optional.** Use TCP instead of UDP [default=no]
2512 openmanage_timeout | **Optional.** Plugin timeout in seconds [default=30]
2513 openmanage_vdisk_critical | **Optional.** Make any alerts on virtual disks critical
2514 openmanage_warning | **Optional.** Custom temperature warning limits
2516 #### adaptec-raid <a id="plugin-contrib-command-adaptec-raid"></a>
2518 The [check_adaptec_raid](https://github.com/thomas-krenn/check_adaptec_raid) plugin
2519 uses the `arcconf` binary to monitor Adaptec RAID controllers.
2521 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2524 --------------------------------|-----------------------------------------------------------------------
2525 adaptec_controller_number | **Required.** Controller number to monitor.
2526 arcconf_path | **Required.** Path to the `arcconf` binary, e.g. "/sbin/arcconf".
2528 #### lsi-raid <a id="plugin-contrib-command-lsi-raid"></a>
2530 The [check_lsi_raid](https://github.com/thomas-krenn/check_lsi_raid) plugin
2531 uses the `storcli` binary to monitor MegaRAID RAID controllers.
2533 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2536 --------------------------------|-----------------------------------------------------------------------
2537 lsi_controller_number | **Required.** Controller number to monitor.
2538 storcli_path | **Required.** Path to the `storcli` binary, e.g. "/usr/sbin/storcli".
2540 #### smart-attributes <a id="plugin-contrib-command-smart-attributes"></a>
2542 The [check_smart_attributes](https://github.com/thomas-krenn/check_smart_attributes) plugin
2543 uses the `smartctl` binary to monitor SMART values of SSDs and HDDs.
2545 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2548 --------------------------------|-----------------------------------------------------------------------
2549 smart_attributes_config_path | **Required.** Path to the smart attributes config file (e.g. check_smartdb.json).
2550 smart_attributes_device | **Required.** Device name (e.g. /dev/sda) to monitor.
2553 ### IcingaCLI <a id="plugin-contrib-icingacli"></a>
2555 This category includes all plugins using the icingacli provided by Icinga Web 2.
2557 The user running Icinga 2 needs sufficient permissions to read the Icinga Web 2 configuration directory. e.g. `usermod -a -G icingaweb2 icinga`. You need to restart, not reload Icinga 2 for the new group membership to work.
2559 #### Business Process <a id="plugin-contrib-icingacli-businessprocess"></a>
2561 This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process)
2562 and executed as `icingacli businessprocess` CLI command.
2564 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2567 ------------------------------------------|-----------------------------------------------------------------------------------------
2568 icingacli_businessprocess_process | **Required.** Business process to monitor.
2569 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2570 icingacli_businessprocess_details | **Optional.** Get details for root cause analysis. Defaults to false.
2571 icingacli_businessprocess_statetype | **Optional.** Define which state type to look at, `soft` or `hard`. Overrides the default value inside the businessprocess module, if configured.
2573 #### Director <a id="plugin-contrib-icingacli-director"></a>
2575 This subcommand is provided by the [director module](https://github.com/Icinga/icingaweb2-module-director) > 1.4.2 and executed as `icingacli director health check`. Please refer to the [documentation](https://github.com/Icinga/icingaweb2-module-director/blob/master/doc/60-CLI.md#health-check-plugin) for all available sub-checks.
2577 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2580 ------------------------------------------|-----------------------------------------------------------------------------------------
2581 icingacli_director_check | **Optional.** Run only a specific test suite.
2582 icingacli_director_db | **Optional.** Use a specific Icinga Web DB resource.
2584 ### IPMI Devices <a id="plugin-contrib-ipmi"></a>
2586 This category includes all plugins for IPMI devices.
2588 #### ipmi-sensor <a id="plugin-contrib-command-ipmi-sensor"></a>
2590 The [check_ipmi_sensor](https://github.com/thomas-krenn/check_ipmi_sensor_v3) plugin
2591 uses the `ipmimonitoring` binary to monitor sensor data for IPMI devices. Please
2592 read the [documentation](https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin)
2593 for installation and configuration details.
2595 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2598 ---------------------------------|-----------------------------------------------------------------------------------------------------
2599 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2600 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2601 ipmi_username | **Optional.** The IPMI username.
2602 ipmi_password | **Optional.** The IPMI password.
2603 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2604 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2605 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2606 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.
2607 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2608 ipmi_exclude_sensor | **Optional.** Exclude sensor based on IPMI sensor type. (Comma-separated)
2609 ipmi_exclude_sel | **Optional.** Exclude SEL entries of specific sensor types. (comma-separated list).
2610 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2611 ipmi_protocol_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2612 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2613 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2614 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2615 ipmi_no_thresholds | **Optional.** Turn off performance data thresholds from output-sensor-thresholds.
2616 ipmi_verbose | **Optional.** Be Verbose multi line output, also with additional details for warnings.
2617 ipmi_debug | **Optional.** Be Verbose debugging output, followed by normal multi line output.
2619 #### ipmi-alive <a id="plugin-contrib-command-ipmi-alive"></a>
2621 The `ipmi-alive` check commands allows you to create a ping check for the IPMI Interface.
2623 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2626 ---------------------------------|-----------------------------------------------------------------------------------------------------
2627 ping_address | **Optional.** The address of the IPMI interface. Defaults to "$address$" if the IPMI interface's `address` attribute is set, "$address6$" otherwise.
2628 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 5000.
2629 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 100.
2630 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
2631 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
2632 ping_packets | **Optional.** The number of packets to send. Defaults to 1.
2633 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
2636 ### Log Management <a id="plugins-contrib-log-management"></a>
2638 This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
2640 #### logstash <a id="plugins-contrib-command-logstash"></a>
2642 The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
2643 the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
2645 The Node API is not activated by default. You have to configure your Logstash
2646 installation in order to allow plugin connections.
2649 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2650 logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
2651 logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
2652 logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
2653 logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
2654 logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
2655 logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
2656 logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
2657 logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
2658 logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
2659 logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
2662 ### Metrics <a id="plugin-contrib-metrics"></a>
2664 This category includes all plugins for metric-based checks.
2666 #### graphite <a id="plugin-contrib-command-graphite"></a>
2668 The [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin
2669 uses the `rest-client` Ruby library to monitor a [Graphite](https://graphiteapp.org) instance.
2671 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2674 ------------------------------------|-----------------------------------------------------------------------------------------------------
2675 graphite_url | **Required.** Target url.
2676 graphite_metric | **Required.** Metric path string.
2677 graphite_shortname | **Optional.** Metric short name (used for performance data).
2678 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2679 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2680 graphite_warning | **Required.** Warning threshold.
2681 graphite_critical | **Required.** Critical threshold.
2682 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.
2683 graphite_message | **Optional.** Text message to output (default: "metric count:").
2684 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2685 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2687 ### Network Components <a id="plugin-contrib-network-components"></a>
2689 This category includes all plugins for various network components like routers, switches and firewalls.
2691 #### interfacetable <a id="plugin-contrib-command-interfacetable"></a>
2693 The [check_interfacetable_v3t](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) plugin
2694 generates a html page containing information about the monitored node and all of its interfaces.
2696 The Git repository is located on [GitHub](https://github.com/Tontonitch/interfacetable_v3t).
2698 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2701 ------------------------------------|-----------------------------------------------------------------------------------------------------
2702 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2703 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2704 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2705 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2706 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2707 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2708 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2709 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2710 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2711 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2712 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2713 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2714 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.
2715 interfacetable_trackproperty | **Optional.** List of tracked properties.
2716 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2717 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2718 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
2719 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
2720 interfacetable_login | **Optional.** Login for snmpv3 authentication.
2721 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
2722 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
2723 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
2724 interfacetable_domain | **Optional.** SNMP transport domain.
2725 interfacetable_contextname | **Optional.** Context name for the snmp requests.
2726 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
2727 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
2728 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
2729 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
2730 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
2731 interfacetable_snmpmaxmsgsize | **Optional.** Size of the SNMP message in octets, useful in case of too long responses. Be careful 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.
2732 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
2733 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
2734 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
2735 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
2736 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
2737 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
2738 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
2739 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
2740 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
2741 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".
2742 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
2743 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
2744 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"
2745 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
2746 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
2747 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.
2748 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.
2749 interfacetable_delta | **Optional.** Set the delta used for interface throughput calculation in seconds.
2750 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
2751 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
2752 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
2753 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
2754 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
2755 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
2756 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga" or "icinga-alternate1".
2757 interfacetable_config | **Optional.** Specify a config file to load.
2758 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
2759 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
2760 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
2761 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
2762 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
2764 #### iftraffic <a id="plugin-contrib-command-iftraffic"></a>
2766 The [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic) plugin
2767 checks the utilization of a given interface name using the SNMP protocol.
2769 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2772 ------------------------|---------------------------------------------------------
2773 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
2774 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2775 iftraffic_interface | **Required.** Queried interface name.
2776 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2777 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2778 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2779 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2780 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2782 #### iftraffic64 <a id="plugin-contrib-command-iftraffic64"></a>
2784 The [check_iftraffic64](https://exchange.icinga.com/exchange/iftraffic64) plugin
2785 checks the utilization of a given interface name using the SNMP protocol.
2787 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2790 ------------------------|---------------------------------------------------------
2791 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
2792 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2793 iftraffic64_interface | **Required.** Queried interface name.
2794 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2795 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2796 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2797 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2798 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2800 #### interfaces <a id="plugin-contrib-command-interfaces"></a>
2802 The [check_interfaces](https://git.netways.org/plugins/check_interfaces) plugin
2803 uses SNMP to monitor network interfaces and their utilization.
2805 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2808 --------------------------|---------------------------------------------------------
2809 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2810 interfaces_regex | **Optional.** Interface list regexp.
2811 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
2812 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
2813 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
2814 interfaces_perfdata | **Optional.** perfdata from last check result.
2815 interfaces_prefix | **Optional.** Prefix interface names with this label.
2816 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
2817 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
2818 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
2819 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
2820 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
2821 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
2822 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
2823 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
2824 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
2825 interfaces_user | **Optional.** SNMPv3 User
2826 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
2827 interfaces_aliases | **Optional.** Retrieves the interface description.
2828 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
2829 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
2830 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
2831 interfaces_names | **Optional.** If set to true, use ifName instead of ifDescr.
2833 #### nwc_health <a id="plugin-contrib-command-nwc_health"></a>
2835 The [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html) plugin
2836 uses SNMP to monitor network components. The plugin is able to generate interface statistics,
2837 check hardware (CPU, memory, fan, power, etc.), monitor firewall policies, HRSP, load-balancer
2838 pools, processor and memory usage.
2840 Currently the following network components are supported: Cisco IOS, Cisco Nexus, Cisco ASA,
2841 Cisco PIX, F5 BIG-IP, CheckPoint Firewall1, Juniper NetScreen, HP Procurve, Nortel, Brocade 4100/4900,
2842 EMC DS 4700, EMC DS 24, Allied Telesyn. Blue Coat SG600, Cisco Wireless Lan Controller 5500,
2843 Brocade ICX6610-24-HPOE, Cisco UC Telefonzeugs, FOUNDRY-SN-AGENT-MIB, FRITZ!BOX 7390, FRITZ!DECT 200,
2844 Juniper IVE, Pulse-Gateway MAG4610, Cisco IronPort AsyncOS, Foundry, etc. A complete list can be
2845 found in the plugin [documentation](https://labs.consol.de/nagios/check_nwc_health/index.html).
2847 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2850 --------------------------------|---------------------------------------------------------
2851 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2852 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).
2853 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
2854 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
2855 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
2856 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).
2857 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2858 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2859 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2860 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
2861 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2862 nwc_health_privpassword | **Optional.** The password for authPriv security level.
2863 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2864 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
2865 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
2866 nwc_health_name | **Optional.** The name of an interface (ifDescr).
2867 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
2868 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
2869 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
2870 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
2871 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
2872 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
2873 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
2874 nwc_health_name2 | **Optional.** The secondary name of a component.
2875 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
2876 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)
2877 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.
2878 nwc_health_warning | **Optional.** The warning threshold
2879 nwc_health_critical | **Optional.** The critical threshold
2880 nwc_health_warningx | **Optional.** The extended warning thresholds
2881 nwc_health_criticalx | **Optional.** The extended critical thresholds
2882 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning (1) or ok (0).
2883 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.
2884 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'
2885 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
2886 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
2887 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
2888 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2889 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
2890 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
2891 nwc_health_multiline | **Optional.** Multiline output
2894 ### Operating System <a id="plugin-contrib-operating-system"></a>
2896 This category contains plugins which receive details about your operating system
2897 or the guest system.
2899 #### mem <a id="plugin-contrib-command-mem"></a>
2901 The [check_mem.pl](https://github.com/justintime/nagios-plugins) plugin checks the
2902 memory usage on linux and unix hosts. It is able to count cache memory as free when
2903 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).
2905 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2908 -------------|-----------------------------------------------------------------------------------------------------------------------
2909 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
2910 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
2911 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
2912 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
2913 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
2915 #### running_kernel <a id="plugin-contrib-command-running_kernel"></a>
2917 The [check_running_kernel](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin
2918 is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu.
2923 ---------------------------|-------------
2924 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
2926 #### iostats <a id="plugin-contrib-command-iostats"></a>
2928 The [check_iostats](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostats) plugin
2929 uses the `iostat` binary to monitor I/O on a Linux host. The default thresholds are rather high
2930 so you can use a grapher for baselining before setting your own.
2932 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2935 ---------------|-----------------------------------------------------------------------------------------------------------------------
2936 iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda).
2937 iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000).
2938 iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000).
2939 iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000).
2940 iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50).
2941 iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000).
2942 iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000).
2943 iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000).
2944 iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80).
2946 #### iostat <a id="plugin-contrib-command-iostat"></a>
2948 The [check_iostat](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostat) plugin
2949 uses the `iostat` binary to monitor disk I/O on a Linux host. The default thresholds are rather high
2950 so you can use a grapher for baselining before setting your own.
2952 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2955 ---------------|-----------------------------------------------------------------------------------------------------------------------
2956 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda).
2957 iostat\_wtps | **Required.** Warning threshold for tps (default: 100).
2958 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100).
2959 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100).
2960 iostat\_ctps | **Required.** Critical threshold for tps (default: 200).
2961 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200).
2962 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200).
2964 #### yum <a id="plugin-contrib-command-yum"></a>
2966 The [check_yum](https://github.com/calestyo/check_yum) plugin checks the YUM package
2967 management system for package updates.
2968 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
2970 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2973 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2974 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.
2975 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
2976 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.
2977 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.
2978 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.
2979 yum_enablerepo | **Optional.** Explicitly enables a repository 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.
2980 yum_disablerepo | **Optional.** Explicitly disables a repository 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.
2981 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
2982 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
2984 ### Storage <a id="plugins-contrib-storage"></a>
2986 This category includes all plugins for various storage and object storage technologies.
2988 #### glusterfs <a id="plugins-contrib-command-glusterfs"></a>
2990 The [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) plugin
2991 is used to check the GlusterFS storage health on the server.
2992 The plugin requires `sudo` permissions.
2994 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2997 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2998 glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
2999 glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
3000 glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
3001 glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
3002 glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
3003 glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
3004 glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
3007 ### Virtualization <a id="plugin-contrib-virtualization"></a>
3009 This category includes all plugins for various virtualization technologies.
3011 #### esxi_hardware <a id="plugin-contrib-command-esxi-hardware"></a>
3013 The [check_esxi_hardware.py](https://www.claudiokuenzler.com/nagios-plugins/check_esxi_hardware.php) plugin
3014 uses the [pywbem](https://pywbem.github.io/pywbem/) Python library to monitor the hardware of ESXi servers
3015 through the [VMWare API](https://www.vmware.com/support/pubs/sdk_pubs.html) and CIM service.
3017 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3020 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
3021 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
3022 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.
3023 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.
3024 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
3025 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
3026 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
3027 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
3028 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
3029 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
3030 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
3031 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
3032 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
3033 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
3034 esxi_hardware_nolcd | **Optional.** Do not collect lcd/display status data. Defaults to false.
3036 #### VMware <a id="plugin-contrib-vmware"></a>
3038 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
3040 **vmware-esx-dc-volumes**
3042 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
3044 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3047 ------------------------|--------------
3048 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3049 vmware_cluster | **Optional.** ESX or ESXi clustername.
3050 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3051 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3052 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3053 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3054 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3055 vmware_sessionfile | **Optional.** Session file name enhancement.
3056 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3057 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3058 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3059 vmware_password | **Optional.** The username's password. No value defined as default.
3060 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3061 vmware_subselect | **Optional.** Volume name to be checked the free space.
3062 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3063 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3064 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3065 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3066 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3067 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3068 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
3069 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3070 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3073 **vmware-esx-dc-runtime-info**
3075 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
3077 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3080 ------------------------|--------------
3081 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3082 vmware_cluster | **Optional.** ESX or ESXi clustername.
3083 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3084 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3085 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3086 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3087 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3088 vmware_sessionfile | **Optional.** Session file name enhancement.
3089 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3090 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3091 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3092 vmware_password | **Optional.** The username's password. No value defined as default.
3093 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3096 **vmware-esx-dc-runtime-listvms**
3098 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.
3100 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3103 ------------------------|--------------
3104 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3105 vmware_cluster | **Optional.** ESX or ESXi clustername.
3106 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3107 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3108 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3109 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3110 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3111 vmware_sessionfile | **Optional.** Session file name enhancement.
3112 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3113 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3114 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3115 vmware_password | **Optional.** The username's password. No value defined as default.
3116 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3117 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
3118 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3119 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3120 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3121 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.
3124 **vmware-esx-dc-runtime-listhost**
3126 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
3128 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3131 ------------------------|--------------
3132 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3133 vmware_cluster | **Optional.** ESX or ESXi clustername.
3134 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3135 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3136 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3137 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3138 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3139 vmware_sessionfile | **Optional.** Session file name enhancement.
3140 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3141 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3142 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3143 vmware_password | **Optional.** The username's password. No value defined as default.
3144 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3145 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
3146 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
3147 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
3148 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3149 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.
3152 **vmware-esx-dc-runtime-listcluster**
3154 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
3156 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3159 ------------------------|--------------
3160 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3161 vmware_cluster | **Optional.** ESX or ESXi clustername.
3162 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3163 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3164 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3165 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3166 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3167 vmware_sessionfile | **Optional.** Session file name enhancement.
3168 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3169 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3170 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3171 vmware_password | **Optional.** The username's password. No value defined as default.
3172 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3173 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
3174 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
3175 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
3176 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3177 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.
3180 **vmware-esx-dc-runtime-issues**
3182 Check command object for the `check_vmware_esx` plugin. All issues for the host.
3184 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3187 ------------------------|--------------
3188 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3189 vmware_cluster | **Optional.** ESX or ESXi clustername.
3190 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3191 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3192 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3193 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3194 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3195 vmware_sessionfile | **Optional.** Session file name enhancement.
3196 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3197 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3198 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3199 vmware_password | **Optional.** The username's password. No value defined as default.
3200 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3201 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
3202 vmware_include | **Optional.** Whitelist issues. No value defined as default.
3203 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3204 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.
3207 **vmware-esx-dc-runtime-status**
3209 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3211 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3214 ------------------------|--------------
3215 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3216 vmware_cluster | **Optional.** ESX or ESXi clustername.
3217 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3218 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3219 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3220 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3221 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3222 vmware_sessionfile | **Optional.** Session file name enhancement.
3223 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3224 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3225 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3226 vmware_password | **Optional.** The username's password. No value defined as default.
3227 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3230 **vmware-esx-dc-runtime-tools**
3232 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
3234 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3237 ------------------------|--------------
3238 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3239 vmware_cluster | **Optional.** ESX or ESXi clustername.
3240 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3241 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3242 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3243 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3244 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3245 vmware_sessionfile | **Optional.** Session file name enhancement.
3246 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3247 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3248 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3249 vmware_password | **Optional.** The username's password. No value defined as default.
3250 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3251 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
3252 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
3253 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
3254 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
3255 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3256 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.
3257 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
3260 **vmware-esx-soap-host-check**
3262 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successful connection to VMware SOAP API.
3264 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3267 ------------------------|--------------
3268 vmware_host | **Required.** ESX or ESXi hostname.
3269 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3270 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3271 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3272 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3273 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3274 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3275 vmware_sessionfile | **Optional.** Session file name enhancement.
3276 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3277 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3278 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3279 vmware_password | **Optional.** The username's password. No value defined as default.
3280 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3283 **vmware-esx-soap-host-uptime**
3285 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
3287 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3290 ------------------------|--------------
3291 vmware_host | **Required.** ESX or ESXi hostname.
3292 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3293 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3294 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3295 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3296 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3297 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3298 vmware_sessionfile | **Optional.** Session file name enhancement.
3299 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3300 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3301 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3302 vmware_password | **Optional.** The username's password. No value defined as default.
3303 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3306 **vmware-esx-soap-host-cpu**
3308 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
3310 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3313 ------------------------|--------------
3314 vmware_host | **Required.** ESX or ESXi hostname.
3315 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3316 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3317 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3318 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3319 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3320 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3321 vmware_sessionfile | **Optional.** Session file name enhancement.
3322 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3323 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3324 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3325 vmware_password | **Optional.** The username's password. No value defined as default.
3326 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3327 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3328 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3331 **vmware-esx-soap-host-cpu-ready**
3333 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.
3335 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3338 ------------------------|--------------
3339 vmware_host | **Required.** ESX or ESXi hostname.
3340 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3341 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3342 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3343 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3344 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3345 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3346 vmware_sessionfile | **Optional.** Session file name enhancement.
3347 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3348 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3349 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3350 vmware_password | **Optional.** The username's password. No value defined as default.
3351 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3354 **vmware-esx-soap-host-cpu-wait**
3356 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.
3358 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3361 ------------------------|--------------
3362 vmware_host | **Required.** ESX or ESXi hostname.
3363 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3364 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3365 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3366 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3367 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3368 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3369 vmware_sessionfile | **Optional.** Session file name enhancement.
3370 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3371 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3372 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3373 vmware_password | **Optional.** The username's password. No value defined as default.
3374 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3377 **vmware-esx-soap-host-cpu-usage**
3379 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.
3381 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3384 ------------------------|--------------
3385 vmware_host | **Required.** ESX or ESXi hostname.
3386 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3387 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3388 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3389 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3390 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3391 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3392 vmware_sessionfile | **Optional.** Session file name enhancement.
3393 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3394 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3395 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3396 vmware_password | **Optional.** The username's password. No value defined as default.
3397 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3398 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3399 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3402 **vmware-esx-soap-host-mem**
3404 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3406 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3409 ------------------------|--------------
3410 vmware_host | **Required.** ESX or ESXi hostname.
3411 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3412 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3413 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3414 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3415 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3416 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3417 vmware_sessionfile | **Optional.** Session file name enhancement.
3418 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3419 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3420 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3421 vmware_password | **Optional.** The username's password. No value defined as default.
3422 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3425 **vmware-esx-soap-host-mem-usage**
3427 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3429 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3432 ------------------------|--------------
3433 vmware_host | **Required.** ESX or ESXi hostname.
3434 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3435 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3436 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3437 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3438 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3439 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3440 vmware_sessionfile | **Optional.** Session file name enhancement.
3441 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3442 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3443 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3444 vmware_password | **Optional.** The username's password. No value defined as default.
3445 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3446 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3447 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3450 **vmware-esx-soap-host-mem-consumed**
3452 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.
3454 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3457 ------------------------|--------------
3458 vmware_host | **Required.** ESX or ESXi hostname.
3459 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3460 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3461 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3462 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3463 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3464 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3465 vmware_sessionfile | **Optional.** Session file name enhancement.
3466 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3467 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3468 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3469 vmware_password | **Optional.** The username's password. No value defined as default.
3470 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3471 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3472 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3475 **vmware-esx-soap-host-mem-swapused**
3477 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.
3479 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3482 ------------------------|--------------
3483 vmware_host | **Required.** ESX or ESXi hostname.
3484 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3485 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3486 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3487 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3488 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3489 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3490 vmware_sessionfile | **Optional.** Session file name enhancement.
3491 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3492 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3493 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3494 vmware_password | **Optional.** The username's password. No value defined as default.
3495 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3496 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3497 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3498 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.
3501 **vmware-esx-soap-host-mem-overhead**
3503 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3505 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3508 ------------------------|--------------
3509 vmware_host | **Required.** ESX or ESXi hostname.
3510 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3511 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3512 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3513 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3514 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3515 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3516 vmware_sessionfile | **Optional.** Session file name enhancement.
3517 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3518 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3519 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3520 vmware_password | **Optional.** The username's password. No value defined as default.
3521 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Auhentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3522 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3523 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3526 **vmware-esx-soap-host-mem-memctl**
3528 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.
3530 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3533 ------------------------|--------------
3534 vmware_host | **Required.** ESX or ESXi hostname.
3535 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3536 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3537 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3538 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3539 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3540 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3541 vmware_sessionfile | **Optional.** Session file name enhancement.
3542 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3543 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3544 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3545 vmware_password | **Optional.** The username's password. No value defined as default.
3546 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3547 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3548 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3549 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.
3552 **vmware-esx-soap-host-net**
3554 Check command object for the `check_vmware_esx` plugin. Shows net info.
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> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3573 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3574 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3577 **vmware-esx-soap-host-net-usage**
3579 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
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> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3598 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3599 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3602 **vmware-esx-soap-host-net-receive**
3604 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per 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> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3623 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3624 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3627 **vmware-esx-soap-host-net-send**
3629 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
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> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3648 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3649 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3652 **vmware-esx-soap-host-net-nic**
3654 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
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> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3673 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3674 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3677 **vmware-esx-soap-host-volumes**
3679 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
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> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3698 vmware_subselect | **Optional.** Volume name to be checked the free space.
3699 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3700 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3701 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3702 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3703 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3704 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3705 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3706 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3707 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
3710 **vmware-esx-soap-host-io**
3712 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.
3714 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3717 ------------------------|--------------
3718 vmware_host | **Required.** ESX or ESXi hostname.
3719 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3720 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3721 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3722 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3723 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3724 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3725 vmware_sessionfile | **Optional.** Session file name enhancement.
3726 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3727 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3728 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3729 vmware_password | **Optional.** The username's password. No value defined as default.
3730 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3733 **vmware-esx-soap-host-io-aborted**
3735 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
3737 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3740 ------------------------|--------------
3741 vmware_host | **Required.** ESX or ESXi hostname.
3742 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3743 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3744 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3745 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3746 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3747 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3748 vmware_sessionfile | **Optional.** Session file name enhancement.
3749 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3750 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3751 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3752 vmware_password | **Optional.** The username's password. No value defined as default.
3753 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3754 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3755 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3758 **vmware-esx-soap-host-io-resets**
3760 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
3762 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3765 ------------------------|--------------
3766 vmware_host | **Required.** ESX or ESXi hostname.
3767 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3768 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3769 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3770 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3771 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3772 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3773 vmware_sessionfile | **Optional.** Session file name enhancement.
3774 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3775 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3776 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3777 vmware_password | **Optional.** The username's password. No value defined as default.
3778 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3779 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3780 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3783 **vmware-esx-soap-host-io-read**
3785 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3787 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3790 ------------------------|--------------
3791 vmware_host | **Required.** ESX or ESXi hostname.
3792 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3793 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3794 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3795 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3796 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3797 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3798 vmware_sessionfile | **Optional.** Session file name enhancement.
3799 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3800 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3801 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3802 vmware_password | **Optional.** The username's password. No value defined as default.
3803 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3804 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3805 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3808 **vmware-esx-soap-host-io-read-latency**
3810 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.
3812 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3815 ------------------------|--------------
3816 vmware_host | **Required.** ESX or ESXi hostname.
3817 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3818 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3819 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3820 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3821 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3822 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3823 vmware_sessionfile | **Optional.** Session file name enhancement.
3824 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3825 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3826 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3827 vmware_password | **Optional.** The username's password. No value defined as default.
3828 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3829 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3830 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3833 **vmware-esx-soap-host-io-write**
3835 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3837 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3840 ------------------------|--------------
3841 vmware_host | **Required.** ESX or ESXi hostname.
3842 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3843 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3844 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3845 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3846 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3847 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3848 vmware_sessionfile | **Optional.** Session file name enhancement.
3849 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3850 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3851 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3852 vmware_password | **Optional.** The username's password. No value defined as default.
3853 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3854 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3855 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3858 **vmware-esx-soap-host-io-write-latency**
3860 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.
3862 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3865 ------------------------|--------------
3866 vmware_host | **Required.** ESX or ESXi hostname.
3867 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3868 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3869 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3870 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3871 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3872 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3873 vmware_sessionfile | **Optional.** Session file name enhancement.
3874 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3875 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3876 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3877 vmware_password | **Optional.** The username's password. No value defined as default.
3878 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3879 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3880 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3883 **vmware-esx-soap-host-io-usage**
3885 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.
3887 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3890 ------------------------|--------------
3891 vmware_host | **Required.** ESX or ESXi hostname.
3892 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3893 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3894 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3895 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3896 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3897 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3898 vmware_sessionfile | **Optional.** Session file name enhancement.
3899 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3900 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3901 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3902 vmware_password | **Optional.** The username's password. No value defined as default.
3903 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3904 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3905 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3908 **vmware-esx-soap-host-io-kernel-latency**
3910 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
3912 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3915 ------------------------|--------------
3916 vmware_host | **Required.** ESX or ESXi hostname.
3917 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3918 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3919 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3920 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3921 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3922 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3923 vmware_sessionfile | **Optional.** Session file name enhancement.
3924 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3925 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3926 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3927 vmware_password | **Optional.** The username's password. No value defined as default.
3928 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3929 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3930 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3933 **vmware-esx-soap-host-io-device-latency**
3935 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
3937 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3940 ------------------------|--------------
3941 vmware_host | **Required.** ESX or ESXi hostname.
3942 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3943 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3944 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3945 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3946 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3947 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3948 vmware_sessionfile | **Optional.** Session file name enhancement.
3949 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3950 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3951 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3952 vmware_password | **Optional.** The username's password. No value defined as default.
3953 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3954 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3955 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3958 **vmware-esx-soap-host-io-queue-latency**
3960 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
3962 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3965 ------------------------|--------------
3966 vmware_host | **Required.** ESX or ESXi hostname.
3967 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3968 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3969 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3970 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3971 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3972 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3973 vmware_sessionfile | **Optional.** Session file name enhancement.
3974 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3975 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3976 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3977 vmware_password | **Optional.** The username's password. No value defined as default.
3978 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3979 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3980 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3983 **vmware-esx-soap-host-io-total-latency**
3985 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.
3987 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3990 ------------------------|--------------
3991 vmware_host | **Required.** ESX or ESXi hostname.
3992 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3993 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3994 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3995 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3996 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3997 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3998 vmware_sessionfile | **Optional.** Session file name enhancement.
3999 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4000 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4001 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4002 vmware_password | **Optional.** The username's password. No value defined as default.
4003 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4004 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4005 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4008 **vmware-esx-soap-host-media**
4010 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.
4012 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4015 ------------------------|--------------
4016 vmware_host | **Required.** ESX or ESXi hostname.
4017 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4018 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4019 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4020 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4021 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4022 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4023 vmware_sessionfile | **Optional.** Session file name enhancement.
4024 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4025 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4026 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4027 vmware_password | **Optional.** The username's password. No value defined as default.
4028 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4029 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
4030 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
4031 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4032 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.
4035 **vmware-esx-soap-host-service**
4037 Check command object for the `check_vmware_esx` plugin. Shows host service info.
4039 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4042 ------------------------|--------------
4043 vmware_host | **Required.** ESX or ESXi hostname.
4044 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4045 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4046 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4047 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4048 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4049 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4050 vmware_sessionfile | **Optional.** Session file name enhancement.
4051 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4052 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4053 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4054 vmware_password | **Optional.** The username's password. No value defined as default.
4055 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4056 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
4057 vmware_include | **Optional.** Whitelist services name. No value defined as default.
4058 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4059 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.
4062 **vmware-esx-soap-host-runtime**
4064 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.
4066 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4069 ------------------------|--------------
4070 vmware_host | **Required.** ESX or ESXi hostname.
4071 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4072 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4073 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4074 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4075 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4076 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4077 vmware_sessionfile | **Optional.** Session file name enhancement.
4078 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4079 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4080 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4081 vmware_password | **Optional.** The username's password. No value defined as default.
4082 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4085 **vmware-esx-soap-host-runtime-con**
4087 Check command object for the `check_vmware_esx` plugin. Shows connection state.
4089 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4092 ------------------------|--------------
4093 vmware_host | **Required.** ESX or ESXi hostname.
4094 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4095 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4096 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4097 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4098 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4099 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4100 vmware_sessionfile | **Optional.** Session file name enhancement.
4101 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4102 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4103 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4104 vmware_password | **Optional.** The username's password. No value defined as default.
4105 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4108 **vmware-esx-soap-host-runtime-listvms**
4110 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
4112 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4115 ------------------------|--------------
4116 vmware_host | **Required.** ESX or ESXi hostname.
4117 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4118 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4119 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4120 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4121 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4122 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4123 vmware_sessionfile | **Optional.** Session file name enhancement.
4124 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4125 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4126 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4127 vmware_password | **Optional.** The username's password. No value defined as default.
4128 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4129 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
4130 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
4131 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4132 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.
4135 **vmware-esx-soap-host-runtime-status**
4137 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4139 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4142 ------------------------|--------------
4143 vmware_host | **Required.** ESX or ESXi hostname.
4144 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4145 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4146 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4147 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4148 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4149 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4150 vmware_sessionfile | **Optional.** Session file name enhancement.
4151 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4152 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4153 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4154 vmware_password | **Optional.** The username's password. No value defined as default.
4155 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4158 **vmware-esx-soap-host-runtime-health**
4160 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
4162 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4165 ------------------------|--------------
4166 vmware_host | **Required.** ESX or ESXi hostname.
4167 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4168 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4169 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4170 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4171 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4172 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4173 vmware_sessionfile | **Optional.** Session file name enhancement.
4174 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4175 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4176 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4177 vmware_password | **Optional.** The username's password. No value defined as default.
4178 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4179 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
4180 vmware_include | **Optional.** Whitelist status name. No value defined as default.
4181 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4184 **vmware-esx-soap-host-runtime-health-listsensors**
4186 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
4188 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4191 ------------------------|--------------
4192 vmware_host | **Required.** ESX or ESXi hostname.
4193 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4194 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4195 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4196 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4197 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4198 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4199 vmware_sessionfile | **Optional.** Session file name enhancement.
4200 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4201 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4202 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4203 vmware_password | **Optional.** The username's password. No value defined as default.
4204 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4205 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
4206 vmware_include | **Optional.** Whitelist status name. No value defined as default.
4207 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4210 **vmware-esx-soap-host-runtime-health-nostoragestatus**
4212 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**.
4214 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4217 ------------------------|--------------
4218 vmware_host | **Required.** ESX or ESXi hostname.
4219 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4220 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4221 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4222 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4223 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4224 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4225 vmware_sessionfile | **Optional.** Session file name enhancement.
4226 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4227 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4228 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4229 vmware_password | **Optional.** The username's password. No value defined as default.
4230 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4231 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
4232 vmware_include | **Optional.** Whitelist status name. No value defined as default.
4233 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4236 **vmware-esx-soap-host-runtime-storagehealth**
4238 Check command object for the `check_vmware_esx` plugin. Local storage status check.
4240 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4243 ------------------------|--------------
4244 vmware_host | **Required.** ESX or ESXi hostname.
4245 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4246 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4247 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4248 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4249 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4250 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4251 vmware_sessionfile | **Optional.** Session file name enhancement.
4252 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4253 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4254 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4255 vmware_password | **Optional.** The username's password. No value defined as default.
4256 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4257 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
4258 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
4259 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4260 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.
4263 **vmware-esx-soap-host-runtime-temp**
4265 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
4267 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4270 ------------------------|--------------
4271 vmware_host | **Required.** ESX or ESXi hostname.
4272 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4273 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4274 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4275 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4276 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4277 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4278 vmware_sessionfile | **Optional.** Session file name enhancement.
4279 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4280 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4281 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4282 vmware_password | **Optional.** The username's password. No value defined as default.
4283 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4284 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
4285 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
4286 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4287 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.
4290 **vmware-esx-soap-host-runtime-issues**
4292 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
4294 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4297 ------------------------|--------------
4298 vmware_host | **Required.** ESX or ESXi hostname.
4299 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4300 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4301 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4302 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4303 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4304 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4305 vmware_sessionfile | **Optional.** Session file name enhancement.
4306 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4307 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4308 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4309 vmware_password | **Optional.** The username's password. No value defined as default.
4310 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4311 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
4312 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
4313 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4314 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.
4317 **vmware-esx-soap-host-storage**
4319 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
4321 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4324 ------------------------|--------------
4325 vmware_host | **Required.** ESX or ESXi hostname.
4326 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4327 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4328 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4329 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4330 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4331 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4332 vmware_sessionfile | **Optional.** Session file name enhancement.
4333 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4334 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4335 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4336 vmware_password | **Optional.** The username's password. No value defined as default.
4337 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4338 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
4339 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
4340 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4343 **vmware-esx-soap-host-storage-adapter**
4345 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
4347 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4350 ------------------------|--------------
4351 vmware_host | **Required.** ESX or ESXi hostname.
4352 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4353 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4354 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4355 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4356 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4357 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4358 vmware_sessionfile | **Optional.** Session file name enhancement.
4359 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4360 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4361 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4362 vmware_password | **Optional.** The username's password. No value defined as default.
4363 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4364 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
4365 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
4366 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4367 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.
4370 **vmware-esx-soap-host-storage-lun**
4372 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.
4374 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4377 ------------------------|--------------
4378 vmware_host | **Required.** ESX or ESXi hostname.
4379 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4380 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4381 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4382 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4383 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4384 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4385 vmware_sessionfile | **Optional.** Session file name enhancement.
4386 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4387 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4388 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4389 vmware_password | **Optional.** The username's password. No value defined as default.
4390 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4391 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
4392 vmware_include | **Optional.** Whitelist luns. No value defined as default.
4393 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4394 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.
4397 **vmware-esx-soap-host-storage-path**
4399 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
4401 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4404 ------------------------|--------------
4405 vmware_host | **Required.** ESX or ESXi hostname.
4406 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4407 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4408 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4409 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4410 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4411 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4412 vmware_sessionfile | **Optional.** Session file name enhancement.
4413 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4414 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4415 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4416 vmware_password | **Optional.** The username's password. No value defined as default.
4417 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4418 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4419 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4420 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4421 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4422 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.
4423 vmware_standbyok | **Optional.** For storage systems where a standby multipath is ok and not a warning. Defaults to false.
4426 **vmware-esx-soap-vm-cpu**
4428 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4430 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4433 ------------------------|--------------
4434 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4435 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4436 vmware_vmname | **Required.** Virtual machine name.
4437 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4438 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4439 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4440 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4441 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4442 vmware_sessionfile | **Optional.** Session file name enhancement.
4443 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4444 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4445 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4446 vmware_password | **Optional.** The username's password. No value defined as default.
4447 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4451 **vmware-esx-soap-vm-cpu-ready**
4453 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.
4455 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4458 ------------------------|--------------
4459 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4460 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4461 vmware_vmname | **Required.** Virtual machine name.
4462 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4463 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4464 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4465 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4466 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4467 vmware_sessionfile | **Optional.** Session file name enhancement.
4468 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4469 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4470 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4471 vmware_password | **Optional.** The username's password. No value defined as default.
4472 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4473 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4474 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4477 **vmware-esx-soap-vm-cpu-wait**
4479 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.
4481 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4484 ------------------------|--------------
4485 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4486 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4487 vmware_vmname | **Required.** Virtual machine name.
4488 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4489 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4490 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4491 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4492 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4493 vmware_sessionfile | **Optional.** Session file name enhancement.
4494 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4495 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4496 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4497 vmware_password | **Optional.** The username's password. No value defined as default.
4498 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4499 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4500 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4503 **vmware-esx-soap-vm-cpu-usage**
4505 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.
4507 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4510 ------------------------|--------------
4511 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4512 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4513 vmware_vmname | **Required.** Virtual machine name.
4514 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4515 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4516 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4517 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4518 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4519 vmware_sessionfile | **Optional.** Session file name enhancement.
4520 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4521 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4522 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4523 vmware_password | **Optional.** The username's password. No value defined as default.
4524 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4525 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4526 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4529 **vmware-esx-soap-vm-mem**
4531 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4533 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4536 ------------------------|--------------
4537 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4538 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4539 vmware_vmname | **Required.** Virtual machine name.
4540 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4541 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4542 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4543 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4544 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4545 vmware_sessionfile | **Optional.** Session file name enhancement.
4546 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4547 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4548 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4549 vmware_password | **Optional.** The username's password. No value defined as default.
4550 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4553 **vmware-esx-soap-vm-mem-usage**
4555 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4557 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4560 ------------------------|--------------
4561 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4562 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4563 vmware_vmname | **Required.** Virtual machine name.
4564 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4565 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4566 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4567 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4568 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4569 vmware_sessionfile | **Optional.** Session file name enhancement.
4570 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4571 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4572 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4573 vmware_password | **Optional.** The username's password. No value defined as default.
4574 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4575 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4576 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4579 **vmware-esx-soap-vm-mem-consumed**
4581 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>
4582 **vm consumed memory = memory granted -- memory saved**
4584 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4587 ------------------------|--------------
4588 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4589 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4590 vmware_vmname | **Required.** Virtual machine name.
4591 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4592 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4593 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4594 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4595 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4596 vmware_sessionfile | **Optional.** Session file name enhancement.
4597 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4598 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4599 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4600 vmware_password | **Optional.** The username's password. No value defined as default.
4601 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4602 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4603 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4606 **vmware-esx-soap-vm-mem-memctl**
4608 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.
4610 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4613 ------------------------|--------------
4614 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4615 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4616 vmware_vmname | **Required.** Virtual machine name.
4617 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4618 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4619 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4620 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4621 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4622 vmware_sessionfile | **Optional.** Session file name enhancement.
4623 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4624 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4625 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4626 vmware_password | **Optional.** The username's password. No value defined as default.
4627 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4628 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4629 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4633 **vmware-esx-soap-vm-net**
4635 Check command object for the `check_vmware_esx` plugin. Shows net info.
4637 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4640 ------------------------|--------------
4641 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4642 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4643 vmware_vmname | **Required.** Virtual machine name.
4644 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4645 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4646 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4647 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4648 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4649 vmware_sessionfile | **Optional.** Session file name enhancement.
4650 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4651 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4652 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4653 vmware_password | **Optional.** The username's password. No value defined as default.
4654 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4657 **vmware-esx-soap-vm-net-usage**
4659 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4661 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4664 ------------------------|--------------
4665 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4666 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4667 vmware_vmname | **Required.** Virtual machine name.
4668 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4669 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4670 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4671 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4672 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4673 vmware_sessionfile | **Optional.** Session file name enhancement.
4674 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4675 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4676 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4677 vmware_password | **Optional.** The username's password. No value defined as default.
4678 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4679 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4680 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4683 **vmware-esx-soap-vm-net-receive**
4685 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
4687 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4690 ------------------------|--------------
4691 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4692 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4693 vmware_vmname | **Required.** Virtual machine name.
4694 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4695 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4696 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4697 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4698 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4699 vmware_sessionfile | **Optional.** Session file name enhancement.
4700 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4701 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4702 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4703 vmware_password | **Optional.** The username's password. No value defined as default.
4704 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4705 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4706 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4709 **vmware-esx-soap-vm-net-send**
4711 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
4713 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4716 ------------------------|--------------
4717 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4718 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4719 vmware_vmname | **Required.** Virtual machine name.
4720 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4721 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4722 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4723 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4724 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4725 vmware_sessionfile | **Optional.** Session file name enhancement.
4726 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4727 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4728 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4729 vmware_password | **Optional.** The username's password. No value defined as default.
4730 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4731 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4732 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4735 **vmware-esx-soap-vm-io**
4737 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.
4739 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4742 ------------------------|--------------
4743 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4744 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4745 vmware_vmname | **Required.** Virtual machine name.
4746 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4747 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4748 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4749 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4750 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4751 vmware_sessionfile | **Optional.** Session file name enhancement.
4752 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4753 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4754 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4755 vmware_password | **Optional.** The username's password. No value defined as default.
4756 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4759 **vmware-esx-soap-vm-io-read**
4761 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4763 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4766 ------------------------|--------------
4767 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4768 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4769 vmware_vmname | **Required.** Virtual machine name.
4770 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4771 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4772 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4773 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4774 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4775 vmware_sessionfile | **Optional.** Session file name enhancement.
4776 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4777 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4778 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4779 vmware_password | **Optional.** The username's password. No value defined as default.
4780 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4781 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4782 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4785 **vmware-esx-soap-vm-io-write**
4787 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4789 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4792 ------------------------|--------------
4793 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4794 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4795 vmware_vmname | **Required.** Virtual machine name.
4796 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4797 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4798 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4799 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4800 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4801 vmware_sessionfile | **Optional.** Session file name enhancement.
4802 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4803 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4804 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4805 vmware_password | **Optional.** The username's password. No value defined as default.
4806 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4807 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4808 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4811 **vmware-esx-soap-vm-io-usage**
4813 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
4815 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4818 ------------------------|--------------
4819 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4820 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4821 vmware_vmname | **Required.** Virtual machine name.
4822 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4823 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4824 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4825 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4826 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4827 vmware_sessionfile | **Optional.** Session file name enhancement.
4828 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4829 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4830 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4831 vmware_password | **Optional.** The username's password. No value defined as default.
4832 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4833 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4834 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4837 **vmware-esx-soap-vm-runtime**
4839 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
4841 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4844 ------------------------|--------------
4845 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4846 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4847 vmware_vmname | **Required.** Virtual machine name.
4848 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4849 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4850 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4851 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4852 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4853 vmware_sessionfile | **Optional.** Session file name enhancement.
4854 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4855 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4856 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4857 vmware_password | **Optional.** The username's password. No value defined as default.
4858 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4861 **vmware-esx-soap-vm-runtime-con**
4863 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
4865 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4868 ------------------------|--------------
4869 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4870 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4871 vmware_vmname | **Required.** Virtual machine name.
4872 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4873 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4874 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4875 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4876 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4877 vmware_sessionfile | **Optional.** Session file name enhancement.
4878 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4879 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4880 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4881 vmware_password | **Optional.** The username's password. No value defined as default.
4882 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4885 **vmware-esx-soap-vm-runtime-powerstate**
4887 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
4889 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4892 ------------------------|--------------
4893 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4894 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4895 vmware_vmname | **Required.** Virtual machine name.
4896 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4897 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4898 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4899 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4900 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4901 vmware_sessionfile | **Optional.** Session file name enhancement.
4902 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4903 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4904 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4905 vmware_password | **Optional.** The username's password. No value defined as default.
4906 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4909 **vmware-esx-soap-vm-runtime-status**
4911 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4913 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4916 ------------------------|--------------
4917 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4918 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4919 vmware_vmname | **Required.** Virtual machine name.
4920 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4921 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4922 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4923 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4924 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4925 vmware_sessionfile | **Optional.** Session file name enhancement.
4926 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4927 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4928 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4929 vmware_password | **Optional.** The username's password. No value defined as default.
4930 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4933 **vmware-esx-soap-vm-runtime-consoleconnections**
4935 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
4937 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4940 ------------------------|--------------
4941 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4942 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4943 vmware_vmname | **Required.** Virtual machine name.
4944 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4945 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4946 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4947 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4948 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4949 vmware_sessionfile | **Optional.** Session file name enhancement.
4950 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4951 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4952 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4953 vmware_password | **Optional.** The username's password. No value defined as default.
4954 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4955 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4956 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4959 **vmware-esx-soap-vm-runtime-gueststate**
4961 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
4963 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4966 ------------------------|--------------
4967 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4968 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4969 vmware_vmname | **Required.** Virtual machine name.
4970 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4971 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4972 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4973 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4974 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4975 vmware_sessionfile | **Optional.** Session file name enhancement.
4976 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4977 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4978 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4979 vmware_password | **Optional.** The username's password. No value defined as default.
4980 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4982 **vmware-esx-soap-vm-runtime-tools**
4984 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
4986 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4989 ------------------------|--------------
4990 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4991 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4992 vmware_vmname | **Required.** Virtual machine name.
4993 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4994 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4995 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4996 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4997 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4998 vmware_sessionfile | **Optional.** Session file name enhancement.
4999 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5000 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5001 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5002 vmware_password | **Optional.** The username's password. No value defined as default.
5003 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
5004 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
5007 **vmware-esx-soap-vm-runtime-issues**
5009 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
5011 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5014 ------------------------|--------------
5015 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5016 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5017 vmware_vmname | **Required.** Virtual machine name.
5018 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5019 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5020 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5021 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5022 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5023 vmware_sessionfile | **Optional.** Session file name enhancement.
5024 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5025 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5026 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5027 vmware_password | **Optional.** The username's password. No value defined as default.
5028 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd
5029 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.
5032 ### Web <a id="plugin-contrib-web"></a>
5034 This category includes all plugins for web-based checks.
5036 #### apache_status <a id="plugin-contrib-command-apache_status"></a>
5038 The [check_apache_status.pl](https://github.com/lbetz/check_apache_status) plugin
5039 uses the [/server-status](https://httpd.apache.org/docs/current/mod/mod_status.html)
5040 HTTP endpoint to monitor status metrics for the Apache webserver.
5042 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5045 ------------------------|----------------------------------------------------------------------------------
5046 apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
5047 apache_status_port | **Optional.** the http port.
5048 apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
5049 apache_status_ssl | **Optional.** set to use ssl connection
5050 apache_status_timeout | **Optional.** timeout in seconds
5051 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
5052 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
5055 ### cert <a id="plugin-check-command-ssl_cert"></a>
5057 The [check_ssl_cert](https://github.com/matteocorti/check_ssl_cert) plugin
5058 uses the openssl binary (and optional curl) to check a X.509 certificate.
5060 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5063 --------------------------|--------------
5064 ssl_cert_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
5065 ssl_cert_port | **Optional.** TCP port number (default: 443).
5066 ssl_cert_file | **Optional.** Local file path. Works only if `ssl_cert_address` is set to "localhost".
5067 ssl_cert_warn | **Optional.** Minimum number of days a certificate has to be valid.
5068 ssl_cert_critical | **Optional.** Minimum number of days a certificate has to be valid to issue a critical status.
5069 ssl_cert_cn | **Optional.** Pattern to match the CN of the certificate.
5070 ssl_cert_altnames | **Optional.** Matches the pattern specified in -n with alternate
5071 ssl_cert_issuer | **Optional.** Pattern to match the issuer of the certificate.
5072 ssl_cert_org | **Optional.** Pattern to match the organization of the certificate.
5073 ssl_cert_email | **Optional.** Pattern to match the email address contained in the certificate.
5074 ssl_cert_serial | **Optional.** Pattern to match the serial number.
5075 ssl_cert_noauth | **Optional.** Ignore authority warnings (expiration only)
5076 ssl_cert_match_host | **Optional.** Match CN with the host name.
5077 ssl_cert_selfsigned | **Optional.** Allow self-signed certificate.
5078 ssl_cert_sni | **Optional.** Sets the TLS SNI (Server Name Indication) extension.
5079 ssl_cert_timeout | **Optional.** Seconds before connection times out (default: 15)
5080 ssl_cert_protocol | **Optional.** Use the specific protocol {http,smtp,pop3,imap,ftp,xmpp,irc,ldap} (default: http).
5081 ssl_cert_clientcert | **Optional.** Use client certificate to authenticate.
5082 ssl_cert_clientpass | **Optional.** Set passphrase for client certificate.
5083 ssl_cert_ssllabs | **Optional.** SSL Labs assessment
5084 ssl_cert_ssllabs_nocache | **Optional.** Forces a new check by SSL Labs
5085 ssl_cert_rootcert | **Optional.** Root certificate or directory to be used for certificate validation.
5086 ssl_cert_ignore_signature | **Optional.** Do not check if the certificate was signed with SHA1 od MD5.
5087 ssl_cert_ssl_version | **Optional.** Force specific SSL version out of {ssl2,ssl3,tls1,tls1_1,tls1_2}.
5088 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.
5089 ssl_cert_cipher | **Optional.** Cipher selection: force {ecdsa,rsa} authentication.
5090 ssl_cert_ignore_expiration | **Optional.** Ignore expiration date.
5091 ssl_cert_ignore_ocsp | **Optional.** Do not check revocation with OCSP.
5094 #### jmx4perl <a id="plugin-contrib-command-jmx4perl"></a>
5096 The [check_jmx4perl](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl) plugin
5097 uses the HTTP API exposed by the [Jolokia](https://jolokia.org)
5098 web application and queries Java message beans on an application server. It is
5099 part of the `JMX::Jmx4Perl` Perl module which includes detailed
5100 [documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl).
5102 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5105 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
5106 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
5107 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an auto detection facility.
5108 jmx4perl_alias | **Optional.** Alias name for attribute (e.g. MEMORY_HEAP_USED). All available aliases can be viewed by executing `jmx4perl aliases` on the command line.
5109 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
5110 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
5111 jmx4perl_operation | **Optional.** Operation to execute.
5112 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
5113 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
5114 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
5115 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
5116 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
5117 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
5118 jmx4perl_proxy | **Optional.** Proxy to use.
5119 jmx4perl_user | **Optional.** User for HTTP authentication.
5120 jmx4perl_password | **Optional.** Password for HTTP authentication.
5121 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
5122 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
5123 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.
5124 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
5125 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
5126 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
5127 jmx4perl_unit | **Optional.** Unit of measurement of the data retrieved. Recognized values are [B\|KB\|MN\|GB\|TB] for memory values and [us\|ms\|s\|m\|h\|d] for time values.
5128 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
5129 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
5130 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
5131 jmx4perl_critical | **Optional.** Critical threshold for value.
5132 jmx4perl_warning | **Optional.** Warning threshold for value.
5133 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
5134 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
5135 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
5136 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
5137 jmx4perl_config | **Optional.** Path to configuration file.
5138 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
5139 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
5142 #### kdc <a id="plugin-contrib-command-kdc"></a>
5144 The [check_kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details) plugin
5145 uses the Kerberos `kinit` binary to monitor Kerberos 5 KDC by acquiring a ticket.
5147 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5150 ----------------|--------------------------------------------------------------------------
5151 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
5152 kdc_port | **Optional** Port on which KDC runs (default 88).
5153 kdc_principal | **Required** Principal name to authenticate as (including realm).
5154 kdc_keytab | **Required** Keytab file containing principal's key.
5157 #### nginx_status <a id="plugin-contrib-command-nginx_status"></a>
5159 The [check_nginx_status.pl](https://github.com/regilero/check_nginx_status) plugin
5160 uses the [/nginx_status](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
5161 HTTP endpoint which provides metrics for monitoring Nginx.
5163 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5166 --------------------------------|----------------------------------------------------------------------------------
5167 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
5168 nginx_status_port | **Optional.** the http port.
5169 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
5170 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target.
5171 nginx_status_ssl | **Optional.** set to use ssl connection.
5172 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification.
5173 nginx_status_user | **Optional.** Username for basic auth.
5174 nginx_status_pass | **Optional.** Password for basic auth.
5175 nginx_status_realm | **Optional.** Realm for basic auth.
5176 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert.
5177 nginx_status_timeout | **Optional.** timeout in seconds.
5178 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
5179 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
5182 #### rbl <a id="plugin-contrib-command-rbl"></a>
5184 The [check_rbl](https://github.com/matteocorti/check_rbl) plugin
5185 uses the `Net::DNS` Perl library to check whether your SMTP server
5188 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5191 ----------------|--------------------------------------------------------------------------
5192 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.
5193 rbl_server | **Required** List of RBL servers as an array.
5194 rbl_warning | **Optional** Number of blacklisting servers for a warning.
5195 rbl_critical | **Optional** Number of blacklisting servers for a critical.
5196 tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
5199 #### squid <a id="plugin-contrib-command-squid"></a>
5201 The [check_squid](https://exchange.icinga.com/exchange/check_squid) plugin
5202 uses the `squidclient` binary to monitor a [Squid proxy](http://www.squid-cache.org).
5204 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5207 ------------------------|----------------------------------------------------------------------------------
5208 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
5209 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
5210 squid_port | **Optional.** Port number (default: 3128).
5211 squid_user | **Optional.** WWW user.
5212 squid_password | **Optional.** WWW password.
5213 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
5214 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
5215 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
5216 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
5219 #### webinject <a id="plugin-contrib-command-webinject"></a>
5221 The [check_webinject](https://labs.consol.de/de/nagios/check_webinject/index.html) plugin
5222 uses [WebInject](http://www.webinject.org/manual.html) to test web applications
5223 and web services in an automated fashion.
5224 It can be used to test individual system components that have HTTP interfaces
5225 (JSP, ASP, CGI, PHP, AJAX, Servlets, HTML Forms, XML/SOAP Web Services, REST, etc),
5226 and can be used as a test harness to create a suite of HTTP level automated functional,
5227 acceptance, and regression tests. A test harness allows you to run many test cases
5228 and collect/report your results. WebInject offers real-time results
5229 display and may also be used for monitoring system response times.
5231 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5234 ------------------------|--------------
5235 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.
5236 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 omitted, 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.
5237 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
5238 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.
5239 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.
5240 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.