summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/intersect.yml
blob: d811ecaaf0a3986898f12ef9fce30943b955ff92 (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
DOCUMENTATION:
  name: intersect
  author: Brian Coca (@bcoca)
  version_added: "1.4"
  short_description: intersection of lists
  description:
    - Provide a list with the common elements from other lists.
  options:
    _input:
      description: A list.
      type: list
      required: true
    _second_list:
      description: A list.
      type: list
      required: true
  seealso:
    - plugin_type: filter
      plugin: ansible.builtin.difference
    - plugin_type: filter
      plugin: ansible.builtin.symmetric_difference
    - plugin_type: filter
      plugin: ansible.builtin.unique
    - plugin_type: filter
      plugin: ansible.builtin.union
EXAMPLES: |
  # return only the common elements of list1 and list2
  # list1: [1, 2, 5, 3, 4, 10]
  # list2: [1, 2, 3, 4, 5, 11, 99]
  {{ list1 | intersect(list2) }}
  # => [1, 2, 5, 3, 4]
RETURN:
  _value:
    description: A list with unique elements common to both lists, also known as a set.
    type: list