Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

PUT cliTemplateConfiguration/deployTemplateThroughJob

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

Deploy a template to a list of devices through Job. A job name will be returned. Use the job name to query the job result using Job Operations services. To query job status, use the query api/v1/data/JobSummary?jobName=CliTemplateDeploy123. To query the full run result if the deployment fails, use the query api/v1/op/jobService/runhistory?jobName=CliTemplateDeploy123

Since Product Version: 2.2

Resource URL

/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob

Request Payload Parameters

Type Attribute Name Description

CliTemplateCommandTarget[]

targetDeviceAndVariableValues

The devices to execute the template configuration against along with template variable values.

String

templateName

The template to apply.

Response Parameters

Type Attribute Name Description

String

jobName

The job name which is created by the system

String

message

A message generated by the system

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Request Payload

https://172.25.123.114/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob

<?xml version="1.0" ?>
<cliTemplateCommand>
  <targetDevices>
    <targetDevice>
      <targetDeviceID>String value</targetDeviceID>
      <variableValues>
        <variableValue>
          <name>String value</name>
          <value>String value</value>
        </variableValue>
      </variableValues>
    </targetDevice>
  </targetDevices>
  <templateName>String value</templateName>
</cliTemplateCommand>

Sample JSON Request Payload

https://172.25.123.114/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob.json

{
  "cliTemplateCommand" : {
    "targetDevices" : {
      "targetDevice" : {
        "targetDeviceID" : "String value",
        "variableValues" : {
          "variableValue" : {
            "name" : "String value",
            "value" : "String value"
          }
        }
      }
    },
    "templateName" : "String value"
  }
}

Sample XML Response Payload

https://172.25.123.114/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <cliTemplateCommandJobResult>
    <jobName>String value</jobName>
    <message>String value</message>
  </cliTemplateCommandJobResult>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/cliTemplateConfiguration\/deployTemplateThroughJob",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "cliTemplateCommandJobResult" : {
      "jobName" : "String value",
      "message" : "String value"
    }
  }
}