community.general.dict_kv filter – Convert a value to a dictionary with a single key-value pair
Note
This filter plugin is part of the community.general collection (version 8.6.4).
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
Synopsis
Convert a value to a dictionary with a single key-value pair.
Input
This describes the input of the filter, the value before | community.general.dict_kv
.
Parameter |
Comments |
---|---|
The value for the single key-value pair. |
Positional parameters
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 |
---|---|
The key for the single key-value pair. |
Examples
- name: Create a one-element dictionary from a value
ansible.builtin.debug:
msg: "{{ 'myvalue' | dict_kv('mykey') }}"
# Produces the dictionary {'mykey': 'myvalue'}
Return Value
Key |
Description |
---|---|
A dictionary with a single key-value pair. Returned: success |