ipmi_username | **Optional.** The IPMI username.
ipmi_password | **Optional.** The IPMI password.
ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
-ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
+ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
+
+### <a id="plugins-contrib-log-management"></a> Log Management
+
+This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
+
+#### <a id="plugins-contrib-command-logstash"></a> logstash
+
+The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
+the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
+
+The Node API is not activated by default. You have to configure your Logstash
+installation in order to allow plugin connections.
+
+Name | Description
+---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
+logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
+logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
+logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
+logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
+logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
+logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
+logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
+logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
+logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
+
+
### <a id="plugin-contrib-metrics"></a> Metrics
This category includes all plugins for metric-based checks.
nwc_health_multiline | **Optional.** Multiline output
-### <a id="plugin-contrib-web"></a> Web
-
-This category includes all plugins for web-based checks.
-
-#### <a id="plugin-contrib-command-webinject"></a> webinject
-
-Check command object for the [check_webinject](http://www.webinject.org/manual.html) plugin.
-
-Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
-
-Name | Description
-------------------------|--------------
-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.
-webinject_output | **Optional.** This option is followed by a directory name or a prefix to prepended to the output files. This is used to specify the location for writing output files (http.log, results.html, and results.xml). If a directory name is supplied (use either an absolute or relative path and make sure to add the trailing slash), all output files are written to this directory. If the trailing slash is ommitted, it is assumed to a prefix and this will be prepended to the output files. You may also use a combination of a directory and prefix.
-webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
-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.
-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.
-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.
-
-#### <a id="plugin-contrib-command-jmx4perl"></a> jmx4perl
-
-The plugin `jmx4perl` utilizes the api provided by the jolokia web application to query java message beans on an application server. It is part of the perl module provided by Roland Huß on [cpan](http://search.cpan.org/~roland/jmx4perl/) including a detailed [documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl) containing installation tutorial, security advices und usage examples.
-
-Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
-
-Name | Description
------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
-jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
-jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
-jmx4perl_alias | **Optional.** Alias name for attribute (e.g. MEMORY_HEAP_USED). All availables aliases can be viewed by executing `jmx4perl aliases` on the command line.
-jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
-jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
-jmx4perl_operation | **Optional.** Operation to execute.
-jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
-jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
-jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
-jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
-jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
-jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
-jmx4perl_proxy | **Optional.** Proxy to use.
-jmx4perl_user | **Optional.** User for HTTP authentication.
-jmx4perl_password | **Optional.** Password for HTTP authentication.
-jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
-jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
-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.
-jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
-jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
-jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
-jmx4perl_unit | **Optional.** Unit of measurement of the data retreived. Recognized values are [B\|KB\|MN\|GB\|TB] for memory values and [us\|ms\|s\|m\|h\|d] for time values.
-jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
-jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
-jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
-jmx4perl_critical | **Optional.** Critical threshold for value.
-jmx4perl_warning | **Optional.** Warning threshold for value.
-jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
-jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
-jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
-jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
-jmx4perl_config | **Optional.** Path to configuration file.
-jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
-jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
-
-#### <a id="plugin-contrib-command-squid"></a> squid
-
-Plugin for monitoring [Squid](https://exchange.icinga.org/exchange/check_squid).
-
-Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
-
-Name | Description
-------------------------|----------------------------------------------------------------------------------
-squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
-squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
-squid_port | **Optional.** Port number (default: 3128).
-squid_user | **Optional.** WWW user
-squid_password | **Optional.** WWW password
-squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
-squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
-squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
-squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
-
-
-#### <a id="plugin-contrib-command-nginx_status"></a> nginx_status
-
-Plugin for monitoring [nginx_status](https://github.com/regilero/check_nginx_status).
-
-Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
-
-Name | Description
-------------------------|----------------------------------------------------------------------------------
-nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
-nginx_status_port | **Optional.** the http port.
-nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
-nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
-nginx_status_ssl | **Optional.** set to use ssl connection
-nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
-nginx_status_user | **Optional.** Username for basic auth
-nginx_status_pass | **Optional.** Password for basic auth
-nginx_status_realm | **Optional.** Realm for basic auth
-nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
-nginx_status_timeout | **Optional.** timeout in seconds
-nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
-nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
-
-
-#### <a id="plugin-contrib-command-apache_status"></a> apache_status
-
-Plugin for monitoring [apache_status](https://github.com/lbetz/check_apache_status).
-
-Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
-
-Name | Description
-------------------------|----------------------------------------------------------------------------------
-apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
-apache_status_port | **Optional.** the http port.
-apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
-apache_status_ssl | **Optional.** set to use ssl connection
-apache_status_timeout | **Optional.** timeout in seconds
-apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
-apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
-
-
-#### <a id="plugin-contrib-command-kdc"></a> kdc
-
-Plugin for monitoring [kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details).
-
-Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
-
-Name | Description
-----------------|--------------------------------------------------------------------------
-kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
-kdc_port | **Optional** Port on which KDC runs (default 88).
-kdc_principal | **Required** Principal name to authenticate as (including realm).
-kdc_keytab | **Required** Keytab file containing principal's key.
-
-
-#### <a id="plugin-contrib-command-rbl"></a> rbl
-
-Plugin for monitoring [rbl](https://github.com/matteocorti/check_rbl)
-
-Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
-
-Name | Description
-----------------|--------------------------------------------------------------------------
-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.
-rbl_server | **Required** List of RBL servers as an array.
-rbl_warning | **Optional** Number of blacklisting servers for a warning.
-rbl_critical | **Optional** Number of blacklisting servers for a critical.
-tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
-
-
### <a id="plugin-contrib-operating-system"></a> Operating System
In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
+### <a id="plugins-contrib-storage"></a> Storage
+
+This category includes all plugins for various storage and object storage technologies.
+
+#### <a id="plugins-contrib-command-glusterfs"></a> glusterfs
+
+The plugin [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) is used to check the GlusterFS storage health on the server.
+The plugin requires `sudo` permissions.
+
+Name | Description
+---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
+glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
+glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
+glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
+glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
+glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
+glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
+
+
### <a id="plugin-contrib-virtualization"></a> Virtualization
This category includes all plugins for various virtualization technologies.
esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
-### <a id="plugin-contrib-vmware"></a> VMware
+###
# <a id="plugin-contrib-vmware"></a> VMware
Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
-#### <a id="plugin-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
+####
# <a id="plugin-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
-#### <a id="plugin-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
+####
# <a id="plugin-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
+####
# <a id="plugin-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
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.
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.
-#### <a id="plugin-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
+####
# <a id="plugin-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
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.
-#### <a id="plugin-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
+####
# <a id="plugin-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
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.
-#### <a id="plugin-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
+####
# <a id="plugin-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
Check command object for the `check_vmware_esx` plugin. All issues for the host.
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.
-#### <a id="plugin-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
+####
# <a id="plugin-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
+####
# <a id="plugin-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
-#### <a id="plugin-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
+####
# <a id="plugin-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
+####
# <a id="plugin-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
+####
# <a id="plugin-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
-#### <a id="plugin-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
+####
# <a id="plugin-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
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.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
+####
# <a id="plugin-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
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.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
+####
# <a id="plugin-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
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.
vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
-#### <a id="plugin-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
+####
# <a id="plugin-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
+####
# <a id="plugin-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
-#### <a id="plugin-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
+####
# <a id="plugin-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
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.
vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
+####
# <a id="plugin-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
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.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
+####
# <a id="plugin-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
+####
# <a id="plugin-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
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.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
+####
# <a id="plugin-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
Check command object for the `check_vmware_esx` plugin. Shows net info.
vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
-#### <a id="plugin-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
+####
# <a id="plugin-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
+####
# <a id="plugin-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
+####
# <a id="plugin-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
+####
# <a id="plugin-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
Check command object for the `check_vmware_esx` plugin. Check all active NICs.
vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
-#### <a id="plugin-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
+####
# <a id="plugin-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
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.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
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.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
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.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
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.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
+####
# <a id="plugin-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
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.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
+####
# <a id="plugin-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
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.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
+####
# <a id="plugin-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
Check command object for the `check_vmware_esx` plugin. Shows host service info.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
+####
# <a id="plugin-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
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.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
+####
# <a id="plugin-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
Check command object for the `check_vmware_esx` plugin. Shows connection state.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
+####
# <a id="plugin-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
+####
# <a id="plugin-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
+####
# <a id="plugin-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
-#### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
+####
# <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
-#### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
+####
# <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
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**.
vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
-#### <a id="plugin-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
+####
# <a id="plugin-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
Check command object for the `check_vmware_esx` plugin. Local storage status check.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
+####
# <a id="plugin-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
+####
# <a id="plugin-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
+####
# <a id="plugin-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
-#### <a id="plugin-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
+####
# <a id="plugin-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
Check command object for the `check_vmware_esx` plugin. List host bus adapters.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
+####
# <a id="plugin-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
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.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
+####
# <a id="plugin-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
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.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
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.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
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.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
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.
vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
-#### <a id="plugin-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
-#### <a id="plugin-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
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>
**vm consumed memory = memory granted -- memory saved**
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
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.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
Check command object for the `check_vmware_esx` plugin. Shows net info.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
Check command object for the `check_vmware_esx` plugin. SShows all disk io info. Without subselect no thresholds can be given. All I/O values are aggregated from historical intervals over the past 24 hours with a 5 minute sample rate.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
Check command object for the `check_vmware_esx` plugin. Shows the connection state.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
vmware_crit | **Optional.** The critical threshold. No value defined as default.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
vmware_password | **Optional.** The username's password. No value defined as default.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
-#### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
-#### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
+####
# <a id="plugin-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
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.
-### <a id="plugins-contrib-storage"></a> Storage
-This category includes all plugins for various storage and object storage technologies.
+### <a id="plugin-contrib-web"></a> Web
-#### <a id="plugins-contrib-command-glusterfs"></a> glusterfs
+This category includes all plugins for web-based checks.
-The plugin `glusterfs` is a plugin to checks the GlusterFS storage health on the server. It is provided by `Philippe Kueck` on [https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs). This plugin needs sudo to run properly.
+#### <a id="plugin-contrib-command-webinject"></a> webinject
-Name | Description
----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
-glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
-glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
-glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
-glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
-glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
-glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
+Check command object for the [check_webinject](http://www.webinject.org/manual.html) plugin.
-### <a id="plugins-contrib-logmanagement"></a> Logmanagement
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
-This category includes all plugins for services dealing with logfiles and logevents
+Name | Description
+------------------------|--------------
+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.
+webinject_output | **Optional.** This option is followed by a directory name or a prefix to prepended to the output files. This is used to specify the location for writing output files (http.log, results.html, and results.xml). If a directory name is supplied (use either an absolute or relative path and make sure to add the trailing slash), all output files are written to this directory. If the trailing slash is ommitted, it is assumed to a prefix and this will be prepended to the output files. You may also use a combination of a directory and prefix.
+webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
+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.
+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.
+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.
-#### <a id="plugins-contrib-command-logstash"></a> logstash
+#### <a id="plugin-contrib-command-jmx4perl"></a> jmx4perl
+
+The plugin `jmx4perl` utilizes the api provided by the jolokia web application to query java message beans on an application server. It is part of the perl module provided by Roland Huß on [cpan](http://search.cpan.org/~roland/jmx4perl/) including a detailed [documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl) containing installation tutorial, security advices und usage examples.
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
+jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
+jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
+jmx4perl_alias | **Optional.** Alias name for attribute (e.g. MEMORY_HEAP_USED). All availables aliases can be viewed by executing `jmx4perl aliases` on the command line.
+jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
+jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
+jmx4perl_operation | **Optional.** Operation to execute.
+jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
+jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
+jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
+jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
+jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
+jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
+jmx4perl_proxy | **Optional.** Proxy to use.
+jmx4perl_user | **Optional.** User for HTTP authentication.
+jmx4perl_password | **Optional.** Password for HTTP authentication.
+jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
+jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
+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.
+jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
+jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
+jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
+jmx4perl_unit | **Optional.** Unit of measurement of the data retreived. Recognized values are [B\|KB\|MN\|GB\|TB] for memory values and [us\|ms\|s\|m\|h\|d] for time values.
+jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
+jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
+jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
+jmx4perl_critical | **Optional.** Critical threshold for value.
+jmx4perl_warning | **Optional.** Warning threshold for value.
+jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
+jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
+jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
+jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
+jmx4perl_config | **Optional.** Path to configuration file.
+jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
+jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
+
+#### <a id="plugin-contrib-command-squid"></a> squid
+
+Plugin for monitoring [Squid](https://exchange.icinga.org/exchange/check_squid).
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+------------------------|----------------------------------------------------------------------------------
+squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
+squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
+squid_port | **Optional.** Port number (default: 3128).
+squid_user | **Optional.** WWW user
+squid_password | **Optional.** WWW password
+squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
+squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
+squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
+squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
+
+
+#### <a id="plugin-contrib-command-nginx_status"></a> nginx_status
+
+Plugin for monitoring [nginx_status](https://github.com/regilero/check_nginx_status).
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+------------------------|----------------------------------------------------------------------------------
+nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
+nginx_status_port | **Optional.** the http port.
+nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
+nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
+nginx_status_ssl | **Optional.** set to use ssl connection
+nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
+nginx_status_user | **Optional.** Username for basic auth
+nginx_status_pass | **Optional.** Password for basic auth
+nginx_status_realm | **Optional.** Realm for basic auth
+nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
+nginx_status_timeout | **Optional.** timeout in seconds
+nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
+nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
+
+
+#### <a id="plugin-contrib-command-apache_status"></a> apache_status
+
+Plugin for monitoring [apache_status](https://github.com/lbetz/check_apache_status).
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+------------------------|----------------------------------------------------------------------------------
+apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
+apache_status_port | **Optional.** the http port.
+apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
+apache_status_ssl | **Optional.** set to use ssl connection
+apache_status_timeout | **Optional.** timeout in seconds
+apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
+apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
+
+
+#### <a id="plugin-contrib-command-kdc"></a> kdc
+
+Plugin for monitoring [kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details).
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+----------------|--------------------------------------------------------------------------
+kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
+kdc_port | **Optional** Port on which KDC runs (default 88).
+kdc_principal | **Required** Principal name to authenticate as (including realm).
+kdc_keytab | **Required** Keytab file containing principal's key.
+
+
+#### <a id="plugin-contrib-command-rbl"></a> rbl
+
+Plugin for monitoring [rbl](https://github.com/matteocorti/check_rbl)
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+----------------|--------------------------------------------------------------------------
+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.
+rbl_server | **Required** List of RBL servers as an array.
+rbl_warning | **Optional** Number of blacklisting servers for a warning.
+rbl_critical | **Optional** Number of blacklisting servers for a critical.
+tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
-The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to the Node API of Logstash. This feature was introduced with Logstash version 5.0 so the plugin won't work with prior versions of Logstash. The Node API is not activated by default, you will have to reconfigure your Logstash installation for the plugin to connect.
-Name | Description
----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
-logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
-logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
-logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
-logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
-logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
-logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
-logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
-logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
-logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
projects / icinga2 / commitdiff