Note
This filter plugin is part of the community.general collection (version 10.7.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.dict_kv.
New in community.general 1.3.0
This describes the input of the filter, the value before | community.general.dict_kv.
Parameter | Comments |
|---|---|
Input any / required | The value for the single key-value pair. |
This describes positional parameters of the filter. These are the values positional1, positional2 and so on in the following example: input | community.general.dict_kv(positional1, positional2, ...)
Parameter | Comments |
|---|---|
key any / required | The key for the single key-value pair. |
- name: Create a one-element dictionary from a value
ansible.builtin.debug:
msg: "{{ 'myvalue' | dict_kv('mykey') }}"
# Produces the dictionary {'mykey': 'myvalue'}
Key | Description |
|---|---|
Return value dictionary | A dictionary with a single key-value pair. Returned: success |
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/dict_kv_filter.html