merge

Task purpose

The merge task combines data from job variables, static data, and the outgoing variables of tasks to create a new variable. By merging data, you can create new data structures to match the existing parameters of a task, allowing you to reuse existing tasks without programming new ones. The merge task can combine number, boolean, string, array, and object data types.

Two assignment modes are supported:

Properties

Configure the task

The following examples use data returned from three tasks, which return these objects:

1
{
2
  "vendor": "Cisco",
3
  "platforms": [ "3945", "6500" ],
4
  "chassis": [ "fixed", "modular" ]
5
}

1
{
2
  "release": "15.5"
3
}

1
{
2
  "features": [ "L3VPN", "STP" ]
3
}

No keys assigned

Configure the merge task properties with no keys.

The merge task returns an array. The order is not deterministic.

Unique keys assigned

Configure the merge task properties with unique keys. In addition to the three objects above, this example includes a number, string, boolean, and array.

The merge task returns this object of specified key/value fields:

1
{
2
  "merged_object": {
3
    "chassis": {
4
      "vendor": "Cisco",
5
      "platforms": [ "3945", "6500" ],
6
      "chassis": [ "fixed", "modular" ]
7
    },
8
    "os-image": {
9
      "release": "15.5"
10
    },
11
    "services": {
12
      "features": [ "L3VPN", "STP" ]
13
    },
14
    "number": {
15
      "myNumber": 13
16
    },
17
    "string": {
18
      "myString": "hello world"
19
    },
20
    "boo": {
21
      "myBoolean": true
22
    },
23
    "arr": {
24
      "myArray": [ "apple", "pear" ]
25
    }
26
  }
27
}

Related reading

• merge API reference