telekom_mms.icinga_director.icinga_dependency_template module – Manage dependency templates in Icinga2

Note

This module is part of the telekom_mms.icinga_director collection (version 2.4.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 telekom_mms.icinga_director.

To use it in a playbook, specify: telekom_mms.icinga_director.icinga_dependency_template.

Synopsis

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

Parameters

Parameter

Comments

api_timeout

integer

Default timeout to wait for transaction to finish in seconds.

Default: 10

append

boolean

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:

  • false

  • true

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.

disable_checks

boolean

Whether to disable checks when this dependency fails.

Choices:

  • false

  • true

disable_notifications

boolean

Whether to disable notifications when this dependency fails.

Choices:

  • false

  • true

force

boolean

If yes do not get a cached copy.

Choices:

  • false ← (default)

  • true

force_basic_auth

boolean

Credentials specified with url_username and url_password should be passed in HTTP Header.

Choices:

  • false ← (default)

  • true

http_agent

string

Header to identify as, generally appears in web server logs.

Default: "ansible-httpget"

ignore_soft_states

boolean

Whether to ignore soft states for the reachability calculation.

Choices:

  • false

  • true

object_name

aliases: name

string / required

Name for the Icinga dependency apply rule.

parent_host

string

The parent host.

parent_service

string

The parent service. If omitted this dependency object is treated as host dependency.

period

string

The name of a time period which determines when this notification should be triggered.

state

string

Apply feature state.

Choices:

  • "present" ← (default)

  • "absent"

states

list / elements=string

The host/service states you want to get notifications for.

Choices:

  • "Critical"

  • "Down"

  • "OK"

  • "Unknown"

  • "Up"

  • "Warning"

Default: []

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 ansible-core 2.11

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.

Choices:

  • false ← (default)

  • true

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

zone

string

Icinga cluster zone.

Notes

Note

  • This module supports check mode.

Examples

- name: Add dependency template to icinga
  telekom_mms.icinga_director.icinga_dependency_template:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: footdependencytemplate
    period: "24/7"

- name: Add dependency template to icinga with customization
  telekom_mms.icinga_director.icinga_dependency_template:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: footdependencytemplatecustom
    disable_checks: true
    disable_notifications: true
    ignore_soft_states: false
    period: "24/7"
    zone: master
    states:
      - Warning
      - Critical

- name: Update dependency template with ignore_soft_states
  telekom_mms.icinga_director.icinga_dependency_template:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: footdependencytemplateappend
    ignore_soft_states: true
    append: true

Authors

  • Gianmarco Mameli (@gianmarco-mameli)