ansible.builtin.contains test – does the list contain this element
Note
This test plugin is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
plugin name
contains
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 test plugin name.
New in Ansible 2.4
Synopsis
Checks the supplied element against the input list to see if it exists within it.
Input
This describes the input of the test, the value before is ansible.builtin.contains
or is not ansible.builtin.contains
.
Parameter |
Comments |
---|---|
List of elements to compare. |
Keyword parameters
This describes keyword parameters of the test. These are the values key1=value1
, key2=value2
and so on in the following examples: input is ansible.builtin.contains(key1=value1, key2=value2, ...)
and input is not ansible.builtin.contains(key1=value1, key2=value2, ...)
.
Parameter |
Comments |
---|---|
Element to test for. |
Examples
# simple expression
{{ listofthings is contains('this') }}
# as a selector
- action: module=doessomething
when: lacp_groups|selectattr('interfaces', 'contains', 'em1')|first).master
vars:
lacp_groups:
- master: lacp0
network: 10.65.100.0/24
gateway: 10.65.100.1
dns4:
- 10.65.100.10
- 10.65.100.11
interfaces:
- em1
- em2
- master: lacp1
network: 10.65.120.0/24
gateway: 10.65.120.1
dns4:
- 10.65.100.10
- 10.65.100.11
interfaces:
- em3
- em4
Return Value
Key |
Description |
---|---|
Returns Returned: success |