Docs4dev
Docs
ansible / latest / collections / t_systems_mms / icinga_director / icinga_host_template_module.html

t_systems_mms.icinga_director.icinga_host_template – Manage host templates in Icinga2

Note

This plugin is part of the t_systems_mms.icinga_director collection (version 1.23.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_template.

New in version 1.2.0: of t_systems_mms.icinga_director

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
accept_config
boolean
added in 1.9.0 of t_systems_mms.icinga_director
    Choices:
  • no
  • yes
Whether the agent is configured to accept config.
address
string
Host address. Usually an IPv4 address, but may be any kind of address your check plugin is able to deal with.
address6
string
Host IPv6 address. Usually an IPv64 address, but may be any kind of address your check plugin is able to deal with.
check_command
string
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.
check_interval
string
Your regular check interval.
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.
command_endpoint
string
The endpoint where commands are executed on.
disabled
boolean
    Choices:
  • no ←
  • yes
Disabled objects will not be deployed.
display_name
string
Alternative name for this host.
Might be a host alias or and kind of string helping your users to identify this host.
event_command
string
Event command for host which gets called on every check execution if one of these conditions matches
The host is in a soft state
The host state changes into a hard state
The host state recovers from a soft or hard state to OK/Up
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.
groups
list / elements=string
Default:
[]
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.
has_agent
boolean
added in 1.9.0 of t_systems_mms.icinga_director
    Choices:
  • no
  • yes
Whether this host has the Icinga 2 Agent installed.
http_agent
string
Default:
"ansible-httpget"
Header to identify as, generally appears in web server logs.
imports
list / elements=string
Choose a host-template.
master_should_connect
boolean
added in 1.9.0 of t_systems_mms.icinga_director
    Choices:
  • no
  • yes
Whether the parent (master) node should actively try to connect to this agent.
max_check_attempts
string
Defines after how many check attempts a new hard state is reached.
notes
string
added in 1.8.0 of t_systems_mms.icinga_director
Additional notes for this object.
notes_url
string
added in 1.8.0 of t_systems_mms.icinga_director
An URL pointing to additional notes for this object.
Separate multiple urls like this "'http://url1' 'http://url2'".
Maximum length is 255 characters.
object_name
string / required
Icinga object name for this host template.
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.

aliases: name
retry_interval
string
Retry interval, will be applied after a state change unless the next hard state is reached.
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_gssapi
boolean
added in 2.11 of ansible.builtin
    Choices:
  • no ←
  • yes
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.
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.
vars
dictionary
Custom properties of the host.
zone
string
Set the zone.

Notes

Note

  • This module supports check mode.

Examples

- name: Create host template
  t_systems_mms.icinga_director.icinga_host_template:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: foohosttemplate
    display_name: foohosttemplate
    disabled: false
    check_command: dummy
    check_interval: 90s
    retry_interval: 30s
    groups:
      - "foohostgroup"
    imports:
      - ''
    notes: "example note"
    notes_url: "'http://url1' 'http://url2'"
    has_agent: true
    master_should_connect: true
    max_check_attempts: 3
    accept_config: true
    command_endpoint: fooendpoint

Authors

  • Michaela Mattes (@michaelamattes)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/t_systems_mms/icinga_director/icinga_host_template_module.html