Create A Device Template From Feature Templates
Create A Device Template From Feature Templates
Create A Device Template From Feature Templates
Templates
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 Cisco SD-WAN 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, 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.
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:
Table 1:
Device Specific Use a device-specific value for the parameter. For device-specific parameters, you
(indicated by a host cannot enter a value in the feature template. You enter the value when you attach a
icon) 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 device to a device template. For more
information, see Use Variable Values in Configuration Templates .
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 Enter a value for the parameter, and apply that value to all devices.
globe icon)
Examples of parameters that you might apply globally to a group of devices are
DNS server, syslog server, and interface MTUs.
1. For some groups of parameters, you can mark the entire group as device-specific. To do this, click the
Mark as Optional Row box. These parameters are then grayed out so that you cannot enter a value for
them in the feature template. You enter the value or values when you attach a device to a device template.
2. Click Save.
3. Repeat Steps 7 through 13 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.
4. 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.
Configure Devices
Create a Device CLI Template
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.
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.
Delete a Template
Deleting a template does not remove the associated configuration from devices.
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.
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.
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.
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.
• 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.
• 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. When you are using optional rows, if
you do not want to include the parameter for the specific device, do not specify a value.
• 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.
1. Click Update
2. 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.
3. 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.
4. If you are attaching a Cisco vEdge device, 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.
a. From the Devices drop-down, select a device.
b. 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.
c. 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.
d. 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.
e. To exclude a device from the rollback timer setting, click Add Exception and select the devices to
exclude.
f. 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.
g. Click Save.
5. 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.
9. To exclude a device from the rollback timer setting, click Add Exception and select the devices to
exclude.
10. 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.
11. Click Save.
12. 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.
7. Click Configure Devices to push the configuration to the device. The Status column displays if the
configuration was successfully pushed or not. Click the right angle bracket to the left of the row to display
details of the push operation.
When you attach a template to a device from vManage, it puts the device in vManage mode. You can change
the device back to CLI mode if needed to make local changes to its configuration.
To toggle a router from vManage mode to CLI mode:
1. In WAN Edge List tab, select a device.
2. Click the Change Mode drop-down and select CLI mode.
An SSH window opens. To log in to the device, enter a username and password. You can then issue CLI
commands to configure or monitor the device.
To toggle a controller device from vManage mode to CLI mode:
1. In the Controllers tab, select a device.
2. Click the Change Mode drop-down.
3. Select CLI mode and then select the device type. The Change Mode CLI window opens.
4. From the vManage mode pane, select the device and click the right arrow to move the device to the CLI
mode pane.
5. Click Update to CLI Mode.
An SSH window opens. To log in to the device, enter a username and password. You can then issue CLI
commands to configure or monitor the device.
A list of routers in the network is displayed in the router table, with details about each router.
Upload WAN Edge Router Serial Numbers from Cisco Smart Account
Chassis and serial numbers of all valid Cisco vEdge devices in the overlay network are required to allow the
Cisco SD-WAN overlay network components to validate and authenticate each other and thus to allow the
overlay network to become operational.
To upload the WAN edge router authorized serial numbers from a Cisco Smart account to the vManage NMS
and then download it to all the controllers in the overlay network:
1. In the WAN Edge List tab, click Sync Smart Account.
2. In the Sync Smart Account window:
A list of routers in the network is displayed in the router table, with details about each router.
After you provision the vEdge Cloud router instance, vManage NMS installs a certificate on the device and
the device's token changes to a serial number. After the device's control connections to vManage NMS come
up, any templates attached to the device are automatically pushed to the device.
After you have copied the configuration to the new router, you can add the new router to the network. First,
delete the old router from the network, as described below. Then add the new router to the network:
1. In the Configuration ► Certificates screen, mark the new router as valid.
2. Click Send to Controller.
2. In the Configuration ► Devices screen, in the WAN Edge List tab, select the router.
3. Click the More Actions icon to the right of the row and click Delete WAN Edge.
4. Click OK to confirm deletion of the device.
5. In the Configuration ► Certificates screen, click Send to Controller.
c. Select the Generate CSR checkbox to allow the certificate-generation process to occur automatically.
d. Click Add.
The new Cisco vBond Orchestrator is added to the list of controllers in the Controllers screen.
3. Repeat Steps 1 and 2 to add additional Cisco vSmart Controllers. The vManage NMS can support up to
20 Cisco vSmart Controllers in the network.
The new Cisco vSmart Controller is added to the list of controllers in the Controllers screen.
Delete a Controller
Deleting a controller removes it from the overlay. Delete a controller it if you are replacing it or if you no
longer need it in your network.
To delete a controller:
1. In the Controllers tab, select the controller.
2. Click the More Actions icon to the right of the row and click Invalidate.
3. Click OK to confirm the removal of the device and all its control connections.
To enable reverse proxy in the overlay network, in vManage NMS select Administration ► Settings. Then
click Edit to the right of the Reverse Proxy bar, click Enabled, and click Save.
For more information about the Cisco Unified Computing System (UCS) E-Series Servers, see the Cisco UCS
E-Series Servers and the Cisco UCS E-Series Network Compute Engine Hardware Installation Guide.
1. From the vManage menu, select Configuration ► Templates.
2. Click Feature.
3. Click Add Template.
4. Select a Cisco XE SD-WAN device from the list.
IMC Configuration
Click the IMC tab to configure the IMC parameters for the template.
Global (indicated by a globe icon) Enter a value for the parameter and apply that value
to all devices.
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 Cisco SD-WAN 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 Cisco SD-WAN device
to a device template.
To change the default key, type a new string and move
the cursor out of the Enter Key box.