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

Create Configuration Templates for a vSmart Controller

For vSmart controllers that are being managed by a vManage NMS, you must configure them from the vManage NMS. If you configure them directly from the CLI on the vSmart controller, the vManage NMS overwrites the configuration with the one stored on the NMS system.

Configuration Prerequisites

Security Prerequisites

Before you can configure vSmart controllers in the Viptela overlay network, you must have generated a certificate for the vSmart controller, and the certificate must already be installed on the device. See Generate a Certificate.

Variables Spreadsheet

The feature templates that you create will most likely contain variables. To have the vManage NMS populate the variables with actual values when you attach a device template to a device, either enter the values manually or click Import File in the upper right corner to load an Excel file in CSV format that contains the variables values.

In the spreadsheet, the header row contains the variable name and each row after that corresponds to a device, defining the values of the variables. The first three columns in the spreadsheet must be (in order):

  • csv-deviceId—Serial number of the device (used to uniquely identify the device). For vEdge routers, you receive the serial numbers in the vEdge authorized serial number file sent to you from Viptela. For other devices, the serial number is included in the signed certificate you receive from Symantec or from your root CA.
  • csv-deviceIP—System IP address of the device (used to populate the system ip address command).
  • csv-host-name—Hostname of the device (used to populate the system hostname command).

You can create a single spreadsheet for all devices in the overlay network—vEdge routers, vSmart controllers, and vBond orchestrators. You do not need to specify values for all variables for all devices.

Feature Templates for vSmart Controllers

The following features are mandatory for vSmart controller operation, so you must create a feature template for each of them:

Feature

Template Name

Authentication, Authorization, and Accounting (AAA)

AAA

Overlay Management Protocol (OMP)

OMP

Security

Security

System-wide parameters

System

Transport VPN (VPN 0)

VPN with the VPN ID set to 0

Management VPN (for out-of-band management traffic)

VPN with the VPN ID set to 512

The following additional templates are provided for other vSmart controller features:

Feature

Template Name

Archive of the router's running configuration

Archive

Banners display before and login and

Banner

Interfaces

VPN-Interface

Network Time Protocol

NTP

SNMP

SNMP

System message logging

Logging

Create Feature Templates

Feature templates are the building blocks of a vSmart controller's complete configuration. For each feature that you can enable on a vSmart controller, the vManage NMS provides a template form that you fill out with the desired parameters for that feature.

You must create feature templates for the mandatory vSmart controller features.

You can create multiple templates for the same feature.

To create vSmart feature templates:

  1. In vManage NMS, select the Configuration ► Templates screen.
  2. From the Templates title bar, select Feature.
  3. Click Add Template.
  4. In the left pane, from Select Devices, select vSmart. You can create a single feature template for features that are available on both vSmart controllers and other devices. You must, however, create separate feature templates for software features that are available only on vSmart controllers.
  5. In the right pane, select the template. The template form is displayed. The top of the form contains fields for naming the template, and the bottom contains fields for defining parameters applicable to that template. Optional parameters are generally grayed out. A plus sign (+) is displayed to the right when you can add multiple entries for the same parameter.
  6. Enter a template name and description. These fields are mandatory. You cannot use any special characters in template names.
  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 field:

    Parameter Scope

    Scope Description

    Default

    Use the default value for the parameter.

    If the parameter is already configured on a device, the configured value is not modified.

    If the parameter is not yet configured on a device and if it has a default value, that default value is configured on the device. Examples of parameters that have default values are timers.

    Device specific

    Use a device-specific value for the parameter.

    When you attach the device template to the vSmart controller, you must enter the value for the parameter. You can type the values manually, or you can upload an Excel file in CSV format that contains the parameter's value.

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

    Global

    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.

  8. Click the plus sign (+) below the required parameters to set values for additional parameters, if applicable.
  9. Click Create.
  10. Create feature templates for each of the required features listed in the previous section.
    For the transport VPN, use the template called VPN-vSmart and in the VPN Template section, set the VPN to 0, with a scope of Global.
    For the management VPN, use the template called VPN-vSmart and in the VPN Template section, set the VPN to 512, with a scope of Global.
  11. Create any additional feature templates for each optional feature that you want to enable on vSmart controllers.

Create Device Templates

Device templates contain a device's complete operational configuration. You create device templates by consolidating together individual feature templates. You can also create them by entering a CLI text-style configuration directly on the vManage NMS.

You can attach only one device template to configure a vSmart controller, so it must contain, at a minimum, all the required portions of the vSmart configuration. If it does not, the vManage NMS returns an error message. If you attach a second device template to the vSmart controller, it overwrites the first one.

To create device templates from feature templates:

  1. In vManage NMS, select the Configuration ► Templates screen.
  2. From the Templates title bar, select Device.
  3. Click Create Template, and from the drop-down list select From Feature Templates.
  4. From the Device Model drop-down, select vSmart.
  5. Enter a name and description for the vSmart device template. These fields are mandatory. You cannot use any special characters in template names.
  6. Complete the Required Templates section. All required templates are marked with an asterisk. 
    1. For each required template, select the feature template from the drop-down list. These templates are the ones that you previously created (see Create Feature Templates above). After you select a template, the circle next to the template name turns green and displays a green check mark. 
    2. For templates that have Sub-Templates, click the plus (+) sign or the Sub-Templates title to display a list of sub-templates. As you select a sub-template, the name of the sub-template along with a drop-down is displayed. If the sub-template is mandatory, its name is marked with an asterisk. 
    3. Select the desired sub-template.
  7. Complete the Optional Templates section, if required. To do so:
    1. Click Optional Templates to add optional feature templates to the device template.
    2. Select the template to add.
    3. Click the template name and select a specific feature template.
  8. Click Create. The new device template is listed in the Templates 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.

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

  1. In vManage NMS, select the Configuration ► Templates screen.
  2. From the Templates title bar, select Device.
  3. Click Create Template, and from the drop-down list, select CLI Template.
  4. In the Add Device CLI Template box, enter a template name and description, and select vSmart.
  5. Enter the configuration in the CLI Configuration box, 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 right pane on the screen lists the new device template. 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.

Attach a Device Template To vSmart Controllers

To configure a vSmart controller, you attach one device template to the controller. You can attach the same template to multiple vSmart controllers simultaneously.

To attach a device template to vSmart controllers:

  1. In vManage NMS, select the Configuration ► Templates screen.
  2. From the Templates title bar, select Device.
  3. In the right pane, select the desired device template.
  4. Click the More Actions icon to the right of the row, and select Attach Devices.
  5. In the Attach Devices box, select the desired vSmart controllers from the Available Devices list, and click the right-pointing arrow to move them to the Selected Devices box. You can select one or more controllers. Click Select All to choose all listed controllers.
  6. Click Attach.
  7. If the device template contains variables, either enter the values manually or click Import file in the upper right corner to load an Excel file in CSV format that contains the variable values.
  8. Click Next.
  9. To preview the configuration that is about to be sent to the vSmart controller, in the left pane, click the device. The configuration is displayed in the right pane, in the Device Configuration Preview window.
  10. To send the configuration in the device template to the vSmart controllers, click Configure Devices.

Release Information

Introduced in vManage NMS in Release 15.3.

  • Was this article helpful?