telekom_mms.icinga_director.icinga_hostgroup_info module – Query hostgroups 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_hostgroup_info
.
New in telekom_mms.icinga_director 1.13.0
Synopsis
Get a list of hostgroup objects from Icinga2 through the director API.
Parameters
Parameter |
Comments |
---|---|
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:
|
|
Header to identify as, generally appears in web server logs. 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. Default: |
|
Resolve all inherited object properties and omit templates in output. 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:
|
Notes
Note
This module supports check mode.
Examples
- name: Query a hostgroup in icinga
telekom_mms.icinga_director.icinga_hostgroup_info:
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
query: "foohostgroup"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
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. Returned: always |