telekom_mms.icinga_director.icinga_scheduled_downtime module – Manage downtimes in Icinga2
Note
This module is part of the telekom_mms.icinga_director collection (version 2.1.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install telekom_mms.icinga_director
.
To use it in a playbook, specify: telekom_mms.icinga_director.icinga_scheduled_downtime
.
New in telekom_mms.icinga_director 1.25.0
Synopsis
Add or remove a downtime to Icinga2 through the director API.
Parameters
Parameter |
Comments |
---|---|
Do not overwrite the whole object but instead append the defined properties. Note - Appending to existing vars, imports or any other list/dict is not possible. You have to overwrite the complete list/dict. Note - Variables that are set by default will also be applied, even if not set. Choices:
|
|
Whether this dependency should affect hosts or services Required if state is Choices:
|
|
The filter where the downtime will take effect. |
|
Name of the downtime author. Required if state is |
|
PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, |
|
PEM formatted file that contains your private key to be used for SSL client authentication. If |
|
A descriptive comment for the downtime. Required if state is |
|
Disabled objects will not be deployed. Choices:
|
|
How long the downtime lasts. Only has an effect for flexible (non-fixed) downtimes. Time in seconds, supported suffixes include ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). To express “90 minutes” you might want to write 1h 30m |
|
Whether this downtime is fixed or flexible. If unsure please check the related documentation https://icinga.com/docs/icinga2/latest/doc/08-advanced-topics/#downtimes Required if state is Choices:
|
|
If Choices:
|
|
Credentials specified with Choices:
|
|
Header to identify as, generally appears in web server logs. Default: |
|
Icinga object name for this downtime. |
|
The period which should be downtimed Default: |
|
Apply feature state. Choices:
|
|
HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
|
The password for use in HTTP basic authentication. If the |
|
The username for use in HTTP basic authentication. This parameter can be used without |
|
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library gssapi to be installed. Credentials for GSSAPI can be specified with NTLM authentication is not supported even if the GSSAPI mech for NTLM has been installed. Choices:
|
|
If Choices:
|
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
|
Whether you only downtime the hosts or add some services with it. Choices:
|
Notes
Note
This module supports check mode.
Examples
- name: create icinga_scheduled_downtime
telekom_mms.icinga_director.icinga_scheduled_downtime:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
disabled: false
object_name: "foodowntime"
state: present
author: testuser
comment: test
fixed: true
with_services: true
apply_to: host
assign_filter: 'host.name="foohost"'
duration: 500
ranges:
"tuesday": "00:00-24:00"
- name: create icinga_scheduled_downtime2
telekom_mms.icinga_director.icinga_scheduled_downtime:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
disabled: false
object_name: "foodowntime2"
state: present
author: testuser
comment: test
fixed: false
with_services: false
apply_to: host
assign_filter: 'host.name="foohost"'
duration: 500
ranges:
"tuesday": "00:00-24:00"
- name: update icinga_scheduled_downtime2
telekom_mms.icinga_director.icinga_scheduled_downtime:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "foodowntime2"
state: present
duration: 1000
append: true
apply_to: host
with_services: false