This resource deploys templates in a synchronized way which may take a long time to respond. Use the resource Deploy Configuration Template Through Job instead
Deploy a template to a list of devices.
Since Product Version: 2.0
Resource URL
/webacs/api/v1/op/cliTemplateConfiguration/deployRequest Payload Parameters
Type | Attribute Name | Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
deviceResults |
The results of the template action for each device. |
|||||||||||||
|
||||||||||||||
int |
failureCount |
|||||||||||||
String |
message |
A status message for the job. |
||||||||||||
int |
successCount |
|||||||||||||
int |
totalCount |
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.115.187/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.115.187/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.115.187/webacs/api/v1/op/cliTemplateConfiguration/deploy
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <mgmtResponse rootUrl="https://192.168.115.187/webacs/api/v1/op/" requestUrl="https://192.168.115.187/webacs/api/v1/op/cliTemplateConfiguration/deploy" responseType="operation"> <cliTemplateCommandResult> <results> <result> <deviceId>String value</deviceId> <isSuccess>true</isSuccess> <message>String value</message> </result> </results> <failureCount>1</failureCount> <message>String value</message> <successCount>1</successCount> <totalCount>1</totalCount> </cliTemplateCommandResult> </mgmtResponse>
Sample JSON Response Payload
https://192.168.115.187/webacs/api/v1/op/cliTemplateConfiguration/deploy.json
{ "mgmtResponse" : { "@rootUrl" : "https : \/\/192.168.115.187\/webacs\/api\/v1\/op\/", "@requestUrl" : "https : \/\/192.168.115.187\/webacs\/api\/v1\/op\/cliTemplateConfiguration\/deploy", "@responseType" : "operation", "cliTemplateCommandResult" : { "results" : { "result" : { "deviceId" : "String value", "isSuccess" : true, "message" : "String value" } }, "failureCount" : 1, "message" : "String value", "successCount" : 1, "totalCount" : 1 } } }