Skip to main content
Viptela is now part of Cisco.
Support
Product Documentation
Viptela Documentation

Create Configuration Templates for a vBond Orchestrator

This article describes how to configure vBond orchestrators that are being managed by a vManage NMS. These devices must be configured from the vManage NMS. If you configure them directly from the CLI on the router, the vManage NMS overwrites the configuration with the one stored on the NMS system.

Configuration Prerequisites

Security Prerequisites

Before you can configure vBond orchestrators in the Viptela overlay network, you must have generated a certificate for the vBond orchestrator, 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 the order listed below):

  • 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 vBond Orchestrators

The following features are mandatory for vBond orchestrator operation, and so creating a feature template for each of them is required:

Feature

Template Name

Authentication, Authorization, and Accounting (AAA)

AAA

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 templates are provided for other vBond orchestrator features:

Feature

Template Name

Archive of the router's running configuration

Archive

Banner text displayed before and after login

Banner

Interfaces

VPN and VPN-Interface-Ethernet

SNMP

SNMP

System message logging Logging

Create Feature Templates

Feature templates are the building blocks of a vBond orchestrator's complete configuration. For each feature that you can enable on a vBond orchestrator, 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 vBond orchestrator features.

You can create multiple templates for the same feature.

To create vBond 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 vEdge Cloud. (For Releases 15.4 and earlier, select vBond Software.) In Releases 16.1 and later, you must create a vBond-only templates, that define only orchestrator functionality. These templates must not contain any vEdge functionality.
  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 required 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's value box:

    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 the various timers for routing protocol hello intervals.

    Device specific

    Use a device-specific value for the parameter.

    When you attach the device template to the router, 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 the values for additional parameters, if applicable.
  9. Click Create.
  10. Create feature templates for each of the required features listed in the previous section.
    1. In the System template, in the top portion, configure all desired parameters except for Controller Groups, Maximum Controllers, and Maximum OMP Sessions. These parameters are specific to vEdge routers and have no meaning for a vBond orchestrator.
      In the Advanced Options portion, in vBond Only and Local vBond, click On. These two parameters are what instantiate the vBond orchestrator.
    2. Create two VPN templates, one for VPN 0 (the VPN that connects to the Internet or other public transport network) and one for VPN 512 (the VPN that handles out-of-band management traffic).
    3. Create AAA and Security templates.
  11. Create feature templates for each optional feature that you want to enable on vBond orchestrators:
    1. Create Archive and Banner templates
    2. Create one VPN-Interface-Ethernet template for each additional Ethernet interface you want to configure on the vBond orchestrator. Do not create any tunnel interfaces, or tunnels of any kind, for vBond orchestrators.

Create Device Templates

Device templates contain all or large portions of 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 use both styles of device templates when configuring a vBond orchestrator.

To create vBond 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 vEdge Cloud. (For Releases 15.4 and earlier, select vBond Software.)
  5. Enter a name and description for the vBond device template. These fields are mandatory. You cannot use any special characters in template names.
  6. From the bar beneath the template name and description, select the desired group of templates.
  7. In each section, select the desired template. All required templates are marked with an asterisk (*). Initially, the drop-down list for each template lists the default feature template
    1. For each required and optional template, select the feature template from the drop-down list. These templates are the ones that you previously created (see Create Feature Templates above). Do not select a BFD or an OMP template for vBond orchestrators.
    2. For additional templates, click the plus (+) sign next to the template name, and select the feature template from the drop-down list.
  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 vBond Software.
  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 Device Templates To vBond Orchestrators

To configure a vBond orchestrator, you attach one device template to the orchestrator. You can attach the same template to multiple vBond orchestrators simultaneously.

To attach a device template to vBond orchestrators:

  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 vBond orchestrators 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 orchestrators. Click Select All to choose all listed orchestrators.
  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 send the configuration in the device template to the vBond orchestrators, click Configure Devices.

Release Information

Introduced in vManage NMS in Release 15.3.
Procedure revised in Release 16.1.

  • Was this article helpful?