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

263 lines
8.0 KiB
Markdown
Raw Normal View History

2013-10-02 09:50:26 +02:00
# Icinga Template Library
2013-10-01 12:59:02 +02:00
2013-10-02 09:50:26 +02:00
## 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>
2013-10-02 09:50:26 +02:00
## Check Commands
2013-10-01 12:59:02 +02:00
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
packets | **Optional.** The number of packets to send. Defaults to 5.
timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address6 | **Required.** The host's IPv6 address.
wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
packets | **Optional.** The number of packets to send. Defaults to 5.
timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
text | **Optional.** Plugin output. Defaults to "Check was successful.".
### passive
Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
port | **Required.** The port that should be checked.
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
port | **Required.** The port that should be checked.
2013-10-02 09:50:26 +02:00
### http_vhost
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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
vhost | **Required.** The name of the virtual host that should be checked.
2013-10-02 09:50:26 +02:00
### http_ip
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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
2013-10-02 09:50:26 +02:00
### https_vhost
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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
vhost | **Required.** The name of the virtual host that should be checked.
2013-10-02 09:50:26 +02:00
### https_ip
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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
port | **Optional.** The port that should be checked. Defaults to 465.
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
wfree | **Optional.** The free space warning threshold in %. Defaults to 20.
cfree | **Optional.** The free space critical threshold in %. Defaults to 10.
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
wgreater | **Optional.** The user count warning threshold. Defaults to 20.
cgreater | **Optional.** The user count warning threshold. Defaults to 50.
2013-10-02 09:50:26 +02:00
### processes
2013-10-01 12:59:02 +02:00
2013-10-07 09:35:44 +02:00
Check command object for the `check_processes` plugin.
2013-10-01 15:33:34 +02:00
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
wgreater | **Optional.** The process count warning threshold. Defaults to 250.
cgreater | **Optional.** The process count warning threshold. Defaults to 400.
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
oid | **Required.** The SNMP OID.
community | **Optional.** The SNMP community. Defaults to "public".
2013-10-02 09:50:26 +02:00
### 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
Macros:
Name | Description
----------------|--------------
plugindir | **Required.** The directory containing this plugin.
address | **Required.** The host's address.
oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
community | **Optional.** The SNMP community. Defaults to "public".