Cisco Managed Services Accelerator (MSX) 3.8 Managed Device Service Pack Guide

Provisioning a Device Supported Out-of-the-Box By Managed Device

Out of the box, Managed Device service pack support for CISCO IOS-XE based devices by default.

Table 1. Provisionig a Supported Device in the Service Pack
Task	See
Onboarding the device.	Adding the Device
Bulk provisioning	Importing Multiple Devices
Configuring the template parameters to the default device using the MSX portal.	Applying Template from Cisco MSX Portal
Configuring the template parameters to the default device using the site template, which is in the CSV file format.	Applying Template Using Site Template File
Deconfiguring the applied template parameter from the device.	Removing Site
Deprovision the device to bring back the Day-1 configuration.	Deprovisioning Site
Deleting and removing the site information from Cisco MSX.	Deleting Site

Placing an Order for a Managed Device Service

The Cisco MSX Managed Device service pack allows you to onboard devices to the MSX platform and monitor their status and metrics. You can onboard a single device manually or multiple devices at once using the Bulk Import feature.

Before you begin

The prerequisites for the task are that:

A tenant and a tenant user are created.
The device template is defined and is available for the tenant user.
Import the device model.

Procedure

Step 1	Log in to the Cisco MSX Portal.
Step 2	In the main menu, go to MSX Dashboard and then click Managed Device. The Managed Device home page window appears.
Step 3	Select an appropriate tenant.
Step 4	Click Add Device. Next step: Now add a new device into the Cisco MSX. For more information see Adding the Device

Adding the Device

To add a device:

Procedure

Step 1

Step 2

In the main menu, go to MSX Dashboard.

The MSX Dashboard home page window appears.

Step 3

Click Managed Device.

The Managed Device home page appears.

Step 4

Select a tenant.

Step 5

Click Add Device.

Step 6

In the Site Details section, specify the site details such as site name, site description, contact name, contact email, and location.

Step 7

Click Continue.

Step 8

In the Select Template section, you can select templates from the Template Options.

In the right pane, all the selected templates appear as a stack of templates.

To apply multiple templates on the device:
- Select the templates from the Template Options.
- Enter the value for each template instance.
To apply the same template more than once on the device:
- Select a template from Template Options as many times as needed.
- Enter the new set of values for each template instance.

Note

Cisco MSX allows you to reapply the same template repeatedly with a new set of values for each template instance.

Each template in the stack is independent of the other template. These templates can be selected in any order.

The latest selected template appears first in the template stack. These configurations are applied to the device in an appropriate order.

Note

You can revoke a specific template from the template stack to cancel any of the configurations that is applied to a template.

Step 9

Click Continue.

Step 10

Select the device Onboarding Type from the available options.

Zero-Touch Provisioning—Device automatically contacts and connects to MSX either through Cisco Plug-and-Play using an initial configuration, or is redirected using devicehelper.cisco.com.
Direct—MSX initiates a connection to the device directly using the device access details provided through the UI or site template file.

Step 11

Click Continue.

Step 12

Specify the Device Details. Based on the selected onboarding type, enter the device details.

For Zero-Touch Provisioning:

Enter the Serial Number of the device.
From the Device Model drop-down list, choose the required device model.

From the Onboarding Interface drop-down list, choose the onboarding interface.

By default, the onboarding interface is selected for WAN, and you can change the default interface for the WAN.

Note

You cannot change the default interface for LAN.

To add a new interface, check the WAN/LAN check box.
To clear an interface entry, uncheck the WAN/LAN check box.

For the Direct onboarding type:

In the Device Access Information section, specify values for the IP address, port, username, password, and secondary password.

Note

The secondary password is required for Cisco IOS devices to enter into the privilege mode.

In the Device Details section, complete the required fields including the following:

From the Device Model drop-down list, choose the required device model.

For more information, see Importing Device Model.
From the Bring up a secure management tunnel to MSX drop-down list, choose Yes to establish an encrypted management tunnel to connect devices to MSX Cloud. Use thesecure tunnel to send statistics reportand other configuration details to the Cisco MSX or SP Network. This option is available only for the Cisco IOS devices.
From the Onboarding Interface drop-down list, choose the onboarding interface.

The Device Type and NED ID are displayed based on the selected device model.

By default, the onboarding interface is selected for WAN, and you can change the default interface for the WAN.

Note

You cannot change the default interface for LAN.

To add a new interface, check the WAN/LAN check box.
To clear an interface entry, uncheck the WAN/LAN check box.

