ansible.builtin.together lookup – merges lists into synchronized list

Note

This lookup plugin is part of ansible-core and included in all Ansible installations. In most cases, you can use the short plugin name together 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 lookup plugin name.

New in version 1.3: of ansible.builtin

Synopsis

  • Creates a list with the iterated elements of the supplied lists

  • To clarify with an example, [ ‘a’, ‘b’ ] and [ 1, 2 ] turn into [ (‘a’,1), (‘b’, 2) ]

  • This is basically the same as the ‘zip_longest’ filter and Python function

  • Any ‘unbalanced’ elements will be substituted with ‘None’

Parameters

Parameter

Comments

_terms

string / required

list of lists to merge

Examples

- name: item.0 returns from the 'a' list, item.1 returns from the '1' list
  ansible.builtin.debug:
    msg: "{{ item.0 }} and {{ item.1 }}"
  with_together:
    - ['a', 'b', 'c', 'd']
    - [1, 2, 3, 4]

Return Values

Common return values are documented here, the following are the fields unique to this lookup:

Key

Description

_list

list / elements=list

synchronized list

Returned: success

Authors

  • Bradley Young

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.