- 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? |
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/v1/op/cliTemplateConfiguration/deployTemplateThroughJobRequest Parameters
Attribute | Source | Description |
---|---|---|
startTime Date |
query |
OptionalThe 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 |
---|---|
The devices to execute the template configuration against along with template variable values. |
|
templateName String |
The template 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://localhost/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob
<?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/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://localhost/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob" rootUrl="https://localhost/webacs/api/v1/op">
<cliTemplateCommandJobResult>
<jobName>String value</jobName>
<message>String value</message>
</cliTemplateCommandJobResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/cliTemplateConfiguration/deployTemplateThroughJob.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/cliTemplateConfiguration\/deployTemplateThroughJob",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"cliTemplateCommandJobResult" : {
"jobName" : "String value",
"message" : "String value"
}
}
}