Step 13

Click Submit to add a device.

Importing Multiple Devices

Cisco Managed Device service pack allows you to import multiple devices at once using the bulk import feature. The site template file is used to import multiple devices. This file has a custom header row, and each subsequent row in the file represents a device to be created. You need to enter the required data in the appropriate columns of the file and then import the site template file to Cisco MSX..

Note

You must have a role that includes the MANAGE_BULK_IMPORT permission to perform the bulk import operation.

To avoid potential errors, disable the bulk import function if a bulk import job is already running. For example, if an error occurs when the bulk import job includes a device that is already provisioned, then the device gets duplicated in the Cisco MSX. Performing the jobs in sequence ensure that all the devices are added correctly by detecting and ignoring duplicate devices.

Procedure

Step 1

Download a Site Template file.

To download a site template:

Log in to the Cisco MSX portal.
In the MSX main menu, go to MSX Dashboard.

The MSX Dashboard home page window appears.
Click Managed Device.

The Managed Device home page window appears.
Select a tenant.
In the Managed Device main menu, click Bulk Import.

The Bulk Device Import window appears.

Figure 6. Importing Devices in Bulk

Step 2

Prepare the Site Template file.

Click Prepare your CSV file. The list of all the available templates for the tenant is displayed.
Select the templates that are to be applied for the devices at the time of import.
Click Download CSV. Save the file to your computer.

Before editing the site template file:

Determine the sites for which you want to apply the template.
For each site, identify the templates that should be applied.
For each template, determine the values for every template instance.

Note

You can select no template, a single template, or multiple templates on a device. If multiple templates are selected, then all the selected templates are applied to the device. If no template is selected, then no template will be applied to the device when it is created.
You can apply a template multiple times using the downloaded site template file.

Step 3

Edit the downloaded Site Template file.

You can select a single device or any number of devices and apply templates to the selected device using the site template file.

The downloaded site template file is an empty file, and its header content depends on the templates you have selected. Each subsequent row represents a device to be created.

Cisco MSX allows you to enter any number of devices to which you can apply templates, specify values for each instance of the template. You must enter the data manually to represent the devices to be imported accurately.
Cisco MSX enables you to reapply a single template multiple times to a device with a new set of values using a site template file. You have to specify the values for every template instance and use a comma to separate these values in their respective fields of the site template file.

Legend

DNS:SP_Domain_Name: Template_Instance1

DNS:SP_DNS_SERVER1: Template_Instance2

DNS:SP_DNS_SERVER2: Template_Instance3

Cisco.com,cisco.com: Value1,Value2 (Values of Template_Instance1 for site1)

1.1.1.1,2.2.2.2: Value1,Value2 (Values of Template_Instance2 for site1)

3.3.3.3,4.4.4.4: Value1,Value2 (Values of Template_Instance3 for site1)

As per the above table, apply the DNS template to site1 and site2. This template has three instances and two values; thus, the DNS template is applied twice on the site1 and site2. The DNS template is applied once on site 3.

Step 4

Import the site template file.

Upload the prepared site template file in the Import your CSV File section.
Click Start Validation.

Once the file is uploaded, all the data is validated.
- If all the data in the site template file is valid, then click Import Devices in the Validation Complete dialog box.
  
  The Managed Device home page displays the number of devices that are imported for the specific tenant.
- The Errors Found dialog box appears. Click View Errors to view the validation errors. x.
  
  The Device Data Errors page appears. Displays all the errors for each row.

If the validation process fails for some reason, then An Error Occurred dialog box appears.

Note

If you want to add more devices to the site template file after it is uploaded to Cisco MSX, you must add details of these devices to an existing site template file and upload the updated file to Cisco MSX again.

Applying Template from Cisco MSX Portal

To apply template to a device:

Procedure

Step 1

Step 2

In the MSX main menu, click MSX Dashboard.

The MSX Dashboard home page window appears.

Step 3

Click Manage Device.

The Managed Device home page window appears.

Step 4

Click the List View icon to view the devices.

Step 5

Select the device to apply template, click (...) > Apply Template.

Figure 10. Applying Template from Cisco MSX Portal

Note

Cisco Managed Device service pack allows you to import multiple devices at once using the Bulk Import feature. Select multiple device and click (...) > Apply Template by CSV.

For more information, see Importing Multiple Devices.

While adding device, templates can also be applied. For more information, see Adding the Device..

