Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

Templates

Use the Templates screen to configure all Viptela devices in the overlay network that are managed by the vManage NMS. To do so:

  1. Create a device template.
  2. Attach Viptela devices to the device template.

Screen Elements

  • Top bar—On the left are the menu icon, for expanding and collapsing the vManage menu, and the vManage product name. On the right are a number of icons and the user profile drop-down.
  • Title bar—Includes the title of the screen, Templates.
  • Device tab—Create device templates for configuring Viptela devices.
    • Create Template drop-down—Click to create device templates from feature template or the CLI.
    • Device template table—Table of all device templates. To re-arrange the columns, drag the column title to the desired position.
  • Feature tab—Create feature templates for configuring software features that you can enable on a Viptela device.
    • Add Template button—Click to create feature templates.
    • Feature template table—Table of all feature templates. To re-arrange the columns, drag the column title to the desired position.
  • Search box—Includes the Search Options drop-down, for a Contains or Match string.
  • Refresh icon—Click to refresh data in the templates table with the most current data.
  • Show Table Columns icon—Click to display or hide columns from the templates table. By default, all columns are displayed.
  • Templates table—To re-arrange the columns, drag the column title to the desired position.

g00426.png

Create a Device Template

Device templates define a device's complete operational configuration. A device template consists of a number of feature templates. Each feature template defines the configuration for a particular Viptela software feature. Some feature templates are mandatory, indicated with an asterisk (*), and some are optional. Each mandatory feature template, and some of the optional ones too, have a factory-default template. For software features that have a factory-default template, you can use either the factory-default template (named Factory_Default_feature-name_Template) or you can create a custom feature template.

Create a Device Template from Feature Templates

To create a device template:

  1. In the Device tab, click the Create Template drop-down and select From Feature Template.
  2. From the Device Model drop-down, select the type of device for which you are creating the template. vManage NMS displays all the feature templates for that device type. The required feature templates are indicated with an asterisk (*), and the remaining templates are optional. The factory-default template for each feature is selected by default.
  3. In the Template Name field, enter a name for the device template. This field is mandatory and can contain only uppercase and lowercase letters, the digits 0 through 9, hyphens (-), and underscores (_). It cannot contain spaces or any other characters.
  4. In the Description field, enter a description for the device template. This field is mandatory, and it can contain any characters and spaces.
  5. To view the factory-default configuration for a feature template, select the desired feature template and click View Template. Click Cancel to return to the Configuration Template screen.
  6. To create a custom template for a feature, select the desired factory-default feature template and click Create Template. The template form is displayed. The top of the form contains fields for naming the template, and the bottom contains fields for defining feature parameters.
  7. In the Template Name field, enter a name for the feature template. This field is mandatory and can contain only uppercase and lowercase letters, the digits 0 through 9, hyphens (-), and underscores (_). It cannot contain spaces or any other characters.
  8. In the Description field, enter a description for the feature template. This field is mandatory, and it can contain any characters and spaces.
  9. For each field, enter the desired value. You may need to click a tab or the plus sign (+) to display additional fields.
  10. When you first open a feature template, for each parameter that has a default value, the scope is set to Default (indicated by a check mark), and the default setting or value is shown. To change the default or to enter a value, click the scope drop-down to the left of the parameter field and select one of the following:

Parameter Scope

Scope Description

Device Specific (indicated by a host icon)

Use a device-specific value for the parameter. For device-specific parameters, you cannot enter a value in the feature template. You enter the value when you attach a Viptela device to a device template.

When you click Device Specific, the Enter Key box opens. This box displays a key, which is a unique string that identifies the parameter in a CSV file that you create. This file is an Excel spreadsheet that contains one column for each key. The header row contains the key names (one key per column), and each row after that corresponds to a device and defines the values of the keys for that device. You upload the CSV file when you attach a Viptela device to a device template. For more information, see Create a Template Variables Spreadsheet.

To change the default key, type a new string and move the cursor out of the Enter Key box.

