icinga2/doc/5-icinga-template-library.md

264 lines
9.1 KiB
Markdown
Raw Normal View History

# <a id="icinga-template-library"></a> Icinga Template Library
2013-10-01 12:59:02 +02:00
## <a id="itl-overview"></a> Overview
2013-10-01 12:59:02 +02:00
2013-10-01 15:33:34 +02:00
The Icinga Template Library (ITL) implements standard templates and object
definitions for commonly used services.
2013-10-07 09:35:44 +02:00
You can include the ITL by using the `include` directive in your configuration
2013-10-01 15:33:34 +02:00
file:
include <itl/itl.conf>
2014-03-31 13:27:39 +02:00
The ITL assumes that there's a global constant named `PluginDir` which contains
the path of the plugins from the Monitoring Plugins project.
## <a id="itl-check-commands"></a> Check Commands
2013-10-01 12:59:02 +02:00
### <a id="itl-ping4"></a> ping4
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_ping` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
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).
2013-10-01 15:33:34 +02:00
### <a id="itl-ping6"></a> ping6
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_ping` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
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).
2013-10-01 15:33:34 +02:00
### <a id="itl-hostalive"></a> hostalive
Check command object for the `check_ping` plugin with host check default values.
Custom Attributes:
Name | Description
----------------|--------------
ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
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="itl-dummy"></a> dummy
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_dummy` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
2013-10-01 15:33:34 +02:00
### <a id="itl-passive"></a> passive
Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
Custom Attributes:
Name | Description
----------------|--------------
dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
### <a id="itl-tcp"></a> tcp
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_tcp` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
tcp_address | **Optional.** The host's address. Defaults to "$address$".
tcp_port | **Required.** The port that should be checked.
2013-10-01 15:33:34 +02:00
### <a id="itl-udp"></a> udp
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_udp` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
udp_address | **Optional.** The host's address. Defaults to "$address$".
udp_port | **Required.** The port that should be checked.
2013-10-01 15:33:34 +02:00
### <a id="itl-http-ip"></a> http
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_http` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
-------------------|--------------
http_address | **Optional.** The host's address. Defaults to "$address".
http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
http_uri | **Optional.** The request URI.
http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
http_ssl | **Optional.** Whether to use SSL. Defaults to false.
http_warn_time | **Optional.** The warning threshold.
http_critical_time | **Optional.** The critical threshold.
2013-10-01 15:33:34 +02:00
### <a id="itl-smtp"></a> smtp
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_smtp` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
---------------------|--------------
smtp_address | **Optional.** The host's address. Defaults to "$address$".
2013-10-01 15:33:34 +02:00
### <a id="itl-ssmtp"></a> ssmtp
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_ssmtp` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
ssmtp_address | **Required.** The host's address. Defaults to "$address$".
ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
2013-10-01 15:33:34 +02:00
### <a id="itl-ntp-time"></a> ntp_time
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_ntp_time` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
ntp_address | **Optional.** The host's address. Defaults to "$address$".
2013-10-01 15:33:34 +02:00
### <a id="itl-ssh"></a> ssh
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_ssh` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
ssh_address | **Optional.** The host's address. Defaults to "$address$".
ssh_port | **Optional.** The port that should be checked. Defaults to 22.
2013-10-01 15:33:34 +02:00
### <a id="itl-disk"></a> disk
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_disk` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
disk_wfree | **Optional.** The free space warning threshold in %. Defaults to 20.
disk_cfree | **Optional.** The free space critical threshold in %. Defaults to 10.
2013-10-01 15:33:34 +02:00
### <a id="itl-users"></a> users
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_disk` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
2013-10-01 15:33:34 +02:00
### <a id="itl-processes"></a> procs
2013-10-01 12:59:02 +02:00
2014-04-12 08:18:38 +02:00
Check command object for the `check_procs` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
procs_wgreater | **Optional.** The process count warning threshold. Defaults to 250.
procs_cgreater | **Optional.** The process count critical threshold. Defaults to 400.
2013-10-01 15:33:34 +02:00
2014-04-12 08:18:38 +02:00
### <a id="itl-swap"></a> swap
Check command object for the `check_swap` plugin.
Custom Attributes:
Name | Description
----------------|--------------
swap_wfree | **Optional.** The free swap space warning threshold in %. Defaults to 50.
swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25.
2014-04-12 08:18:38 +02:00
### <a id="itl-load"></a> load
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_load` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
2013-10-01 15:33:34 +02:00
### <a id="itl-snmp"></a> snmp
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_snmp` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
snmp_address | **Optional.** The host's address. Defaults to "$address$".
snmp_oid | **Required.** The SNMP OID.
snmp_community | **Optional.** The SNMP community. Defaults to "public".
2013-10-01 15:33:34 +02:00
### <a id="itl-snmp-uptime"></a> snmp-uptime
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_snmp` plugin.
2013-10-01 15:33:34 +02:00
Custom Attributes:
2013-10-01 15:33:34 +02:00
Name | Description
----------------|--------------
snmp_address | **Optional.** The host's address. Defaults to "$address$".
snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
snmp_community | **Optional.** The SNMP community. Defaults to "public".
2014-04-13 18:47:02 +02:00
### <a id="itl-apt"></a> apt
Check command for the `check_apt` plugin.
The `apt` check command does not support any vars.
### <a id="itl-icinga"></a> icinga
Check command for the built-in `icinga` check. This check returns performance
data for the current Icinga instance.
The `icinga` check command does not support any vars.
2014-04-12 08:18:38 +02:00