summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/contains.yml
blob: 68741da09e8e63d1fc61dd178095b5066d9dd931 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
DOCUMENTATION:
  name: contains
  author: Ansible Core
  version_added: "2.4"
  short_description: does the list contain this element
  description:
    - Checks the supplied element against the input list to see if it exists within it.
  options:
    _input:
      description: List of elements to compare.
      type: list
      elements: raw
      required: True
    _contained:
      description: Element to test for.
      type: raw
      required: True
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:
    description: Returns C(True) if the specified element is contained in the supplied sequence, C(False) otherwise.
    type: boolean