community / community.general / 8.5.0 / inventory / icinga2 Icinga2 inventory source | "added in version" 3.7.0 of community.general" Authors: Cliff Hults (@BongoEADGC6) <cliff.hults@gmail.com>community.general.icinga2 (8.5.0) — inventory
Install with ansible-galaxy collection install community.general:==8.5.0
collections: - name: community.general version: 8.5.0
Get inventory hosts from the Icinga2 API.
Uses a configuration file as an inventory source, it must end in C(.icinga2.yml) or C(.icinga2.yaml).
url: description: Root URL of Icinga2 API. required: true type: string user: description: Username to query the API. required: true type: string groups: default: {} description: Add hosts to group based on Jinja2 conditionals. type: dict version_added: 4.4.0 version_added_collection: community.general plugin: choices: - community.general.icinga2 description: Name of the plugin. required: true type: string strict: default: false description: - If V(yes) make invalid entries a fatal error, otherwise skip and continue. - Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. type: bool version_added: 4.4.0 version_added_collection: community.general compose: default: {} description: Create vars from jinja2 expressions. type: dict version_added: 4.4.0 version_added_collection: community.general password: description: Password to query the API. required: true type: string host_filter: description: - An Icinga2 API valid host filter. Leave blank for no filtering required: false type: string keyed_groups: default: [] description: Add hosts to group based on the values of a variable. elements: dict suboptions: default_value: description: - The default value when the host variable's value is an empty string. - This option is mutually exclusive with O(keyed_groups[].trailing_separator). type: str version_added: '2.12' version_added_collection: ansible.builtin key: description: - The key from input dictionary used to generate groups type: str parent_group: description: parent group for keyed group type: str prefix: default: '' description: A keyed group name will start with this prefix type: str separator: default: _ description: separator used to build the keyed group name type: str trailing_separator: default: true description: - Set this option to V(False) to omit the O(keyed_groups[].separator) after the host variable when the value is an empty string. - This option is mutually exclusive with O(keyed_groups[].default_value). type: bool version_added: '2.12' version_added_collection: ansible.builtin type: list version_added: 4.4.0 version_added_collection: community.general inventory_attr: choices: - name - display_name - address default: address description: - Allows the override of the inventory name based on different attributes. - This allows for changing the way limits are used. - The current default, V(address), is sometimes not unique or present. We recommend to use V(name) instead. type: string version_added: 4.2.0 version_added_collection: community.general use_extra_vars: default: false description: Merge extra vars into the available variables for composition (highest precedence). env: - name: ANSIBLE_INVENTORY_USE_EXTRA_VARS ini: - key: use_extra_vars section: inventory_plugins type: bool version_added: '2.11' version_added_collection: ansible.builtin validate_certs: default: true description: Enables or disables SSL certificate verification. type: boolean leading_separator: default: true description: - Use in conjunction with keyed_groups. - By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. - This is because the default prefix is "" and the default separator is "_". - Set this option to False to omit the leading underscore (or other separator) if no prefix is given. - If the group name is derived from a mapping the separator is still used to concatenate the items. - To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. type: boolean version_added: '2.11' version_added_collection: ansible.builtin group_by_hostgroups: default: true description: - Uses Icinga2 hostgroups as groups. type: boolean version_added: 8.4.0 version_added_collection: community.general