From: Michael Friedrich Date: Fri, 11 Oct 2013 16:13:49 +0000 (+0200) Subject: Documentation: Add object type anchors. X-Git-Tag: v0.0.3~154 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1bc9006bf281ff8703638f98929ecf93dcd1413a;p=icinga2 Documentation: Add object type anchors. --- diff --git a/doc/4.3-object-types.md b/doc/4.3-object-types.md index 99f0fa280..76a18e825 100644 --- a/doc/4.3-object-types.md +++ b/doc/4.3-object-types.md @@ -1,6 +1,6 @@ ## Object Types -### Host +### Host A host. @@ -51,7 +51,7 @@ Attributes: services |**Optional.** Inline definition of services. Each dictionary item specifies a service.

The `templates` attribute can be used to specify an array of templates that should be inherited by the service.

The new service's name is "hostname:service" - where "service" is the dictionary key in the services dictionary.

The dictionary key is used as the service's short name. macros |**Optional.** A dictionary containing macros that are specific to this host. -### HostGroup +### HostGroup A group of hosts. @@ -67,7 +67,7 @@ Attributes: ----------------|---------------- display_name |**Optional.** A short description of the host group. -### Service +### Service Service objects describe network services and how they should be checked by Icinga 2. @@ -120,7 +120,7 @@ Attributes: groups |**Optional.** The service groups this service belongs to. notifications |**Optional.** Inline definition of notifications. Each dictionary item specifies a notification.

The `templates` attribute can be used to specify an array of templates that should be inherited by the notification object.

The new notification object's name is "hostname:service:notification" - where "notification" is the dictionary key in the notifications dictionary. -### ServiceGroup +### ServiceGroup A group of services. @@ -136,7 +136,7 @@ Attributes: ----------------|---------------- display_name |**Optional.** A short description of the service group. -### Notification +### Notification Notification objects are used to specify how users should be notified in case of service state changes and other events. @@ -174,7 +174,7 @@ Attributes: notification_type_filter|TODO notification_state_filter|TODO -### User +### User A user. @@ -194,7 +194,7 @@ Attributes: notification_type_filter|TODO notification_state_filter|TODO -### UserGroup +### UserGroup A user group. @@ -210,7 +210,7 @@ Attributes: ----------------|---------------- display_name |**Optional.** A short description of the user group. -### TimePeriod +### TimePeriod Time periods can be used to specify when services should be checked or to limit when notifications should be sent out. @@ -227,7 +227,7 @@ Attributes: methods |**Required.** The "update" script method takes care of updating the internal representation of the time period. In virtually all cases you should just inherit from the "legacy-timeperiod" template to take care of this setting. ranges |TODO -### ConsoleLogger +### ConsoleLogger Specifies Icinga 2 logging to the console. @@ -243,7 +243,7 @@ Attributes: ----------------|---------------- severity |**Optional.** The minimum severity for this log. Can be "debug", "information", "warning" or "critical". Defaults to "information". -### FileLogger +### FileLogger Specifies Icinga 2 logging to a file. @@ -261,7 +261,7 @@ Attributes: path |**Required.** The log path. severity |**Optional.** The minimum severity for this log. Can be "debug", "information", "warning" or "critical". Defaults to "information". -### SyslogLogger +### SyslogLogger Specifies Icinga 2 logging to syslog. @@ -277,7 +277,7 @@ Attributes: ----------------|---------------- severity |**Optional.** The minimum severity for this log. Can be "debug", "information", "warning" or "critical". Defaults to "information". -### CheckCommand +### CheckCommand A check command definition. Additional default command macros can be defined here. @@ -304,7 +304,7 @@ Attributes: macros |**Optional.** A dictionary containing macros that are specific to this command. timeout |**Optional.** The command timeout in seconds. Defaults to 5 minutes. -### NotificationCommand +### NotificationCommand A notification command definition. @@ -343,7 +343,7 @@ Attributes: macros |**Optional.** A dictionary containing macros that are specific to this command. timeout |**Optional.** The command timeout in seconds. Defaults to 5 minutes. -### EventCommand +### EventCommand An event command definition. @@ -369,7 +369,7 @@ Attributes: macros |**Optional.** A dictionary containing macros that are specific to this command. timeout |**Optional.** The command timeout in seconds. Defaults to 5 minutes. -### PerfdataWriter +### PerfdataWriter Writes check result performance data to a defined path using macro pattern. @@ -397,7 +397,7 @@ Attributes: > When rotating the performance data file the current UNIX timestamp is appended to the path specified > in `perfdata\_path` to generate a unique filename. -### IdoMySqlConnection +### IdoMySqlConnection IDO DB schema compatible output into MySQL database. @@ -455,7 +455,7 @@ Cleanup Items: servicechecks_age |**Optional.** Max age for servicechecks table rows (start_time). Defaults to 0 (never). systemcommands_age |**Optional.** Max age for systemcommands table rows (start_time). Defaults to 0 (never). -### LiveStatusListener +### LiveStatusListener Livestatus API interface available as TCP or UNIX socket. @@ -487,7 +487,7 @@ Attributes: > > UNIX sockets are not supported on Windows. -### StatusDataWriter +### StatusDataWriter Periodically writes status data files which are used by the Classic UI and other third-party tools. @@ -507,7 +507,7 @@ Attributes: status\_path |**Optional.** Path to the status.dat file. Defaults to IcingaLocalStateDir + "/cache/icinga2/status.dat". objects\_path |**Optional.** Path to the objects.cache file. Defaults to IcingaLocalStateDir + "/cache/icinga2/objects.cache". -### ExternalCommandListener +### ExternalCommandListener Implements the Icinga 1.x command pipe which can be used to send commands to Icinga. @@ -525,7 +525,7 @@ Attributes: ----------------|---------------- command\_path |**Optional.** Path to the command pipe. Defaults to IcingaLocalStateDir + "/run/icinga2/cmd/icinga2.cmd". -### CompatLogger +### CompatLogger Writes log files in a format that's compatible with Icinga 1.x. @@ -545,7 +545,7 @@ Attributes: log\_dir |**Optional.** Path to the compat log directory. Defaults to IcingaLocalStateDir + "/log/icinga2/compat". rotation\_method|**Optional.** Specifies when to rotate log files. Can be one of "HOURLY", "DAILY", "WEEKLY" or "MONTHLY". Defaults to "HOURLY". -### CheckResultReader +### CheckResultReader Reads Icinga 1.x check results from a directory. This functionality is provided to help existing Icinga 1.x users and might be useful for certain cluster @@ -565,7 +565,7 @@ Attributes: ----------------|---------------- spool\_dir |**Optional.** The directory which contains the check result files. Defaults to IcingaLocalStateDir + "/lib/icinga2/spool/checkresults/". -### CheckerComponent +### CheckerComponent The checker component is responsible for scheduling active checks. There are no configurable options. @@ -575,7 +575,7 @@ Example: object CheckerComponent "checker" { } -### NotificationComponent +### NotificationComponent The notification component is responsible for sending notifications. There are no configurable options. @@ -585,7 +585,7 @@ Example: object NotificationComponent "notification" { } -### ClusterListener +### ClusterListener TODO @@ -603,7 +603,7 @@ Attributes: bind\_port |TODO peers |TODO -### Endpoint +### Endpoint Endpoint objects are used to specify connection information for remote Icinga 2 instances. @@ -626,7 +626,7 @@ Attributes: config\_files |TODO accept\_config |**Optional.** A list of endpoint names from which this endpoint accepts configuration files. -### Domain +### Domain TODO