summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/items2dict.yml
blob: 1352c6742d2ff01983a6e7f53ef8f15a37682ffc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
DOCUMENTATION:
  name: items2dict
  author: Ansible core team
  version_added: "2.7"
  short_description: Consolidate a list of itemized dictionaries into a dictionary
  positional: _input, key_name, value_name
  description:
    - Takes a list of dicts with each having a C(key) and C(value) keys, and transforms the list into a dictionary,
      effectively as the reverse of R(dict2items,ansible_collections.ansible.builtin.dict2items_filter).
  options:
    _input:
      description:
        - A list of dictionaries.
        - Every dictionary must have keys C(key) and C(value).
      type: list
      elements: dict
      required: true
    key_name:
      description: The name of the key in the element dictionaries that holds the key to use at destination.
      type: str
      default: key
    value_name:
      description: The name of the key in the element dictionaries that holds the value to use at destination.
      type: str
      default: value
  seealso:
    - plugin_type: filter
      plugin: ansible.builtin.dict2items

EXAMPLES: |
  # mydict =>  { "hi": "bye", "ciao": "ciao" }
  mydict: {{ [{'key': 'hi', 'value': 'bye'}, {'key': 'ciao', 'value': 'ciao'} ]| items2dict}}

  # The output is a dictionary with two key/value pairs:
  #     Application: payment
  #     Environment: dev
  vars:
    tags:
      - key: Application
        value: payment
      - key: Environment
        value: dev
    consolidated: "{{ tags | items2dict }}"

RETURN:
  _value:
    description: Dictionary with the consolidated key/values.
    type: dict