telekom_mms.icinga_director.icinga_endpoint module – Manage endpoints 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_endpoint
.
New in telekom_mms.icinga_director 1.5.0
Synopsis
Add or remove an endpoint 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:
|
|
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 |
|
If Choices:
|
|
Credentials specified with Choices:
|
|
The hostname/IP address of the remote Icinga 2 instance. |
|
Header to identify as, generally appears in web server logs. Default: |
|
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. |
|
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. |
|
The service name/port of the remote Icinga 2 instance. Defaults to 5665. |
|
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:
|
|
The name of the zone this endpoint is part of. |
Notes
Note
This module supports check mode.
Examples
- name: Create an endpoint in icinga
telekom_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"
- name: Update an endpoint in icinga
telekom_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"
port: 5665
append: true