Summary
Creates a device template
Description
Creates a new device template in pronghorn
Route
POST /configuration_manager/templates
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
name |
string |
yes |
Name of the device template. |
template |
string |
yes |
Jina2 template to save. |
variables |
object |
yes |
Variables used for substituion in the template |
options |
object |
yes |
Additional parameters (optional) |
Copied to Clipboard
{
"name": "do",
"template": "interface Loopback1\n description {{ description }}",
"options": {
"deviceOSTypes": []
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string"
},
"template": {
"title": "template",
"type": "string",
"examples": [
"interface Loopback1\n description {{ description }}"
]
},
"variables": {
"title": "variables",
"type": "object",
"properties": {}
},
"options": {
"title": "options",
"type": "object",
"properties": {
"deviceOSTypes": {
"type": "array"
}
}
}
},
"required": [
"name",
"template",
"variables",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
data |
object |
Result of creating a new device template |
Copied to Clipboard
{
"result": "et nisi adipisicing"
}
Copied to Clipboard
{
"title": "data",
"properties": {
"result": {
"type": "string",
"example": "success"
},
"data": {
"type": "object",
"example": {
"id": "610315295595a5fcb99f8ce2",
"name": "Cisco Login Banner",
"template": "banner login {{ bannerBody }}",
"variables": {
"bannerBody": "Welcome to this Cisco Device."
},
"created": "2021-07-29T20:52:57.378Z",
"updated": "2021-07-29T20:52:57.378Z",
"createdBy": "5eaaf3796b16027c8aeb612a",
"updatedBy": "5eaaf3796b16027c8aeb612a",
"gbac": {
"write": [],
"read": []
}
}
}
}
}