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
- Does not support ports selection for the 'Ports' type templates.
- Does not uptick deploy count.
Since Product Version: 2.0
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
PUT |
DevNet Discussions
Resource URL
/webacs/api/v2/op/cliTemplateConfiguration/deploy UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description |
---|---|
The devices to execute the template configuration against along with template variable values. |
|
templateName String |
The template to apply. |
Response Parameters
Attribute | Description |
---|---|
Results of the template action for each device. |
|
failureCount int |
Count of failure results. |
message String |
Status message for the job. |
successCount int |
Count of successful results. |
totalCount int |
Total count of results. |
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://localhost/webacs/api/v2/op/cliTemplateConfiguration/deploy
<?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://localhost/webacs/api/v2/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://localhost/webacs/api/v2/op/cliTemplateConfiguration/deploy
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/cliTemplateConfiguration/deploy" rootUrl="https://localhost/webacs/api/v2/op">
<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://localhost/webacs/api/v2/op/cliTemplateConfiguration/deploy.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/cliTemplateConfiguration/deploy",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"cliTemplateCommandResult" : [ {
"failureCount" : 1,
"message" : "String value",
"results" : {
"result" : [ {
"deviceId" : "String value",
"isSuccess" : true,
"message" : "String value"
} ]
},
"successCount" : 1,
"totalCount" : 1
} ]
}
}