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
Resource URL
/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob
Since : 2.2
Request Payload Parameters
CliTemplateCommandTarget[]
|
targetDeviceAndVariableValues
|
The devices to execute the template configuration against along with template variable values.
|
String
|
targetDeviceID
|
The Id of the device to act upon.
|
VariableValue[]
|
variableValues
|
The names and values of the variables.
|
String
|
name
|
The name of the variable.
|
String
|
value
|
The value of the variable, as a string.
|
|
|
String
|
templateName
|
|
Response Parameters
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://szier-m8-106.cisco.com/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<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://szier-m8-106.cisco.com/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://szier-m8-106.cisco.com/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob" responseType="operation">
<cliTemplateCommandJobResult>
<jobName>String value</jobName>
<message>String value</message>
</cliTemplateCommandJobResult>
</mgmtResponse>
Sample JSON Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/",
"@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/cliTemplateConfiguration\/deployTemplateThroughJob",
"@responseType" : "operation",
"cliTemplateCommandJobResult" : {
"jobName" : "String value",
"message" : "String value"
}
}
}