summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/union.yml
blob: d7379002b8ff11ca78be4a710edbab92c22d87a9 (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: union
  author: Brian Coca (@bcoca)
  version_added: "1.4"
  short_description: union of lists
  description:
    - Provide a unique list of all the elements of two 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.intersect
    - plugin_type: filter
      plugin: ansible.builtin.symmetric_difference
    - plugin_type: filter
      plugin: ansible.builtin.unique
EXAMPLES: |
  # return the unique elements of list1 added to list2
  # list1: [1, 2, 5, 1, 3, 4, 10]
  # list2: [1, 2, 3, 4, 5, 11, 99]
  {{ list1 | union(list2) }}
  # => [1, 2, 5, 1, 3, 4, 10, 11, 99]
RETURN:
  _value:
    description: A unique list of all the elements from both lists.
    type: list