27 KiB

Raw Blame History

Appendix

Icinga Template Library

Overview

The Icinga Template Library (ITL) implements standard templates and object definitions for commonly used services.

You can include the ITL by using the include directive in your configuration file:

include <itl/itl.conf>

The ITL assumes that there's a global constant named PluginDir which contains the path of the plugins from the Monitoring Plugins project.

Check Commands

ping4

Check command object for the check_ping plugin.

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 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).

ping6

Check command object for the check_ping plugin.

Custom Attributes:

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).

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).

dummy

Check command object for the check_dummy plugin.

Custom Attributes:

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.".

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.".

tcp

Check command object for the check_tcp plugin.

Custom Attributes:

Name	Description
tcp_address	Optional. The host's address. Defaults to "`address`".
tcp_port	Required. The port that should be checked.

udp

Check command object for the check_udp plugin.

Custom Attributes:

Name	Description
udp_address	Optional. The host's address. Defaults to "`address`".
udp_port	Required. The port that should be checked.

http

Check command object for the check_http plugin.

Custom Attributes:

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.

smtp

Check command object for the check_smtp plugin.

Custom Attributes:

Name	Description
smtp_address	Optional. The host's address. Defaults to "`address`".

ssmtp

Check command object for the check_ssmtp plugin.

Custom Attributes:

Name	Description
ssmtp_address	Required. The host's address. Defaults to "`address`".
ssmtp_port	Optional. The port that should be checked. Defaults to 465.

ntp_time

Check command object for the check_ntp_time plugin.

Custom Attributes:

Name	Description
ntp_address	Optional. The host's address. Defaults to "`address`".

ssh

Check command object for the check_ssh plugin.

Custom Attributes:

Name	Description
ssh_address	Optional. The host's address. Defaults to "`address`".
ssh_port	Optional. The port that should be checked. Defaults to 22.

disk

Check command object for the check_disk plugin.

Custom Attributes:

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.

users

Check command object for the check_disk plugin.

Custom Attributes:

Name	Description
users_wgreater	Optional. The user count warning threshold. Defaults to 20.
users_cgreater	Optional. The user count critical threshold. Defaults to 50.

procs

Check command object for the check_procs plugin.

Custom Attributes:

Name	Description
procs_wgreater	Optional. The process count warning threshold. Defaults to 250.
procs_cgreater	Optional. The process count critical threshold. Defaults to 400.

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.

load

Check command object for the check_load plugin.

Custom Attributes:

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.

snmp

Check command object for the check_snmp plugin.

Custom Attributes:

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".

snmp-uptime

Check command object for the check_snmp plugin.

Custom Attributes:

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".

apt

Check command for the check_apt plugin.

The apt check command does not support any vars.

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.

plugin-check-command

Check command template for plugins executed by Icinga 2.

The plugin-check-command check command does not support any vars.

plugin-check-command

Check command template for notification scripts executed by Icinga 2.

The plugin-notification-command check command does not support any vars.

plugin-check-command

Check command template for event handler scripts executed by Icinga 2.

The plugin-event-command check command does not support any vars.

Schemas

DB IDO

