ZTP Templates
ZTP templates are device configuration templates which are used as day0 configuration during ZTP process.
Create a ZTP Template
To add a ZTP Template in Prelude OneBoard, navigate to Application Settings > ZTP Templates.
Fill the form with the following information:
- Template Name A name to identify the usage of this template
- Operating System Select the Network Operating System the template if for
Edit a ZTP Template
When editing a ZTP Template, don't forget to save it if the "Changes not saved" alert is shown.
Your ZTP Template is ready to use.
ZTP Template variables
In a ZTP template, you have three types of variables: - OneBoard variables which are automatically populated by OneBoard - ZTP Extension variables which are populated by the ZTP Extension you activated on a device - User variables which are define and populated by the user
OneBoard variables
List of variables define by OneBoard regarding the target device:
| Variable | Description |
|---|---|
${device.hostname} |
Device hostname |
${device.ip} |
Device management IP |
${device.management_vrf} |
Device management VRF |
${device.username} |
Device username (from the access credentials) |
${device.password} |
Device password (from the access credentials) |
${device.ztp_interface} |
Interface that will be used for ZTP |
In addition, if the in-band ZTP option is enable, OneBoard is providing these variables:
| Variable | Description |
|---|---|
${attachment.device} |
Edge device which will forward the ZTP requests |
${attachment.interface.id} |
Interface ID on the edge device (i.e. for a Cisco XR device: 0/0/1/12) |
${attachment.interface.speed} |
Interface Speed on the edge device (i.e. for a Cisco XR device: TenGigE) |
${attachment.vrf} |
VRF on the edge device which will carry the ZTP traffic (it must route the traffic to Prelude Gateway) |
${attachment.asn} |
AS Number of the edge device |
ZTP Extension variables
The ZTP extension variables are define per extension, so you need to refer to your extension documentation to get the list.
The ZTP extension variables are using the format ${ext.<var-name>}
User variables
User can define as many variable as he needs.
The User variables are using the format ${<var-name>:"<description>"}.
Warning
The var-name of a User variable cannot start with device., attachment. or ext..