Step 6

In the Select Template section, you can select templates from the Template Options.

The selected stack of template appears on the right pane.

To apply multiple templates on the device:
- Select the templates from the Template Options.
- Enter the value for each template instance.
To apply the same template more than once on the device:
- Select a template from Template Options.
- Enter the new set of values for each template instance.
For example:

If you select a template, Cisco MSX allows you to reapply the same template multiple times with new set of values for the template instance.

Figure 11. Selected Templates

Step 7

Click Submit.

Applying Template Using Site Template File

To apply the template to the device using a site template file:

Procedure

Step 1	Log in to the Cisco MSX portal.
Step 2	In the MSX main menu, click MSX Dashboard. The MSX Dashboard home page window appears.
Step 3	Click Manage Device. The Managed Device home page window appears.
Step 4	Click the List View icon to view the devices.
Step 5	Select the devices to apply the template, click (...) > Apply Template By CSV. Figure 12. Applying Template By Site Template File For single-site option: You can select a device and apply a template to the selected device using the site template file. You have to prepare this file and then import it. For multiple-site options: You can select any number of devices from the list to which you want to apply the template using the site template file. Once you prepare this file, you can click (...) option in the header and import the site template file. The downloaded site template file is empty, and its header content depends on the templates you have selected. You can specify various parameters of the template such as hostname, device name, and so on. Applying a single template multiple times using the site template file: Cisco Managed Device enables to apply a template multiple times with the new set of values to a device using a site template file. The format of this file for applying the template is similar for both single device and bulk import. The bulk import allows you to apply the same template continuously on a device, but with multiple instances of the template variables. Enter the multiple variables separated with a comma in their respective fields of the site template file. Figure 13. Reapplying Template Using Template File Legend DNS:SP_Domain_Name: Template_Instance1 DNS:SP_DNS_SERVER1: Template_Instance2 DNS:SP_DNS_SERVER2: Template_Instance3 Cisco.com,cisco.com: Variable1,Variable2 (Variables of Template_Instance1 for site1) 1.1.1.1,2.2.2.2: Variable1,Variable2 (Variables of Template_Instance2 for site1) 3.3.3.3,4.4.4.4: Variable1,Variable2 (Variables of Template_Instance3 for site1) As per the above table, apply the DNS template to site1 and site2. This template has three instances and two variables; thus, the DNS template is applied twice for site1 and site2. The DNS template is applied once for site3. When you upload the site template file, it undergoes the validation process. If the template variables are valid, then the template is applied. If the template variables are found invalid, then it indicates failure status for that particular row.
Step 6	Click Continue.
Step 7	Click Generate & Download to generate and download the site template file, as mentioned in Step 4.

Removing Site

To remove a template from a site:

Procedure

Step 1	Log in to the Cisco MSX portal.
Step 2	In the main menu, go to MSX Dashboard. The MSX Dashboard home page window appears.
Step 3	Click Managed Device. The Managedd Device home page window appears.
Step 4	Click the List view icon, select the site for which you want to remove the templates and click Manage Template Details. The Template Details dialog box appears.
Step 5	Click Remove Template.You can remove only one template at a time.
Step 6	To remove all the templates associated with the sites, navigate to the Managed Device home page window, click (...) > Remove Templates.

Deprovisioning Site

To deprovision a device or a site:

Procedure

Step 1

Step 2

In the main menu, go to Settings.

The Setting home page window appears.

Step 3

Click Service Catalog > Managed Device.

The Managed Device home page window appears.

Step 4

Click the Settings tab.

Step 5

Select the site that you want to deprovision and click the Deprovision icon.

A confirmation dialog box appears.

Note

You can only deprovision devices to which templates have been applied. You can deprovision multiple devices at the same time.

Step 6

Click Deprovision Device.

Note

When you deprovision the site, it goes to Day-1 state and you can reapply a template to bring site back to Day-1 configuration. If the site displays failed state, you can force delete the site. You can check for the site status and manually bring the site back to Day-1 state.

Deleting Site

To delete a site:

Procedure

Step 1	Log in to the Cisco MSX Portal.
Step 2	In the MSX main menu, click MSX Dashboard. The MSX Dashboard home page window appears.
Step 3	Click Manage Device. The Managed Device home page window appears.
Step 4	Select the device that needs to be deleted, click (...) > Force Delete Site. Deletes and removes all the site information from Cisco MSX, and resets it. If the deletion fails, the site status displays a failure message. Click (...) > Force Delete Site. The Force Delete Site window appears. Click Force Delete Site again.