There is a detailed documentation for the Icinga IDOUtils 1.x database schema available on [http://docs.icinga.org/latest/en/db_model.html]

DB IDO Schema Extensions

Icinga 2 specific extensions are shown below:

New tables: endpoints, endpointstatus

Table	Column	Type	Default	Description
endpoints	endpoint_object_id	bigint	NULL	FK: objects table
endpoints	identity	TEXT	NULL	endpoint name
endpoints	node	TEXT	NULL	local node name

Table	Column	Type	Default	Description
endpointstatus	endpoint_object_id	bigint	NULL	FK: objects table
endpointstatus	identity	TEXT	NULL	endpoint name
endpointstatus	node	TEXT	NULL	local node name
endpointstatus	is_connected	smallint	0	update on endpoint connect/disconnect

New columns:

Table	Column	Type	Default	Description
all status/history	endpoint_object_id	bigint	NULL	FK: objects table
servicestatus	check_source	TEXT	NULL	node name where check was executed
hoststatus	check_source	TEXT	NULL	node name where check was executed
statehistory	check_source	TEXT	NULL	node name where check was executed
logentries	object_id	bigint	NULL	FK: objects table (service associated with column)

Additional command custom variables populated from 'vars' dictionary. Additional global custom variables populated from 'Vars' constant (object_id is NULL).

Livestatus

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 and shows log attributes
statehist	hosts, services	parses compatlog and aggregates state change attributes

The commands table is populated with CheckCommand, EventCommand and NotificationCommand objects.

Livestatus Table Attributes

A detailed list which table attributes are supported can be found here: [https://wiki.icinga.org/display/icinga2/Livestatus#Livestatus-Attributes]

Livestatus GET Queries

$ echo -e 'GET services' | netcat 127.0.0.1 6558

$ cat servicegroups <<EOF
GET servicegroups

EOF

(cat servicegroups; sleep 1) | netcat 127.0.0.1 6558

Livestatus COMMAND Queries

A list of available external commands and their parameters can be found here

$ echo -e 'COMMAND <externalcommandstring>' | netcat 127.0.0.1 6558

Livestatus Filters

and, or, negate

Operator | Negate | Description ----------|------------------------ = | != | Euqality ~ | !~ | Regex match =~ | !=~ | Euqality ignoring case ~~ | !~~ | Regex ignoring case

   |          | Less than

< | | Greater than

= | | Less than or equal <= | | Greater than or equal

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

Livestatus Output

CSV Output uses two levels of array seperators: The members array separator is a comma (1st level) while extra info and host|service relation separator is a pipe (2nd level).

Seperators can be set using ASCII codes like:

Separators: 10 59 44 124

JSON

Default separators.

Livestatus Error Codes

Code	Description
200	OK
404	Table does not exist
452	Exception on query

Livestatus Schema Extensions

Icinga 2 specific extensions are shown below:

New table: endpoints

Table	Column
endpoints	name
endpoints	identity
endpoints	node
endpoints	is_connected

New columns:

Table	Column
services	check_source
downtimes	triggers
downtimes	trigger_time
commands	custom_variable_names
commands	custom_variable_values
commands	custom_variables
commands	modified_attributes
commands	modified_attributes_list
status	custom_variable_names
status	custom_variable_values
status	custom_variables

Command custom variables reflect the local 'vars' dictionary. Status custom variables reflect the global 'Vars' constant.

External Commands List

Additional details can be found in the Icinga 1.x Documentation

Command name	Parameters	Description
PROCESS_HOST_CHECK_RESULT	;<host_name>;<status_code>;<plugin_output> (3)
PROCESS_SERVICE_CHECK_RESULT	;<host_name>;<service_name>;<return_code>;<plugin_output> (4)
SCHEDULE_HOST_CHECK	;<host_name>;<check_time> (2)
SCHEDULE_FORCED_HOST_CHECK	;<host_name>;<check_time> (2)
SCHEDULE_SVC_CHECK	;<host_name>;<service_name>;<check_time> (3)
SCHEDULE_FORCED_SVC_CHECK	;<host_name>;<service_name>;<check_time> (3)
ENABLE_HOST_CHECK	;<host_name> (1)
DISABLE_HOST_CHECK	;<host_name> (1)
ENABLE_SVC_CHECK	;<host_name>;<service_name> (2)
DISABLE_SVC_CHECK	;<host_name>;<service_name> (2)
SHUTDOWN_PROCESS	(0)
RESTART_PROCESS	(0)
SCHEDULE_FORCED_HOST_SVC_CHECKS	;<host_name>;<check_time> (2)
SCHEDULE_HOST_SVC_CHECKS	;<host_name>;<check_time> (2)
ENABLE_HOST_SVC_CHECKS	;<host_name> (1)
DISABLE_HOST_SVC_CHECKS	;<host_name> (1)
ACKNOWLEDGE_SVC_PROBLEM	;<host_name>;<service_name>;;;;; (7)	Note: Icinga 2 treats all comments as persistent.
ACKNOWLEDGE_SVC_PROBLEM_EXPIRE	;<host_name>;<service_name>;;;;;; (8)	Note: Icinga 2 treats all comments as persistent.
REMOVE_SVC_ACKNOWLEDGEMENT	;<host_name>;<service_name> (2)
ACKNOWLEDGE_HOST_PROBLEM	;<host_name>;;;;; (6)	Note: Icinga 2 treats all comments as persistent.
ACKNOWLEDGE_HOST_PROBLEM_EXPIRE	;<host_name>;;;;;; (7)	Note: Icinga 2 treats all comments as persistent.
REMOVE_HOST_ACKNOWLEDGEMENT	;<host_name> (1)
DISABLE_HOST_FLAP_DETECTION	;<host_name> (1)
ENABLE_HOST_FLAP_DETECTION	;<host_name> (1)
DISABLE_SVC_FLAP_DETECTION	;<host_name>;<service_name> (2)
ENABLE_SVC_FLAP_DETECTION	;<host_name>;<service_name> (2)
ENABLE_HOSTGROUP_SVC_CHECKS	;<hostgroup_name> (1)
DISABLE_HOSTGROUP_SVC_CHECKS	;<hostgroup_name> (1)
ENABLE_SERVICEGROUP_SVC_CHECKS	;<servicegroup_name> (1)
DISABLE_SERVICEGROUP_SVC_CHECKS	;<servicegroup_name> (1)
ENABLE_PASSIVE_HOST_CHECKS	;<host_name> (1)
DISABLE_PASSIVE_HOST_CHECKS	;<host_name> (1)
ENABLE_PASSIVE_SVC_CHECKS	;<host_name>;<service_name> (2)
DISABLE_PASSIVE_SVC_CHECKS	;<host_name>;<service_name> (2)
ENABLE_SERVICEGROUP_PASSIVE_SVC_CHECKS	;<servicegroup_name> (1)
DISABLE_SERVICEGROUP_PASSIVE_SVC_CHECKS	;<servicegroup_name> (1)
ENABLE_HOSTGROUP_PASSIVE_SVC_CHECKS	;<hostgroup_name> (1)
DISABLE_HOSTGROUP_PASSIVE_SVC_CHECKS	;<hostgroup_name> (1)
PROCESS_FILE	;<file_name>; (2)
SCHEDULE_SVC_DOWNTIME	;<host_name>;<service_name>;<start_time>;<end_time>;;<trigger_id>;;; (9)
DEL_SVC_DOWNTIME	;<downtime_id> (1)
SCHEDULE_HOST_DOWNTIME	;<host_name>;<start_time>;<end_time>;;<trigger_id>;;; (8)
DEL_HOST_DOWNTIME	;<downtime_id> (1)
SCHEDULE_HOST_SVC_DOWNTIME	;<host_name>;<start_time>;<end_time>;;<trigger_id>;;; (8)
SCHEDULE_HOSTGROUP_HOST_DOWNTIME	;<hostgroup_name>;<start_time>;<end_time>;;<trigger_id>;;; (8)
SCHEDULE_HOSTGROUP_SVC_DOWNTIME	;<hostgroup_name>;<start_time>;<end_time>;;<trigger_id>;;; (8)
SCHEDULE_SERVICEGROUP_HOST_DOWNTIME	;<servicegroup_name>;<start_time>;<end_time>;;<trigger_id>;;; (8)
SCHEDULE_SERVICEGROUP_SVC_DOWNTIME	;<servicegroup_name>;<start_time>;<end_time>;;<trigger_id>;;; (8)
ADD_HOST_COMMENT	;<host_name>;;; (4)	Note: Icinga 2 treats all comments as persistent.
DEL_HOST_COMMENT	;<comment_id> (1)
ADD_SVC_COMMENT	;<host_name>;<service_name>;;; (5)	Note: Icinga 2 treats all comments as persistent.
DEL_SVC_COMMENT	;<comment_id> (1)
DEL_ALL_HOST_COMMENTS	;<host_name> (1)
DEL_ALL_SVC_COMMENTS	;<host_name>;<service_name> (2)
SEND_CUSTOM_HOST_NOTIFICATION	;<host_name>;;; (4)
SEND_CUSTOM_SVC_NOTIFICATION	;<host_name>;<service_name>;;; (5)
DELAY_HOST_NOTIFICATION	;<host_name>;<notification_time> (2)
DELAY_SVC_NOTIFICATION	;<host_name>;<service_name>;<notification_time> (3)
ENABLE_HOST_NOTIFICATIONS	;<host_name> (1)
DISABLE_HOST_NOTIFICATIONS	;<host_name> (1)
ENABLE_SVC_NOTIFICATIONS	;<host_name>;<service_name> (2)
DISABLE_SVC_NOTIFICATIONS	;<host_name>;<service_name> (2)
DISABLE_HOSTGROUP_HOST_CHECKS	;<hostgroup_name> (1)
DISABLE_HOSTGROUP_PASSIVE_HOST_CHECKS	;<hostgroup_name> (1)
DISABLE_SERVICEGROUP_HOST_CHECKS	;<servicegroup_name> (1)
DISABLE_SERVICEGROUP_PASSIVE_HOST_CHECKS	;<servicegroup_name> (1)
ENABLE_HOSTGROUP_HOST_CHECKS	;<hostgroup_name> (1)
ENABLE_HOSTGROUP_PASSIVE_HOST_CHECKS	;<hostgroup_name> (1)
ENABLE_SERVICEGROUP_HOST_CHECKS	;<servicegroup_name> (1)
ENABLE_SERVICEGROUP_PASSIVE_HOST_CHECKS	;<servicegroup_name> (1)
ENABLE_NOTIFICATIONS	(0)
DISABLE_NOTIFICATIONS	(0)
ENABLE_FLAP_DETECTION	(0)
DISABLE_FLAP_DETECTION	(0)
ENABLE_EVENT_HANDLERS	(0)
DISABLE_EVENT_HANDLERS	(0)
ENABLE_PERFORMANCE_DATA	(0)
DISABLE_PERFORMANCE_DATA	(0)
START_EXECUTING_HOST_CHECKS	(0)
STOP_EXECUTING_HOST_CHECKS	(0)
START_EXECUTING_SVC_CHECKS	(0)
STOP_EXECUTING_SVC_CHECKS	(0)
CHANGE_SVC_MODATTR	;<host_name>;<service_name>; (3)
CHANGE_HOST_MODATTR	;<host_name>; (2)
CHANGE_USER_MODATTR	;<user_name>; (2)
CHANGE_CHECKCOMMAND_MODATTR	;<checkcommand_name>; (2)
CHANGE_EVENTCOMMAND_MODATTR	;<eventcommand_name>; (2)
CHANGE_NOTIFICATIONCOMMAND_MODATTR	;<notificationcommand_name>; (2)
CHANGE_NORMAL_SVC_CHECK_INTERVAL	;<host_name>;<service_name>;<check_interval> (3)
CHANGE_NORMAL_HOST_CHECK_INTERVAL	;<host_name>;<check_interval> (2)
CHANGE_RETRY_SVC_CHECK_INTERVAL	;<host_name>;<service_name>;<check_interval> (3)
CHANGE_RETRY_HOST_CHECK_INTERVAL	;<host_name>;<check_interval> (2)
ENABLE_HOST_EVENT_HANDLER	;<host_name> (1)
DISABLE_HOST_EVENT_HANDLER	;<host_name> (1)
ENABLE_SVC_EVENT_HANDLER	;<host_name>;<service_name> (2)
DISABLE_SVC_EVENT_HANDLER	;<host_name>;<service_name> (2)
CHANGE_HOST_EVENT_HANDLER	;<host_name>;<event_command_name> (2)
CHANGE_SVC_EVENT_HANDLER	;<host_name>;<service_name>;<event_command_name> (3)
CHANGE_HOST_CHECK_COMMAND	;<host_name>;<check_command_name> (2)
CHANGE_SVC_CHECK_COMMAND	;<host_name>;<service_name>;<check_command_name> (3)
CHANGE_MAX_HOST_CHECK_ATTEMPTS	;<host_name>;<check_attempts> (2)
CHANGE_MAX_SVC_CHECK_ATTEMPTS	;<host_name>;<service_name>;<check_attempts> (3)
CHANGE_HOST_CHECK_TIMEPERIOD	;<host_name>;<timeperiod_name> (2)
CHANGE_SVC_CHECK_TIMEPERIOD	;<host_name>;<service_name>;<timeperiod_name>
CHANGE_CUSTOM_HOST_VAR	;<host_name>;<var_name>;<var_value> (3)
CHANGE_CUSTOM_SVC_VAR	;<host_name>;<service_name>;<var_name>;<var_value> (4)
CHANGE_CUSTOM_USER_VAR	;<user_name>;<var_name>;<var_value> (3)
CHANGE_CUSTOM_CHECKCOMMAND_VAR	;<check_command_name>;<var_name>;<var_value> (3)
CHANGE_CUSTOM_EVENTCOMMAND_VAR	;<event_command_name>;<var_name>;<var_value> (3)
CHANGE_CUSTOM_NOTIFICATIONCOMMAND_VAR	;<notification_command_name>;<var_name>;<var_value> (3)
ENABLE_HOSTGROUP_HOST_NOTIFICATIONS	;<hostgroup_name> (1)
ENABLE_HOSTGROUP_SVC_NOTIFICATIONS	;<hostgroup_name> (1)
DISABLE_HOSTGROUP_HOST_NOTIFICATIONS	;<hostgroup_name> (1)
DISABLE_HOSTGROUP_SVC_NOTIFICATIONS	;<hostgroup_name> (1)
ENABLE_SERVICEGROUP_HOST_NOTIFICATIONS	;<servicegroup_name> (1)
DISABLE_SERVICEGROUP_HOST_NOTIFICATIONS	;<servicegroup_name> (1)
ENABLE_SERVICEGROUP_SVC_NOTIFICATIONS	;<servicegroup_name> (1)
DISABLE_SERVICEGROUP_SVC_NOTIFICATIONS	;<servicegroup_name> (1)

27 KiB Raw Blame History

Appendix

Icinga Template Library

Overview

Check Commands

ping4

ping6

hostalive

dummy

passive

tcp

udp

http

smtp

ssmtp

ntp_time

ssh

disk

users

procs

swap

load

snmp

snmp-uptime

apt

icinga

plugin-check-command

plugin-check-command

plugin-check-command

Schemas

DB IDO

DB IDO Schema Extensions

Livestatus

Livestatus Tables

Livestatus Table Attributes

Livestatus GET Queries

Livestatus COMMAND Queries

Livestatus Filters

Livestatus Stats

Livestatus Output

Livestatus Error Codes

Livestatus Schema Extensions

External Commands List

27 KiB

Raw Blame History