Execute BatchDeployWorkflow | NVIDIA Switch Infrastructure

curl -X POST https://host.com/v1/workflow/ngc/batch_deploy \
     -H "Content-Type: application/json" \
     -d '{
  "batch_devices": [
    {
      "device": {
        "device_type": "router",
        "id": "device-1234",
        "name": "core-router-01",
        "platform": "arista-eos",
        "primary_ip4": "192.168.1.10",
        "primary_ip6": "2001:0db8:85a3::8a2e:0370:7334",
        "role": "core",
        "site": "datacenter-1"
      }
    }
  ],
  "diff_group": {
    "devices": [
      {
        "device": {
          "device_type": "router",
          "id": "device-1234",
          "name": "core-router-01",
          "platform": "arista-eos",
          "primary_ip4": "192.168.1.10",
          "primary_ip6": "2001:0db8:85a3::8a2e:0370:7334",
          "role": "core",
          "site": "datacenter-1"
        }
      }
    ],
    "diff_content": "interface Ethernet1\n  description Uplink to ISP\n  ip address 192.168.1.10/24\n!",
    "diff_hash": "a3f5c8d9e7b4f1a2c6d8e9f0b1a2c3d4"
  },
  "parent_workflow_id": "workflow-5678"
}'

{
  "href": "https://temporal.example.com/workflows/workflow-5678",
  "id": "workflow-5678"
}

curl -X POST https://host.com/v1/workflow/ngc/batch_deploy \
     -H "Content-Type: application/json" \
     -d '{
  "batch_devices": [
    {
      "device": {
        "device_type": "router",
        "id": "device-1234",
        "name": "core-router-01",
        "platform": "arista-eos",
        "primary_ip4": "192.168.1.10",
        "primary_ip6": "2001:0db8:85a3::8a2e:0370:7334",
        "role": "core",
        "site": "datacenter-1"
      }
    }
  ],
  "diff_group": {
    "devices": [
      {
        "device": {
          "device_type": "router",
          "id": "device-1234",
          "name": "core-router-01",
          "platform": "arista-eos",
          "primary_ip4": "192.168.1.10",
          "primary_ip6": "2001:0db8:85a3::8a2e:0370:7334",
          "role": "core",
          "site": "datacenter-1"
        }
      }
    ],
    "diff_content": "interface Ethernet1\n  description Uplink to ISP\n  ip address 192.168.1.10/24\n!",
    "diff_hash": "a3f5c8d9e7b4f1a2c6d8e9f0b1a2c3d4"
  },
  "parent_workflow_id": "workflow-5678"
}'

{
  "href": "https://temporal.example.com/workflows/workflow-5678",
  "id": "workflow-5678"
}

Deploy configurations to a batch of devices with shared diff content

Request

This endpoint expects an object.

batch_deviceslist of objectsRequired

diff_groupobjectRequired

A group of devices with identical diffs.

Note: Each device has its own intended config file and commit SHA. Grouping is only based on identical diff content, not commit IDs.

parent_workflow_idstringRequired

batch_numberinteger or nullOptional

commit_confirmbooleanOptionalDefaults to true

Response

Successful Response

hrefstringRead-only

Calculate URL to Temporal UI Workflow View.

idstring

Errors

422

Unprocessable Entity Error

$	curl -X POST https://host.com/v1/workflow/ngc/batch_deploy \
>	-H "Content-Type: application/json" \
>	-d '{
>	"batch_devices": [
>	{
>	"device": {
>	"device_type": "router",
>	"id": "device-1234",
>	"name": "core-router-01",
>	"platform": "arista-eos",
>	"primary_ip4": "192.168.1.10",
>	"primary_ip6": "2001:0db8:85a3::8a2e:0370:7334",
>	"role": "core",
>	"site": "datacenter-1"
>	}
>	}
>	],
>	"diff_group": {
>	"devices": [
>	{
>	"device": {
>	"device_type": "router",
>	"id": "device-1234",
>	"name": "core-router-01",
>	"platform": "arista-eos",
>	"primary_ip4": "192.168.1.10",
>	"primary_ip6": "2001:0db8:85a3::8a2e:0370:7334",
>	"role": "core",
>	"site": "datacenter-1"
>	}
>	}
>	],
>	"diff_content": "interface Ethernet1\n description Uplink to ISP\n ip address 192.168.1.10/24\n!",
>	"diff_hash": "a3f5c8d9e7b4f1a2c6d8e9f0b1a2c3d4"
>	},
>	"parent_workflow_id": "workflow-5678"
>	}'

1	{
2	"href": "https://temporal.example.com/workflows/workflow-5678",
3	"id": "workflow-5678"
4	}