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 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

  • Validate if the first list is a sub set (is included) of the second list.

  • Same as the all Python function.

Aliases:

Input

This describes the input of the test, the value before is ansible.builtin.subset or is not ansible.builtin.subset.

Parameter

Comments

Input

list / elements=any / required

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

_superset

list / elements=any / required

List to test against.

Examples

big: [1,2,3,4,5]
sml: [3,4]
issmallinbig: '{{ small is subset(big) }}'

Return Value

Key

Description

Return value

boolean

Returns True if the specified list is a subset of the provided list, False otherwise.

Returned: success

Authors

  • Ansible Core

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.