> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/switch-infrastructure/config-manager/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/switch-infrastructure/config-manager/_mcp/server. # Execute BatchDeployWorkflow POST /v1/workflow/ngc/batch_deploy Content-Type: application/json Deploy configurations to a batch of devices with shared diff content Reference: https://docs.nvidia.com/switch-infrastructure/config-manager/switch-infrastructure/config-manager/services/temporal/temporal-api/workflow/batchdeployworkflow-endpoint-v-1-workflow-ngc-batch-deploy-post ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: temporal-api version: 1.0.0 paths: /v1/workflow/ngc/batch_deploy: post: operationId: batchdeployworkflow_endpoint_v1_workflow_ngc_batch_deploy_post summary: Execute BatchDeployWorkflow description: Deploy configurations to a batch of devices with shared diff content tags: - workflow parameters: - name: Authorization in: header description: >- Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow. required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchDeployInput' components: schemas: Platform: type: string enum: - arista-eos - cumulus-linux - nv-os - mlnx-os - ufm description: Network device platform types. title: Platform NetworkDeviceData: type: object properties: backup_enabled: type: boolean default: false config_context: type: - object - 'null' additionalProperties: description: Any type deploy_enabled: type: boolean default: false device_type: type: string id: type: string name: type: string platform: $ref: '#/components/schemas/Platform' position: type: - integer - 'null' primary_ip4: type: - string - 'null' primary_ip6: type: - string - 'null' rack: type: - string - 'null' render_enabled: type: boolean default: false role: type: string site: type: string ztp_enabled: type: boolean default: false required: - device_type - id - name - platform - primary_ip4 - primary_ip6 - role - site description: Network device data. title: NetworkDeviceData DeviceDiffData: type: object properties: commit_id: type: - string - 'null' device: $ref: '#/components/schemas/NetworkDeviceData' diff: type: - string - 'null' error: type: - string - 'null' intended_config: type: - string - 'null' required: - device description: Data structure for device diff information. title: DeviceDiffData DiffGroup: type: object properties: devices: type: array items: $ref: '#/components/schemas/DeviceDiffData' diff_content: type: string diff_hash: type: string required: - devices - diff_content - diff_hash description: |- 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. title: DiffGroup BatchDeployInput: type: object properties: batch_devices: type: array items: $ref: '#/components/schemas/DeviceDiffData' description: Devices whose configurations will be deployed in this batch. batch_number: type: - integer - 'null' description: Sequence number of this batch within the parent workflow. commit_confirm: type: boolean default: true description: Whether to use commit-confirmed mode when the platform supports it. diff_group: $ref: '#/components/schemas/DiffGroup' description: Shared configuration diff for the device batch. parent_workflow_id: type: string description: Identifier of the parent multi-deploy workflow. required: - batch_devices - diff_group - parent_workflow_id description: Input for batch deploy child workflow. title: BatchDeployInput WorkflowResponse: type: object properties: href: type: string description: Calculate URL to Temporal UI Workflow View. id: type: string required: - href - id description: Workflow Response Model. title: WorkflowResponse ValidationErrorCtx: type: object properties: {} title: ValidationErrorCtx ValidationErrorLocItems: oneOf: - type: string - type: integer title: ValidationErrorLocItems ValidationError: type: object properties: ctx: $ref: '#/components/schemas/ValidationErrorCtx' input: description: Any type loc: type: array items: $ref: '#/components/schemas/ValidationErrorLocItems' msg: type: string type: type: string required: - loc - msg - type title: ValidationError HTTPValidationError: type: object properties: detail: type: array items: $ref: '#/components/schemas/ValidationError' title: HTTPValidationError securitySchemes: BearerAuth: type: http scheme: bearer description: >- Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow. ``` ## Examples **Request** ```json { "batch_devices": [ { "device": { "device_type": "switch", "id": "dev-12345", "name": "core-switch-01", "platform": "arista-eos", "primary_ip4": "10.0.1.10", "primary_ip6": "fd00::10", "role": "core", "site": "datacenter-nyc" } } ], "diff_group": { "devices": [ { "device": { "device_type": "switch", "id": "dev-12345", "name": "core-switch-01", "platform": "arista-eos", "primary_ip4": "10.0.1.10", "primary_ip6": "fd00::10", "role": "core", "site": "datacenter-nyc" } } ], "diff_content": "interface Ethernet1\n description Uplink to Router\n no shutdown\n!", "diff_hash": "a3f5c9d8e7b4f1a2c3d6e8f9b0a1c2d3" }, "parent_workflow_id": "wf-7890abcd-1234-5678-9abc-def012345678" } ``` **Response** ```json { "href": "https://temporal.example.com/workflows/wf-7890abcd-1234-5678-9abc-def012345678", "id": "wf-7890abcd-1234-5678-9abc-def012345678" } ``` **SDK Code** ```python import requests url = "https://api.example.com/v1/workflow/ngc/batch_deploy" payload = { "batch_devices": [{ "device": { "device_type": "switch", "id": "dev-12345", "name": "core-switch-01", "platform": "arista-eos", "primary_ip4": "10.0.1.10", "primary_ip6": "fd00::10", "role": "core", "site": "datacenter-nyc" } }], "diff_group": { "devices": [{ "device": { "device_type": "switch", "id": "dev-12345", "name": "core-switch-01", "platform": "arista-eos", "primary_ip4": "10.0.1.10", "primary_ip6": "fd00::10", "role": "core", "site": "datacenter-nyc" } }], "diff_content": "interface Ethernet1 description Uplink to Router no shutdown !", "diff_hash": "a3f5c9d8e7b4f1a2c3d6e8f9b0a1c2d3" }, "parent_workflow_id": "wf-7890abcd-1234-5678-9abc-def012345678" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.example.com/v1/workflow/ngc/batch_deploy'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"batch_devices":[{"device":{"device_type":"switch","id":"dev-12345","name":"core-switch-01","platform":"arista-eos","primary_ip4":"10.0.1.10","primary_ip6":"fd00::10","role":"core","site":"datacenter-nyc"}}],"diff_group":{"devices":[{"device":{"device_type":"switch","id":"dev-12345","name":"core-switch-01","platform":"arista-eos","primary_ip4":"10.0.1.10","primary_ip6":"fd00::10","role":"core","site":"datacenter-nyc"}}],"diff_content":"interface Ethernet1\n description Uplink to Router\n no shutdown\n!","diff_hash":"a3f5c9d8e7b4f1a2c3d6e8f9b0a1c2d3"},"parent_workflow_id":"wf-7890abcd-1234-5678-9abc-def012345678"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.example.com/v1/workflow/ngc/batch_deploy" payload := strings.NewReader("{\n \"batch_devices\": [\n {\n \"device\": {\n \"device_type\": \"switch\",\n \"id\": \"dev-12345\",\n \"name\": \"core-switch-01\",\n \"platform\": \"arista-eos\",\n \"primary_ip4\": \"10.0.1.10\",\n \"primary_ip6\": \"fd00::10\",\n \"role\": \"core\",\n \"site\": \"datacenter-nyc\"\n }\n }\n ],\n \"diff_group\": {\n \"devices\": [\n {\n \"device\": {\n \"device_type\": \"switch\",\n \"id\": \"dev-12345\",\n \"name\": \"core-switch-01\",\n \"platform\": \"arista-eos\",\n \"primary_ip4\": \"10.0.1.10\",\n \"primary_ip6\": \"fd00::10\",\n \"role\": \"core\",\n \"site\": \"datacenter-nyc\"\n }\n }\n ],\n \"diff_content\": \"interface Ethernet1\\n description Uplink to Router\\n no shutdown\\n!\",\n \"diff_hash\": \"a3f5c9d8e7b4f1a2c3d6e8f9b0a1c2d3\"\n },\n \"parent_workflow_id\": \"wf-7890abcd-1234-5678-9abc-def012345678\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.example.com/v1/workflow/ngc/batch_deploy") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"batch_devices\": [\n {\n \"device\": {\n \"device_type\": \"switch\",\n \"id\": \"dev-12345\",\n \"name\": \"core-switch-01\",\n \"platform\": \"arista-eos\",\n \"primary_ip4\": \"10.0.1.10\",\n \"primary_ip6\": \"fd00::10\",\n \"role\": \"core\",\n \"site\": \"datacenter-nyc\"\n }\n }\n ],\n \"diff_group\": {\n \"devices\": [\n {\n \"device\": {\n \"device_type\": \"switch\",\n \"id\": \"dev-12345\",\n \"name\": \"core-switch-01\",\n \"platform\": \"arista-eos\",\n \"primary_ip4\": \"10.0.1.10\",\n \"primary_ip6\": \"fd00::10\",\n \"role\": \"core\",\n \"site\": \"datacenter-nyc\"\n }\n }\n ],\n \"diff_content\": \"interface Ethernet1\\n description Uplink to Router\\n no shutdown\\n!\",\n \"diff_hash\": \"a3f5c9d8e7b4f1a2c3d6e8f9b0a1c2d3\"\n },\n \"parent_workflow_id\": \"wf-7890abcd-1234-5678-9abc-def012345678\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.example.com/v1/workflow/ngc/batch_deploy") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"batch_devices\": [\n {\n \"device\": {\n \"device_type\": \"switch\",\n \"id\": \"dev-12345\",\n \"name\": \"core-switch-01\",\n \"platform\": \"arista-eos\",\n \"primary_ip4\": \"10.0.1.10\",\n \"primary_ip6\": \"fd00::10\",\n \"role\": \"core\",\n \"site\": \"datacenter-nyc\"\n }\n }\n ],\n \"diff_group\": {\n \"devices\": [\n {\n \"device\": {\n \"device_type\": \"switch\",\n \"id\": \"dev-12345\",\n \"name\": \"core-switch-01\",\n \"platform\": \"arista-eos\",\n \"primary_ip4\": \"10.0.1.10\",\n \"primary_ip6\": \"fd00::10\",\n \"role\": \"core\",\n \"site\": \"datacenter-nyc\"\n }\n }\n ],\n \"diff_content\": \"interface Ethernet1\\n description Uplink to Router\\n no shutdown\\n!\",\n \"diff_hash\": \"a3f5c9d8e7b4f1a2c3d6e8f9b0a1c2d3\"\n },\n \"parent_workflow_id\": \"wf-7890abcd-1234-5678-9abc-def012345678\"\n}") .asString(); ``` ```php request('POST', 'https://api.example.com/v1/workflow/ngc/batch_deploy', [ 'body' => '{ "batch_devices": [ { "device": { "device_type": "switch", "id": "dev-12345", "name": "core-switch-01", "platform": "arista-eos", "primary_ip4": "10.0.1.10", "primary_ip6": "fd00::10", "role": "core", "site": "datacenter-nyc" } } ], "diff_group": { "devices": [ { "device": { "device_type": "switch", "id": "dev-12345", "name": "core-switch-01", "platform": "arista-eos", "primary_ip4": "10.0.1.10", "primary_ip6": "fd00::10", "role": "core", "site": "datacenter-nyc" } } ], "diff_content": "interface Ethernet1\\n description Uplink to Router\\n no shutdown\\n!", "diff_hash": "a3f5c9d8e7b4f1a2c3d6e8f9b0a1c2d3" }, "parent_workflow_id": "wf-7890abcd-1234-5678-9abc-def012345678" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.example.com/v1/workflow/ngc/batch_deploy"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"batch_devices\": [\n {\n \"device\": {\n \"device_type\": \"switch\",\n \"id\": \"dev-12345\",\n \"name\": \"core-switch-01\",\n \"platform\": \"arista-eos\",\n \"primary_ip4\": \"10.0.1.10\",\n \"primary_ip6\": \"fd00::10\",\n \"role\": \"core\",\n \"site\": \"datacenter-nyc\"\n }\n }\n ],\n \"diff_group\": {\n \"devices\": [\n {\n \"device\": {\n \"device_type\": \"switch\",\n \"id\": \"dev-12345\",\n \"name\": \"core-switch-01\",\n \"platform\": \"arista-eos\",\n \"primary_ip4\": \"10.0.1.10\",\n \"primary_ip6\": \"fd00::10\",\n \"role\": \"core\",\n \"site\": \"datacenter-nyc\"\n }\n }\n ],\n \"diff_content\": \"interface Ethernet1\\n description Uplink to Router\\n no shutdown\\n!\",\n \"diff_hash\": \"a3f5c9d8e7b4f1a2c3d6e8f9b0a1c2d3\"\n },\n \"parent_workflow_id\": \"wf-7890abcd-1234-5678-9abc-def012345678\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "batch_devices": [["device": [ "device_type": "switch", "id": "dev-12345", "name": "core-switch-01", "platform": "arista-eos", "primary_ip4": "10.0.1.10", "primary_ip6": "fd00::10", "role": "core", "site": "datacenter-nyc" ]]], "diff_group": [ "devices": [["device": [ "device_type": "switch", "id": "dev-12345", "name": "core-switch-01", "platform": "arista-eos", "primary_ip4": "10.0.1.10", "primary_ip6": "fd00::10", "role": "core", "site": "datacenter-nyc" ]]], "diff_content": "interface Ethernet1 description Uplink to Router no shutdown !", "diff_hash": "a3f5c9d8e7b4f1a2c3d6e8f9b0a1c2d3" ], "parent_workflow_id": "wf-7890abcd-1234-5678-9abc-def012345678" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/v1/workflow/ngc/batch_deploy")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```