Create custom templates

Alert: Cisco has made the end-of-life (EOL) announcement for the Cisco Edge Device Manager (EDM).

Introduction

Cisco IoT OD provides a pre-defined set of default configuration templates for your network devices. You can also use the eCVD (Cisco Validated Design) templates for more advanced options. The templates can be selected when creating or updating a device group, where you can enter settings that apply to all devices in the group. See Create Configuration Group.

This document describes how to optionally create custom template configurations if required by your organization. You can edit an existing template or create a new template. Create custom templates before devices are onboarded. Apply the templates to device groups later.

Use the Apache FreeMarker™ Template Language (FTL) to create templates. Apply them to the Cisco IOS router and access point configurations.

The eCVD (Cisco Validated Design) templates provide a form based user interface that enables you to get your IoT OD deployments up and running. You can also modify the eCVD templates to create more customized templates. Send an email request to iotod-account-request@cisco.com to enable eCVD templates.

Note: Changes to an existing template do not automatically propagate to device groups. To push template changes to devices, click Groups > group name > Push Config.

Requirements

  • Knowledge of Cisco IOS router configuration.
  • Knowledge of Cisco router access point configuration.
  • Knowledge of Apache FreeMarker™ Template Language (FTL).

See the Apache FreeMarker Manual.

Create or modify a template

  1. From the left pane, click Configuration.
  2. Click the Templates tab and then Create Template.
  3. Complete the following fields.

Note: You can also edit templates in a device group. Click Groups > group name > Edit Group to modify the devices or template for that group. Be sure to click Push Config when you are done.

Field Description
Name Enter a meaningful name.

To create a copy of an existing template, change the name.
Description Optionally add a description.
Device Type Select the device model that can use the template, such as the IR800 series. Each device type has a different set of features that can be configured.
Tip: Start typing to narrow the selection.
Select a method to create your template
Create my own template Create an entirely new template using your own configuration.
Use reference template Select an existing template from the list.
  1. Click Next.
  2. Modify the configuration.

    1. Click the Configuration tab. Important: Do NOT modify the Bootstrap Configuration or the Embedded AP Configuration.

    2. Modify the configuration as required. For example, enter the variables that can be modified by users when adding a network device.

      Examples of supported variables include:

      bootstrap hostname:
${far.hostnameForBs}
LAN IP address:
${far.lanIPAddress}

      Ask your Cisco representative for more information about supported variables in this release.

    3. Click the Form View button in the top right to preview the form that is displayed when adding or modifying a device config.

    4. Click Next.

    5. Review your changes and click Save.

  3. If the template is already assigned to a group, apply the revised configuration.
    1. Click the Group tab and select a device group.
    2. In the Group detail page, click Push Config, and click Confirm.

Change the template for a device group

To apply your custom template to network devices, assign it to a device group.

  1. From the left pane, click Configuration.
  2. Select the group name and click Edit Group.
  3. In the Edit Group page, select a new base template and click Save.
  4. Click X to close the screen.
  5. Click Refresh and then click Push Config to apply the changes to the devices.