* [Register](https://accounts.icinga.org/register) an Icinga account.
* Create a new issue at the [Icinga 2 Development Tracker](https://dev.icinga.org/projects/i2).
-* When reporting a bug, please include the details described in the [Troubleshooting](17-troubleshooting.md#troubleshooting-information-required) chapter (version, configs, logs, etc).
+* When reporting a bug, please include the details described in the [Troubleshooting](16-troubleshooting.md#troubleshooting-information-required) chapter (version, configs, logs, etc).
## <a id="whats-new"></a> What's New
* Solved a number of issues where cluster instances would not reconnect after intermittent connection problems
* A lot of other, minor changes
-* [DB IDO schema upgrade](18-upgrading-icinga-2.md#upgrading-icinga-2) to `1.13.0` required!
+* [DB IDO schema upgrade](17-upgrading-icinga-2.md#upgrading-icinga-2) to `1.13.0` required!
#### Features
> **Tip**
>
> If you're looking for troubleshooting clients problems, check the general
-> [cluster troubleshooting](17-troubleshooting.md#troubleshooting-cluster) section.
+> [cluster troubleshooting](16-troubleshooting.md#troubleshooting-cluster) section.
### <a id="icinga2-client-configuration-combined-scenarios"></a> Combined Client Scenarios
and specific trap handlers passing the check results to Icinga 2.
Following the SNMPTT [Format](http://snmptt.sourceforge.net/docs/snmptt.shtml#SNMPTT.CONF-FORMAT)
-documentation and the Icinga external command syntax found [here](23-appendix.md#external-commands-list-detail)
+documentation and the Icinga external command syntax found [here](22-appendix.md#external-commands-list-detail)
we can create generic services that can accommodate any number of hosts for a given scenario.
### <a id="simple-traps"></a> Simple SNMP Traps
> **Tip**
>
> If you're looking for troubleshooting cluster problems, check the general
-> [troubleshooting](17-troubleshooting.md#troubleshooting-cluster) section.
+> [troubleshooting](16-troubleshooting.md#troubleshooting-cluster) section.
## <a id="manual-certificate-generation"></a> Manual SSL Certificate Generation
### <a id="configure-nodename"></a> Configure the Icinga Node Name
Instead of using the default FQDN as node name you can optionally set
-that value using the [NodeName](20-language-reference.md#constants) constant.
+that value using the [NodeName](18-language-reference.md#constants) constant.
> ** Note **
>
>
> `zones.d` must not be included in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf). Icinga 2 automatically
> determines the required include directory. This can be overridden using the
-> [global constant](20-language-reference.md#constants) `ZonesDir`.
+> [global constant](18-language-reference.md#constants) `ZonesDir`.
### <a id="zone-global-config-templates"></a> Global Configuration Zone for Templates
> ** Tip **
>
-> Look into the [troubleshooting guides](17-troubleshooting.md#troubleshooting-cluster-config-sync) for debugging
+> Look into the [troubleshooting guides](16-troubleshooting.md#troubleshooting-cluster-config-sync) for debugging
> problems with the configuration synchronisation.
If you're planning to use it configure it to use the
[bulk mode with npcd and npcdmod](http://docs.pnp4nagios.org/pnp-0.6/modes#bulk_mode_with_npcd_and_npcdmod)
-in combination with Icinga 2's [PerfdataWriter](5-advanced-topics.md#performance-data). NPCD collects the performance
+in combination with Icinga 2's [PerfdataWriter](15-features.md#performance-data). NPCD collects the performance
data files which Icinga 2 generates.
Enable performance data writer in icinga 2
* whisper - a simple database library for storing time-series data (similar in design to RRD)
* graphite webapp - A Django webapp that renders graphs on-demand using Cairo
-Use the [GraphiteWriter](5-advanced-topics.md#graphite-carbon-cache-writer) feature
+Use the [GraphiteWriter](15-features.md#graphite-carbon-cache-writer) feature
for sending real-time metrics from Icinga 2 to Graphite.
# icinga2 feature enable graphite
[InfluxDB](https://influxdb.com) is a time series, metrics, and analytics database.
It’s written in Go and has no external dependencies.
-Use the [GraphiteWriter](5-advanced-topics.md#graphite-carbon-cache-writer) feature
+Use the [GraphiteWriter](15-features.md#graphite-carbon-cache-writer) feature
for sending real-time metrics from Icinga 2 to InfluxDB. Note: There are [API changes](https://github.com/influxdb/influxdb/issues/2102)
in InfluxDB 0.9.x.
### <a id="addons-visualization-reporting"></a> Icinga Reporting
-By enabling the [DB IDO](5-advanced-topics.md#db-ido) feature you can use the
+By enabling the [DB IDO](15-features.md#db-ido) feature you can use the
[Icinga Reporting package](https://wiki.icinga.org/display/howtos/Setting+up+Icinga+with+Reporting).
### <a id="addons-visualization-nagvis"></a> NagVis
-By using either [Livestatus](16-livestatus.md#setting-up-livestatus) or
-[DB IDO](5-advanced-topics.md#db-ido) as a backend you can create your own network maps
+By using either [Livestatus](15-features.md#setting-up-livestatus) or
+[DB IDO](15-features.md#db-ido) as a backend you can create your own network maps
based on your monitoring configuration and status data using [NagVis](http://www.nagvis.org).
The configuration in nagvis.ini.php should look like this for Livestatus for example:
### <a id="addons-visualization-thruk"></a> Thruk
[Thruk](http://www.thruk.org) is an alternative web interface which can be used with Icinga 2
-and the [Livestatus](16-livestatus.md#setting-up-livestatus) feature.
+and the [Livestatus](15-features.md#setting-up-livestatus) feature.
## <a id="log-monitoring"></a> Log Monitoring
fix this:
* Create a symlink for example from the `templates.dist/check_ping.php` template to the actual check name in Icinga 2 (`templates/ping4.php`)
-* Pass the check command name inside the [format template configuration](5-advanced-topics.md#writing-performance-data-files)
+* Pass the check command name inside the [format template configuration](15-features.md#writing-performance-data-files)
The latter becomes difficult with agent based checks like NRPE or SSH where the first command argument acts as
graph template identifier. There is the possibility to define the pnp template name as custom attribute
+++ /dev/null
-# <a id="alternative-frontends"></a> Alternative Frontends
-
-## <a id="setting-up-icinga-classic-ui"></a> Setting up Icinga Classic UI 1.x
-
-Icinga 2 can write `status.dat` and `objects.cache` files in the format that
-is supported by the Icinga 1.x Classic UI. [External commands](5-advanced-topics.md#external-commands)
-(a.k.a. the "command pipe") are also supported. It also supports writing Icinga 1.x
-log files which are required for the reporting functionality in the Classic UI.
-
-### <a id="installing-icinga-classic-ui"></a> Installing Icinga Classic UI 1.x
-
-The Icinga package repository has both Debian and RPM packages. You can install
-the Classic UI using the following packages:
-
- Distribution | Packages
- --------------|---------------------
- Debian | icinga2-classicui
- RHEL/SUSE | icinga2-classicui-config icinga-gui
-
-The Debian packages require additional packages which are provided by the
-[Debian Monitoring Project](http://www.debmon.org) (`debmon`) repository.
-
-`libjs-jquery-ui` requires at least version `1.10.*` which is not available
-in Debian 7 (Wheezy) and Ubuntu 12.04 LTS (Precise). Add the following repositories
-to satisfy this dependency:
-
- Distribution | Package Repositories
- ------------------------------|------------------------------
- Debian Wheezy | [wheezy-backports](http://backports.debian.org/Instructions/) or [debmon](http://www.debmon.org)
- Ubuntu 12.04 LTS (Precise) | [Icinga PPA](https://launchpad.net/~formorer/+archive/icinga)
-
-On all distributions other than Debian you may have to restart both your web
-server as well as Icinga 2 after installing the Classic UI package.
-
-Icinga Classic UI requires the [StatusDataWriter](5-advanced-topics.md#status-data), [CompatLogger](5-advanced-topics.md#compat-logging)
-and [ExternalCommandListener](5-advanced-topics.md#external-commands) features.
-Enable these features and restart Icinga 2.
-
- # icinga2 feature enable statusdata compatlog command
-
-In order for commands to work you will need to [setup the external command pipe](2-getting-started.md#setting-up-external-command-pipe).
-
-### <a id="setting-up-icinga-classic-ui-summary"></a> Setting Up Icinga Classic UI 1.x Summary
-
-Verify that your Icinga 1.x Classic UI works by browsing to your Classic
-UI installation URL:
-
- Distribution | URL | Default Login
- --------------|--------------------------------------------------------------------------|--------------------------
- Debian | [http://localhost/icinga2-classicui](http://localhost/icinga2-classicui) | asked during installation
- all others | [http://localhost/icinga](http://localhost/icinga) | icingaadmin/icingaadmin
-
-For further information on configuration, troubleshooting and interface documentation
-please check the official [Icinga 1.x user interface documentation](http://docs.icinga.org/latest/en/ch06.html).
-
-## <a id="setting-up-icinga-web"></a> Setting up Icinga Web 1.x
-
-Icinga 2 can write to the same schema supplied by `Icinga IDOUtils 1.x` which
-is an explicit requirement to run `Icinga Web` next to the external command pipe.
-Therefore you need to setup the [DB IDO feature](2-getting-started.md#configuring-db-ido-mysql) remarked in the previous sections.
-
-### <a id="installing-icinga-web"></a> Installing Icinga Web 1.x
-
-The Icinga package repository has both Debian and RPM packages. You can install
-Icinga Web using the following packages:
-
- Distribution | Packages
- --------------|-------------------------------------------------------
- RHEL/SUSE | icinga-web icinga-web-{mysql,pgsql}
- Debian | icinga-web icinga-web-config-icinga2-ido-{mysql,pgsql}
-
-### <a id="icinga-web-rpm-notes"></a> Icinga Web 1.x on RPM based systems
-
-Additionally you need to setup the `icinga_web` database and import the database schema.
-Details can be found in the package `README` files, for example [README.RHEL](https://github.com/Icinga/icinga-web/blob/master/doc/README.RHEL)
-
-The Icinga Web RPM packages install the schema files into
-`/usr/share/doc/icinga-web-*/schema` (`*` means package version).
-
-On SuSE-based distributions the schema files are installed in
-`/usr/share/doc/packages/icinga-web/schema`.
-
-Example for RHEL and MySQL:
-
- # mysql -u root -p
-
- mysql> CREATE DATABASE icinga_web;
- GRANT SELECT, INSERT, UPDATE, DELETE, DROP, CREATE VIEW, INDEX, EXECUTE ON icinga_web.* TO 'icinga_web'@'localhost' IDENTIFIED BY 'icinga_web';
- quit
-
- # mysql -u root -p icinga_web < /usr/share/doc/icinga-web-<version>/schema/mysql.sql
-
-Icinga Web requires the IDO feature as database backend using MySQL or PostgreSQL.
-Enable that feature, e.g. for MySQL.
-
- # icinga2 feature enable ido-mysql
-
-If you've changed your default credentials you may either create a read-only user
-or use the credentials defined in the IDO feature for Icinga Web backend configuration.
-Edit `databases.xml` accordingly and clear the cache afterwards. Further details can be
-found in the [Icinga Web documentation](http://docs.icinga.org/latest/en/icinga-web-config.html).
-
- # vim /etc/icinga-web/conf.d/databases.xml
-
- # icinga-web-clearcache
-
-Additionally you need to enable the `command` feature for sending [external commands](5-advanced-topics.md#external-commands):
-
- # icinga2 feature enable command
-
-In order for commands to work you will need to [setup the external command pipe](2-getting-started.md#setting-up-external-command-pipe).
-
-Then edit the Icinga Web configuration for sending commands in `/etc/icinga-web/conf.d/access.xml`
-(RHEL) or `/etc/icinga-web/access.xml` (SUSE) setting the command pipe path
-to the default used in Icinga 2. Make sure to clear the cache afterwards.
-
- # vim /etc/icinga-web/conf.d/access.xml
-
- <write>
- <files>
- <resource name="icinga_pipe">/var/run/icinga2/cmd/icinga2.cmd</resource>
- </files>
- </write>
-
- # icinga-web-clearcache
-
-> **Note**
->
-> The path to the Icinga Web `clearcache` script may differ. Please check the
-> [Icinga Web documentation](https://docs.icinga.org) for details.
-
-### <a id="icinga-web-debian-notes"></a> Icinga Web on Debian systems
-
-Since Icinga Web `1.11.1-2` the IDO auto-configuration has been moved into
-additional packages on Debian and Ubuntu.
-
-The package `icinga-web` no longer configures the IDO connection. You must now
-use one of the config packages:
-
- - `icinga-web-config-icinga2-ido-mysql`
- - `icinga-web-config-icinga2-ido-pgsql`
-
-These packages take care of setting up the [DB IDO](2-getting-started.md#configuring-db-ido-mysql) configuration,
-enabling the external command pipe for Icinga Web and depend on
-the corresponding packages of Icinga 2.
-
-Please read the `README.Debian` files for details and advanced configuration:
-
- - `/usr/share/doc/icinga-web/README.Debian`
- - `/usr/share/doc/icinga-web-config-icinga2-ido-mysql/README.Debian`
- - `/usr/share/doc/icinga-web-config-icinga2-ido-pgsql/README.Debian`
-
-When changing Icinga Web configuration files make sure to clear the config cache:
-
- # /usr/lib/icinga-web/bin/clearcache.sh
-
-> **Note**
->
-> If you are using an older version of Icinga Web, install it like this and adapt
-> the configuration manually as shown in [the RPM notes](15-alternative-frontends.md#icinga-web-rpm-notes):
->
-> `apt-get install --no-install-recommends icinga-web`
-
-### <a id="setting-up-icinga-web-summary"></a> Setting Up Icinga Web 1.x Summary
-
-Verify that your Icinga 1.x Web works by browsing to your Web installation URL:
-
- Distribution | URL | Default Login
- --------------|-------------------------------------------------------------|--------------------------
- Debian | [http://localhost/icinga-web](http://localhost/icinga-web) | asked during installation
- all others | [http://localhost/icinga-web](http://localhost/icinga-web) | root/password
-
-For further information on configuration, troubleshooting and interface documentation
-please check the official [Icinga 1.x user interface documentation](http://docs.icinga.org/latest/en/ch06.html).
-
--- /dev/null
+# <a id="icinga2-features"></a> Icinga 2 Features
+
+## <a id="logging"></a> Logging
+
+Icinga 2 supports three different types of logging:
+
+* File logging
+* Syslog (on *NIX-based operating systems)
+* Console logging (`STDOUT` on tty)
+
+You can enable additional loggers using the `icinga2 feature enable`
+and `icinga2 feature disable` commands to configure loggers:
+
+Feature | Description
+---------|------------
+debuglog | Debug log (path: `/var/log/icinga2/debug.log`, severity: `debug` or higher)
+mainlog | Main log (path: `/var/log/icinga2/icinga2.log`, severity: `information` or higher)
+syslog | Syslog (severity: `warning` or higher)
+
+By default file the `mainlog` feature is enabled. When running Icinga 2
+on a terminal log messages with severity `information` or higher are
+written to the console.
+
+## <a id="db-ido"></a> DB IDO
+
+The IDO (Icinga Data Output) modules for Icinga 2 take care of exporting all
+configuration and status information into a database. The IDO database is used
+by a number of projects including Icinga Web 1.x and 2.
+
+Details on the installation can be found in the [Configuring DB IDO](2-getting-started.md#configuring-db-ido-mysql)
+chapter. Details on the configuration can be found in the
+[IdoMysqlConnection](6-object-types.md#objecttype-idomysqlconnection) and
+[IdoPgsqlConnection](6-object-types.md#objecttype-idopgsqlconnection)
+object configuration documentation.
+The DB IDO feature supports [High Availability](13-distributed-monitoring-ha.md#high-availability-db-ido) in
+the Icinga 2 cluster.
+
+The following example query checks the health of the current Icinga 2 instance
+writing its current status to the DB IDO backend table `icinga_programstatus`
+every 10 seconds. By default it checks 60 seconds into the past which is a reasonable
+amount of time - adjust it for your requirements. If the condition is not met,
+the query returns an empty result.
+
+> **Tip**
+>
+> Use [check plugins](14-addons-plugins.md#plugins) to monitor the backend.
+
+Replace the `default` string with your instance name, if different.
+
+Example for MySQL:
+
+ # mysql -u root -p icinga -e "SELECT status_update_time FROM icinga_programstatus ps
+ JOIN icinga_instances i ON ps.instance_id=i.instance_id
+ WHERE (UNIX_TIMESTAMP(ps.status_update_time) > UNIX_TIMESTAMP(NOW())-60)
+ AND i.instance_name='default';"
+
+ +---------------------+
+ | status_update_time |
+ +---------------------+
+ | 2014-05-29 14:29:56 |
+ +---------------------+
+
+
+Example for PostgreSQL:
+
+ # export PGPASSWORD=icinga; psql -U icinga -d icinga -c "SELECT ps.status_update_time FROM icinga_programstatus AS ps
+ JOIN icinga_instances AS i ON ps.instance_id=i.instance_id
+ WHERE ((SELECT extract(epoch from status_update_time) FROM icinga_programstatus) > (SELECT extract(epoch from now())-60))
+ AND i.instance_name='default'";
+
+ status_update_time
+ ------------------------
+ 2014-05-29 15:11:38+02
+ (1 Zeile)
+
+
+A detailed list on the available table attributes can be found in the [DB IDO Schema documentation](22-appendix.md#schema-db-ido).
+
+
+## <a id="external-commands"></a> External Commands
+
+Icinga 2 provides an external command pipe for processing commands
+triggering specific actions (for example rescheduling a service check
+through the web interface).
+
+In order to enable the `ExternalCommandListener` configuration use the
+following command and restart Icinga 2 afterwards:
+
+ # icinga2 feature enable command
+
+Icinga 2 creates the command pipe file as `/var/run/icinga2/cmd/icinga2.cmd`
+using the default configuration.
+
+Web interfaces and other Icinga addons are able to send commands to
+Icinga 2 through the external command pipe, for example for rescheduling
+a forced service check:
+
+ # /bin/echo "[`date +%s`] SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;`date +%s`" >> /var/run/icinga2/cmd/icinga2.cmd
+
+ # tail -f /var/log/messages
+
+ Oct 17 15:01:25 icinga-server icinga2: Executing external command: [1382014885] SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;1382014885
+ Oct 17 15:01:25 icinga-server icinga2: Rescheduling next check for service 'ping4'
+
+A list of currently supported external commands can be found [here](22-appendix.md#external-commands-list-detail).
+
+Detailed information on the commands and their required parameters can be found
+on the [Icinga 1.x documentation](http://docs.icinga.org/latest/en/extcommands2.html).
+
+## <a id="performance-data"></a> Performance Data
+
+When a host or service check is executed plugins should provide so-called
+`performance data`. Next to that additional check performance data
+can be fetched using Icinga 2 runtime macros such as the check latency
+or the current service state (or additional custom attributes).
+
+The performance data can be passed to external applications which aggregate and
+store them in their backends. These tools usually generate graphs for historical
+reporting and trending.
+
+Well-known addons processing Icinga performance data are [PNP4Nagios](14-addons-plugins.md#addons-graphing-pnp),
+[Graphite](14-addons-plugins.md#addons-graphing-graphite) or [OpenTSDB](15-features.md#opentsdb-writer).
+
+### <a id="writing-performance-data-files"></a> Writing Performance Data Files
+
+PNP4Nagios and Graphios use performance data collector daemons to fetch
+the current performance files for their backend updates.
+
+Therefore the Icinga 2 [PerfdataWriter](6-object-types.md#objecttype-perfdatawriter)
+feature allows you to define the output template format for host and services helped
+with Icinga 2 runtime vars.
+
+ host_format_template = "DATATYPE::HOSTPERFDATA\tTIMET::$icinga.timet$\tHOSTNAME::$host.name$\tHOSTPERFDATA::$host.perfdata$\tHOSTCHECKCOMMAND::$host.check_command$\tHOSTSTATE::$host.state$\tHOSTSTATETYPE::$host.state_type$"
+ service_format_template = "DATATYPE::SERVICEPERFDATA\tTIMET::$icinga.timet$\tHOSTNAME::$host.name$\tSERVICEDESC::$service.name$\tSERVICEPERFDATA::$service.perfdata$\tSERVICECHECKCOMMAND::$service.check_command$\tHOSTSTATE::$host.state$\tHOSTSTATETYPE::$host.state_type$\tSERVICESTATE::$service.state$\tSERVICESTATETYPE::$service.state_type$"
+
+The default templates are already provided with the Icinga 2 feature configuration
+which can be enabled using
+
+ # icinga2 feature enable perfdata
+
+By default all performance data files are rotated in a 15 seconds interval into
+the `/var/spool/icinga2/perfdata/` directory as `host-perfdata.<timestamp>` and
+`service-perfdata.<timestamp>`.
+External collectors need to parse the rotated performance data files and then
+remove the processed files.
+
+### <a id="graphite-carbon-cache-writer"></a> Graphite Carbon Cache Writer
+
+While there are some [Graphite](14-addons-plugins.md#addons-graphing-graphite)
+collector scripts and daemons like Graphios available for Icinga 1.x it's more
+reasonable to directly process the check and plugin performance
+in memory in Icinga 2. Once there are new metrics available, Icinga 2 will directly
+write them to the defined Graphite Carbon daemon tcp socket.
+
+You can enable the feature using
+
+ # icinga2 feature enable graphite
+
+By default the [GraphiteWriter](6-object-types.md#objecttype-graphitewriter) feature
+expects the Graphite Carbon Cache to listen at `127.0.0.1` on TCP port `2003`.
+
+#### <a id="graphite-carbon-cache-writer-schema"></a> Current Graphite Schema
+
+The current naming schema is defined as follows. The official Icinga Web 2 Graphite
+module will use that schema too.
+
+The default prefix for hosts and services is configured using
+[runtime macros](3-monitoring-basics.md#runtime-macros)like this:
+
+ icinga2.$host.name$.host.$host.check_command$
+ icinga2.$host.name$.services.$service.name$.$service.check_command$
+
+You can customize the prefix name by using the `host_name_template` and
+`service_name_template` configuration attributes.
+
+The additional levels will allow fine granular filters and also template
+capabilities, e.g. by using the check command `disk` for specific
+graph templates in web applications rendering the Graphite data.
+
+The following characters are escaped in prefix labels:
+
+ Character | Escaped character
+ --------------|--------------------------
+ whitespace | _
+ . | _
+ \ | _
+ / | _
+
+Metric values are stored like this:
+
+ <prefix>.perfdata.<perfdata-label>.value
+
+The following characters are escaped in perfdata labels:
+
+ Character | Escaped character
+ --------------|--------------------------
+ whitespace | _
+ \ | _
+ / | _
+ :: | .
+
+Note that perfdata labels may contain dots (`.`) allowing to
+add more subsequent levels inside the Graphite tree.
+`::` adds support for [multi performance labels](http://my-plugin.de/wiki/projects/check_multi/configuration/performance)
+and is therefore replaced by `.`.
+
+By enabling `enable_send_thresholds` Icinga 2 automatically adds the following threshold metrics:
+
+ <prefix>.perfdata.<perfdata-label>.min
+ <prefix>.perfdata.<perfdata-label>.max
+ <prefix>.perfdata.<perfdata-label>.warn
+ <prefix>.perfdata.<perfdata-label>.crit
+
+By enabling `enable_send_metadata` Icinga 2 automatically adds the following metadata metrics:
+
+ <prefix>.metadata.current_attempt
+ <prefix>.metadata.downtime_depth
+ <prefix>.metadata.execution_time
+ <prefix>.metadata.latency
+ <prefix>.metadata.max_check_attempts
+ <prefix>.metadata.reachable
+ <prefix>.metadata.state
+ <prefix>.metadata.state_type
+
+Metadata metric overview:
+
+ metric | description
+ -------------------|------------------------------------------
+ current_attempt | current check attempt
+ max_check_attempts | maximum check attempts until the hard state is reached
+ reachable | checked object is reachable
+ downtime_depth | number of downtimes this object is in
+ execution_time | check execution time
+ latency | check latency
+ state | current state of the checked object
+ state_type | 0=SOFT, 1=HARD state
+
+The following example illustrates how to configure the storage schemas for Graphite Carbon
+Cache.
+
+ [icinga2_default]
+ # intervals like PNP4Nagios uses them per default
+ pattern = ^icinga2\.
+ retentions = 1m:2d,5m:10d,30m:90d,360m:4y
+
+#### <a id="graphite-carbon-cache-writer-schema-legacy"></a> Graphite Schema < 2.4
+
+In order to restore the old legacy schema, you'll need to adopt the `GraphiteWriter`
+configuration:
+
+ object GraphiteWriter "graphite" {
+
+ enable_legacy_mode = true
+
+ host_name_template = "icinga.$host.name$"
+ service_name_template = "icinga.$host.name$.$service.name$"
+ }
+
+The old legacy naming schema is
+
+ icinga.<hostname>.<metricname>
+ icinga.<hostname>.<servicename>.<metricname>
+
+You can customize the metric prefix name by using the `host_name_template` and
+`service_name_template` configuration attributes.
+
+The example below uses [runtime macros](3-monitoring-basics.md#runtime-macros) and a
+[global constant](18-language-reference.md#constants) named `GraphiteEnv`. The constant name
+is freely definable and should be put in the [constants.conf](4-configuring-icinga-2.md#constants-conf) file.
+
+ const GraphiteEnv = "icinga.env1"
+
+ object GraphiteWriter "graphite" {
+ host_name_template = GraphiteEnv + ".$host.name$"
+ service_name_template = GraphiteEnv + ".$host.name$.$service.name$"
+ }
+
+To make sure Icinga 2 writes a valid label into Graphite some characters are replaced
+with `_` in the target name:
+
+ \/.- (and space)
+
+The resulting name in Graphite might look like:
+
+ www-01 / http-cert / response time
+ icinga.www_01.http_cert.response_time
+
+In addition to the performance data retrieved from the check plugin, Icinga 2 sends
+internal check statistic data to Graphite:
+
+ metric | description
+ -------------------|------------------------------------------
+ current_attempt | current check attempt
+ max_check_attempts | maximum check attempts until the hard state is reached
+ reachable | checked object is reachable
+ downtime_depth | number of downtimes this object is in
+ execution_time | check execution time
+ latency | check latency
+ state | current state of the checked object
+ state_type | 0=SOFT, 1=HARD state
+
+The following example illustrates how to configure the storage-schemas for Graphite Carbon
+Cache. Please make sure that the order is correct because the first match wins.
+
+ [icinga_internals]
+ pattern = ^icinga\..*\.(max_check_attempts|reachable|current_attempt|execution_time|latency|state|state_type)
+ retentions = 5m:7d
+
+ [icinga_default]
+ # intervals like PNP4Nagios uses them per default
+ pattern = ^icinga\.
+ retentions = 1m:2d,5m:10d,30m:90d,360m:4y
+
+### <a id="gelfwriter"></a> GELF Writer
+
+The `Graylog Extended Log Format` (short: [GELF](http://www.graylog2.org/resources/gelf))
+can be used to send application logs directly to a TCP socket.
+
+While it has been specified by the [graylog2](http://www.graylog2.org/) project as their
+[input resource standard](http://www.graylog2.org/resources/gelf), other tools such as
+[Logstash](http://www.logstash.net) also support `GELF` as
+[input type](http://logstash.net/docs/latest/inputs/gelf).
+
+You can enable the feature using
+
+ # icinga2 feature enable gelf
+
+By default the `GelfWriter` object expects the GELF receiver to listen at `127.0.0.1` on TCP port `12201`.
+The default `source` attribute is set to `icinga2`. You can customize that for your needs if required.
+
+Currently these events are processed:
+* Check results
+* State changes
+* Notifications
+
+### <a id="opentsdb-writer"></a> OpenTSDB Writer
+
+While there are some OpenTSDB collector scripts and daemons like tcollector available for
+Icinga 1.x it's more reasonable to directly process the check and plugin performance
+in memory in Icinga 2. Once there are new metrics available, Icinga 2 will directly
+write them to the defined TSDB TCP socket.
+
+You can enable the feature using
+
+ # icinga2 feature enable opentsdb
+
+By default the `OpenTsdbWriter` object expects the TSD to listen at
+`127.0.0.1` on port `4242`.
+
+The current naming schema is
+
+ icinga.host.<metricname>
+ icinga.service.<servicename>.<metricname>
+
+for host and service checks. The tag host is always applied.
+
+To make sure Icinga 2 writes a valid metric into OpenTSDB some characters are replaced
+with `_` in the target name:
+
+ \ (and space)
+
+The resulting name in OpenTSDB might look like:
+
+ www-01 / http-cert / response time
+ icinga.http_cert.response_time
+
+In addition to the performance data retrieved from the check plugin, Icinga 2 sends
+internal check statistic data to OpenTSDB:
+
+ metric | description
+ -------------------|------------------------------------------
+ current_attempt | current check attempt
+ max_check_attempts | maximum check attempts until the hard state is reached
+ reachable | checked object is reachable
+ downtime_depth | number of downtimes this object is in
+ execution_time | check execution time
+ latency | check latency
+ state | current state of the checked object
+ state_type | 0=SOFT, 1=HARD state
+
+While reachable, state and state_type are metrics for the host or service the
+other metrics follow the current naming schema
+
+ icinga.check.<metricname>
+
+with the following tags
+
+ tag | description
+ --------|------------------------------------------
+ type | the check type, one of [host, service]
+ host | hostname, the check ran on
+ service | the service name (if type=service)
+
+> **Note**
+>
+> You might want to set the tsd.core.auto_create_metrics setting to `true`
+> in your opentsdb.conf configuration file.
+
+
+## <a id="setting-up-livestatus"></a> Livestatus
+
+The [MK Livestatus](http://mathias-kettner.de/checkmk_livestatus.html) project
+implements a query protocol that lets users query their Icinga instance for
+status information. It can also be used to send commands.
+
+> **Tip**
+>
+> Only install the Livestatus feature if your web interface or addon requires
+> you to do so (for example, [Icinga Web 2](2-getting-started.md#setting-up-icingaweb2)).
+> Icinga Classic UI 1.x and Icinga Web 1.x do not use Livestatus as backend.
+
+The Livestatus component that is distributed as part of Icinga 2 is a
+re-implementation of the Livestatus protocol which is compatible with MK
+Livestatus.
+
+Details on the available tables and attributes with Icinga 2 can be found
+in the [Livestatus Schema](22-appendix.md#schema-livestatus) section.
+
+You can enable Livestatus using icinga2 feature enable:
+
+ # icinga2 feature enable livestatus
+
+After that you will have to restart Icinga 2:
+
+Debian/Ubuntu, RHEL/CentOS 6 and SUSE:
+
+ # service icinga2 restart
+
+RHEL/CentOS 7 and Fedora:
+
+ # systemctl restart icinga2
+
+By default the Livestatus socket is available in `/var/run/icinga2/cmd/livestatus`.
+
+In order for queries and commands to work you will need to add your query user
+(e.g. your web server) to the `icingacmd` group:
+
+ # usermod -a -G icingacmd www-data
+
+The Debian packages use `nagios` as the user and group name. Make sure to change `icingacmd` to
+`nagios` if you're using Debian.
+
+Change `www-data` to the user you're using to run queries.
+
+In order to use the historical tables provided by the livestatus feature (for example, the
+`log` table) you need to have the `CompatLogger` feature enabled. By default these logs
+are expected to be in `/var/log/icinga2/compat`. A different path can be set using the
+`compat_log_path` configuration attribute.
+
+ # icinga2 feature enable compatlog
+
+
+### <a id="livestatus-sockets"></a> Livestatus Sockets
+
+Other to the Icinga 1.x Addon, Icinga 2 supports two socket types
+
+* Unix socket (default)
+* TCP socket
+
+Details on the configuration can be found in the [LivestatusListener](6-object-types.md#objecttype-livestatuslistener)
+object configuration.
+
+### <a id="livestatus-get-queries"></a> Livestatus GET Queries
+
+> **Note**
+>
+> All Livestatus queries require an additional empty line as query end identifier.
+> The `nc` tool (`netcat`) provides the `-U` parameter to communicate using
+> a unix socket.
+
+There also is a Perl module available in CPAN for accessing the Livestatus socket
+programmatically: [Monitoring::Livestatus](http://search.cpan.org/~nierlein/Monitoring-Livestatus-0.74/)
+
+
+Example using the unix socket:
+
+ # echo -e "GET services\n" | /usr/bin/nc -U /var/run/icinga2/cmd/livestatus
+
+Example using the tcp socket listening on port `6558`:
+
+ # echo -e 'GET services\n' | netcat 127.0.0.1 6558
+
+ # cat servicegroups <<EOF
+ GET servicegroups
+
+ EOF
+
+ (cat servicegroups; sleep 1) | netcat 127.0.0.1 6558
+
+
+### <a id="livestatus-command-queries"></a> Livestatus COMMAND Queries
+
+A list of available external commands and their parameters can be found [here](22-appendix.md#external-commands-list-detail)
+
+ $ echo -e 'COMMAND <externalcommandstring>' | netcat 127.0.0.1 6558
+
+
+### <a id="livestatus-filters"></a> Livestatus Filters
+
+and, or, negate
+
+ Operator | Negate | Description
+ ----------|------------------------
+ = | != | Equality
+ ~ | !~ | Regex match
+ =~ | !=~ | Equality ignoring case
+ ~~ | !~~ | Regex ignoring case
+ < | | Less than
+ > | | Greater than
+ <= | | Less than or equal
+ >= | | Greater than or equal
+
+
+### <a id="livestatus-stats"></a> Livestatus Stats
+
+Schema: "Stats: aggregatefunction aggregateattribute"
+
+ Aggregate Function | Description
+ -------------------|--------------
+ sum |
+ min |
+ max |
+ avg | sum / count
+ std | standard deviation
+ suminv | sum (1 / value)
+ avginv | suminv / count
+ count | ordinary default for any stats query if not aggregate function defined
+
+Example:
+
+ GET hosts
+ Filter: has_been_checked = 1
+ Filter: check_type = 0
+ Stats: sum execution_time
+ Stats: sum latency
+ Stats: sum percent_state_change
+ Stats: min execution_time
+ Stats: min latency
+ Stats: min percent_state_change
+ Stats: max execution_time
+ Stats: max latency
+ Stats: max percent_state_change
+ OutputFormat: json
+ ResponseHeader: fixed16
+
+### <a id="livestatus-output"></a> Livestatus Output
+
+* CSV
+
+CSV output uses two levels of array separators: The members array separator
+is a comma (1st level) while extra info and host|service relation separator
+is a pipe (2nd level).
+
+Separators can be set using ASCII codes like:
+
+ Separators: 10 59 44 124
+
+* JSON
+
+Default separators.
+
+### <a id="livestatus-error-codes"></a> Livestatus Error Codes
+
+ Code | Description
+ ----------|--------------
+ 200 | OK
+ 404 | Table does not exist
+ 452 | Exception on query
+
+### <a id="livestatus-tables"></a> Livestatus Tables
+
+ Table | Join |Description
+ --------------|-----------|----------------------------
+ hosts | | host config and status attributes, services counter
+ hostgroups | | hostgroup config, status attributes and host/service counters
+ services | hosts | service config and status attributes
+ servicegroups | | servicegroup config, status attributes and service counters
+ contacts | | contact config and status attributes
+ contactgroups | | contact config, members
+ commands | | command name and line
+ status | | programstatus, config and stats
+ comments | services | status attributes
+ downtimes | services | status attributes
+ timeperiods | | name and is inside flag
+ endpoints | | config and status attributes
+ log | services, hosts, contacts, commands | parses [compatlog](6-object-types.md#objecttype-compatlogger) and shows log attributes
+ statehist | hosts, services | parses [compatlog](6-object-types.md#objecttype-compatlogger) and aggregates state change attributes
+ hostsbygroup | hostgroups | host attributes grouped by hostgroup and its attributes
+ servicesbygroup | servicegroups | service attributes grouped by servicegroup and its attributes
+ servicesbyhostgroup | hostgroups | service attributes grouped by hostgroup and its attributes
+
+The `commands` table is populated with `CheckCommand`, `EventCommand` and `NotificationCommand` objects.
+
+A detailed list on the available table attributes can be found in the [Livestatus Schema documentation](22-appendix.md#schema-livestatus).
+
+
+## <a id="status-data"></a> Status Data Files
+
+Icinga 1.x writes object configuration data and status data in a cyclic
+interval to its `objects.cache` and `status.dat` files. Icinga 2 provides
+the `StatusDataWriter` object which dumps all configuration objects and
+status updates in a regular interval.
+
+ # icinga2 feature enable statusdata
+
+Icinga 1.x Classic UI requires this data set as part of its backend.
+
+> **Note**
+>
+> If you are not using any web interface or addon which uses these files
+> you can safely disable this feature.
+
+
+## <a id="compat-logging"></a> Compat Log Files
+
+The Icinga 1.x log format is considered being the `Compat Log`
+in Icinga 2 provided with the `CompatLogger` object.
+
+These logs are not only used for informational representation in
+external web interfaces parsing the logs, but also to generate
+SLA reports and trends in Icinga 1.x Classic UI. Furthermore the
+[Livestatus](15-features.md#setting-up-livestatus) feature uses these logs for answering queries to
+historical tables.
+
+The `CompatLogger` object can be enabled with
+
+ # icinga2 feature enable compatlog
+
+By default, the Icinga 1.x log file called `icinga.log` is located
+in `/var/log/icinga2/compat`. Rotated log files are moved into
+`var/log/icinga2/compat/archives`.
+
+The format cannot be changed without breaking compatibility to
+existing log parsers.
+
+ # tail -f /var/log/icinga2/compat/icinga.log
+
+ [1382115688] LOG ROTATION: HOURLY
+ [1382115688] LOG VERSION: 2.0
+ [1382115688] HOST STATE: CURRENT;localhost;UP;HARD;1;
+ [1382115688] SERVICE STATE: CURRENT;localhost;disk;WARNING;HARD;1;
+ [1382115688] SERVICE STATE: CURRENT;localhost;http;OK;HARD;1;
+ [1382115688] SERVICE STATE: CURRENT;localhost;load;OK;HARD;1;
+ [1382115688] SERVICE STATE: CURRENT;localhost;ping4;OK;HARD;1;
+ [1382115688] SERVICE STATE: CURRENT;localhost;ping6;OK;HARD;1;
+ [1382115688] SERVICE STATE: CURRENT;localhost;processes;WARNING;HARD;1;
+ [1382115688] SERVICE STATE: CURRENT;localhost;ssh;OK;HARD;1;
+ [1382115688] SERVICE STATE: CURRENT;localhost;users;OK;HARD;1;
+ [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;disk;1382115705
+ [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;http;1382115705
+ [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;load;1382115705
+ [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;1382115705
+ [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;ping6;1382115705
+ [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;processes;1382115705
+ [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;ssh;1382115705
+ [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;users;1382115705
+ [1382115731] EXTERNAL COMMAND: PROCESS_SERVICE_CHECK_RESULT;localhost;ping6;2;critical test|
+ [1382115731] SERVICE ALERT: localhost;ping6;CRITICAL;SOFT;2;critical test
+
+
+## <a id="check-result-files"></a> Check Result Files
+
+Icinga 1.x writes its check result files to a temporary spool directory
+where they are processed in a regular interval.
+While this is extremely inefficient in performance regards it has been
+rendered useful for passing passive check results directly into Icinga 1.x
+skipping the external command pipe.
+
+Several clustered/distributed environments and check-aggregation addons
+use that method. In order to support step-by-step migration of these
+environments, Icinga 2 supports the `CheckResultReader` object.
+
+There is no feature configuration available, but it must be defined
+on-demand in your Icinga 2 objects configuration.
+
+ object CheckResultReader "reader" {
+ spool_dir = "/data/check-results"
+ }
+
+++ /dev/null
-## <a id="setting-up-livestatus"></a> Livestatus
-
-The [MK Livestatus](http://mathias-kettner.de/checkmk_livestatus.html) project
-implements a query protocol that lets users query their Icinga instance for
-status information. It can also be used to send commands.
-
-> **Tip**
->
-> Only install the Livestatus feature if your web interface or addon requires
-> you to do so (for example, [Icinga Web 2](2-getting-started.md#setting-up-icingaweb2)).
-> [Icinga Classic UI](15-alternative-frontends.md#setting-up-icinga-classic-ui) and [Icinga Web](15-alternative-frontends.md#setting-up-icinga-web)
-> do not use Livestatus as backend.
-
-The Livestatus component that is distributed as part of Icinga 2 is a
-re-implementation of the Livestatus protocol which is compatible with MK
-Livestatus.
-
-Details on the available tables and attributes with Icinga 2 can be found
-in the [Livestatus Schema](23-appendix.md#schema-livestatus) section.
-
-You can enable Livestatus using icinga2 feature enable:
-
- # icinga2 feature enable livestatus
-
-After that you will have to restart Icinga 2:
-
-Debian/Ubuntu, RHEL/CentOS 6 and SUSE:
-
- # service icinga2 restart
-
-RHEL/CentOS 7 and Fedora:
-
- # systemctl restart icinga2
-
-By default the Livestatus socket is available in `/var/run/icinga2/cmd/livestatus`.
-
-In order for queries and commands to work you will need to add your query user
-(e.g. your web server) to the `icingacmd` group:
-
- # usermod -a -G icingacmd www-data
-
-The Debian packages use `nagios` as the user and group name. Make sure to change `icingacmd` to
-`nagios` if you're using Debian.
-
-Change `www-data` to the user you're using to run queries.
-
-In order to use the historical tables provided by the livestatus feature (for example, the
-`log` table) you need to have the `CompatLogger` feature enabled. By default these logs
-are expected to be in `/var/log/icinga2/compat`. A different path can be set using the
-`compat_log_path` configuration attribute.
-
- # icinga2 feature enable compatlog
-
-
-### <a id="livestatus-sockets"></a> Livestatus Sockets
-
-Other to the Icinga 1.x Addon, Icinga 2 supports two socket types
-
-* Unix socket (default)
-* TCP socket
-
-Details on the configuration can be found in the [LivestatusListener](6-object-types.md#objecttype-livestatuslistener)
-object configuration.
-
-### <a id="livestatus-get-queries"></a> Livestatus GET Queries
-
-> **Note**
->
-> All Livestatus queries require an additional empty line as query end identifier.
-> The `nc` tool (`netcat`) provides the `-U` parameter to communicate using
-> a unix socket.
-
-There also is a Perl module available in CPAN for accessing the Livestatus socket
-programmatically: [Monitoring::Livestatus](http://search.cpan.org/~nierlein/Monitoring-Livestatus-0.74/)
-
-
-Example using the unix socket:
-
- # echo -e "GET services\n" | /usr/bin/nc -U /var/run/icinga2/cmd/livestatus
-
-Example using the tcp socket listening on port `6558`:
-
- # echo -e 'GET services\n' | netcat 127.0.0.1 6558
-
- # cat servicegroups <<EOF
- GET servicegroups
-
- EOF
-
- (cat servicegroups; sleep 1) | netcat 127.0.0.1 6558
-
-
-### <a id="livestatus-command-queries"></a> Livestatus COMMAND Queries
-
-A list of available external commands and their parameters can be found [here](23-appendix.md#external-commands-list-detail)
-
- $ echo -e 'COMMAND <externalcommandstring>' | netcat 127.0.0.1 6558
-
-
-### <a id="livestatus-filters"></a> Livestatus Filters
-
-and, or, negate
-
- Operator | Negate | Description
- ----------|------------------------
- = | != | Equality
- ~ | !~ | Regex match
- =~ | !=~ | Equality ignoring case
- ~~ | !~~ | Regex ignoring case
- < | | Less than
- > | | Greater than
- <= | | Less than or equal
- >= | | Greater than or equal
-
-
-### <a id="livestatus-stats"></a> Livestatus Stats
-
-Schema: "Stats: aggregatefunction aggregateattribute"
-
- Aggregate Function | Description
- -------------------|--------------
- sum |
- min |
- max |
- avg | sum / count
- std | standard deviation
- suminv | sum (1 / value)
- avginv | suminv / count
- count | ordinary default for any stats query if not aggregate function defined
-
-Example:
-
- GET hosts
- Filter: has_been_checked = 1
- Filter: check_type = 0
- Stats: sum execution_time
- Stats: sum latency
- Stats: sum percent_state_change
- Stats: min execution_time
- Stats: min latency
- Stats: min percent_state_change
- Stats: max execution_time
- Stats: max latency
- Stats: max percent_state_change
- OutputFormat: json
- ResponseHeader: fixed16
-
-### <a id="livestatus-output"></a> Livestatus Output
-
-* CSV
-
-CSV output uses two levels of array separators: The members array separator
-is a comma (1st level) while extra info and host|service relation separator
-is a pipe (2nd level).
-
-Separators can be set using ASCII codes like:
-
- Separators: 10 59 44 124
-
-* JSON
-
-Default separators.
-
-### <a id="livestatus-error-codes"></a> Livestatus Error Codes
-
- Code | Description
- ----------|--------------
- 200 | OK
- 404 | Table does not exist
- 452 | Exception on query
-
-### <a id="livestatus-tables"></a> Livestatus Tables
-
- Table | Join |Description
- --------------|-----------|----------------------------
- hosts | | host config and status attributes, services counter
- hostgroups | | hostgroup config, status attributes and host/service counters
- services | hosts | service config and status attributes
- servicegroups | | servicegroup config, status attributes and service counters
- contacts | | contact config and status attributes
- contactgroups | | contact config, members
- commands | | command name and line
- status | | programstatus, config and stats
- comments | services | status attributes
- downtimes | services | status attributes
- timeperiods | | name and is inside flag
- endpoints | | config and status attributes
- log | services, hosts, contacts, commands | parses [compatlog](6-object-types.md#objecttype-compatlogger) and shows log attributes
- statehist | hosts, services | parses [compatlog](6-object-types.md#objecttype-compatlogger) and aggregates state change attributes
- hostsbygroup | hostgroups | host attributes grouped by hostgroup and its attributes
- servicesbygroup | servicegroups | service attributes grouped by servicegroup and its attributes
- servicesbyhostgroup | hostgroups | service attributes grouped by hostgroup and its attributes
-
-The `commands` table is populated with `CheckCommand`, `EventCommand` and `NotificationCommand` objects.
-
-A detailed list on the available table attributes can be found in the [Livestatus Schema documentation](23-appendix.md#schema-livestatus).
-
* How was Icinga 2 installed (and which repository in case) and which distribution are you using
* Provide complete configuration snippets explaining your problem in detail
* If the check command failed - what's the output of your manual plugin tests?
-* In case of [debugging](22-debug.md#debug) Icinga 2, the full back traces and outputs
+* In case of [debugging](20-debug.md#debug) Icinga 2, the full back traces and outputs
## <a id="troubleshooting-enable-debug-output"></a> Enable Debug Output
The `icinga2 object list` CLI command can be used to list all configuration objects and their
attributes. The tool also shows where each of the attributes was modified.
-That way you can also identify which objects have been created from your [apply rules](20-language-reference.md#apply).
+That way you can also identify which objects have been created from your [apply rules](18-language-reference.md#apply).
# icinga2 object list
* Check the debug log to see if the check command gets executed
* Verify that failed depedencies do not prevent command execution
* Make sure that the plugin is executable by the Icinga 2 user (run a manual test)
-* Make sure the [checker](8-cli-commands.md#features) feature is enabled.
+* Make sure the [checker](8-cli-commands.md#enable-features) feature is enabled.
Examples:
* Do the notification attributes `states`, `types`, `period` match the notification conditions?
* Do the user attributes `states`, `types`, `period` match the notification conditions?
* Are there any notification `begin` and `end` times configured?
-* Make sure the [notification](8-cli-commands.md#features) feature is enabled.
+* Make sure the [notification](8-cli-commands.md#enable-features) feature is enabled.
* Does the referenced NotificationCommand work when executed as Icinga user on the shell?
If notifications are to be sent via mail make sure that the mail program specified exists.
## <a id="configuration-ignored"></a> Configuration is ignored
-* Make sure that the line(s) are not [commented out](20-language-reference.md#comments) (starting with `//` or `#`, or
+* Make sure that the line(s) are not [commented out](18-language-reference.md#comments) (starting with `//` or `#`, or
encapsulated by `/* ... */`).
* Is the configuration file included in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf)?
## <a id="configuration-attribute-inheritance"></a> Configuration attributes are inherited from
-Icinga 2 allows you to import templates using the [import](20-language-reference.md#template-imports) keyword. If these templates
+Icinga 2 allows you to import templates using the [import](18-language-reference.md#template-imports) keyword. If these templates
contain additional attributes, your objects will automatically inherit them. You can override
or modify these attributes in the current object.
---
...
-If the connection attempt fails or your CA does not match, [verify the master and client certificates](17-troubleshooting.md#troubleshooting-cluster-ssl-certificate-verification).
+If the connection attempt fails or your CA does not match, [verify the master and client certificates](16-troubleshooting.md#troubleshooting-cluster-ssl-certificate-verification).
#### <a id="troubleshooting-cluster-unauthenticated-clients"></a> Cluster Troubleshooting Unauthenticated Clients
[2015-07-13 18:29:26 +1000] notice/ApiEvents: Discarding 'execute command' message from 'icinga-master': Invalid endpoint origin (client not allowed).
-If these messages do not go away, make sure to [verify the master and client certificates](17-troubleshooting.md#troubleshooting-cluster-ssl-certificate-verification).
+If these messages do not go away, make sure to [verify the master and client certificates](16-troubleshooting.md#troubleshooting-cluster-ssl-certificate-verification).
#### <a id="troubleshooting-cluster-ssl-certificate-verification"></a> Cluster Troubleshooting SSL Certificate Verification
will be disconnected. If the connection can't be re-established between zones and endpoints,
they remain in a Split-Brain-mode and history may differ.
-Although the Icinga 2 cluster protocol stores historical events in a [replay log](17-troubleshooting.md#troubleshooting-cluster-replay-log)
+Although the Icinga 2 cluster protocol stores historical events in a [replay log](16-troubleshooting.md#troubleshooting-cluster-replay-log)
for later synchronisation, you should make sure to check why the network connection failed.
### <a id="troubleshooting-cluster-command-endpoint-errors"></a> Cluster Troubleshooting Command Endpoint Errors
* Referenced check plugin not found on the remote client.
* Runtime warnings and errors, e.g. unresolved runtime macros or configuration problems.
* Specific error messages are also populated into `UNKNOWN` check results including a detailed error message in their output.
-* More verbose logs are found inside the [debug log](17-troubleshooting.md#troubleshooting-enable-debug-output).
+* More verbose logs are found inside the [debug log](16-troubleshooting.md#troubleshooting-enable-debug-output).
### <a id="troubleshooting-cluster-config-sync"></a> Cluster Troubleshooting Config Sync
> [Icinga Web 2](2-getting-started.md#setting-up-the-user-interface) provides a dashboard view
> for overdue check results.
-Enable the [debug log](17-troubleshooting.md#troubleshooting-enable-debug-output) on the master
+Enable the [debug log](16-troubleshooting.md#troubleshooting-enable-debug-output) on the master
for more verbose insights.
-If the client cannot authenticate, it's a more general [problem](17-troubleshooting.md#troubleshooting-cluster-unauthenticated-clients).
+If the client cannot authenticate, it's a more general [problem](16-troubleshooting.md#troubleshooting-cluster-unauthenticated-clients).
The client's endpoint is not configured on nor trusted by the master node:
Check the following:
* All clients are connected? (e.g. [cluster health check](13-distributed-monitoring-ha.md#cluster-health-check)).
-* Check your [connection](17-troubleshooting.md#troubleshooting-cluster-connection-errors) in general.
+* Check your [connection](16-troubleshooting.md#troubleshooting-cluster-connection-errors) in general.
* Does the log replay work, e.g. are all events processed and the directory gets cleared up over time?
* Decrease the `log_duration` attribute value for that specific [endpoint](6-object-types.md#objecttype-endpoint).
check_interval = len(MyGroups) * 1m
}
-A list of available functions is available in the [Library Reference](21-library-reference.md#library-reference) chapter.
+A list of available functions is available in the [Library Reference](19-library-reference.md#library-reference) chapter.
## <a id="dictionary-operators"></a> Assignments
In this example the `assign where` condition is a boolean expression which is
evaluated for all objects of type `Host` and a new service with name "ping"
-is created for each matching host. [Expression operators](20-language-reference.md#expression-operators)
+is created for each matching host. [Expression operators](18-language-reference.md#expression-operators)
may be used in `assign where` conditions.
The `to` keyword and the target type may be omitted if there is only one target
## <a id="apply-for"></a> Apply For
-[Apply](20-language-reference.md#apply) rules can be extended with the
-[for loop](20-language-reference.md#for-loops) keyword.
+[Apply](18-language-reference.md#apply) rules can be extended with the
+[for loop](18-language-reference.md#for-loops) keyword.
apply Service "prefix-" for (key => value in host.vars.dictionary) to Host {
import "generic-service"
In this example the `assign where` condition is a boolean expression which is evaluated
for all objects of the type `Host`. Each matching host is added as member to the host group
with the name "linux-servers". Membership exclusion can be controlled using the `ignore where`
-condition. [Expression operators](20-language-reference.md#expression-operators) may be used in `assign where` and
+condition. [Expression operators](18-language-reference.md#expression-operators) may be used in `assign where` and
`ignore where` conditions.
Source Type | Variables
Non-empty dictionary | { key = "value" } | true
For a list of supported expression operators for `assign where` and `ignore where`
-statements, see [expression operators](20-language-reference.md#expression-operators).
+statements, see [expression operators](18-language-reference.md#expression-operators).
## <a id="comments"></a> Comments
keys(String.prototype)
Additional documentation on type methods is available in the
-[library reference](21-library-reference.md#library-reference).
+[library reference](19-library-reference.md#library-reference).
## <a id="reserved-keywords"></a> Reserved Keywords
function contains(str);
Returns `true` if the string `str` was found in the string. If the string
-was not found `false` is returned. Use [find](21-library-reference.md#string-find)
+was not found `false` is returned. Use [find](19-library-reference.md#string-find)
for getting the index instead.
Example:
## <a id="array-type"></a> Array type
-Inherits methods from the [object type](21-library-reference.md#object-type).
+Inherits methods from the [object type](19-library-reference.md#object-type).
### <a id="array-add"></a> Array#add
## <a id="dictionary-type"></a> Dictionary type
-Inherits methods from the [object type](21-library-reference.md#object-type).
+Inherits methods from the [object type](19-library-reference.md#object-type).
### <a id="dictionary-shallow-clone"></a> Dictionary#shallow_clone
## <a id="setting-up-the-user-interface"></a> Setting up Icinga Web 2
Icinga 2 can be used with Icinga Web 2 and a number of other web interfaces.
-This chapter explains how to set up Icinga Web 2. The
-[Alternative Frontends](15-alternative-frontends.md#alternative-frontends)
-chapter can be used as a starting point for installing some of the other web
-interfaces which are also available.
+This chapter explains how to set up Icinga Web 2.
The DB IDO (Database Icinga Data Output) modules for Icinga 2 take care of
exporting all configuration and status information into a database. The IDO
For a long-term migration of your configuration you should consider re-creating
your configuration based on the proposed Icinga 2 configuration paradigm.
-Please read the [next chapter](19-migrating-from-icinga-1x.md#differences-1x-2) to find out more about the differences
+Please read the [next chapter](21-migrating-from-icinga-1x.md#differences-1x-2) to find out more about the differences
between 1.x and 2.
### <a id="manual-config-migration-hints"></a> Manual Config Migration Hints
straight into a possible Icinga 2 format. If you found a different strategy, please
let us know!
-If you require in-depth explanations, please check the [next chapter](19-migrating-from-icinga-1x.md#differences-1x-2).
+If you require in-depth explanations, please check the [next chapter](21-migrating-from-icinga-1x.md#differences-1x-2).
#### <a id="manual-config-migration-hints-Intervals"></a> Manual Config Migration Hints for Intervals
hostgroup_members hg1
}
-This can be migrated to Icinga 2 and [using group assign](20-language-reference.md#group-assign). The additional nested hostgroup
+This can be migrated to Icinga 2 and [using group assign](18-language-reference.md#group-assign). The additional nested hostgroup
`hg1` is included into `hg2` with the `groups` attribute.
#### <a id="manual-config-migration-hints-runtime-macros"></a> Manual Config Migration Hints for Runtime Macros
-Runtime macros have been renamed. A detailed comparison table can be found [here](19-migrating-from-icinga-1x.md#differences-1x-2-runtime-macros).
+Runtime macros have been renamed. A detailed comparison table can be found [here](21-migrating-from-icinga-1x.md#differences-1x-2-runtime-macros).
For example, accessing the service check output looks like the following in Icinga 1.x:
#### <a id="manual-config-migration-hints-contacts-users"></a> Manual Config Migration Hints for Contacts (Users)
Contacts in Icinga 1.x act as users in Icinga 2, but do not have any notification commands specified.
-This migration part is explained in the [next chapter](19-migrating-from-icinga-1x.md#manual-config-migration-hints-notifications).
+This migration part is explained in the [next chapter](21-migrating-from-icinga-1x.md#manual-config-migration-hints-notifications).
define contact{
contact_name testconfig-user
email icinga@localhost
}
-The `service_notification_options` can be [mapped](19-migrating-from-icinga-1x.md#manual-config-migration-hints-notification-filters)
+The `service_notification_options` can be [mapped](21-migrating-from-icinga-1x.md#manual-config-migration-hints-notification-filters)
into generic `state` and `type` filters, if additional notification filtering is required. `alias` gets
renamed to `display_name`.
Convert the `notification_options` attribute from Icinga 1.x to Icinga 2 `states` and `types`. Details
-[here](19-migrating-from-icinga-1x.md#manual-config-migration-hints-notification-filters). Add the notification period.
+[here](21-migrating-from-icinga-1x.md#manual-config-migration-hints-notification-filters). Add the notification period.
states = [ OK, Warning, Critical ]
types = [ Recovery, Problem, Custom ]
assign where "hg_svcdep2" in host.groups
}
-Host dependencies are explained in the [next chapter](19-migrating-from-icinga-1x.md#manual-config-migration-hints-host-parents).
+Host dependencies are explained in the [next chapter](21-migrating-from-icinga-1x.md#manual-config-migration-hints-host-parents).
### <a id="differences-1x-2-main-config"></a> Main Config File
In Icinga 1.x there are many global configuration settings available in `icinga.cfg`.
-Icinga 2 only uses a small set of [global constants](20-language-reference.md#constants) allowing
+Icinga 2 only uses a small set of [global constants](18-language-reference.md#constants) allowing
you to specify certain different setting such as the `NodeName` in a cluster scenario.
Aside from that, the [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) should take care of including
-global constants, enabled [features](8-cli-commands.md#features) and the object configuration.
+global constants, enabled [features](8-cli-commands.md#enable-features) and the object configuration.
### <a id="differences-1x-2-include-files-dirs"></a> Include Files and Directories
const PluginDir = "/usr/lib/nagios/plugins"
-[Global macros](20-language-reference.md#constants) can only be defined once. Trying to modify a
+[Global macros](18-language-reference.md#constants) can only be defined once. Trying to modify a
global constant will result in an error.
### <a id="differences-1x-2-configuration-comments"></a> Configuration Comments
are separated from the command name using an exclamation mark (`!`).
Please check the migration hints for a detailed
-[migration example](19-migrating-from-icinga-1x.md#manual-config-migration-hints-check-command-arguments).
+[migration example](21-migrating-from-icinga-1x.md#manual-config-migration-hints-check-command-arguments).
> **Note**
>
For detailed examples on how to use the dependencies please check the [dependencies](3-monitoring-basics.md#dependencies)
chapter.
-Dependencies can be applied to hosts or services using the [apply rules](20-language-reference.md#apply).
+Dependencies can be applied to hosts or services using the [apply rules](18-language-reference.md#apply).
The `StatusDataWriter`, `IdoMysqlConnection` and `LivestatusListener` types
support the Icinga 1.x schema with dependencies and parent attributes for
The `address` attribute is used by check commands to determine which network
address is associated with the host object.
-Details on troubleshooting check problems can be found [here](17-troubleshooting.md#troubleshooting).
+Details on troubleshooting check problems can be found [here](16-troubleshooting.md#troubleshooting).
### <a id="host-states"></a> Host States
Valid values for custom attributes include:
-* [Strings](20-language-reference.md#string-literals), [numbers](20-language-reference.md#numeric-literals) and [booleans](20-language-reference.md#boolean-literals)
-* [Arrays](20-language-reference.md#array) and [dictionaries](20-language-reference.md#dictionary)
+* [Strings](18-language-reference.md#string-literals), [numbers](18-language-reference.md#numeric-literals) and [booleans](18-language-reference.md#boolean-literals)
+* [Arrays](18-language-reference.md#array) and [dictionaries](18-language-reference.md#dictionary)
* [Functions](3-monitoring-basics.md#custom-attributes-functions)
### <a id="custom-attributes-functions"></a> Functions as Custom Attributes
-Icinga 2 lets you specify [functions](20-language-reference.md#functions) for custom attributes.
+Icinga 2 lets you specify [functions](18-language-reference.md#functions) for custom attributes.
The special case here is that whenever Icinga 2 needs the value for such a custom attribute it runs
the function and uses whatever value the function returns:
vars.text = {{ Math.random() * 100 }}
}
-This example uses the [abbreviated lambda syntax](20-language-reference.md#nullary-lambdas).
+This example uses the [abbreviated lambda syntax](18-language-reference.md#nullary-lambdas).
These functions have access to a number of variables:
Instead of assigning each object ([Service](6-object-types.md#objecttype-service),
[Notification](6-object-types.md#objecttype-notification), [Dependency](6-object-types.md#objecttype-dependency),
[ScheduledDowntime](6-object-types.md#objecttype-scheduleddowntime))
-based on attribute identifiers for example `host_name` objects can be [applied](20-language-reference.md#apply).
+based on attribute identifiers for example `host_name` objects can be [applied](18-language-reference.md#apply).
Before you start using the apply rules keep the following in mind:
* Define the best match.
* A set of unique [custom attributes](3-monitoring-basics.md#custom-attributes) for these hosts/services?
* Or [group](3-monitoring-basics.md#groups) memberships, e.g. a host being a member of a hostgroup, applying services to it?
- * A generic pattern [match](20-language-reference.md#function-calls) on the host/service name?
- * [Multiple expressions combined](3-monitoring-basics.md#using-apply-expressions) with `&&` or `||` [operators](20-language-reference.md#expression-operators)
+ * A generic pattern [match](18-language-reference.md#function-calls) on the host/service name?
+ * [Multiple expressions combined](3-monitoring-basics.md#using-apply-expressions) with `&&` or `||` [operators](18-language-reference.md#expression-operators)
* All expressions must return a boolean value (an empty string is equal to `false` e.g.)
> **Note**
`OR` the host custom attribute `always_notify` is set to `true`.
The notification is ignored for services whose host name ends with `*internal`
-`OR` the `priority` custom attribute is [less than](20-language-reference.md#expression-operators) `2`.
+`OR` the `priority` custom attribute is [less than](18-language-reference.md#expression-operators) `2`.
template Notification "cust-xy-notification" {
users = [ "noc-xy", "mgmt-xy" ]
and all members of the user group `noc` will get notified.
It is also possible to generally apply a notification template and dynamically overwrite values from
-the template by checking for custom attributes. This can be achieved by using [conditional statements](20-language-reference.md#conditional-statements):
+the template by checking for custom attributes. This can be achieved by using [conditional statements](18-language-reference.md#conditional-statements):
apply Notification "host-mail-noc" to Host {
import "mail-host-notification"
Next to the standard way of using [apply rules](3-monitoring-basics.md#using-apply)
there is the requirement of applying objects based on a set (array or
-dictionary) using [apply for](20-language-reference.md#apply-for) expressions.
+dictionary) using [apply for](18-language-reference.md#apply-for) expressions.
The sample configuration already includes a detailed example in [hosts.conf](4-configuring-icinga-2.md#hosts-conf)
and [services.conf](4-configuring-icinga-2.md#services-conf) for this use case.
provided host attributes. For strings, you can use string concatention with the `+` operator.
You can also specifiy the display_name, check command, interval, notes, notes_url, action_url, etc.
-attributes that way. Attribute strings can be [concatenated](20-language-reference.md#expression-operators),
+attributes that way. Attribute strings can be [concatenated](18-language-reference.md#expression-operators),
for example for adding a more detailed service `display_name`.
-This example also uses [if conditions](20-language-reference.md#conditional-statements)
+This example also uses [if conditions](18-language-reference.md#conditional-statements)
if specific values are not set, adding a local default value.
The other way around you can override specific custom attributes inherited from a service template,
if set.
group.
Details on the `assign where` syntax can be found in the
-[Language Reference](20-language-reference.md#apply)
+[Language Reference](18-language-reference.md#apply)
## <a id="notifications"></a> Notifications
If you don't set the `states` and `types` configuration attributes for the `User`
object, notifications for all states and types will be sent.
-Details on troubleshooting notification problems can be found [here](17-troubleshooting.md#troubleshooting).
+Details on troubleshooting notification problems can be found [here](16-troubleshooting.md#troubleshooting).
> **Note**
>
-> Make sure that the [notification](8-cli-commands.md#features) feature is enabled
+> Make sure that the [notification](8-cli-commands.md#enable-features) feature is enabled
> in order to execute notification commands.
You should choose which information you (and your notified users) are interested in
> **Note**
>
-> Make sure that the [checker](8-cli-commands.md#features) feature is enabled in order to
+> Make sure that the [checker](8-cli-commands.md#enable-features) feature is enabled in order to
> execute checks.
#### <a id="command-plugin-integration"></a> Integrate the Plugin with a CheckCommand Definition
> **Note**
>
-> Make sure that the [notification](8-cli-commands.md#features) feature is enabled
+> Make sure that the [notification](8-cli-commands.md#enable-features) feature is enabled
> in order to execute notification commands.
Below is an example using runtime macros from Icinga 2 (such as `$service.output$` for
dependency will fail and render all child objects (hosts or services) unreachable.
You can determine the child's reachability by querying the `is_reachable` attribute
-in for example [DB IDO](23-appendix.md#schema-db-ido-extensions).
+in for example [DB IDO](22-appendix.md#schema-db-ido-extensions).
### <a id="dependencies-implicit-host-service"></a> Implicit Dependencies for Services on Host
are a good way to start with Icinga 2.
If you're interested in a detailed explanation of each language feature used in those
-configuration files you can find more information in the [Language Reference](20-language-reference.md#language-reference)
+configuration files you can find more information in the [Language Reference](18-language-reference.md#language-reference)
chapter.
## <a id="configuration-best-practice"></a> Configuration Best Practice
* to the documentation that is distributed as part of Icinga 2.
*/
-Icinga 2 supports [C/C++-style comments](20-language-reference.md#comments).
+Icinga 2 supports [C/C++-style comments](18-language-reference.md#comments).
/**
* The constants.conf defines global constants.
This `include` directive takes care of including the configuration files for all
the features which have been enabled with `icinga2 feature enable`. See
-[Enabling/Disabling Features](8-cli-commands.md#features) for more details.
+[Enabling/Disabling Features](8-cli-commands.md#enable-features) for more details.
/**
* The repository.d directory contains all configuration objects
> **Tip**
>
-> If you don't understand all the attributes and how to use [apply rules](20-language-reference.md#apply)
+> If you don't understand all the attributes and how to use [apply rules](18-language-reference.md#apply)
> don't worry - the [monitoring basics](3-monitoring-basics.md#monitoring-basics) chapter will explain
> that in detail.
#### <a id="services-conf"></a> services.conf
-These service [apply rules](20-language-reference.md#apply) will show you how to monitor
+These service [apply rules](18-language-reference.md#apply) will show you how to monitor
the local host, but also allow you to re-use or modify them for
your own requirements.
In this example the `assign where` condition is a boolean expression which is
evaluated for all objects of type `Host` and a new service with name "load"
-is created for each matching host. [Expression operators](20-language-reference.md#expression-operators)
+is created for each matching host. [Expression operators](18-language-reference.md#expression-operators)
may be used in `assign where` conditions.
Multiple `assign where` condition can be combined with `AND` using the `&&` operator
attribute defined `AND` having the custom attribute `os` set to the string
`Linux`.
You can modify this condition to match multiple expressions by combinding `AND`
-and `OR` using `&&` and `||` [operators](20-language-reference.md#expression-operators), for example
+and `OR` using `&&` and `||` [operators](18-language-reference.md#expression-operators), for example
`assign where host.address && (vars.os == "Linux" || vars.os == "Windows")`.
custom attribute `os` set to `Linux` and is therefore automatically
a member of the host group `linux-servers`.
-This is done by using the [group assign](20-language-reference.md#group-assign) expressions similar
+This is done by using the [group assign](18-language-reference.md#group-assign) expressions similar
to previously seen [apply rules](3-monitoring-basics.md#using-apply).
object HostGroup "linux-servers" {
}
Service groups can be grouped together by similar pattern matches.
-The [match() function](20-language-reference.md#function-calls) expects a wildcard match string
+The [match() function](18-language-reference.md#function-calls) expects a wildcard match string
and the attribute string to match with.
object ServiceGroup "ping" {
### <a id="scheduling-downtime"></a> Scheduling a downtime
-This can either happen through a web interface or by sending an [external command](5-advanced-topics.md#external-commands)
+This can either happen through a web interface or by sending an [external command](15-features.md#external-commands)
to the external command pipe provided by the `ExternalCommandListener` configuration.
Fixed downtimes require a start and end time (a duration will be ignored).
Tips when implementing functions:
-* Use [log()](21-library-reference.md#global-functions) to dump variables. You can see the output
+* Use [log()](19-library-reference.md#global-functions) to dump variables. You can see the output
inside the `icinga2.log` file depending in your log severity
* Use the `icinga2 console` to test basic functionality (e.g. iterating over a dictionary)
* Build them step-by-step. You can always refactor your code later on.
The more significant problem was to only add the command parameter `--disk` to the plugin call
when the dictionary `compellent` contains the key `disks`, and omit it if not found.
-By defining `set_if` as [abbreviated lambda function](20-language-reference.md#nullary-lambdas)
+By defining `set_if` as [abbreviated lambda function](18-language-reference.md#nullary-lambdas)
and evaluating the host custom attribute `compellent` containing the `disks` this problem was
solved like this:
}
}
-This implementation uses the dictionary type method [contains](21-library-reference.md#dictionary-contains)
+This implementation uses the dictionary type method [contains](19-library-reference.md#dictionary-contains)
and will fail if `host.vars.compellent` is not of the type `Dictionary`.
-Therefore you can extend the checks using the [typeof](20-language-reference.md#types) function.
+Therefore you can extend the checks using the [typeof](18-language-reference.md#types) function.
You can test the types using the `icinga2 console`:
## <a id="access-object-attributes-at-runtime"></a> Access Object Attributes at Runtime
-The [Object Accessor Functions](21-library-reference.md#object-accessor-functions)
+The [Object Accessor Functions](19-library-reference.md#object-accessor-functions)
can be used to retrieve references to other objects by name.
This allows you to access configuration and runtime object attributes. A detailed
service recheck will automatically trigger a notification unless the
service is acknowledged or in a scheduled downtime.
+## <a id="api"></a> Icinga 2 API
-## <a id="external-commands"></a> External Commands
+The Icinga 2 API allows you to manage configuration objects
+and resources in a simple, programmatic way using HTTP requests.
-Icinga 2 provides an external command pipe for processing commands
-triggering specific actions (for example rescheduling a service check
-through the web interface).
+More details can be found in [this chapter](9-icinga2-api.md#icinga2-api).
-In order to enable the `ExternalCommandListener` configuration use the
-following command and restart Icinga 2 afterwards:
+## <a id="features"></a> Icinga 2 Feature Configuration
- # icinga2 feature enable command
+Icinga 2 provides several features which can be enabled using [CLI commands](8-cli-commands.md#cli-command-feature).
-Icinga 2 creates the command pipe file as `/var/run/icinga2/cmd/icinga2.cmd`
-using the default configuration.
+More details can be found in [this chapter](15-features.md#icinga2-features).
-Web interfaces and other Icinga addons are able to send commands to
-Icinga 2 through the external command pipe, for example for rescheduling
-a forced service check:
- # /bin/echo "[`date +%s`] SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;`date +%s`" >> /var/run/icinga2/cmd/icinga2.cmd
-
- # tail -f /var/log/messages
-
- Oct 17 15:01:25 icinga-server icinga2: Executing external command: [1382014885] SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;1382014885
- Oct 17 15:01:25 icinga-server icinga2: Rescheduling next check for service 'ping4'
-
-A list of currently supported external commands can be found [here](23-appendix.md#external-commands-list-detail).
-
-Detailed information on the commands and their required parameters can be found
-on the [Icinga 1.x documentation](http://docs.icinga.org/latest/en/extcommands2.html).
-
-## <a id="logging"></a> Logging
-
-Icinga 2 supports three different types of logging:
-
-* File logging
-* Syslog (on *NIX-based operating systems)
-* Console logging (`STDOUT` on tty)
-
-You can enable additional loggers using the `icinga2 feature enable`
-and `icinga2 feature disable` commands to configure loggers:
-
-Feature | Description
----------|------------
-debuglog | Debug log (path: `/var/log/icinga2/debug.log`, severity: `debug` or higher)
-mainlog | Main log (path: `/var/log/icinga2/icinga2.log`, severity: `information` or higher)
-syslog | Syslog (severity: `warning` or higher)
-
-By default file the `mainlog` feature is enabled. When running Icinga 2
-on a terminal log messages with severity `information` or higher are
-written to the console.
-
-## <a id="performance-data"></a> Performance Data
-
-When a host or service check is executed plugins should provide so-called
-`performance data`. Next to that additional check performance data
-can be fetched using Icinga 2 runtime macros such as the check latency
-or the current service state (or additional custom attributes).
-
-The performance data can be passed to external applications which aggregate and
-store them in their backends. These tools usually generate graphs for historical
-reporting and trending.
-
-Well-known addons processing Icinga performance data are [PNP4Nagios](14-addons-plugins.md#addons-graphing-pnp),
-[Graphite](14-addons-plugins.md#addons-graphing-graphite) or [OpenTSDB](5-advanced-topics.md#opentsdb-writer).
-
-### <a id="writing-performance-data-files"></a> Writing Performance Data Files
-
-PNP4Nagios and Graphios use performance data collector daemons to fetch
-the current performance files for their backend updates.
-
-Therefore the Icinga 2 [PerfdataWriter](6-object-types.md#objecttype-perfdatawriter)
-feature allows you to define the output template format for host and services helped
-with Icinga 2 runtime vars.
-
- host_format_template = "DATATYPE::HOSTPERFDATA\tTIMET::$icinga.timet$\tHOSTNAME::$host.name$\tHOSTPERFDATA::$host.perfdata$\tHOSTCHECKCOMMAND::$host.check_command$\tHOSTSTATE::$host.state$\tHOSTSTATETYPE::$host.state_type$"
- service_format_template = "DATATYPE::SERVICEPERFDATA\tTIMET::$icinga.timet$\tHOSTNAME::$host.name$\tSERVICEDESC::$service.name$\tSERVICEPERFDATA::$service.perfdata$\tSERVICECHECKCOMMAND::$service.check_command$\tHOSTSTATE::$host.state$\tHOSTSTATETYPE::$host.state_type$\tSERVICESTATE::$service.state$\tSERVICESTATETYPE::$service.state_type$"
-
-The default templates are already provided with the Icinga 2 feature configuration
-which can be enabled using
-
- # icinga2 feature enable perfdata
-
-By default all performance data files are rotated in a 15 seconds interval into
-the `/var/spool/icinga2/perfdata/` directory as `host-perfdata.<timestamp>` and
-`service-perfdata.<timestamp>`.
-External collectors need to parse the rotated performance data files and then
-remove the processed files.
-
-### <a id="graphite-carbon-cache-writer"></a> Graphite Carbon Cache Writer
-
-While there are some [Graphite](14-addons-plugins.md#addons-graphing-graphite)
-collector scripts and daemons like Graphios available for Icinga 1.x it's more
-reasonable to directly process the check and plugin performance
-in memory in Icinga 2. Once there are new metrics available, Icinga 2 will directly
-write them to the defined Graphite Carbon daemon tcp socket.
-
-You can enable the feature using
-
- # icinga2 feature enable graphite
-
-By default the [GraphiteWriter](6-object-types.md#objecttype-graphitewriter) feature
-expects the Graphite Carbon Cache to listen at `127.0.0.1` on TCP port `2003`.
-
-#### <a id="graphite-carbon-cache-writer-schema"></a> Current Graphite Schema
-
-The current naming schema is defined as follows. The official Icinga Web 2 Graphite
-module will use that schema too.
-
-The default prefix for hosts and services is configured using
-[runtime macros](3-monitoring-basics.md#runtime-macros)like this:
-
- icinga2.$host.name$.host.$host.check_command$
- icinga2.$host.name$.services.$service.name$.$service.check_command$
-
-You can customize the prefix name by using the `host_name_template` and
-`service_name_template` configuration attributes.
-
-The additional levels will allow fine granular filters and also template
-capabilities, e.g. by using the check command `disk` for specific
-graph templates in web applications rendering the Graphite data.
-
-The following characters are escaped in prefix labels:
-
- Character | Escaped character
- --------------|--------------------------
- whitespace | _
- . | _
- \ | _
- / | _
-
-Metric values are stored like this:
-
- <prefix>.perfdata.<perfdata-label>.value
-
-The following characters are escaped in perfdata labels:
-
- Character | Escaped character
- --------------|--------------------------
- whitespace | _
- \ | _
- / | _
- :: | .
-
-Note that perfdata labels may contain dots (`.`) allowing to
-add more subsequent levels inside the Graphite tree.
-`::` adds support for [multi performance labels](http://my-plugin.de/wiki/projects/check_multi/configuration/performance)
-and is therefore replaced by `.`.
-
-By enabling `enable_send_thresholds` Icinga 2 automatically adds the following threshold metrics:
-
- <prefix>.perfdata.<perfdata-label>.min
- <prefix>.perfdata.<perfdata-label>.max
- <prefix>.perfdata.<perfdata-label>.warn
- <prefix>.perfdata.<perfdata-label>.crit
-
-By enabling `enable_send_metadata` Icinga 2 automatically adds the following metadata metrics:
-
- <prefix>.metadata.current_attempt
- <prefix>.metadata.downtime_depth
- <prefix>.metadata.execution_time
- <prefix>.metadata.latency
- <prefix>.metadata.max_check_attempts
- <prefix>.metadata.reachable
- <prefix>.metadata.state
- <prefix>.metadata.state_type
-
-Metadata metric overview:
-
- metric | description
- -------------------|------------------------------------------
- current_attempt | current check attempt
- max_check_attempts | maximum check attempts until the hard state is reached
- reachable | checked object is reachable
- downtime_depth | number of downtimes this object is in
- execution_time | check execution time
- latency | check latency
- state | current state of the checked object
- state_type | 0=SOFT, 1=HARD state
-
-The following example illustrates how to configure the storage schemas for Graphite Carbon
-Cache.
-
- [icinga2_default]
- # intervals like PNP4Nagios uses them per default
- pattern = ^icinga2\.
- retentions = 1m:2d,5m:10d,30m:90d,360m:4y
-
-#### <a id="graphite-carbon-cache-writer-schema-legacy"></a> Graphite Schema < 2.4
-
-In order to restore the old legacy schema, you'll need to adopt the `GraphiteWriter`
-configuration:
-
- object GraphiteWriter "graphite" {
-
- enable_legacy_mode = true
-
- host_name_template = "icinga.$host.name$"
- service_name_template = "icinga.$host.name$.$service.name$"
- }
-
-The old legacy naming schema is
-
- icinga.<hostname>.<metricname>
- icinga.<hostname>.<servicename>.<metricname>
-
-You can customize the metric prefix name by using the `host_name_template` and
-`service_name_template` configuration attributes.
-
-The example below uses [runtime macros](3-monitoring-basics.md#runtime-macros) and a
-[global constant](20-language-reference.md#constants) named `GraphiteEnv`. The constant name
-is freely definable and should be put in the [constants.conf](4-configuring-icinga-2.md#constants-conf) file.
-
- const GraphiteEnv = "icinga.env1"
-
- object GraphiteWriter "graphite" {
- host_name_template = GraphiteEnv + ".$host.name$"
- service_name_template = GraphiteEnv + ".$host.name$.$service.name$"
- }
-
-To make sure Icinga 2 writes a valid label into Graphite some characters are replaced
-with `_` in the target name:
-
- \/.- (and space)
-
-The resulting name in Graphite might look like:
-
- www-01 / http-cert / response time
- icinga.www_01.http_cert.response_time
-
-In addition to the performance data retrieved from the check plugin, Icinga 2 sends
-internal check statistic data to Graphite:
-
- metric | description
- -------------------|------------------------------------------
- current_attempt | current check attempt
- max_check_attempts | maximum check attempts until the hard state is reached
- reachable | checked object is reachable
- downtime_depth | number of downtimes this object is in
- execution_time | check execution time
- latency | check latency
- state | current state of the checked object
- state_type | 0=SOFT, 1=HARD state
-
-The following example illustrates how to configure the storage-schemas for Graphite Carbon
-Cache. Please make sure that the order is correct because the first match wins.
-
- [icinga_internals]
- pattern = ^icinga\..*\.(max_check_attempts|reachable|current_attempt|execution_time|latency|state|state_type)
- retentions = 5m:7d
-
- [icinga_default]
- # intervals like PNP4Nagios uses them per default
- pattern = ^icinga\.
- retentions = 1m:2d,5m:10d,30m:90d,360m:4y
-
-### <a id="gelfwriter"></a> GELF Writer
-
-The `Graylog Extended Log Format` (short: [GELF](http://www.graylog2.org/resources/gelf))
-can be used to send application logs directly to a TCP socket.
-
-While it has been specified by the [graylog2](http://www.graylog2.org/) project as their
-[input resource standard](http://www.graylog2.org/resources/gelf), other tools such as
-[Logstash](http://www.logstash.net) also support `GELF` as
-[input type](http://logstash.net/docs/latest/inputs/gelf).
-
-You can enable the feature using
-
- # icinga2 feature enable gelf
-
-By default the `GelfWriter` object expects the GELF receiver to listen at `127.0.0.1` on TCP port `12201`.
-The default `source` attribute is set to `icinga2`. You can customize that for your needs if required.
-
-Currently these events are processed:
-* Check results
-* State changes
-* Notifications
-
-### <a id="opentsdb-writer"></a> OpenTSDB Writer
-
-While there are some OpenTSDB collector scripts and daemons like tcollector available for
-Icinga 1.x it's more reasonable to directly process the check and plugin performance
-in memory in Icinga 2. Once there are new metrics available, Icinga 2 will directly
-write them to the defined TSDB TCP socket.
-
-You can enable the feature using
-
- # icinga2 feature enable opentsdb
-
-By default the `OpenTsdbWriter` object expects the TSD to listen at
-`127.0.0.1` on port `4242`.
-
-The current naming schema is
-
- icinga.host.<metricname>
- icinga.service.<servicename>.<metricname>
-
-for host and service checks. The tag host is always applied.
-
-To make sure Icinga 2 writes a valid metric into OpenTSDB some characters are replaced
-with `_` in the target name:
-
- \ (and space)
-
-The resulting name in OpenTSDB might look like:
-
- www-01 / http-cert / response time
- icinga.http_cert.response_time
-
-In addition to the performance data retrieved from the check plugin, Icinga 2 sends
-internal check statistic data to OpenTSDB:
-
- metric | description
- -------------------|------------------------------------------
- current_attempt | current check attempt
- max_check_attempts | maximum check attempts until the hard state is reached
- reachable | checked object is reachable
- downtime_depth | number of downtimes this object is in
- execution_time | check execution time
- latency | check latency
- state | current state of the checked object
- state_type | 0=SOFT, 1=HARD state
-
-While reachable, state and state_type are metrics for the host or service the
-other metrics follow the current naming schema
-
- icinga.check.<metricname>
-
-with the following tags
-
- tag | description
- --------|------------------------------------------
- type | the check type, one of [host, service]
- host | hostname, the check ran on
- service | the service name (if type=service)
-
-> **Note**
->
-> You might want to set the tsd.core.auto_create_metrics setting to `true`
-> in your opentsdb.conf configuration file.
-
-
-## <a id="status-data"></a> Status Data
-
-Icinga 1.x writes object configuration data and status data in a cyclic
-interval to its `objects.cache` and `status.dat` files. Icinga 2 provides
-the `StatusDataWriter` object which dumps all configuration objects and
-status updates in a regular interval.
-
- # icinga2 feature enable statusdata
-
-Icinga 1.x Classic UI requires this data set as part of its backend.
-
-> **Note**
->
-> If you are not using any web interface or addon which uses these files
-> you can safely disable this feature.
-
-
-## <a id="compat-logging"></a> Compat Logging
-
-The Icinga 1.x log format is considered being the `Compat Log`
-in Icinga 2 provided with the `CompatLogger` object.
-
-These logs are not only used for informational representation in
-external web interfaces parsing the logs, but also to generate
-SLA reports and trends in Icinga 1.x Classic UI. Furthermore the
-[Livestatus](16-livestatus.md#setting-up-livestatus) feature uses these logs for answering queries to
-historical tables.
-
-The `CompatLogger` object can be enabled with
-
- # icinga2 feature enable compatlog
-
-By default, the Icinga 1.x log file called `icinga.log` is located
-in `/var/log/icinga2/compat`. Rotated log files are moved into
-`var/log/icinga2/compat/archives`.
-
-The format cannot be changed without breaking compatibility to
-existing log parsers.
-
- # tail -f /var/log/icinga2/compat/icinga.log
-
- [1382115688] LOG ROTATION: HOURLY
- [1382115688] LOG VERSION: 2.0
- [1382115688] HOST STATE: CURRENT;localhost;UP;HARD;1;
- [1382115688] SERVICE STATE: CURRENT;localhost;disk;WARNING;HARD;1;
- [1382115688] SERVICE STATE: CURRENT;localhost;http;OK;HARD;1;
- [1382115688] SERVICE STATE: CURRENT;localhost;load;OK;HARD;1;
- [1382115688] SERVICE STATE: CURRENT;localhost;ping4;OK;HARD;1;
- [1382115688] SERVICE STATE: CURRENT;localhost;ping6;OK;HARD;1;
- [1382115688] SERVICE STATE: CURRENT;localhost;processes;WARNING;HARD;1;
- [1382115688] SERVICE STATE: CURRENT;localhost;ssh;OK;HARD;1;
- [1382115688] SERVICE STATE: CURRENT;localhost;users;OK;HARD;1;
- [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;disk;1382115705
- [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;http;1382115705
- [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;load;1382115705
- [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;1382115705
- [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;ping6;1382115705
- [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;processes;1382115705
- [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;ssh;1382115705
- [1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;users;1382115705
- [1382115731] EXTERNAL COMMAND: PROCESS_SERVICE_CHECK_RESULT;localhost;ping6;2;critical test|
- [1382115731] SERVICE ALERT: localhost;ping6;CRITICAL;SOFT;2;critical test
-
-
-
-
-## <a id="db-ido"></a> DB IDO
-
-The IDO (Icinga Data Output) modules for Icinga 2 take care of exporting all
-configuration and status information into a database. The IDO database is used
-by a number of projects including Icinga Web 1.x and 2.
-
-Details on the installation can be found in the [Configuring DB IDO](2-getting-started.md#configuring-db-ido-mysql)
-chapter. Details on the configuration can be found in the
-[IdoMysqlConnection](6-object-types.md#objecttype-idomysqlconnection) and
-[IdoPgsqlConnection](6-object-types.md#objecttype-idopgsqlconnection)
-object configuration documentation.
-The DB IDO feature supports [High Availability](13-distributed-monitoring-ha.md#high-availability-db-ido) in
-the Icinga 2 cluster.
-
-The following example query checks the health of the current Icinga 2 instance
-writing its current status to the DB IDO backend table `icinga_programstatus`
-every 10 seconds. By default it checks 60 seconds into the past which is a reasonable
-amount of time - adjust it for your requirements. If the condition is not met,
-the query returns an empty result.
-
-> **Tip**
->
-> Use [check plugins](14-addons-plugins.md#plugins) to monitor the backend.
-
-Replace the `default` string with your instance name, if different.
-
-Example for MySQL:
-
- # mysql -u root -p icinga -e "SELECT status_update_time FROM icinga_programstatus ps
- JOIN icinga_instances i ON ps.instance_id=i.instance_id
- WHERE (UNIX_TIMESTAMP(ps.status_update_time) > UNIX_TIMESTAMP(NOW())-60)
- AND i.instance_name='default';"
-
- +---------------------+
- | status_update_time |
- +---------------------+
- | 2014-05-29 14:29:56 |
- +---------------------+
-
-
-Example for PostgreSQL:
-
- # export PGPASSWORD=icinga; psql -U icinga -d icinga -c "SELECT ps.status_update_time FROM icinga_programstatus AS ps
- JOIN icinga_instances AS i ON ps.instance_id=i.instance_id
- WHERE ((SELECT extract(epoch from status_update_time) FROM icinga_programstatus) > (SELECT extract(epoch from now())-60))
- AND i.instance_name='default'";
-
- status_update_time
- ------------------------
- 2014-05-29 15:11:38+02
- (1 Zeile)
-
-
-A detailed list on the available table attributes can be found in the [DB IDO Schema documentation](23-appendix.md#schema-db-ido).
-
-
-## <a id="check-result-files"></a> Check Result Files
-
-Icinga 1.x writes its check result files to a temporary spool directory
-where they are processed in a regular interval.
-While this is extremely inefficient in performance regards it has been
-rendered useful for passing passive check results directly into Icinga 1.x
-skipping the external command pipe.
-
-Several clustered/distributed environments and check-aggregation addons
-use that method. In order to support step-by-step migration of these
-environments, Icinga 2 supports the `CheckResultReader` object.
-
-There is no feature configuration available, but it must be defined
-on-demand in your Icinga 2 objects configuration.
-
- object CheckResultReader "reader" {
- spool_dir = "/data/check-results"
- }
enable_send_metadata | **Optional.** Send additional metadata metrics. Defaults to `false`.
enable_legacy_mode | **Optional.** Enable legacy mode for schema < 2.4. **Note**: This will be removed in future versions.
-Additional usage examples can be found [here](5-advanced-topics.md#graphite-carbon-cache-writer).
+Additional usage examples can be found [here](15-features.md#graphite-carbon-cache-writer).
> **Best Practice**
>
-> Assign host group members using the [group assign](20-language-reference.md#group-assign) rules.
+> Assign host group members using the [group assign](18-language-reference.md#group-assign) rules.
Example:
> **Best Practice**
>
-> Assign service group members using the [group assign](20-language-reference.md#group-assign) rules.
+> Assign service group members using the [group assign](18-language-reference.md#group-assign) rules.
Example:
> **Best Practice**
>
-> Assign user group members using the [group assign](20-language-reference.md#group-assign) rules.
+> Assign user group members using the [group assign](18-language-reference.md#group-assign) rules.
Example:
For test and demo purposes only. The `random` check command does not support
any vars.
+
# <a id="plugin-check-commands"></a> Plugin Check Commands
+## <a id="plugin-check-commands-monitoring-plugins"></a> Plugin Check Commands for Monitoring Plugins
+
The Plugin Check Commands provides example configuration for plugin check commands
provided by the Monitoring Plugins project.
The plugin check commands assume that there's a global constant named `PluginDir`
which contains the path of the plugins from the Monitoring Plugins project.
-## <a id="plugin-check-command-apt"></a> apt
+##
# <a id="plugin-check-command-apt"></a> apt
Check command for the `check_apt` plugin.
The `apt` check command does not support any vars.
-## <a id="plugin-check-command-by-ssh"></a> by_ssh
+##
# <a id="plugin-check-command-by-ssh"></a> by_ssh
Check command object for the `check_by_ssh` plugin.
by_ssh_timeout | **Optional.** The timeout in seconds.
-## <a id="plugin-check-command-dhcp"></a> dhcp
+##
# <a id="plugin-check-command-dhcp"></a> dhcp
Check command object for the `check_dhcp` plugin.
dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false.
-## <a id="plugin-check-command-dig"></a> dig
+##
# <a id="plugin-check-command-dig"></a> dig
Check command object for the `check_dig` plugin.
dig_timeout | **Optional.** Seconds before connection times out (default: 10).
-## <a id="plugin-check-command-disk"></a> disk
+##
# <a id="plugin-check-command-disk"></a> disk
Check command object for the `check_disk` plugin.
disk_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB).
disk_exclude_type | **Optional.** Ignore all filesystems of indicated type (may be repeated).
-## <a id="plugin-check-command-disk-smb"></a> disk_smb
+##
# <a id="plugin-check-command-disk-smb"></a> disk_smb
Check command object for the `check_disk_smb` plugin.
disk_smb_cused | **Optional.** The used space critical threshold. Defaults to "95%". If the percent sign is omitted, use optional disk units.
disk_smb_port | **Optional.** Connection port, e.g. `139` or `445`. Defaults to `smbclient` default if omitted.
-## <a id="plugin-check-command-dns"></a> dns
+##
# <a id="plugin-check-command-dns"></a> dns
Check command object for the `check_dns` plugin.
dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
-## <a id="plugin-check-command-dummy"></a> dummy
+##
# <a id="plugin-check-command-dummy"></a> dummy
Check command object for the `check_dummy` plugin.
dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
-## <a id="plugin-check-command-fping4"></a> fping4
+##
# <a id="plugin-check-command-fping4"></a> fping4
Check command object for the `check_fping` plugin.
fping_source_interface | **Optional.** The source interface name.
-## <a id="plugin-check-command-fping6"></a> fping6
+##
# <a id="plugin-check-command-fping6"></a> fping6
Check command object for the `check_fping` plugin.
fping_source_interface | **Optional.** The source interface name.
-## <a id="plugin-check-command-ftp"></a> ftp
+##
# <a id="plugin-check-command-ftp"></a> ftp
Check command object for the `check_ftp` plugin.
ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
-## <a id="plugin-check-command-hostalive"></a> hostalive
+##
# <a id="plugin-check-command-hostalive"></a> hostalive
Check command object for the `check_ping` plugin with host check default values. This variant
uses the host's `address` attribute if available and falls back to using the `address6` attribute
ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
-## <a id="plugin-check-command-hostalive4"></a> hostalive4
+##
# <a id="plugin-check-command-hostalive4"></a> hostalive4
Check command object for the `check_ping` plugin with host check default values. This variant
uses the host's `address` attribute.
ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
-## <a id="plugin-check-command-hostalive6"></a> hostalive6
+##
# <a id="plugin-check-command-hostalive6"></a> hostalive6
Check command object for the `check_ping` plugin with host check default values. This variant
uses the host's `address6` attribute.
ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
-## <a id="plugin-check-command-hpjd"></a> hpjd
+##
# <a id="plugin-check-command-hpjd"></a> hpjd
Check command object for the `check_hpjd` plugin.
hpjd_community | **Optional.** The SNMP community. Defaults to "public".
-## <a id="plugin-check-command-http"></a> http
+##
# <a id="plugin-check-command-http"></a> http
Check command object for the `check_http` plugin.
http_timeout | **Optional.** Seconds before connection times out.
-## <a id="plugin-check-command-icmp"></a> icmp
+##
# <a id="plugin-check-command-icmp"></a> icmp
Check command object for the `check_icmp` plugin.
icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
-## <a id="plugin-check-command-imap"></a> imap
+##
# <a id="plugin-check-command-imap"></a> imap
Check command object for the `check_imap` plugin.
imap_timeout | **Optional.** The timeout in seconds.
-## <a id="plugin-check-command-ldap"></a> ldap
+##
# <a id="plugin-check-command-ldap"></a> ldap
Check command object for the `check_ldap` plugin.
ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
-## <a id="plugin-check-command-load"></a> load
+##
# <a id="plugin-check-command-load"></a> load
Check command object for the `check_load` plugin.
load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
-## <a id="plugin-check-command-nrpe"></a> nrpe
+##
# <a id="plugin-check-command-nrpe"></a> nrpe
Check command object for the `check_nrpe` plugin.
nrpe_ipv6 | **Optional.** Use IPv6 only.
-## <a id="plugin-check-command-nscp"></a> nscp
+##
# <a id="plugin-check-command-nscp"></a> nscp
Check command object for the `check_nt` plugin.
nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
-## <a id="plugin-check-command-ntp-time"></a> ntp_time
+##
# <a id="plugin-check-command-ntp-time"></a> ntp_time
Check command object for the `check_ntp_time` plugin.
ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
-## <a id="plugin-check-command-ntp-peer"></a> ntp_peer
+##
# <a id="plugin-check-command-ntp-peer"></a> ntp_peer
Check command object for the `check_ntp_peer` plugin.
ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
-## <a id="plugin-check-command-passive"></a> passive
+##
# <a id="plugin-check-command-passive"></a> passive
Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
-## <a id="plugin-check-command-ping"></a> ping
+##
# <a id="plugin-check-command-ping"></a> ping
Check command object for the `check_ping` plugin. This command uses the host's `address` attribute
if available and falls back to using the `address6` attribute if the `address` attribute is not set.
ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
-## <a id="plugin-check-command-ping4"></a> ping4
+##
# <a id="plugin-check-command-ping4"></a> ping4
Check command object for the `check_ping` plugin.
ping_packets | **Optional.** The number of packets to send. Defaults to 5.
ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
-## <a id="plugin-check-command-ping6"></a> ping6
+##
# <a id="plugin-check-command-ping6"></a> ping6
Check command object for the `check_ping` plugin.
ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
-## <a id="plugin-check-command-pop"></a> pop
+##
# <a id="plugin-check-command-pop"></a> pop
Check command object for the `check_pop` plugin.
pop_timeout | **Optional.** The timeout in seconds.
-## <a id="plugin-check-command-processes"></a> procs
+##
# <a id="plugin-check-command-processes"></a> procs
Check command object for the `check_procs` plugin.
procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
-## <a id="plugin-check-command-simap"></a> simap
+##
# <a id="plugin-check-command-simap"></a> simap
Check command object for the `check_simap` plugin.
simap_timeout | **Optional.** The timeout in seconds.
-## <a id="plugin-check-command-smtp"></a> smtp
+##
# <a id="plugin-check-command-smtp"></a> smtp
Check command object for the `check_smtp` plugin.
smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
-## <a id="plugin-check-command-snmp"></a> snmp
+##
# <a id="plugin-check-command-snmp"></a> snmp
Check command object for the `check_snmp` plugin.
snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
-## <a id="plugin-check-command-snmpv3"></a> snmpv3
+##
# <a id="plugin-check-command-snmpv3"></a> snmpv3
Check command object for the `check_snmp` plugin, using SNMPv3 authentication and encryption options.
snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
snmpv3_label | **Optional.** Prefix label for output value.
-## <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
+##
# <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
Check command object for the `check_snmp` plugin.
snmp_community | **Optional.** The SNMP community. Defaults to "public".
-## <a id="plugin-check-command-spop"></a> spop
+##
# <a id="plugin-check-command-spop"></a> spop
Check command object for the `check_spop` plugin.
spop_timeout | **Optional.** The timeout in seconds.
-## <a id="plugin-check-command-ssh"></a> ssh
+##
# <a id="plugin-check-command-ssh"></a> ssh
Check command object for the `check_ssh` plugin.
ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
-## <a id="plugin-check-command-ssl"></a> ssl
+##
# <a id="plugin-check-command-ssl"></a> ssl
Check command object for the `check_tcp` plugin, using ssl-related options.
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.
-## <a id="plugin-check-command-ssmtp"></a> ssmtp
+##
# <a id="plugin-check-command-ssmtp"></a> ssmtp
Check command object for the `check_ssmtp` plugin.
ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
-## <a id="plugin-check-command-swap"></a> swap
+##
# <a id="plugin-check-command-swap"></a> swap
Check command object for the `check_swap` plugin.
swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25.
-## <a id="plugin-check-command-tcp"></a> tcp
+##
# <a id="plugin-check-command-tcp"></a> tcp
Check command object for the `check_tcp` plugin.
tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
-## <a id="plugin-check-command-udp"></a> udp
+##
# <a id="plugin-check-command-udp"></a> udp
Check command object for the `check_udp` plugin.
udp_quit | **Optional.** The payload to send to 'close' the session.
-## <a id="plugin-check-command-ups"></a> ups
+##
# <a id="plugin-check-command-ups"></a> ups
Check command object for the `check_ups` plugin.
ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
-## <a id="plugin-check-command-users"></a> users
+##
# <a id="plugin-check-command-users"></a> users
Check command object for the `check_users` plugin.
users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
-## <a id="plugin-check-command-clamd"></a> clamd
+##
# <a id="plugin-check-command-clamd"></a> clamd
Check command object for the `check_clamd` plugin.
clamd_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
-## <a id="plugin-check-command-mailq"></a> mailq
+##
# <a id="plugin-check-command-mailq"></a> mailq
Check command object for the `check_mailq` plugin.
mailq_servertype | **Optional.** [ sendmail | qmail | postfix | exim | nullmailer ] (default = autodetect).
-## <a id="plugin-check-command-pgsql"></a> pgsql
+##
# <a id="plugin-check-command-pgsql"></a> pgsql
Check command object for the `check_pgsql` plugin.
Name | Description
------------------------|---------------------------------------------------------------
-pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
+pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
pgsql_port | **Optional.** Port number (default: 5432).
pgsql_database | **Optional.** Database to check (default: template1).
pgsql_username | **Optional.** Login name of user.
pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
-# <a id="windows-plugins"></a> Icinga 2 Windows plugins
+## <a id="windows-plugins"></a> Windows Plugins for Icinga 2
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.
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.
-## <a id="windows-plugins-thresholds"></a> Threshold syntax
+##
# <a id="windows-plugins-thresholds"></a> Threshold syntax
So not specified differently the thresholds for the plugins all follow the same pattern
"![10-40]" | Same as above, but the result is inverted.
-## <a id="windows-plugins-disk-windows"></a> disk-windows
+##
# <a id="windows-plugins-disk-windows"></a> disk-windows
Check command object for the `check_disk.exe` plugin.
Aggregates the free disk space of all volumes and mount points it can find, or the ones defined in `disk_win_path`. Ignores removable storage like fash drives and discs (CD, DVD etc.).
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.
-## <a id="windows-plugins-load-windows"></a> load-windows
+##
# <a id="windows-plugins-load-windows"></a> load-windows
Check command object for the `check_load.exe` plugin.
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`](7-icinga-template-library.md#windows-plugins-load-windows).
load\_win\_crit | **Optional**. The critical threshold.
-## <a id="windows-plugins-memory-windows"></a> memory-windows
+##
# <a id="windows-plugins-memory-windows"></a> memory-windows
Check command object for the `check_memory.exe` plugin.
The memory collection is instant.
memory\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabye), possible values are: b, kb, mb, gb and tb.
-## <a id="windows-plugins-network-windows"></a> network-windows
+##
# <a id="windows-plugins-network-windows"></a> network-windows
Check command object for the `check_network.exe` plugin.
Collects the total Bytes inbount and outbound for all interfaces in one second, to itemise interfaces or use a different collection interval use [`perfmon-windows`](7-icinga-template-library.md#windows-plugins-load-windows).
network\_win\_crit | **Optional**. The critical threshold.
-## <a id="windows-plugins-permon-windows"></a> perfmon-windows
+##
# <a id="windows-plugins-permon-windows"></a> perfmon-windows
Check command object for the `check_perfmon.exe` plugin.
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`.
perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
-## <a id="windows-plugins-ping-windows"></a> ping-windows
+##
# <a id="windows-plugins-ping-windows"></a> ping-windows
Check command object for the `check_ping.exe` plugin.
ping-windows should automaticly detect whether `ping_win_address` is an IPv4 or IPv6 address, if not use ping4-windows and ping6-windows. Also note that check\_ping.exe waits at least `ping_win_timeout` milliseconds between the pings.
ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
-## <a id="windows-plugins-procs-windows"></a> procs-windows
+##
# <a id="windows-plugins-procs-windows"></a> procs-windows
Check command object for `check_procs.exe` plugin.
When useing `procs_win_user` this plugins needs adminstratice privileges to access the processes of other users, to just enumerate them no additional privileges are required.
procs\_win\_user | **Optional**. Count this useres processes.
-## <a id="windows-plugins-service-windows"></a> service-windows
+##
# <a id="windows-plugins-service-windows"></a> service-windows
Check command object for `check_service.exe` plugin.
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.
service\_win\_service | **Required**. The critical threshold.
-## <a id="windows-plugins-swap-windows"></a> swap-windows
+##
# <a id="windows-plugins-swap-windows"></a> swap-windows
Check command object for `check_swap.exe` plugin.
The data collection is instant.
swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
-## <a id="windows-plugins-update-windows"></a> update-windows
+##
# <a id="windows-plugins-update-windows"></a> update-windows
Check command object for `check_update.exe` plugin.
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.
update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
-## <a id="windows-plugins-uptime-windows"></a> uptime-windows
+##
# <a id="windows-plugins-uptime-windows"></a> uptime-windows
Check command opject for `check_uptime.exe` plugin.
Uses GetTickCount64 to get the uptime, so boot time is not included.
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).
-## <a id="windows-plugins-users-windows"></a> users-windows
+##
# <a id="windows-plugins-users-windows"></a> users-windows
Check command object for `check_users.exe` plugin.
users\_win\_crit | **Optional**. The critical threshold.
-# <a id="nscp-plugin-check-commands"></a> NSClient++ Check Commands
+## <a id="nscp-plugin-check-commands"></a> Plugin Check Commands for NSClient++
Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
-## <a id="nscp-check-local"></a> nscp-local
+##
# <a id="nscp-check-local"></a> nscp-local
Check command object for NSClient++
nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
nscp_arguments | **Optional.** An array of query arguments.
-## <a id="nscp-check-local-cpu"></a> nscp-local-cpu
+##
# <a id="nscp-check-local-cpu"></a> nscp-local-cpu
Check command object for the `check_cpu` NSClient++ plugin.
This command has the same custom attributes like the `nscp-local` check command.
-## <a id="nscp-check-local-memory"></a> nscp-local-memory
+##
# <a id="nscp-check-local-memory"></a> nscp-local-memory
Check command object for the `check_memory` NSClient++ plugin.
This command has the same custom attributes like the `nscp-local` check command.
-## <a id="nscp-check-local-os-version"></a> nscp-local-os-version
+##
# <a id="nscp-check-local-os-version"></a> nscp-local-os-version
Check command object for the `check_os_version` NSClient++ plugin.
This command has the same custom attributes like the `nscp-local` check command.
-## <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
+##
# <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
Check command object for the `check_pagefile` NSClient++ plugin.
This command has the same custom attributes like the `nscp-local` check command.
-## <a id="nscp-check-local-process"></a> nscp-local-process
+##
# <a id="nscp-check-local-process"></a> nscp-local-process
Check command object for the `check_process` NSClient++ plugin.
This command has the same custom attributes like the `nscp-local` check command.
-## <a id="nscp-check-local-service"></a> nscp-local-service
+##
# <a id="nscp-check-local-service"></a> nscp-local-service
Check command object for the `check_service` NSClient++ plugin.
This command has the same custom attributes like the `nscp-local` check command.
-## <a id="nscp-check-local-uptime"></a> nscp-local-uptime
+##
# <a id="nscp-check-local-uptime"></a> nscp-local-uptime
Check command object for the `check_uptime` NSClient++ plugin.
This command has the same custom attributes like the `nscp-local` check command.
-## <a id="nscp-check-local-version"></a> nscp-local-version
+##
# <a id="nscp-check-local-version"></a> nscp-local-version
Check command object for the `check_version` NSClient++ plugin.
This command has the same custom attributes like the `nscp-local` check command.
-## <a id="nscp-check-local-disk"></a> nscp-local-disk
+##
# <a id="nscp-check-local-disk"></a> nscp-local-disk
Check command object for the `check_drivesize` NSClient++ plugin.
This command has the same custom attributes like the `nscp-local` check command.
-## <a id="nscp-check-local-counter"></a> nscp-local-counter
+##
# <a id="nscp-check-local-counter"></a> nscp-local-counter
Check command object for the `check_pdh` NSClient++ plugin.
This command has the same custom attributes like the `nscp-local` check command.
-# <a id="snmp-manubulon-plugin-check-commands"></a> SNMP Manubulon Plugin Check Commands
+
+
+## <a id="snmp-manubulon-plugin-check-commands"></a> Plugin Check Commands for Manubulon SNMP
The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check
commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
include <manubulon>
-## Checks by Host Type
+### Checks by Host Type
**N/A** : Not available for this type.
Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
-## <a id="plugin-check-command-snmp-load"></a> snmp-load
+##
# <a id="plugin-check-command-snmp-load"></a> snmp-load
Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
-## <a id="plugin-check-command-snmp-memory"></a> snmp-memory
+##
# <a id="plugin-check-command-snmp-memory"></a> snmp-memory
Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
-## <a id="plugin-check-command-snmp-storage"></a> snmp-storage
+##
# <a id="plugin-check-command-snmp-storage"></a> snmp-storage
Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
-## <a id="plugin-check-command-snmp-interface"></a> snmp-interface
+##
# <a id="plugin-check-command-snmp-interface"></a> snmp-interface
Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
-## <a id="plugin-check-command-snmp-process"></a> snmp-process
+##
# <a id="plugin-check-command-snmp-process"></a> snmp-process
Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
-# <a id="plugins-contrib"></a> Plugins Contrib
-The Plugins contrib collects various contributed command definitions.
+
+## <a id="plugins-contrib"></a> Contributed Plugin Check Commands
+
+The contributed Plugin Check Commands provides various additional command definitions
+contributed by community members.
These check commands assume that the global constant named `PluginContribDir`
-is set to the path where the user installs custom plugins and can be enabled by uncommenting the corresponding line in icinga2.conf.
+is set to the path where the user installs custom plugins and can be enabled by
+uncommenting the corresponding line in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf):
+
+ include <plugins-contrib>
-## <a id="plugins-contrib-databases"></a> Databases
+##
# <a id="plugins-contrib-databases"></a> Databases
All database plugins go in this category.
-### <a id="plugins-contrib-command-mssql_health"></a> mssql_health
+###
# <a id="plugins-contrib-command-mssql_health"></a> mssql_health
The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
For release tarballs, detailed documentation especially on the different modes and scripts for creating a monitoring user see [https://labs.consol.de](https://labs.consol.de/nagios/check_mssql_health/). For development check [https://github.com](https://github.com/lausser/check_mssql_health).
mssql_health_offlineok | **Optional.** Set this to true, if offline databases are perfectly ok for you. Defaults to false.
mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
-### <a id="plugins-contrib-command-mysql_health"></a> mysql_health
+###
# <a id="plugins-contrib-command-mysql_health"></a> mysql_health
The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
For release tarballs and detailed documentation especially on the different modes and required permissions see [https://labs.consol.de](https://labs.consol.de/nagios/check_mysql_health/). For development check [https://github.com](https://github.com/lausser/check_mysql_health).
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".
mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
-### <a id="plugins-contrib-command-oracle_health"></a> oracle_health
+###
# <a id="plugins-contrib-command-oracle_health"></a> oracle_health
The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
For release tarballs and detailed documentation especially on the different modes and required permissions see [https://labs.consol.de](https://labs.consol.de/nagios/check_oracle_health/). For development check [https://github.com](https://github.com/lausser/check_oracle_health).
ORACLE_HOME | **Required.** Specifies the location of the oracle instant client libraries. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting "oracle_home".
TNS_ADMIN | **Required.** Specifies the location of the tnsnames.ora including the database connection strings. Defaults to "/etc/icinga2/plugin-configs". Can be overridden by setting "oracle_tns_admin".
-### <a id="plugins-contrib-command-postgres"></a> postgres
+###
# <a id="plugins-contrib-command-postgres"></a> postgres
The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
For release tarballs and detailed documentation especially the different actions and required persmissions see [https://bucardo.org/wiki/Check_postgres](https://bucardo.org/wiki/Check_postgres). For development check [https://github.com](https://github.com/bucardo/check_postgres).
postgres_action | **Required.** Determines the test executed.
postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true the unix socket is used instead of an address. Defaults to false.
-### <a id="plugins-contrib-command-mongodb"></a> mongodb
+###
# <a id="plugins-contrib-command-mongodb"></a> mongodb
The plugin `mongodb` utilises Python PyMongo.
For development check [https://github.com](https://github.com/mzupan/nagios-plugin-mongodb).
mongodb_collection | **Optional.** Specify the collection to check
mongodb_sampletime | **Optional.** Time used to sample number of pages faults
-### <a id="plugins-contrib-command-elasticsearch"></a> elasticsearch
+###
# <a id="plugins-contrib-command-elasticsearch"></a> elasticsearch
An [ElasticSearch](https://www.elastic.co/products/elasticsearch) availability
and performance monitoring plugin available for download at [GitHub](https://github.com/anchor/nagios-plugin-elasticsearch).
elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
-### <a id="plugins-contrib-command-redis"></a> redis
+###
# <a id="plugins-contrib-command-redis"></a> redis
The plugin `redis` can measure response time, hitrate, memory utilization, check replication sync and more. It can also test data in a specified key (if necessary doing average or sum on range).
It is provided by `William Leibzon` at [https://github.com](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl).
redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
-## <a id="plugins-contrib-ipmi"></a> IPMI Devices
+
+### <a id="plugins-contrib-hardware"></a> Hardware
+
+This category includes all plugins for various hardware checks.
+
+#### <a id="plugins-contrib-command-hpasm"></a> hpasm
+
+The plugin [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) is a plugin to monitor HP hardware through the HP Insight Agent via SNMP.
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+--------------------------------|-----------------------------------------------------------------------
+hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
+hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
+hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
+hpasm_port | **Optional.** The SNMP port to use (default: 161).
+hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
+hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
+hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
+hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
+hpasm_eventrange | **Optional.** Period of time before critical IML events respecively become warnings or vanish. A range is descibed as a number and a unit (s, m, h, d), e.g. --eventrange 1h/20m.
+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.
+hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
+hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
+hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5|sha).
+hpasm_privpassword | **Optional.** The password for authPriv security level.
+hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des|aes|aes128|3des|3desde).
+hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
+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 get an error and you think, it is not justified for your configuration, please tell me about it. (alwasy send the output of "snmpwalk -On .... 1.3.6.1.4.1.232" and a description how you setup your nics and why it is correct opposed to the plugins error message.
+
+
+### <a id="plugins-contrib-ipmi"></a> IPMI Devices
This category includes all plugins for IPMI devices.
-### <a id="plugins-contrib-command-ipmi-sensor"></a> ipmi-sensor
+###
# <a id="plugins-contrib-command-ipmi-sensor"></a> ipmi-sensor
With the plugin `ipmi-sensor` provided by <a href="https://www.thomas-krenn.com/">Thomas-Krenn.AG</a> you can monitor sensor data for IPMI devices. See https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin for installation and configuration instructions.
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-network-components"></a> Network Components
+##
# <a id="plugins-contrib-network-components"></a> Network Components
This category includes all plugins for various network components like routers, switches and firewalls.
-### <a id="plugins-contrib-command-interfacetable"></a> interfacetable
+###
# <a id="plugins-contrib-command-interfacetable"></a> interfacetable
The plugin `interfacetable` generates a html page containing information about the monitored node and all of its interfaces. The actively developed and maintained version is `interfacetable_v3t` provided by `Yannick Charton` on [http://www.tontonitch.com](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) or [https://github.com](https://github.com/Tontonitch/interfacetable_v3t).
interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
-### <a id="plugins-contrib-command-iftraffic"></a> iftraffic
+###
# <a id="plugins-contrib-command-iftraffic"></a> iftraffic
The plugin [check_iftraffic](https://exchange.icinga.org/exchange/iftraffic)
checks the utilization of a given interface name using the SNMP protocol.
iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98%`).
iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
-### <a id="plugins-contrib-command-interfaces"></a> interfaces
+###
# <a id="plugins-contrib-command-interfaces"></a> interfaces
The plugin [check_interfaces](https://www.netways.org/projects/check-interfaces)
Check interfaces and utilization.
interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
-### <a id="plugins-contrib-command-nwc_health"></a> nwc_health
+###
# <a id="plugins-contrib-command-nwc_health"></a> nwc_health
The plugin [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html)
Check switches, router, there interfaces and utilization.
nwc_health_multiline | **Optional.** Multiline output
-## <a id="plugins-contrib-web"></a> Web
+##
# <a id="plugins-contrib-web"></a> Web
This category includes all plugins for web-based checks.
-### <a id="plugin-check-command-webinject"></a> webinject
+###
# <a id="plugin-check-command-webinject"></a> webinject
Check command object for the [check_webinject](http://http://www.webinject.org/manual.html) plugin.
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-check-command-jmx4perl"></a> jmx4perl
+###
# <a id="plugin-check-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.
jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
-### <a id="plugins-contrib-squid"></a> squid
+###
# <a id="plugins-contrib-squid"></a> squid
Plugin for monitoring [Squid](https://exchange.icinga.org/exchange/check_squid).
squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
-### <a id="plugins-contrib-nginx_status"></a> nginx_status
+###
# <a id="plugins-contrib-nginx_status"></a> nginx_status
Plugin for monitoring [nginx_status](https://github.com/regilero/check_nginx_status).
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="plugins-contrib-operating-system"></a> Operating System
+##
# <a id="plugins-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.
-### <a id="plugins-contrib-command-mem"></a> mem
+###
# <a id="plugins-contrib-command-mem"></a> mem
The plugin `mem` is used for gathering information about memory usage on linux and unix hosts. It is able to count cache memory as free when comparing it to the thresholds. It is provided by `Justin Ellison` on [https://github.com](https://github.com/justintime/nagios-plugins). For more details see the developers blog [http://sysadminsjourney.com](http://sysadminsjourney.com/content/2009/06/04/new-and-improved-checkmempl-nagios-plugin).
mem_warning | **Required.** Specifiy the warning threshold as number interpreted as percent.
mem_critical | **Required.** Specifiy the critical threshold as number interpreted as percent.
-### <a id="plugin-contrib-command-running-kernel"></a> running_kernel
+###
# <a id="plugin-contrib-command-running-kernel"></a> running_kernel
Check command object for the `check_running_kernel` plugin
provided by the `nagios-plugins-contrib` package on Debian.
The `running_kernel` check command does not support any vars.
-### <a id="plugin-contrib-command-yum"></a> yum
+###
# <a id="plugin-contrib-command-yum"></a> yum
The plugin `yum` is used to check the YUM package management system for package updates. To differentiate between security and normal updates it requires the YUM security plugin installed. It is provied by `Christoph Anton Mitterer` on [https://github.com](https://github.com/calestyo/check_yum).
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-virtualization"></a> Virtualization
+##
# <a id="plugins-contrib-virtualization"></a> Virtualization
This category includes all plugins for various virtualization technologies.
-### <a id="plugins-contrib-command-esxi-hardware"></a> esxi_hardware
+###
# <a id="plugins-contrib-command-esxi-hardware"></a> esxi_hardware
The plugin `esxi_hardware` is a plugin to monitor hardware of ESXi servers through the vmware api and cim service. It is provided by `Claudio Kuenzler` on [http://www.claudiokuenzler.com](http://www.claudiokuenzler.com/nagios-plugins/check_esxi_hardware.php). For instruction on creating the required local user and workarounds for some hardware types have a look on his homepage.
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="plugins-contrib-vmware"></a> VMware
+#
## <a id="plugins-contrib-vmware"></a> VMware
Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
-## <a id="plugins-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
+##
## <a id="plugins-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="plugins-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
+##
## <a id="plugins-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-hardware"></a> Hardware
-
-This category includes all plugins for various hardware checks.
-
-### <a id="plugins-contrib-command-hpasm"></a> hpasm
-
-The plugin [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) is a plugin to monitor HP hardware through the HP Insight Agent via SNMP.
-
-Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
-
-Name | Description
---------------------------------|-----------------------------------------------------------------------
-hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
-hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
-hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
-hpasm_port | **Optional.** The SNMP port to use (default: 161).
-hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
-hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
-hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
-hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
-hpasm_eventrange | **Optional.** Period of time before critical IML events respecively become warnings or vanish. A range is descibed as a number and a unit (s, m, h, d), e.g. --eventrange 1h/20m.
-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.
-hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
-hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
-hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5|sha).
-hpasm_privpassword | **Optional.** The password for authPriv security level.
-hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des|aes|aes128|3des|3desde).
-hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
-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 get an error and you think, it is not justified for your configuration, please tell me about it. (alwasy send the output of "snmpwalk -On .... 1.3.6.1.4.1.232" and a description how you setup your nics and why it is correct opposed to the plugins error message.
### Libraries
-Instead of loading libraries using the [`library` config directive](20-language-reference.md#library)
+Instead of loading libraries using the [`library` config directive](18-language-reference.md#library)
you can also use the `--library` command-line option.
### Constants
-[Global constants](20-language-reference.md#constants) can be set using the `--define` command-line option.
+[Global constants](18-language-reference.md#constants) can be set using the `--define` command-line option.
### <a id="config-include-path"></a> Config Include Path
The `object` CLI command can be used to list all configuration objects and their
attributes. The command also shows where each of the attributes was modified.
-That way you can also identify which objects have been created from your [apply rules](20-language-reference.md#apply).
+That way you can also identify which objects have been created from your [apply rules](18-language-reference.md#apply).
-More information can be found in the [troubleshooting](17-troubleshooting.md#list-configuration-objects) section.
+More information can be found in the [troubleshooting](16-troubleshooting.md#list-configuration-objects) section.
# icinga2 object --help
icinga2 - The Icinga 2 network monitoring daemon (version: v2.1.1-299-gf695275)
## <a id="cli-command-troubleshoot"></a> CLI command: Troubleshoot
-Collects basic information like version, paths, log files and crash reports for troubleshooting purposes and prints them to a file or the console. See [troubleshooting](17-troubleshooting.md#troubleshooting-information-required).
+Collects basic information like version, paths, log files and crash reports for troubleshooting purposes and prints them to a file or the console. See [troubleshooting](16-troubleshooting.md#troubleshooting-information-required).
Its output defaults to a file named `troubleshooting-[TIMESTAMP].log` so it won't overwrite older troubleshooting files.
Icinga home page: <https://www.icinga.org/>
-## <a id="features"></a> Enabling/Disabling Features
+## <a id="enable-features"></a> Enabling/Disabling Features
Icinga 2 provides configuration files for some commonly used features. These
are installed in the `/etc/icinga2/features-available` directory and can be
> `# icinga2 daemon -C`
If you encouter errors during configuration validation, please make sure
-to read the [troubleshooting](17-troubleshooting.md#troubleshooting) chapter.
+to read the [troubleshooting](16-troubleshooting.md#troubleshooting) chapter.
You can also use the [CLI command](8-cli-commands.md#cli-command-object) `icinga2 object list`
after validation passes to analyze object attributes, inheritance or created
objects by apply rules.
-Find more on troubleshooting with `object list` in [this chapter](17-troubleshooting.md#list-configuration-objects).
+Find more on troubleshooting with `object list` in [this chapter](16-troubleshooting.md#list-configuration-objects).
Example filtered by `Service` objects with the name `ping*`:
> which will validate the configuration in a separate process and not stop
> the other events like check execution, notifications, etc.
>
-> Details can be found [here](19-migrating-from-icinga-1x.md#differences-1x-2-real-reload).
+> Details can be found [here](21-migrating-from-icinga-1x.md#differences-1x-2-real-reload).
list. Depending on the number of affected objects in your request, the
results may contain one or more entries.
-The [output](9-icinga2-api.md#icinga2-api-output-format) will be sent back as a JSON object:
+The output will be sent back as a JSON object:
{
permissions = [ "*" ]
A yet more sophisticated approach is to specify additional permissions
-and their filters. The latter must be defined as [lamdba function](20-language-reference.md#nullary-lambdas)
+and their filters. The latter must be defined as [lamdba function](18-language-reference.md#nullary-lambdas)
returning a boolean expression.
The `permission` attribute contains the action and the specific capitalized
There are several actions available for Icinga 2 provided by the `actions`
URL endpoint `/v1/actions`. You can run actions by sending a `POST` request.
-In case you have been using the [external commands](5-advanced-topics.md#external-commands)
+In case you have been using the [external commands](15-features.md#external-commands)
in the past, the API actions provide a similar interface with filter
capabilities for some of the more common targets which do not directly change
the configuration.
Parameter | Type | Description
------------------|--------------|--------------
type | string | **Required.** `Host` or `Service`.
- filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api#icinga2-api-filters).
+ filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api.md#icinga2-api-filters).
exit\_status | integer | **Required.** For services: 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN, for hosts: 0=OK, 1=CRITICAL.
plugin\_output | string | **Required.** The plugins main output, i.e. the text before the `|`. Does **not** contain the perfomance data.
performance\_data | string array | **Optional.** One array entry per `;` separated block.
Parameter | Type | Description
-------------|-----------|--------------
type | string | **Required.** `Host` or `Service`.
- filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api#icinga2-api-filters).
+ filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api.md#icinga2-api-filters).
next\_check | timestamp | **Optional.** The next check will be run at this timestamp. Defaults to `now`.
force\_check | boolean | **Optional.** Defaults to `false`. See blow for further information.
Parameter | Type | Description
----------|---------|--------------
type | string | **Required.** `Host` or `Service`.
- filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api#icinga2-api-filters).
+ filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api.md#icinga2-api-filters).
author | string | **Required.** Name of the author, may be empty.
comment | string | **Required.** Comment text, may be empty.
force | boolean | **Optional.** Default: false. If true, the notification is sent regardless of downtimes or whether notifications are enabled or not.
Parameter | Type | Description
----------|-----------|--------------
type | string | **Required.** `Host` or `Service`.
- filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api#icinga2-api-filters).
+ filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api.md#icinga2-api-filters).
timestamp | timestamp | **Required.** Delay notifications until this timestamp.
Note that this will only have an effect if the service stays in the same problem
Parameter | Type | Description
----------|-----------|--------------
type | string | **Required.** `Host` or `Service`.
- filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api#icinga2-api-filters).
+ filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api.md#icinga2-api-filters).
author | string | **Required.** Name of the author, may be empty.
comment | string | **Required.** Comment text, may be empty.
expiry | timestamp | **Optional.** If set the acknowledgement will vanish after this timestamp.
parameter | type | description
----------|--------|--------------
type | string | **Required.** `Host` or `Service`.
- filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api#icinga2-api-filters).
+ filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api.md#icinga2-api-filters).
Remove the acknowledgements for services or hosts. Once the acknowledgement has
been removed notifications will be sent out again.
parameter | type | description
----------|--------|--------------
type | string | **Required.** `Host` or `Service`.
- filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api#icinga2-api-filters).
+ filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api.md#icinga2-api-filters).
author | string | **Required.** name of the author, may be empty.
comment | string | **Required.** Comment text, may be empty.
parameter | type | description
------------|---------|--------------
type | string | **Required.** `Host` or `Service`.
- filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api#icinga2-api-filters).
+ filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api.md#icinga2-api-filters).
Removes all comments for services or hosts.
parameter | type | description
------------|-----------|--------------
type | string | **Required.** `Host` or `Service`.
- filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api#icinga2-api-filters).
+ filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api.md#icinga2-api-filters).
start\_time | timestamp | **Required.** Timestamp marking the begining of the downtime.
end\_time | timestamp | **Required.** Timestamp marking the end of the downtime.
duration | integer | **Required.** Duration of the downtime in seconds if `fixed` is set to false.
- fixed | boolean | **Optional.** Defaults to `false`. If true the downtime is `fixed` otherwise `flexible`. See [downtimes](5-advanced-topics.md#Downtimes) for more information.
- trigger\_id | integer | **Optional.** Sets the trigger for a triggered downtime. See [downtimes](5-advanced-topics.md#Downtimes) for more information on triggered downtimes.
+ fixed | boolean | **Optional.** Defaults to `false`. If true the downtime is `fixed` otherwise `flexible`. See [downtimes](#Downtimes) for more information.
+ trigger\_id | integer | **Optional.** Sets the trigger for a triggered downtime. See [downtimes](#Downtimes) for more information on triggered downtimes.
Example:
parameter | type | description
----------|--------|--------------
type | string | **Required.** `Host` or `Service`.
- filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api#icinga2-api-filters).
+ filter | string | **Optional.** Apply the action only to objects matching the [filter](9-icinga2-api.md#icinga2-api-filters).
Removes all downtimes for services or hosts.
- [12-agent-based-checks.md, Additional Agent-based Checks]
- [13-distributed-monitoring-ha.md, Distributed Monitoring and High Availability]
- [14-addons-plugins.md, Addons and Plugins]
-- [15-alternative-frontends.md, Alternative Frontends]
-- [16-livestatus.md, Livestatus]
-- [17-troubleshooting.md, Troubleshooting]
-- [18-upgrading-icinga-2.md, Upgrading Icinga 2]
-- [19-migrating-from-icinga-1x.md, Migrating from Icinga 1.x]
-- [20-language-reference.md, Language Reference]
-- [21-library-reference.md, Library Reference]
-- [22-debug.md, Debug]
-- [23-appendix.md, Appendix]
+- [15-features.md, Features]
+- [16-troubleshooting.md, Troubleshooting]
+- [17-upgrading-icinga-2.md, Upgrading Icinga 2]
+- [18-language-reference.md, Language Reference]
+- [19-library-reference.md, Library Reference]
+- [20-debug.md, Debug]
+- [21-migrating-from-icinga-1x.md, Migrating from Icinga 1.x]
+- [22-appendix.md, Appendix]
theme: readthedocs
markdown_extensions: [smarty]
extra_javascript: [scroll.js]
projects / icinga2 / commitdiff