community.general.hiera – get info from hiera data
Note
This plugin is part of the community.general collection (version 3.8.3).
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 community.general
.
To use it in a playbook, specify: community.general.hiera
.
Requirements
The below requirements are needed on the local controller node that executes this lookup.
hiera (command line utility)
Parameters
Parameter |
Comments |
---|---|
Binary file to execute Hiera Default: “/usr/bin/hiera” Configuration:
|
|
The list of keys to lookup on the Puppetmaster |
|
File that describes the hierarchy of Hiera Default: “/etc/hiera.yaml” Configuration:
|
Examples
# All this examples depends on hiera.yml that describes the hierarchy
- name: "a value from Hiera 'DB'"
ansible.builtin.debug:
msg: "{{ lookup('community.general.hiera', 'foo') }}"
- name: "a value from a Hiera 'DB' on other environment"
ansible.builtin.debug:
msg: "{{ lookup('community.general.hiera', 'foo environment=production') }}"
- name: "a value from a Hiera 'DB' for a concrete node"
ansible.builtin.debug:
msg: "{{ lookup('community.general.hiera', 'foo fqdn=puppet01.localdomain') }}"
Return Values
Common return values are documented here, the following are the fields unique to this lookup:
Key |
Description |
---|---|
a value associated with input key Returned: success |
Authors
Juan Manuel Parrilla (@jparrill)