t_systems_mms.icinga_director.icinga_endpoint – Manage endpoints in Icinga2

Note

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

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_endpoint.

New in version 1.5.0: of t_systems_mms.icinga_director

Synopsis

  • Add or remove an endpoint to Icinga2 through the director API.

Parameters

Parameter Choices/Defaults Comments
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.
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.
host
string
The hostname/IP address of the remote Icinga 2 instance.
http_agent
string
Default:
"ansible-httpget"
Header to identify as, generally appears in web server logs.
log_duration
string
Duration for keeping replay logs on connection loss. Defaults to 1d (86400 seconds). Attribute is specified in seconds. If log_duration is set to 0, replaying logs is disabled. You could also specify the value in human readable format like 10m for 10 minutes or 1h for one hour.
object_name
string / required
Icinga object name for this endpoint.
This is usually a fully qualified host name but it could basically be any kind of string.
To make things easier for your users we strongly suggest to use meaningful names for templates.
For example "generic-endpoint" is ugly, "Standard Linux Server" is easier to understand.

aliases: name
port
integer
The service name/port of the remote Icinga 2 instance. Defaults to 5665.
state
string
    Choices:
  • present ←
  • absent
Apply feature state.
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_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
The name of the zone this endpoint is part of.

Notes

Note

  • This module supports check mode.

Examples

- name: Create an endpoint in icinga
  t_systems_mms.icinga_director.icinga_endpoint:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "fooendpoint"
    host: "127.0.0.1"
    zone: "foozone"

Authors

  • Aaron Bulmahn (@arbu)