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

PUT cliTemplateConfiguration/deployTemplateThroughJob

Deploy a template to a list of devices through Job. A job name will be returned.
  • Use the parameter startTime to define when the CLI template will be deployed. If the start time is not defined the deployment will start immediately. The start time should be provided in the ISO 8601 format. For example: v1/op/cliTemplateConfiguration/deployTemplateThroughJob?startTime="2016-11-9T07:00Z"
  • 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
  • Does not support ports selection for the 'Ports' type templates.

Since Product Version: 2.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource URL

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

Request Parameters

Attribute Source Description

startTime Date

query

Optional

The time when the CLI template will be deployed. If the start time is not defined the deployment will start immediately. The start time should be provided in the ISO 8601 format.

Request Payload Parameters

Attribute Description

options Arrow image DeployOptionsDTO

The deploy options.

targetDeviceAndVariableValues Arrow image CliTemplateCommandTarget[]

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

templateName String

Required

The template name to apply.

Response Parameters

Attribute Description

jobName String

The job name which is created by the system

message String

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.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob?startTime=2020-10-31T18:30:00

<?xml version="1.0" ?>
<cliTemplateCommand>
  <options>
    <copyConfigToStartup>true</copyConfigToStartup>
  </options>
  <targetDevices>
    <targetDevice>
      <targetDeviceID>String value</targetDeviceID>
      <variableValues>
        <variableValue>
          <name>String value</name>
          <value>String value</value>
        </variableValue>
        <variableValue>
          <name>Another string value</name>
          <value>Another string value</value>
        </variableValue>
      </variableValues>
    </targetDevice>
    <targetDevice>
      <targetDeviceID>Another string value</targetDeviceID>
      <variableValues>
        <variableValue>
          <name>String value</name>
          <value>String value</value>
        </variableValue>
        <variableValue>
          <name>Another string value</name>
          <value>Another string value</value>
        </variableValue>
      </variableValues>
    </targetDevice>
  </targetDevices>
  <templateName>String value</templateName>
</cliTemplateCommand>

Sample JSON Request Payload

https://172.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob.json?startTime=2020-10-31T18:30:00

{
  "cliTemplateCommand" : {
    "options" : {
      "copyConfigToStartup" : true
    },
    "targetDevices" : {
      "targetDevice" : [{
        "targetDeviceID" : "String value",
        "variableValues" : {
          "variableValue" : [{
            "name" : "String value",
            "value" : "String value"
          },
          {
            "name" : "Another string value",
            "value" : "Another string value"
          }]
        }
      },
      {
        "targetDeviceID" : "Another string value",
        "variableValues" : {
          "variableValue" : [{
            "name" : "String value",
            "value" : "String value"
          },
          {
            "name" : "Another string value",
            "value" : "Another string value"
          }]
        }
      }]
    },
    "templateName" : "String value"
  }
}

Sample XML Response Payload

https://172.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob?startTime=2020-10-31T18:30:00

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob?startTime=2020-10-31T18:30:00" rootUrl="https://172.20.127.108/webacs/api/v1/op">
  <cliTemplateCommandJobResult>
    <jobName>String value</jobName>
    <message>String value</message>
  </cliTemplateCommandJobResult>
</mgmtResponse>

Sample JSON Response Payload

https://172.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob.json?startTime=2020-10-31T18:30:00

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/cliTemplateConfiguration\/deployTemplateThroughJob?startTime=2020-10-31T18 : 30 : 00",
    "@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
    "cliTemplateCommandJobResult" : {
      "jobName" : "String value",
      "message" : "String value"
    }
  }
}