ansible.builtin.difference filter – the difference of one list from another
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
difference 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 1.4
Synopsis
Provide a unique list of all the elements of the first list that do not appear in the second one.
Input
This describes the input of the filter, the value before | ansible.builtin.difference.
Parameter |
Comments |
|---|---|
A list. |
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.difference(key1=value1, key2=value2, ...).
Parameter |
Comments |
|---|---|
A list. |
See Also
See also
- ansible.builtin.intersect filter plugin
The official documentation on the ansible.builtin.intersect filter plugin.
- ansible.builtin.symmetric_difference filter plugin
The official documentation on the ansible.builtin.symmetric_difference filter plugin.
- ansible.builtin.union filter plugin
The official documentation on the ansible.builtin.union filter plugin.
- ansible.builtin.unique filter plugin
The official documentation on the ansible.builtin.unique filter plugin.
Examples
# return the elements of list1 not in list2
# list1: [1, 2, 5, 1, 3, 4, 10]
# list2: [1, 2, 3, 4, 5, 11, 99]
{{ list1 | difference(list2) }}
# => [10]
Return Value
Key |
Description |
|---|---|
A unique list of the elements from the first list that do not appear on the second. Returned: success |