t_systems_mms.icinga_director.icinga_host – Manage hosts 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_host.
New in version 1.0.0: of t_systems_mms.icinga_director
Parameters
Parameter |
Comments |
|---|---|
Whether the agent is configured to accept config. Choices:
|
|
Host address. Usually an IPv4 address, but may be any kind of address your check plugin is able to deal with. |
|
Host IPv6 address. Usually an IPv6 address, but may be any kind of address your check plugin is able to deal with. |
|
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:
|
|
The name of the check command. Though this is not required to be defined in the director, you still have to supply a check_command in a host or host-template. |
|
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 |
|
The endpoint where commands are executed on. |
|
Disabled objects will not be deployed. Choices:
|
|
Alternative name for this host. Might be a host alias or and kind of string helping your users to identify this host. |
|
If Alias Choices:
|
|
Credentials specified with url_username and url_password should be passed in HTTP Header. Choices:
|
|
Hostgroups that should be directly assigned to this node. Hostgroups can be useful for various reasons. You might assign service checks based on assigned hostgroup. They are also often used as an instrument to enforce restricted views in Icinga Web 2. Hostgroups can be directly assigned to single hosts or to host templates. You might also want to consider assigning hostgroups using apply rules. Default: [] |
|
Whether this host has the Icinga 2 Agent installed. Choices:
|
|
Header to identify as, generally appears in web server logs. Default: “ansible-httpget” |
|
Choose a Host Template. Required when state is Required if state is |
|
Whether the parent (master) node should actively try to connect to this agent. Choices:
|
|
Additional notes for this object. |
|
An URL pointing to additional notes for this object. Separate multiple urls like this “’http://url1’ ‘http://url2’”. The maximum length is 255 characters. |
|
Icinga object name for this host. 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-host” is ugly, “Standard Linux Server” is easier to understand. |
|
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 url_username parameter is not specified, the url_password parameter will not be used. |
|
The username for use in HTTP basic authentication. This parameter can be used without url_password for sites that allow empty passwords |
|
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 NTLM authentication is Choices:
|
|
If Choices:
|
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
|
Custom properties of the host. |
|
Set the zone. |
Examples
- name: Create a host in icinga
t_systems_mms.icinga_director.icinga_host:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
disabled: false
object_name: "foohost"
address: "127.0.0.1"
address6: "::1"
display_name: "foohost"
groups:
- "foohostgroup"
imports:
- "foohosttemplate"
vars:
dnscheck: "no"
check_command: hostalive
has_agent: true
master_should_connect: true
accept_config: true
command_endpoint: fooendpoint
- name: update a host in icinga
t_systems_mms.icinga_director.icinga_host:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "foohost"
notes: "example note"
notes_url: "'http://url1' 'http://url2'"
append: true
Authors
Sebastian Gumprich (@rndmh3ro)