tyler.durden
/
icinga2
mirror of https://github.com/Icinga/icinga2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation: Add object type anchors.

This commit is contained in:
Michael Friedrich 2013-10-11 18:13:49 +02:00
parent 1884edcc5e
commit 1bc9006bf2
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
doc/4.3-object-types.md
View File

@ -1,6 +1,6 @@
## Object Types ## Object Types
### Host ### <a id="objecttype-host"></a> Host
A host. A host.
@ -51,7 +51,7 @@ Attributes:
services |**Optional.** Inline definition of services. Each dictionary item specifies a service.<br /><br />The `templates` attribute can be used to specify an array of templates that should be inherited by the service.<br /><br />The new service's name is "hostname:service" - where "service" is the dictionary key in the services dictionary.<br /><br />The dictionary key is used as the service's short name. services |**Optional.** Inline definition of services. Each dictionary item specifies a service.<br /><br />The `templates` attribute can be used to specify an array of templates that should be inherited by the service.<br /><br />The new service's name is "hostname:service" - where "service" is the dictionary key in the services dictionary.<br /><br />The dictionary key is used as the service's short name.
macros |**Optional.** A dictionary containing macros that are specific to this host. macros |**Optional.** A dictionary containing macros that are specific to this host.
### HostGroup ### <a id="objecttype-hostgroup"></a> HostGroup
A group of hosts. A group of hosts.
@ -67,7 +67,7 @@ Attributes:
----------------|---------------- ----------------|----------------
display_name |**Optional.** A short description of the host group. display_name |**Optional.** A short description of the host group.
### Service ### <a id="objecttype-service"></a> Service
Service objects describe network services and how they should be checked Service objects describe network services and how they should be checked
by Icinga 2. by Icinga 2.
@ -120,7 +120,7 @@ Attributes:
groups |**Optional.** The service groups this service belongs to. groups |**Optional.** The service groups this service belongs to.
notifications |**Optional.** Inline definition of notifications. Each dictionary item specifies a notification.<br /><br />The `templates` attribute can be used to specify an array of templates that should be inherited by the notification object.<br /><br />The new notification object's name is "hostname:service:notification" - where "notification" is the dictionary key in the notifications dictionary. notifications |**Optional.** Inline definition of notifications. Each dictionary item specifies a notification.<br /><br />The `templates` attribute can be used to specify an array of templates that should be inherited by the notification object.<br /><br />The new notification object's name is "hostname:service:notification" - where "notification" is the dictionary key in the notifications dictionary.
### ServiceGroup ### <a id="objecttype-servicegroup"></a> ServiceGroup
A group of services. A group of services.
@ -136,7 +136,7 @@ Attributes:
----------------|---------------- ----------------|----------------
display_name |**Optional.** A short description of the service group. display_name |**Optional.** A short description of the service group.
### Notification ### <a id="objecttype-notification"></a> Notification
Notification objects are used to specify how users should be notified in case Notification objects are used to specify how users should be notified in case
of service state changes and other events. of service state changes and other events.
@ -174,7 +174,7 @@ Attributes:
notification_type_filter|TODO notification_type_filter|TODO
notification_state_filter|TODO notification_state_filter|TODO
### User ### <a id="objecttype-user"></a> User
A user. A user.
@ -194,7 +194,7 @@ Attributes:
notification_type_filter|TODO notification_type_filter|TODO
notification_state_filter|TODO notification_state_filter|TODO
### UserGroup ### <a id="objecttype-usergroup"></a> UserGroup
A user group. A user group.
@ -210,7 +210,7 @@ Attributes:
----------------|---------------- ----------------|----------------
display_name |**Optional.** A short description of the user group. display_name |**Optional.** A short description of the user group.
### TimePeriod ### <a id="objecttype-timeperiod"></a> TimePeriod
Time periods can be used to specify when services should be checked or to limit Time periods can be used to specify when services should be checked or to limit
when notifications should be sent out. 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. 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 ranges |TODO
### ConsoleLogger ### <a id="objecttype-consolelogger"></a> ConsoleLogger
Specifies Icinga 2 logging to the console. 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". severity |**Optional.** The minimum severity for this log. Can be "debug", "information", "warning" or "critical". Defaults to "information".
### FileLogger ### <a id="objecttype-filelogger"></a> FileLogger
Specifies Icinga 2 logging to a file. Specifies Icinga 2 logging to a file.
@ -261,7 +261,7 @@ Attributes:
path |**Required.** The log path. path |**Required.** The log path.
severity |**Optional.** The minimum severity for this log. Can be "debug", "information", "warning" or "critical". Defaults to "information". severity |**Optional.** The minimum severity for this log. Can be "debug", "information", "warning" or "critical". Defaults to "information".
### SyslogLogger ### <a id="objecttype-sysloglogger"></a> SyslogLogger
Specifies Icinga 2 logging to syslog. 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". severity |**Optional.** The minimum severity for this log. Can be "debug", "information", "warning" or "critical". Defaults to "information".
### CheckCommand ### <a id="objecttype-checkcommand"></a> CheckCommand
A check command definition. Additional default command macros can be A check command definition. Additional default command macros can be
defined here. defined here.
@ -304,7 +304,7 @@ Attributes:
macros |**Optional.** A dictionary containing macros that are specific to this command. macros |**Optional.** A dictionary containing macros that are specific to this command.
timeout |**Optional.** The command timeout in seconds. Defaults to 5 minutes. timeout |**Optional.** The command timeout in seconds. Defaults to 5 minutes.
### NotificationCommand ### <a id="objecttype-notificationcommand"></a> NotificationCommand
A notification command definition. A notification command definition.
@ -343,7 +343,7 @@ Attributes:
macros |**Optional.** A dictionary containing macros that are specific to this command. macros |**Optional.** A dictionary containing macros that are specific to this command.
timeout |**Optional.** The command timeout in seconds. Defaults to 5 minutes. timeout |**Optional.** The command timeout in seconds. Defaults to 5 minutes.
### EventCommand ### <a id="objecttype-eventcommand"></a> EventCommand
An event command definition. An event command definition.
@ -369,7 +369,7 @@ Attributes:
macros |**Optional.** A dictionary containing macros that are specific to this command. macros |**Optional.** A dictionary containing macros that are specific to this command.
timeout |**Optional.** The command timeout in seconds. Defaults to 5 minutes. timeout |**Optional.** The command timeout in seconds. Defaults to 5 minutes.
### PerfdataWriter ### <a id="objecttype-perfdatawriter"></a> PerfdataWriter
Writes check result performance data to a defined path using macro Writes check result performance data to a defined path using macro
pattern. pattern.
@ -397,7 +397,7 @@ Attributes:
> When rotating the performance data file the current UNIX timestamp is appended to the path specified > When rotating the performance data file the current UNIX timestamp is appended to the path specified
> in `perfdata\_path` to generate a unique filename. > in `perfdata\_path` to generate a unique filename.
### IdoMySqlConnection ### <a id="objecttype-idomysqlconnection"></a> IdoMySqlConnection
IDO DB schema compatible output into MySQL database. 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). 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). systemcommands_age |**Optional.** Max age for systemcommands table rows (start_time). Defaults to 0 (never).
### LiveStatusListener ### <a id="objecttype-livestatuslistener"></a> LiveStatusListener
Livestatus API interface available as TCP or UNIX socket. Livestatus API interface available as TCP or UNIX socket.
@ -487,7 +487,7 @@ Attributes:
> >
> UNIX sockets are not supported on Windows. > UNIX sockets are not supported on Windows.
### StatusDataWriter ### <a id="objecttype-statusdatawriter"></a> StatusDataWriter
Periodically writes status data files which are used by the Classic UI and other third-party tools. 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". 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". objects\_path |**Optional.** Path to the objects.cache file. Defaults to IcingaLocalStateDir + "/cache/icinga2/objects.cache".
### ExternalCommandListener ### <a id="objecttype-externalcommandlistener"></a> ExternalCommandListener
Implements the Icinga 1.x command pipe which can be used to send commands to Icinga. 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". command\_path |**Optional.** Path to the command pipe. Defaults to IcingaLocalStateDir + "/run/icinga2/cmd/icinga2.cmd".
### CompatLogger ### <a id="objecttype-compatlogger"></a> CompatLogger
Writes log files in a format that's compatible with Icinga 1.x. 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". 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". rotation\_method|**Optional.** Specifies when to rotate log files. Can be one of "HOURLY", "DAILY", "WEEKLY" or "MONTHLY". Defaults to "HOURLY".
### CheckResultReader ### <a id="objecttype-checkresultreader"></a> CheckResultReader
Reads Icinga 1.x check results from a directory. This functionality is provided 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 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/". spool\_dir |**Optional.** The directory which contains the check result files. Defaults to IcingaLocalStateDir + "/lib/icinga2/spool/checkresults/".
### CheckerComponent ### <a id="objecttype-checkcomponent"></a> CheckerComponent
The checker component is responsible for scheduling active checks. There are no configurable options. The checker component is responsible for scheduling active checks. There are no configurable options.
@ -575,7 +575,7 @@ Example:
object CheckerComponent "checker" { } object CheckerComponent "checker" { }
### NotificationComponent ### <a id="objecttype-notificationcomponent"></a> NotificationComponent
The notification component is responsible for sending notifications. There are no configurable options. The notification component is responsible for sending notifications. There are no configurable options.
@ -585,7 +585,7 @@ Example:
object NotificationComponent "notification" { } object NotificationComponent "notification" { }
### ClusterListener ### <a id="objecttype-clusterlistener"></a> ClusterListener
TODO TODO
@ -603,7 +603,7 @@ Attributes:
bind\_port |TODO bind\_port |TODO
peers |TODO peers |TODO
### Endpoint ### <a id="objecttype-endpoint"></a> Endpoint
Endpoint objects are used to specify connection information for remote Endpoint objects are used to specify connection information for remote
Icinga 2 instances. Icinga 2 instances.
@ -626,7 +626,7 @@ Attributes:
config\_files |TODO config\_files |TODO
accept\_config |**Optional.** A list of endpoint names from which this endpoint accepts configuration files. accept\_config |**Optional.** A list of endpoint names from which this endpoint accepts configuration files.
### Domain ### <a id="objecttype-domain"></a> Domain
TODO TODO