ansible.builtin.subset test – is the list a subset of this other list
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
subset
.
However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.subset
for easy linking to the
plugin documentation and to avoid conflicting with other collections that may have
the same test plugin name.
Synopsis
Validate if the first list is a sub set (is included) of the second list.
Aliases: issubset
Input
This describes the input of the test, the value before is ansible.builtin.subset
or is not ansible.builtin.subset
.
Parameter |
Comments |
---|---|
List. |
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.subset(key1=value1, key2=value2, ...)
and input is not ansible.builtin.subset(key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
List to test against. |
Examples
big: [1,2,3,4,5]
sml: [3,4]
issmallinbig: '{{ small is subset(big) }}'
Return Value
Key |
Description |
---|---|
Returns Returned: success |