t_systems_mms.icinga_director.icinga_timeperiod_template – Manage timeperiod templates in Icinga2

Note

This plugin is part of the t_systems_mms.icinga_director collection (version 1.26.0).

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 t_systems_mms.icinga_director.

To use it in a playbook, specify: t_systems_mms.icinga_director.icinga_timeperiod_template.

New in version 1.17.0: of t_systems_mms.icinga_director

Synopsis

  • Add or remove a timeperiod template to Icinga2 through the director API.

Parameters

Parameter Choices/Defaults Comments
append
boolean
added in 1.25.0 of t_systems_mms.icinga_director
    Choices:
  • no
  • yes
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.
client_cert
path
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, client_key is not required.
client_key
path
PEM formatted file that contains your private key to be used for SSL client authentication.
If client_cert contains both the certificate and key, this option is not required.
disabled
boolean
    Choices:
  • no ←
  • yes
Disabled objects will not be deployed.
display_name
string
Alternative name for this timeperiod template.
excludes
list / elements=string
Exclude other time periods from this.

aliases: exclude_period
force
boolean
    Choices:
  • no ←
  • yes
If yes do not get a cached copy.
Alias thirsty has been deprecated and will be removed in 2.13.

aliases: thirsty
force_basic_auth
boolean
    Choices:
  • no ←
  • yes
Credentials specified with url_username and url_password should be passed in HTTP Header.
http_agent
string
Default:
"ansible-httpget"
Header to identify as, generally appears in web server logs.
imports
list / elements=string
Importable templates, add as many as you want.
Please note that order matters when importing properties from multiple templates - last one wins.
includes
list / elements=string
Include other time periods into this.

aliases: include_period
object_name
string / required
Name of the time period.

aliases: name
prefer_includes
boolean
    Choices:
  • no
  • yes ←
Whether to prefer timeperiods includes or excludes. Default to true.
ranges
dictionary
A dict of days and timeperiods.
state
string
    Choices:
  • present ←
  • absent
Apply feature state.
update_method
string
Default:
"LegacyTimePeriod"
Define the update method.
url
string / required
HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
url_password
string
The password for use in HTTP basic authentication.
If the url_username parameter is not specified, the url_password parameter will not be used.
url_username
string
The username for use in HTTP basic authentication.
This parameter can be used without url_password for sites that allow empty passwords
use_gssapi
boolean
added in 2.11 of ansible.builtin
    Choices:
  • no ←
  • yes
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 url_username/url_password or with the GSSAPI env var KRB5CCNAME that specified a custom Kerberos credential cache.
NTLM authentication is not supported even if the GSSAPI mech for NTLM has been installed.
use_proxy
boolean
    Choices:
  • no
  • yes ←
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated.
This should only be used on personally controlled sites using self-signed certificates.
zone
string
Set the zone.

Notes

Note

  • This module supports check mode.

Examples

- name: Create timeperiod template
  t_systems_mms.icinga_director.icinga_timeperiod_template:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "timeperiod_template"
    imports: []
    disabled: false
    prefer_includes: false
    ranges:
      monday: "00:00-23:59"
      tuesday: "00:00-23:59"
      wednesday: "00:00-23:59"
      thursday: "00:00-23:59"
      friday: "00:00-23:59"
      saturday: "00:00-23:59"
      sunday: "00:00-23:59"
    update_method: "LegacyTimePeriod"

- name: Update timeperiod template
  t_systems_mms.icinga_director.icinga_timeperiod_template:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "timeperiod_template"
    display_name: "timeperiod template"
    append: true

Authors

  • Sebastian Gumprich (@rndmh3ro)