ansible.builtin.combine filter – combine two dictionaries

Note

This filter plugin is part of ansible-core and included in all Ansible installations. In most cases, you can use the short plugin name combine even without specifying the collections: keyword. However, we recommend you use the FQCN for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same filter plugin name.

New in Ansible 2.0

Synopsis

  • Create a dictionary (hash/associative array) as a result of merging existing dictionaries.

Input

This describes the input of the filter, the value before | ansible.builtin.combine.

Parameter

Comments

Input

dictionary / required

First dictionary to combine.

Positional parameters

This describes positional parameters of the filter. These are the values positional1, positional2 and so on in the following example: input | ansible.builtin.combine(positional1, positional2, ...).

Parameter

Comments

_dicts

list / elements=dictionary / required

The list of dictionaries to combine.

Keyword parameters

This describes keyword parameters of the filter. These are the values key1=value1, key2=value2 and so on in the following example: input | ansible.builtin.combine(key1=value1, key2=value2, ...).

Parameter

Comments

list_merge

string

Behavior when encountering list elements.

Choices:

  • "append": append newer entries to the older ones

  • "append_rp": append newer entries to the older ones, overwrite duplicates

  • "keep": discard newer entries

  • "prepend": insert newer entries in front of the older ones

  • "prepend_rp": insert newer entries in front of the older ones, discard duplicates

  • "replace" (default): overwrite older entries with newer ones

recursive

boolean

If True, merge elements recursively.

Choices:

  • false ← (default)

  • true

Examples

# ab => {'a':1, 'b':3, 'c': 4}
ab: {{ {'a':1, 'b':2} | combine({'b':3, 'c':4}) }}

# ab => {'a':1, 'b':3, 'c': 4}
many: "{{ dict1 | combine(dict2, dict3, dict4) }}"

Return Value

Key

Description

Return value

dictionary

Resulting merge of supplied dictionaries.

Returned: success

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.