Skip to content

icinga_dependency_apply.rst

Latest commit

 

History

History
231 lines (128 loc) · 6.16 KB

icinga_dependency_apply.rst

File metadata and controls

231 lines (128 loc) · 6.16 KB

icinga_dependency_apply -- Manage dependency apply rules in Icinga2

Synopsis

Add or remove a dependency apply rule to Icinga2 through the director API.

Parameters

state (optional, str, present)
Apply feature state.
object_name (True, str, None)
Name for the Icinga dependency apply rule.
imports (optional, list, None)

Importable templates, add as many as you want. Required when state is present.

Please note that order matters when importing properties from multiple templates - last one wins.

Required if state is present.

apply_to (optional, str, None)

Whether this notification should affect hosts or services.

Required if state is present.

parent_host (optional, str, None)
The parent host. You can refer to Host Custom Variables via $host.vars.varname$
parent_service (optional, str, None)
The parent service. If omitted this dependency object is treated as host dependency. You can refer to Host Custom Variables via $host.vars.varname$
disable_checks (False, bool, None)
Whether to disable checks when this dependency fails.
disable_notifications (False, bool, None)
Whether to disable notifications when this dependency fails.
ignore_soft_states (False, bool, None)
Whether to ignore soft states for the reachability calculation.
period (False, str, None)
The name of a time period which determines when this notification should be triggered.
zone (False, str, None)
Icinga cluster zone.
states (False, list, None)
The host/service states you want to get notifications for.
append (optional, bool, None)

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.

assign_filter (optional, str, None)
The filter where the service apply rule will take effect.
url (True, str, None)
HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
force (optional, bool, False)
If yes do not get a cached copy.
http_agent (optional, str, ansible-httpget)
Header to identify as, generally appears in web server logs.
use_proxy (optional, bool, True)
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs (optional, bool, True)

If no, SSL certificates will not be validated.

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

url_username (optional, str, None)

The username for use in HTTP basic authentication.

This parameter can be used without url_password for sites that allow empty passwords.

url_password (optional, str, None)

The password for use in HTTP basic authentication.

If the url_username parameter is not specified, the url_password parameter will not be used.

force_basic_auth (optional, bool, False)
Credentials specified with url_username and url_password should be passed in HTTP Header.
client_cert (optional, path, None)

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 (optional, path, None)

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.

use_gssapi (optional, bool, False)

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 :envvar:`KRB5CCNAME` that specified a custom Kerberos credential cache.

NTLM authentication is not supported even if the GSSAPI mech for NTLM has been installed.

api_timeout (optional, int, 10)
Default timeout to wait for transaction to finish in seconds.

Notes

Note

  • This module supports check mode.

Examples

- name: Add dependency apply to icinga
  telekom_mms.icinga_director.icinga_dependency_apply:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: foodependencyapply
    imports:
      - footdependencytemplate
    apply_to: host
    assign_filter: 'host.name="foohost"'

- name: Add dependency apply to icinga with customization
  telekom_mms.icinga_director.icinga_dependency_apply:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: foodependencyapplycustom
    imports:
      - footdependencytemplate
    apply_to: host
    parent_host: $host.vars.variable$
    assign_filter: 'host.name="foohost"'
    disable_checks: true
    disable_notifications: true
    ignore_soft_states: false
    period: "24/7"
    zone: master
    states:
      - Critical
      - Warning

- name: Update dependency apply rule with ignore_soft_states
  telekom_mms.icinga_director.icinga_dependency_apply:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: foodependencyapply
    ignore_soft_states: true
    append: true

Status

Authors

  • Gianmarco Mameli (@gianmarco-mameli)