Skip to content

Commit bde67a9

Browse files
author
T-Systems MMS
committed
update documentation
1 parent 9ee0826 commit bde67a9

2 files changed

Lines changed: 33 additions & 19 deletions

File tree

docs/icinga_host.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ Parameters
4949

5050

5151
check_interval (optional, str, None)
52-
Your regular check interval
52+
Your regular check interval.
5353

5454

5555
check_period (optional, str, None)
5656
The name of a time period which determines when this object should be monitored. Not limited by default.
5757

5858

5959
check_timeout (optional, str, None)
60-
Check command timeout in seconds. Overrides the CheckCommand's timeout attribute.
60+
Check command timeout in seconds. Overrides the CheckCommand's timeout attribute
6161

6262

6363
command_endpoint (optional, str, None)
@@ -75,6 +75,7 @@ Parameters
7575
enable_active_checks (optional, bool, None)
7676
Whether to actively check this object.
7777

78+
7879
enable_event_handler (optional, bool, None)
7980
Whether to enable event handlers this object.
8081

@@ -160,7 +161,7 @@ Parameters
160161

161162
Separate multiple urls like this "'http://url1' 'http://url2'".
162163

163-
The maximum length is 255 characters.
164+
Maximum length is 255 characters.
164165

165166

166167
object_name (True, str, None)

docs/icinga_host_template.rst

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ Parameters
4949

5050

5151
check_interval (optional, str, None)
52-
Your regular check interval
52+
Your regular check interval.
5353

5454

5555
check_period (optional, str, None)
5656
The name of a time period which determines when this object should be monitored. Not limited by default.
5757

5858

5959
check_timeout (optional, str, None)
60-
Check command timeout in seconds. Overrides the CheckCommand's timeout attribute.
60+
Check command timeout in seconds. Overrides the CheckCommand's timeout attribute
6161

6262

6363
command_endpoint (optional, str, None)
@@ -75,6 +75,7 @@ Parameters
7575
enable_active_checks (optional, bool, None)
7676
Whether to actively check this object.
7777

78+
7879
enable_event_handler (optional, bool, None)
7980
Whether to enable event handlers this object.
8081

@@ -138,9 +139,7 @@ Parameters
138139

139140

140141
imports (optional, list, None)
141-
Choose a Host Template. Required when state is ``present``.
142-
143-
Required if *state* is ``present``.
142+
Choose a host-template.
144143

145144

146145
master_should_connect (optional, bool, None)
@@ -160,7 +159,7 @@ Parameters
160159

161160
Separate multiple urls like this "'http://url1' 'http://url2'".
162161

163-
The maximum length is 255 characters.
162+
Maximum length is 255 characters.
164163

165164

166165
object_name (True, str, None)
@@ -279,21 +278,35 @@ Examples
279278
url: "{{ icinga_url }}"
280279
url_username: "{{ icinga_user }}"
281280
url_password: "{{ icinga_pass }}"
282-
object_name: foohosttemplate
283-
display_name: foohosttemplate
284-
disabled: false
285-
check_command: dummy
281+
accept_config: true
282+
check_command: hostalive
286283
check_interval: 90s
287-
retry_interval: 30s
284+
check_timeout: 60
285+
command_endpoint: fooendpoint
286+
disabled: false
287+
display_name: foohosttemplate
288+
enable_active_checks: true
289+
enable_event_handler: false
290+
enable_flapping: false
291+
enable_notifications: true
292+
enable_passive_checks: false
293+
enable_perfdata: false
294+
flapping_threshold_high: "30.0"
295+
flapping_threshold_low: "25.0"
296+
has_agent: true
297+
icon_image_alt: "alt text"
298+
icon_image: "http://url1"
299+
master_should_connect: true
300+
max_check_attempts: 3
301+
object_name: foohosttemplate
302+
retry_interval: "1m"
303+
volatile: false
288304
groups:
289305
- "foohostgroup"
290306
imports:
291307
- ''
292-
has_agent: true
293-
master_should_connect: true
294-
max_check_attempts: 3
295-
accept_config: true
296-
command_endpoint: fooendpoint
308+
vars:
309+
dnscheck: "no"
297310

298311
- name: Update host template
299312
t_systems_mms.icinga_director.icinga_host_template:

0 commit comments

Comments
 (0)