ansible.builtin.together – merges lists into synchronized list¶
Note
This module is part of ansible-base
and included in all Ansible
installations. In most cases, you can use the short module name
together even without specifying the collections:
keyword.
Despite that, we recommend you use the FQCN for easy linking to the module
documentation and to avoid conflicting with other collections that may have
the same module 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 | Choices/Defaults | Configuration | 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
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 | Returned | Description |
---|---|---|
_list
list
/ elements=list
|
success |
synchronized list
|
Authors¶
Bradley Young (!UNKNOWN) <young.bradley@gmail.com>