From: Michael Friedrich Date: Fri, 4 Apr 2014 16:57:23 +0000 (+0200) Subject: Update documentation. X-Git-Tag: v0.0.10~221 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f64ba65eade9be6edd5d9cf08bdbcc09102e751a;p=icinga2 Update documentation. Refs #5855 Refs #5919 Refs #5939 --- diff --git a/doc/3.01-hosts-and-services.md b/doc/3.01-hosts-and-services.md index c82abb35b..97abc5e1d 100644 --- a/doc/3.01-hosts-and-services.md +++ b/doc/3.01-hosts-and-services.md @@ -16,7 +16,7 @@ Here is an example of a host object which defines two child services: object Host "my-server1" { vars.address = "10.0.0.1" - check = "ping4" + check_command = "hostcheck" } apply Service "ping4" { @@ -32,17 +32,10 @@ Here is an example of a host object which defines two child services: The example host `my-server1` creates two services which belong to this host: `ping4` and `http`. -It also specifies that the host should inherit its availability state from the -`ping4` service. +It also specifies that the host should perform its own check using the `hostcheck` +check command. -> **Note** -> -> In Icinga 1.x hosts had their own check command, check interval and -> notification settings. Instead, in Icinga 2 hosts inherit their state -> from one of its child services. No checks are performed for the host -> itself. - -The `address` macro is used by check commands to determine which network +The `address` custom attribute is used by check commands to determine which network address is associated with the host object. ### Host States diff --git a/doc/3.09-event-handlers.md b/doc/3.09-event-handlers.md index d1aafbe94..54bddb59d 100644 --- a/doc/3.09-event-handlers.md +++ b/doc/3.09-event-handlers.md @@ -2,7 +2,7 @@ Event handlers are defined as `EventCommand` objects in Icinga 2. -Unlike notifications event commands are called on every service state change +Unlike notifications event commands are called on every host/service state change if defined. Therefore the `EventCommand` object should define a command line evaluating the current service state and other service runtime attributes available through runtime macros. Runtime macros such as `$SERVICESTATETYPE$` diff --git a/doc/4.3-object-types.md b/doc/4.3-object-types.md index 1d114f35b..8fe9bef8d 100644 --- a/doc/4.3-object-types.md +++ b/doc/4.3-object-types.md @@ -4,12 +4,6 @@ A host. -> **Note** -> -> Unlike in Icinga 1.x hosts are not checkable objects in Icinga 2. Instead -> hosts inherit their state from the service that is specified using the `check` -> attribute. - Example: object Host "localhost" { @@ -17,7 +11,7 @@ Example: groups = [ "all-hosts" ] - check = "ping" + check_command = "hostcheck" } Attributes: diff --git a/doc/5-icinga-template-library.md b/doc/5-icinga-template-library.md index 1169d12c9..de5bef68a 100644 --- a/doc/5-icinga-template-library.md +++ b/doc/5-icinga-template-library.md @@ -19,7 +19,7 @@ the path of the plugins from the Monitoring Plugins project. Check command object for the `check_ping` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -35,7 +35,7 @@ timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no Check command object for the `check_ping` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -47,11 +47,27 @@ cpl | **Optional.** The packet loss critical threshold in %. Default packets | **Optional.** The number of packets to send. Defaults to 5. timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). +### hostcheck + +Check command object for the `check_ping` plugin with host check default values. + +Custom Attributes: + +Name | Description +----------------|-------------- +address | **Required.** The host's IPv4 address. +wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.0. +wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80. +crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.0. +cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100. +packets | **Optional.** The number of packets to send. Defaults to 5. +timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). + ### dummy Check command object for the `check_dummy` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -62,7 +78,7 @@ text | **Optional.** Plugin output. Defaults to "Check was successful Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -73,7 +89,7 @@ text | **Optional.** Plugin output. Defaults to "No Passive Check Res Check command object for the `check_tcp` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -84,7 +100,7 @@ port | **Required.** The port that should be checked. Check command object for the `check_udp` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -95,7 +111,7 @@ port | **Required.** The port that should be checked. Check command object for the `check_http` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -105,7 +121,7 @@ vhost | **Required.** The name of the virtual host that should be chec Check command object for the `check_http` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -115,7 +131,7 @@ address | **Required.** The host's address. Check command object for the `check_http` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -125,7 +141,7 @@ vhost | **Required.** The name of the virtual host that should be chec Check command object for the `check_http` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -135,7 +151,7 @@ address | **Required.** The host's address. Check command object for the `check_smtp` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -145,7 +161,7 @@ address | **Required.** The host's address. Check command object for the `check_ssmtp` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -156,7 +172,7 @@ port | **Optional.** The port that should be checked. Defaults to 465 Check command object for the `check_ntp_time` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -166,7 +182,7 @@ address | **Required.** The host's address. Check command object for the `check_ssh` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -176,7 +192,7 @@ address | **Required.** The host's address. Check command object for the `check_disk` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -187,7 +203,7 @@ cfree | **Optional.** The free space critical threshold in %. Defaults Check command object for the `check_disk` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -198,7 +214,7 @@ cgreater | **Optional.** The user count critical threshold. Defaults to 5 Check command object for the `check_processes` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -209,7 +225,7 @@ cgreater | **Optional.** The process count critical threshold. Defaults t Check command object for the `check_load` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -224,7 +240,7 @@ cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4. Check command object for the `check_snmp` plugin. -Macros: +Custom Attributes: Name | Description ----------------|-------------- @@ -236,7 +252,7 @@ community | **Optional.** The SNMP community. Defaults to "public". Check command object for the `check_snmp` plugin. -Macros: +Custom Attributes: Name | Description ----------------|--------------