Managing Centralized Configuration Templates

This chapter has the following sections:

Managing the Centralized Configuration Templates

Cisco MSX Enterprise Access service pack allows you to create and manage device CLI configuration templates. You can deploy these templates across tenants. The templates can contain parameterized variables applied to specific device family types. You can deploy these templates to one or more Cisco DNA Center at the same time. The feature allows you to:

  • Create, edit, and delete templates

  • Add notes and comments

  • Associate one or more templates to one or more tenants

  • Dissociate (only if not deployed) a template from a tenant

  • Identify the applicability of the template for:

    • Device family, for example, routers, switches, wireless devices, and so on

    • Device series, for example, Cisco Catalyst 9800 Series Wireless Controllers

    • Device type, for example, Catalyst 9000-CL Wireless Controller

    • Operating system, for example, IOS-XE

    • Operating system version, for example, 10.0

Creating a Configuration Template

To create a configuration template:

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, choose Settings > Template Management.

The Template Management window is displayed.

Step 3

Select Enterprise Access.

The Enterprise Access Template Management window is displayed with the templates that are currently available in the MSX library.

Note 

Only templates for Enterprise Access will show up in this page.
Step 4

Click the + icon (Create Template) displayed at the top-right corner of the page.

The Create Template wizard is displayed with instructions to create a template.

Step 5

Click Next.

Step 6

In the Name text box, enter a unique name for the template.

Step 7

(Optional) In the Description text box, enter a description for the template.

Step 8

(Optional) In the Notes text box, enter note.

Step 9

Click Next.

Step 10

In the Template CLI area, enter the CLI commands.

Step 11

In the Template Applicability area, choose the device applicability for Family, Series, or Device Type from the listed devices. Click the > icon to collapse the list of devices. You can select one of more device applicabilities.

Step 12

From the Software Type drop-down list, choose a software type.

Step 13

(Optional) In the Software Version text box, enter the software version.

Step 14

Click Next.

The template is created. It may take a while before the template is ready for assignment.
Step 15

Click Close.

Assigning a Configuration Template to a Tenant

You can assign a configuration template to one or more tenants in Cisco MSX. After you assign a template, you can see the template in the Tenant Workspace and deploy it on a domain controller and provision the device.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, choose Settings > Template Management.

The Template Management window is displayed.

Step 3

Click Enterprise Access.

The Enterprise Access Template Management window is displayed with the templates that are currently available in the MSX library.

Step 4

From the list, choose a template and click the ellipsis (…), and click Assign Tenants.

A wizard is displayed with instructions to assign templates.
Step 5

From the Select tenants drop-down list, choose a tenant.

Step 6

Click Next to confirm the assignment.

The process of assigning template starts. It may take approximately one minute to assign a template.

Step 7

(Optional) Click View Template Activity to view the progress of the assignment.

Note 

Not all assignments are successful.
Step 8

(Optional) Click Continue to Template Library to view the template library.

Unassigning a Configuration Template from a Tenant

You can unassign a template from a tenant. After you unassign a template, you cannot retrieve the list of templates associated with that tenant. To unassign a template:

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, choose Settings > Template Management.

The Template Management window is displayed.

Step 3

Select Enterprise Access.

The Enterprise Access Template Management window is displayed with the templates that are currently available in the MSX library.

Step 4

Click a template name. The page displays four tabs: Applicability, Tenants, CLI, and Notes.

Step 5

Click Tenants tab.

The window displays the list of tenants assigned to a template.
Step 6

Choose a tenant from the list and click X to unassign the template from the tenant.

You are prompted before you unassign the template.
Step 7

Click Unassign.

Deploying a Configuration Template in Cisco DNA Center

You can deploy one or more templates in Cisco DNA Center.


Note

If you want to deploy the same template for a second time to the same controller, you have to undeploy it first and then deploy it again.

To deploy a configuration template:

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, click Tenant Workspace and then choose a tenant from the drop-down list.

Step 3

Under Tenant Workspace, click Service Controls.

The list of service controls attached to a tenant is displayed.
Step 4

Click Enterprise Access.

Step 5

Click Template Management.

The Template Management window is displayed with the templates that are assigned to the tenant.

Step 6

From the list, choose a template and click the ellipsis (…), and then click Deploy Template. Alternatively, you can also click a template name, click the Controllers tab, and click Deploy Template to deploy a template.

The Deploy to Controllers window is displayed.

Step 7

Click Next.

Step 8

Choose one or more controllers from the list.
Step 9

Click Next.

Step 10

From the Project drop-down list, choose a project. If no projects are displayed in the drop-down list, then you can enter a new project name.

Step 11

From the Tags drop-down list, choose a tag. If the tag you specified does not exist on the controllers, then you can enter new tags. After entering a tag name, click Add new. Note that you can add multiple tags.

