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_hostgroup_info.
New in version 1.13.0: of t_systems_mms.icinga_director
| 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 |
| 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 |
| Credentials specified with url_username and url_password should be passed in HTTP Header. |
| http_agent string | Default: "ansible-httpget" | Header to identify as, generally appears in web server logs. |
| query string | Default: "" | Text to filter search results. The text is matched on object_name. Only objects containing this text will be returned in the resultset. Requires Icinga Director 1.8.0+, in earlier versions this parameter is ignored and all objects are returned. |
| resolved boolean |
| Resolve all inherited object properties and omit templates in output. |
| 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 |
| 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 |
| If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| validate_certs boolean |
| If no, SSL certificates will not be validated.This should only be used on personally controlled sites using self-signed certificates. |
Note
- name: Query a hostgroup in icinga
t_systems_mms.icinga_director.icinga_hostgroup_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "foohostgroup"
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| objects list / elements=string | always | A list of returned Director objects. The list contains all objects matching the query filter. If the filter does not match any object, the list will be empty. |
© 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_hostgroup_info_module.html