summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/difference.yml
blob: decc811a199542d5a4f5407115ce1649ccc52d9b (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: difference
  author: Brian Coca (@bcoca)
  version_added: "1.4"
  short_description: the difference of one list from another
  description:
    - Provide a unique list of all the elements of the first list that do not appear in the second one.
  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.intersect
    - plugin_type: filter
      plugin: ansible.builtin.symmetric_difference
    - plugin_type: filter
      plugin: ansible.builtin.union
    - plugin_type: filter
      plugin: ansible.builtin.unique
EXAMPLES: |
  # return the elements of list1 not in list2
  # list1: [1, 2, 5, 1, 3, 4, 10]
  # list2: [1, 2, 3, 4, 5, 11, 99]
  {{ list1 | difference(list2) }}
  # => [10]
RETURN:
  _value:
    description: A unique list of the elements from the first list that do not appear on the second.
    type: list