Note 

You can create new projects and tags, and not select them. After you click Add new and enter a project name or tag, the new project and tag will be stored in MSX, and you can use them later when you deploy a template, as required. Also, note that if you unselect a newly created tag or project, it will not be saved. The saved tags and projects are saved on a per tenant basis.

Step 12

Click Next.

The Review window is displayed with the details you selected.

Step 13

Review the details and click Next.

A message displays 'Successfully Initiated Deployment'.

Step 14

Click Close.

Undeploying a Configuration Template from Cisco DNA Center

You can undeploy a configuration template from Cisco DNA Centre. To undeploy a configuration template:

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, click Tenant Workspace and then choose a tenant from the drop-down list.

Step 3

Under Tenant Workspace, click Service Controls.

The list of service controls attached to a tenant is displayed.
Step 4

Click Enterprise Access.

Step 5

Click Template Management.

The Template Management window is displayed with the templates that are assigned to the tenant.

Step 6

Click a template name. The page displays four tabs: Controllers, Applicability, CLI, and Notes.

Step 7

Click Controllers.

The controllers that are assigned to the template are listed.
Step 8

Choose a controller from the list, click the ellipsis (…), and then click Undeploy.

You are prompted before you remove the template.
Step 9

Click Undeploy.

A message displays 'Undeployment Initiated'.

Step 10

Click Okay.

Viewing Configuration Templates

After you create a configuration template, you can view the details of the template in the Enterprise Access Template Management page. To view the details:

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, choose Settings > Template Management.

The Template Management window is displayed.

Step 3

Select Enterprise Access.

The Enterprise Access Template Management window is displayed with the templates that are currently available in the MSX library.

Step 4

Click a template name. The page displays four tabs: Applicability, Tenants, CLI, and Notes. Click a tab to view the details:

  • Applicability: Displays the applicability of the templates. It lists all the applicable devices supported by a template and the operating system.

  • Tenants: Displays tenants assigned to a template. From this tab, you can assign a tenant to a template. Click the + icon (Add Tenant). For more information, see Assigning/Unassigning Template to a Tenant.

  • CLI: The CLI configuration applied to a template.

  • Notes: Any note that was entered.

Step 5

Click Close to close the display of template details.

Viewing Configuration Templates for a Specific Tenant

To view the configuration templates assigned to a tenant:

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, click Tenant Workspace and then choose a tenant from the drop-down list.

Step 3

Under Tenant Workspace, click Service Controls.

The list of service controls attached to a tenant is displayed.
Step 4

Click Enterprise Access.

Step 5

Click Template Management.

The Template Management window is displayed with the templates assigned to the tenant.

Step 6

Click a template name. The page displays four tabs: Controllers, Applicability, CLI, and Notes. Click a tab to view the details:

  • Controllers: Lists all the controllers attached to a template. If no controllers are listed, you can create controllers from here and deploy a template. To deploy a template, click Deploy Template. For more information, see Deploying/Undeploying a Template in Cisco DNAC.

  • Applicability: Displays the applicability of the templates. It lists all the applicable devices supported by a template and the operating system.

  • CLI: The CLI configuration applied to a template.

  • Notes: Any note that was entered.

Step 7

Click Close to close the display of template details.

Viewing Deployment History

Template history lists the history of all the activities performed on a template. To view the template history:

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, choose Settings > Template Management.

The Template Management window is displayed.

Step 3

Select Enterprise Access.

The Enterprise Access Template Management window is displayed with the templates that are currently available in the Cisco MSX library.

Step 4

Click the clock icon (History) displayed at the top-right corner of the page.

The template history is displayed.

Note 

The template history shows the events related to creation, deletion, assignment, and unassignment of templates.

Viewing the Template History of a Tenant

To view the template history of a tenant:

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, click Tenant Workspace and then choose a tenant from the drop-down list.

Step 3

Under Tenant Workspace, click Service Controls.

The list of service controls attached to the tenant is displayed.
Step 4

Click Enterprise Access.

Step 5

Click Template Management.

The Template Management window is displayed with the templates that are assigned to the tenant.

Step 6

Click the clock icon (History) displayed at the top-right corner of the page.

The template history is displayed.

Note 

The template history shows only the deployment actions.

Deleting a Configuration Template

You can delete a configuration template from the Template Library. Before you delete a template, ensure that it is not assigned to a tenant. If it is assigned to a tenant, you can't delete it. To delete a configuration template:

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, choose Settings > Template Management.

The Template Management window is displayed.

Step 3

Select Enterprise Access.

The Enterprise Access Template Management window is displayed with the templates that are currently available in the MSX library.

Step 4

From the list, choose a template and click the ellipsis (…), and then click Delete Template.

You are prompted before you delete a template.
Step 5

Click Delete.