Examples of device-specific parameters are system IP address, hostname, GPS location, and site ID.

Global (indicated by a globe icon)

Enter a value for the parameter, and apply that value to all devices.

Examples of parameters that you might apply globally to a group of devices are DNS server, syslog server, and interface MTUs.

  1. Click Save.
  2. Repeat Steps 7 through 12 to create a custom template for each additional software feature. For details on creating specific feature templates, see the templates listed in Available Feature Templates.
  3. Click Create. The new configuration template is displayed in the Device Template table. The Feature Templates column shows the number of feature templates that are included in the device template, and the Type column shows "Feature" to indicate that the device template was created from a collection of feature templates.

Another way to create device templates from feature templates is to first create one or more custom feature templates and then create device templates. You can create multiple feature templates for the same feature. For a list of feature templates, see Available Feature Templates.

  1. From the Templates title bar, select Feature.
  2. Click the Add Template button.
  3. In the left pane, from Select Devices, select the type of device for which you are creating a template. You can create a single feature template for features that are available on multiple device types. You must, however, create separate feature templates for software features that are available only on the device type you are configuring.
  4. In the right pane, select the feature template. The template form is displayed. The top of the form contains fields for naming the template, and the bottom contains fields for defining required parameters. If the feature has optional parameters, the bottom of the template form shows a plus sign (+) after the required parameters.
  5. In the Template Name field, enter a name for the feature template. This field is mandatory and can contain only uppercase and lowercase letters, the digits 0 through 9, hyphens (-), and underscores (_). It cannot contain spaces or any other characters.
  6. In the Description field, enter a description for the feature template. This field is mandatory, and it can contain any characters and spaces.
  7. For each required parameter, choose the desired value, and if applicable, select the scope of the parameter. Select the scope from the drop-down menu to the left of each parameter's value box
  8. Click the plus sign (+) below the required parameters to set the values of optional parameters.
  9. Click Save.
  10. Repeat Steps 2 to 9 for each additional feature template you wish to create.
  11. From the Templates title bar, select Device.
  12. Click the Create Template drop-down and select From Feature Template.
  13. From the Device Model drop-down, select the type of device for which you are creating the device template. vManage NMS displays the feature templates for the device type you selected. The required feature templates are indicated with an asterisk (*). The remaining templates are optional.
  14. In the Template Name field, enter a name for the device template. This field is mandatory and can contain only uppercase and lowercase letters, the digits 0 through 9, hyphens (-), and underscores (_). It cannot contain spaces or any other characters.
  15. In the Description field, enter a description for the device template. This field is mandatory, and it can contain any characters and spaces.
  16. To view the factory-default configuration for a feature template, select the desired feature template and click View Template. Click Cancel to return to the Configuration Template screen.
  17. To use the factory-default configuration, click Create to create the device template. The new device template is displayed in the Device Template table. The Feature Templates column shows the number of feature templates that are included in the device template, and the Type column shows "Feature" to indicate that the device template was created from a collection of feature templates.
  18. To modify the factory-default configuration, select the feature template for which you do not wish to use the factory-default template. From the drop-down list of available feature templates, select a feature template that you created.
  19. Repeat Step 18 for each factory-default feature template you wish to modify.
  20. Click Create. The new configuration template is displayed in the Device Template table. The Feature Templates column shows the number of feature templates that are included in the device template, and the Type column shows "Feature" to indicate that the device template was created from a collection of feature templates.

Create a Device Template from the CLI

