community.general.cartesian lookup – returns the cartesian product of lists
Note
This lookup plugin is part of the community.general collection (version 5.8.3).
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.cartesian
.
Synopsis
Takes the input lists and returns a list that represents the product of the input lists.
It is clearer with an example, it turns [1, 2, 3], [a, b] into [1, a], [1, b], [2, a], [2, b], [3, a], [3, b]. You can see the exact syntax in the examples section.
Keyword parameters
This describes keyword parameters of the lookup. These are the values key1=value1
, key2=value2
and so on in the following
examples: lookup('community.general.cartesian', key1=value1, key2=value2, ...)
and query('community.general.cartesian', key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
a set of lists |
Examples
- name: Example of the change in the description
ansible.builtin.debug:
msg: "{{ lookup('community.general.cartesian', [1,2,3], [a, b])}}"
- name: loops over the cartesian product of the supplied lists
ansible.builtin.debug:
msg: "{{item}}"
with_community.general.cartesian:
- "{{list1}}"
- "{{list2}}"
- [1,2,3,4,5,6]
Return Value
Key |
Description |
---|---|
list of lists composed of elements of the input lists Returned: success |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication