Deploy a template to a list of devices.
Resource URL
/webacs/api/v1/op/cliTemplateConfiguration/deploy
Since : 2.0
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
CliTemplateCommandDeviceResult[]
|
deviceResults
|
The results of the template action for each device.
|
String
|
deviceId
|
The Id of the device for this result.
|
boolean
|
isSuccess
|
If true, the action was successfully performed. If false, it ended in some failure condition.
|
String
|
message
|
The action status message.
|
|
String
|
message
|
A status message for the job.
|
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://192.168.116.207/webacs/api/v1/op/cliTemplateConfiguration/deploy
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://192.168.116.207/webacs/api/v1/op/cliTemplateConfiguration/deploy.json
{
"cliTemplateCommand" : {
"targetDevices" : {
"targetDevice" : {
"targetDeviceID" : "String value",
"variableValues" : {
"variableValue" : {
"name" : "String value",
"value" : "String value"
}
}
}
},
"templateName" : "String value"
}
}
Sample XML Response Payload
https://192.168.116.207/webacs/api/v1/op/cliTemplateConfiguration/deploy
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://192.168.116.207/webacs/api/v1/op/cliTemplateConfiguration/cliTemplateConfiguration/deploy" requestUrl="https://192.168.116.207/webacs/api/v1/op/cliTemplateConfiguration/deploy" responseType="operation">
<cliTemplateCommandResult>
<results>
<result>
<deviceId>String value</deviceId>
<isSuccess>true</isSuccess>
<message>String value</message>
</result>
</results>
<message>String value</message>
</cliTemplateCommandResult>
</mgmtResponse>
Sample JSON Response Payload
https://192.168.116.207/webacs/api/v1/op/cliTemplateConfiguration/deploy.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/cliTemplateConfiguration\/cliTemplateConfiguration\/deploy",
"@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/cliTemplateConfiguration\/deploy",
"@responseType" : "operation",
"cliTemplateCommandResult" : {
"results" : {
"result" : {
"deviceId" : "String value",
"isSuccess" : true,
"message" : "String value"
}
},
"message" : "String value"
}
}
}