To create a device template by entering a CLI text-style configuration directly on the vManage NMS:

  1. In the Device tab, click the Create Template drop-down and select CLI Template.
  2. From the Device Type drop-down, select the type of device for which you are creating the template.
  3. In the Template Name field, enter a name for the device template. This field is mandatory and can contain only uppercase and lowercase letters, the digits 0 through 9, hyphens (–), and underscores (_). It cannot contain spaces or any other characters.
  4. In the Description field, enter a description for the device template. This field is mandatory, and it can contain any characters and spaces.
  5. In the CLI Configuration box, enter the configuration either by typing it, cutting and pasting it, or uploading a file.
  6. To convert an actual configuration value to a variable, select the value and click Create Variable. Enter the variable name, and click Create Variable. You can also type the variable name directly, in the format {{variable-name}}; for example, {{hostname}}.
  7. Click Add. The new device template is displayed in the Device Template table. The Feature Templates column shows the number of feature templates that are included in the device template, and the Type column shows "CLI" to indicate that the device template was created from CLI text.

Edit a Template

  1. In the Device or Feature tab, select a template.
  2. Click the More Actions icon to the right of the row and click Edit.

You cannot change the name of a device or feature template when that template is attached to a device.

Note that you can edit templates simultaneously from one or more vManage servers. For simultaneous template edit operations, the following rules apply:

  • You cannot edit the same device or feature template simultaneously.
  • When you are editing a device template, all other feature templates attached to that device template are locked and you cannot perform any edit operations on them.
  • When you are editing a feature template that is attached to a device template, that device template as well as all other feature templates attached to it are locked and you cannot perform any edit operations on them.

View a Template

  1. In the Device or Feature tab, select a template.
  2. Click the More Actions icon to the right of the row and click View.

Delete a Template

  1. In the Device or Feature tab, select a template.
  2. Click the More Actions icon to the right of the row and click Delete.
  3. Click OK to confirm deletion of the template.

View Device Templates Attached to a Feature Template

  1. In the Feature tab, select a template.
  2. Click the More Actions icon to the right of the row and click Show Attached Device Templates.

The View Attached Device Templates popup window opens displaying the names of the device templates to which the feature template is attached.

View Devices Attached to a Device Template

For a device template that you created from feature templates:

  1. In the Device tab, select a template.
  2. Click the More Actions icon to the right of the row and click Attach Devices.
  3. In the Attach Devices window, click the Attached Devices tab.

For a device template that you created from a CLI template:

  1. In the Device tab, select a template.
  2. Click the More Actions icon to the right of the row and click Show Attached Devices.

Perform Parallel Template Operations

On Viptela devices in the overlay network, you can perform the same operations, in parallel, from one or more vManage servers. You can perform the following template operations in parallel:

  • Attach devices to a device template
  • Detach devices from a device template
  • Change the variable values for a device template that has devices attached to it

For template operations, the following rules apply:

  • When a device template is already attached to a device, you can modify one of its feature templates. Then when you click Update ► Configure Devices, all other template operations—including attach devices, detach devices, and edit device values—are locked on all vManage servers until the update operation completes. This means that a user on another vManage server cannot perform any template operations until the update completes.
  • You can perform the attach and detach device template operations on different devices, from one or more vManage servers, at the same time. However, if any one of these operations is in progress on one vManage server, you cannot edit any feature templates on any of the servers until the attach or detach operation completes.

Attach Devices to a Device Template

To attach one or more devices to a device template:

  1. In the Device tab, select a template.
  2. Click the More Actions icon to the right of the row and click Attach Devices. The Attach Devices dialog box opens with the Select Devices tab selected
  3. In the Available Devices column on the left, select a group and search for one or more devices, select a device from the list, or click Select All.
  4. Click the arrow pointing right to move the device to the Selected Devices column on the right.
  5. Click Attach.
  6. If the template contains variables, enter the missing variable values for each device you selected in one of the following ways:
  • Enter the values manually for each device either in the table column or by clicking the More Actions icon to the right of the row and clicking Edit Device Template.
  • Click Import File in the upper right corner of the screen to upload a CSV file that lists all the variables and defines each variable's value for each device.