Provisioning a Device that is Not Supported Out-of-the-Box by Managed Device

Table 2. Steps Involved in Provisioning New Device Type in Managed Device
Task	See
The Managed Device consists of Cisco IOS NED by default to onboard any Cisco IOS-XE devices. The NED package is decided based on the new device type that is to be onboarded. Upload the new NED into the Managed Device NSO.	Uploading a NED Package
Preparing the SNMP device template.	Loading SNMP Configuration Template
Preparing the device model construct (JSON file) to collect the SNMP metrics data for the new device type that is to be onboarded into Cisco MSX.	Preparing Device Model Information for New Device Type
The JSON file now has all the necessary device model fields. Upload this file into the Cisco MSX portal to capture the SNMP metric data of the new device type.	Importing Device Model
Onboard the new device type in the Managed Device service pack.	Adding the Device

Loading SNMP Configuration Template

Procedure

Step 1

Convert CLI configuration into the NSO XML template for a new device type using the nTool workflow. For more information on workflow, see Creating Device Template.

Note

If you are using nTool workflow, then the CLI to XML conversion is limited to some of the device types, such as Cisco IOS, Cisco IOS-XR, Junos, and Cisco NX-OS.

Convert some of the tags in the XML template to variables. The tags are:

smmp-user
snmp-priv-password
snmp-auth-password

Note

While preparing the CLI configuration for SNMP support, ensure to make a note of authentication protocol, privacy protocol, and user name.

"snmpAuthProto": "AuthProto",
"snmpVersion": "3",
"snmpPrivProto": "aes",
"snmpUserName": "username"

Step 2

Add the SNMP template to custom-templates folder on kubernetes-master node.

To navigate to kubernetes master node, execute the following:
```
cd /data/vms/custom-templates/manageddevice/templates/
```

Create a .xml file. Add the NSO XML contents into this file and save it.

For example: junos-snmp.xml file

Note

Ensure to make a note of the .xml file name. The XML file will be later reused while preparing the device model information.

Step 3

Reload the NSO. The XML template should be loaded into NSO database system.

Log in to NSO POD and connect to NCS_CLI.
To reload NSO, execute the following:
```
vmsnso@ncs> request packages reload
```

To verify if the XML template is loaded successfully, execute the following:

vmsnso@ncs> show packages package custom-templates templates
templates [ junos-snmp ]

Next Steps

Preparing device model information. For more information, see Preparing Device Model Information for New Device Type.

Preparing Device Model Information for New Device Type

To facilitate the SNMP metric collection for the new device type, you can utilize the device model construct to collect metrics details.

For more details on how to build each SNMP field in the device model construct, see 'Sample device model field with description' in the Preparing Device Modelsection.

Sample device model construct of Juniper:

{
    "deviceModels": [{
        "deviceModelName": "Juniper SRX",
        "platformDeviceType": "",
        "platformDeviceSubType": "",
        "interfaces": [],
        "lan": [],
        "wan": [],
        "nedId": "",
        "deviceType": "",
        "directTemplate":""
  
  
    }],
    "deviceMetricConfigurations": [{
        "snmpDetails": {
            "snmpAuthProto": "",
            "snmpVersion": "",
            "snmpPrivProto": "",
            "snmpUserName": ""
        },
        "platformDeviceType": "",
        "platformDeviceSubType": "",
        "snmpOidList":[], 
        "snmpCpuMemoryUptimeQueryTemplate": {
        }
    }]
}

Next step:

After preparing the device model information (JSON file) for the new device type, upload this JSON file into Cisco MSX. For more information, see Importing Device Model.

Book Title

Chapter Title

Results

Chapter: Provisioning Managed Device

Provisioning Managed Device

Provisioning a Device Supported Out-of-the-Box By Managed Device

Placing an Order for a Managed Device Service

Before you begin

Procedure

Adding the Device

Procedure

Importing Multiple Devices

Procedure

Applying Template from Cisco MSX Portal

Procedure

Applying Template Using Site Template File

Procedure

Removing Site

Procedure

Deprovisioning Site

Procedure

Deleting Site

Procedure

Provisioning a Device that is Not Supported Out-of-the-Box by Managed Device

Loading SNMP Configuration Template

Procedure

Preparing Device Model Information for New Device Type

Was this Document Helpful?

Contact Cisco

Related Cisco Community Discussions