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

Update documentation 

fixes #9399
This commit is contained in:
Michael Friedrich 2015-06-15 11:03:45 +02:00
parent 228e1a11a2
commit ca60591f63
2 changed files with 1 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/3-monitoring-basics.md
View File

@ -535,7 +535,7 @@ Detailed examples can be found in the [dependencies](3-monitoring-basics.md#depe
### <a id="using-apply-scheduledowntimes"></a> Apply Recurring Downtimes to Hosts and Services ### <a id="using-apply-scheduledowntimes"></a> Apply Recurring Downtimes to Hosts and Services
The sample confituration includes an example in [downtimes.conf](5-configuring-icinga-2.md#downtimes-conf). The sample configuration includes an example in [downtimes.conf](5-configuring-icinga-2.md#downtimes-conf).
Detailed examples can be found in the [recurring downtimes](4-advanced-topics.md#recurring-downtimes) chapter. Detailed examples can be found in the [recurring downtimes](4-advanced-topics.md#recurring-downtimes) chapter.

7
doc/6-object-types.md
View File

@ -86,7 +86,6 @@ Configuration Attributes:
env |**Optional.** A dictionary of macros which should be exported as environment variables prior to executing the command. env |**Optional.** A dictionary of macros which should be exported as environment variables prior to executing the command.
vars |**Optional.** A dictionary containing custom attributes that are specific to this command. vars |**Optional.** A dictionary containing custom attributes that are specific to this command.
timeout |**Optional.** The command timeout in seconds. Defaults to 60 seconds. timeout |**Optional.** The command timeout in seconds. Defaults to 60 seconds.
zone |**Optional.** The zone this object is a member of.
arguments |**Optional.** A dictionary of command arguments. arguments |**Optional.** A dictionary of command arguments.
@ -254,7 +253,6 @@ Configuration Attributes:
disable_notifications |**Optional.** Whether to disable notifications when this dependency fails. Defaults to true. disable_notifications |**Optional.** Whether to disable notifications when this dependency fails. Defaults to true.
ignore_soft_states |**Optional.** Whether to ignore soft states for the reachability calculation. Defaults to true. ignore_soft_states |**Optional.** Whether to ignore soft states for the reachability calculation. Defaults to true.
period |**Optional.** Time period during which this dependency is enabled. period |**Optional.** Time period during which this dependency is enabled.
zone |**Optional.** The zone this object is a member of.
states |**Optional.** A list of state filters when this dependency should be OK. Defaults to [ OK, Warning ] for services and [ Up ] for hosts. states |**Optional.** A list of state filters when this dependency should be OK. Defaults to [ OK, Warning ] for services and [ Up ] for hosts.
Available state filters: Available state filters:
@ -913,7 +911,6 @@ Configuration Attributes:
env |**Optional.** A dictionary of macros which should be exported as environment variables prior to executing the command. env |**Optional.** A dictionary of macros which should be exported as environment variables prior to executing the command.
vars |**Optional.** A dictionary containing custom attributes that are specific to this command. vars |**Optional.** A dictionary containing custom attributes that are specific to this command.
timeout |**Optional.** The command timeout in seconds. Defaults to 60 seconds. timeout |**Optional.** The command timeout in seconds. Defaults to 60 seconds.
zone |**Optional.** The zone this object is a member of.
arguments |**Optional.** A dictionary of command arguments. arguments |**Optional.** A dictionary of command arguments.
Command arguments can be used the same way as for [CheckCommand objects](6-object-types.md#objecttype-checkcommand-arguments). Command arguments can be used the same way as for [CheckCommand objects](6-object-types.md#objecttype-checkcommand-arguments).
@ -1031,7 +1028,6 @@ Configuration Attributes:
comment |**Required.** A comment for the downtime. comment |**Required.** A comment for the downtime.
fixed |**Optional.** Whether this is a fixed downtime. Defaults to true. fixed |**Optional.** Whether this is a fixed downtime. Defaults to true.
duration |**Optional.** How long the downtime lasts. Only has an effect for flexible (non-fixed) downtimes. duration |**Optional.** How long the downtime lasts. Only has an effect for flexible (non-fixed) downtimes.
zone |**Optional.** The zone this object is a member of.
ranges |**Required.** A dictionary containing information which days and durations apply to this timeperiod. ranges |**Required.** A dictionary containing information which days and durations apply to this timeperiod.
ScheduledDowntime objects have composite names, i.e. their names are based ScheduledDowntime objects have composite names, i.e. their names are based
@ -1218,7 +1214,6 @@ Configuration Attributes:
----------------|---------------- ----------------|----------------
display_name |**Optional.** A short description of the time period. display_name |**Optional.** A short description of the time period.
update |**Required.** The "update" script method takes care of updating the internal representation of the time period. In virtually all cases you should import the "legacy-timeperiod" template to take care of this setting. update |**Required.** The "update" script method takes care of updating the internal representation of the time period. In virtually all cases you should import the "legacy-timeperiod" template to take care of this setting.
zone |**Optional.** The zone this object is a member of.
ranges |**Required.** A dictionary containing information which days and durations apply to this timeperiod. ranges |**Required.** A dictionary containing information which days and durations apply to this timeperiod.
The `/etc/icinga2/conf.d/timeperiods.conf` file is usually used to define The `/etc/icinga2/conf.d/timeperiods.conf` file is usually used to define
@ -1285,7 +1280,6 @@ Configuration Attributes:
period |**Optional.** The name of a time period which determines when a notification for this user should be triggered. Not set by default. period |**Optional.** The name of a time period which determines when a notification for this user should be triggered. Not set by default.
types |**Optional.** A set of type filters when this notification should be triggered. By default everything is matched. types |**Optional.** A set of type filters when this notification should be triggered. By default everything is matched.
states |**Optional.** A set of state filters when this notification should be triggered. By default everything is matched. states |**Optional.** A set of state filters when this notification should be triggered. By default everything is matched.
zone |**Optional.** The zone this object is a member of.
Runtime Attributes: Runtime Attributes:
@ -1313,7 +1307,6 @@ Configuration Attributes:
----------------|---------------- ----------------|----------------
display_name |**Optional.** A short description of the user group. display_name |**Optional.** A short description of the user group.
groups |**Optional.** An array of nested group names. groups |**Optional.** An array of nested group names.
zone |**Optional.** The zone this object is a member of.
## <a id="objecttype-zone"></a> Zone ## <a id="objecttype-zone"></a> Zone