Once you provide values for all variables, the Status column to the right of each device row changes to green.​​​​

  1. Click Next.
    If any devices have the same system IP address, a pop-up or an error message is displayed when you click Next. Modify the system IP addresses so that there are no duplicates, and click Save. Then click Next again.
  2. In the left pane, select the device, to preview the configuration that is ready to be pushed to the device. The right pane displays the device's configuration and the Config Preview tab in the upper right corner is selected.
    Click the Config Diff tab to view the differences between this configuration and the configuration currently running on the device, if applicable.
    Click the Back button to edit the variable values entered in the previous screen.
  3. If you are attaching a vEdge router, click Configure Device Rollback Timer located at the bottom of the left pane, to configure the time interval at which the device rolls back to its previous configuration if the router loses its control connection to the overlay network. The Configure Device Rollback Time dialog box is displayed.
    1. From the Devices drop-down, select a device.
    2. To enable the rollback timer, in the Set Rollback slider beneath the Devices drop-down, drag the slider to the left to enable the rollback timer. When you do this, the slider changes in color from gray to green.
    3. To disable the rollback timer, click the Enable Rollback slider. When you disable the timer, the Password field pops up. Enter the password that you used to log in to the vManage NMS.
    4. In the Device Rollback Time slider, drag the slider to the desired value. The default time is 5 minutes. You can configure a time from 6 to 15 minutes.
    5. To exclude a device from the rollback timer setting, click Add Exception and select the devices to exclude.
    6. The table at the bottom of the Configure Device Rollback Time dialog box lists all the devices to which you are attaching the template and their rollback time. To delete a configured rollback time, click the Trash icon to right right of the device name.
    7. Click Save.
  4. Click Configure Devices to push the configuration to the devices.
    The Status column displays whether the configuration was successfully pushed. Click the right angle bracket to the left of the row to display details of the push operation.

Copy a Template

  1. In the Device or Feature tab, select a template.
  2. Click the More Actions icon to the right of the row and click Copy.
  3. Enter a new template name and description.
  4. Click Copy.

Edit a CLI Device Template

  1. In the Device tab, select a template.
  2. Click the More Actions icon to the right of the row and click Edit.
  3. In the Device CLI Template window, edit the template.
  4. Click Update.

Export a Variables Spreadsheet in CSV Format for a Template

  1. In the Device tab, select a device template.
  2. Click the More Actions icon to the right of the row and click Export CSV.

Change the Device Rollback Time and View Configuration Differences

  1. In the Device tab, select a device template.
  2. Click the More Actions icon to the right of the row and click Change Device Values. The right pane displays the device's configuration and the Config Preview tab in the upper right corner is selected.
  3. In the left pane, click the name of a device.
  4. Click the Config Diff tab to view the differences between this configuration and the configuration currently running on the device, if applicable.
    Click the Back button to edit the variable values entered in the previous screen.
  5. click Configure Device Rollback Timer located at the bottom of the left pane, to configure or change the time interval at which the device rolls back back to its previous configuration if the router loses its control connection to the overlay network. The Configure Device Rollback Time dialog box is displayed.
    1. From the Devices drop-down, select a device.
    2. To enable the rollback timer, in the Set Rollback slider beneath the Devices drop-down, drag the slider to the left to enable the rollback timer. When you do this, the slider changes in color from gray to green.
    3. To disable the rollback timer, click the Enable Rollback slider. When you disable the timer, the Password field pops up. Enter the password that you used to log in to the vManage NMS.
    4. In the Device Rollback Time slider, drag the slider to the desired value. The default time is 5 minutes. You can configure a time from 6 to 15 minutes.
    5. To exclude a device from the rollback timer setting, click Add Exception and select the devices to exclude.
    6. The table at the bottom of the Configure Device Rollback Time dialog box lists all the devices to which you are attaching the template and their rollback time. To delete a configured rollback time, click the Trash icon to right right of the device name.
    7. Click Save.
  6. Click Configure Devices to push the configuration to the devices.
    The Status column displays whether the configuration was successfully pushed. Click the right angle bracket to the left of the row to display details of the push operation.
  • Was this article helpful?