Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

Devices

Use the Devices screen to add or delete Viptela devices from the overlay network.

Note: For purposes of certificate management, the term controller is used to collectively refer to the vManage NMS, the vSmart controller, and the vBond orchestrator.

Screen Elements

  • Title bar—Includes tabs for vEdge List and Controllers.
  • vEdge List tab—Upload the vEdge authorized serial number file to the vManage NMS. When you first open the Devices screen, the vEdge List tab is selected.
    • Upload vEdge List—Upload the vEdge router authorized serial number file to the vManage NMS.
    • Change mode—Switch between vManage and CLI mode.
  • Controllers tab—Add controllers to the overlay network.
    • Change mode—Switch between vManage and CLI mode.
  • Filter criteria—Sort options drop-down and Search box, for a Contains or Match string.
  • vEdge router table.

Install vEdge Authorized Serial Number File

The vEdge authorized serial number file contains the chassis and serial numbers of all valid vEdge routers in your overlay network. You receive this file from Viptela. Then, from the vManage NMS, you send it to the controllers in the network. This file is required to allow the Viptela overlay network components to validate and authenticate each other and thus to allow the overlay network to become operational.

To upload the vEdge router authorized serial number file to the vManage NMS and then download it to all the controllers in the overlay network:

  1. In the vEdge List tab, click Upload vEdge List.
  2. In the Upload vEdge dialog box:
    1. Click Choose File and select the vEdge authorized serial number file you received from Viptela.
    2. To automatically validate the vEdge routers and send their chassis and serial numbers to the controllers, click and select the checkbox Validate the Uploaded vEdge List and Send to Controllers. If you do not select this option, you must individually validate each router in Configuration ► Certificates ► vEdge List.
    3. Click Upload.

A list of vEdge routers in the network is displayed, showing detailed information about each router.

Change Configuration Modes

To toggle a vEdge router from vManage mode to CLI mode:

  1. In vEdge List tab, select a device.
  2. Click the Change Mode button 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 Controllers tab, select a device.
  2. Click the Change Mode button.
  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.

Add a vBond Orchestrator

  1. In the Controllers tab, click Add Controller and select vBond.
  2. In the Add vBond dialog box:
    1. Enter the management IP address of the vBond controller.
    2. Enter the username and password to access the vBond orchestrator.
    3. Select the Generate CSR checkbox to allow the certificate-generation process to occur automatically.
    4. Click Add.
  3. Repeat Steps 1 and 2 to add additional vBond orchestrators.

The new vBond orchestrator is added to the list of controllers in the Controller screen. The screen displays detailed information about each controller, including controller type, hostname, IP address, site ID, configuration mode, assigned template, configuration status, and certificate status.

Add a vSmart Controller

  1. In the Controllers tab, click Add Controller and select vSmart.
  2. In the Add vSmart dialog box:
    1. Enter the system IP address of the vSmart controller.
    2. Enter the username and password to access the vSmart controller.
    3. Select the protocol to use for control-plane connections. The default is DTLS.
    4. If you select TLS, enter the port number to use for TLS connections. The default is 23456.
    5. Select the Generate CSR checkbox to allow the certificate-generation process to occur automatically.
    6. Click Add.
  3. Repeat Steps 1 and 2 to add additional vSmart controllers. The vManage NMS can support up to 20 vSmart controllers in the network.

The new vSmart controller is added to the list of controllers in the Controller screen. The screen displays detailed information about each controller, including controller type, hostname, IP address, site ID, configuration mode, assigned template, configuration status, and certificate status.

Edit Controller Details

To edit the IP address and login credentials of a controller device:

  1. In the Controllers tab, select a controller.
  2. Click the More Actions icon to the right of the row and click Edit.
  3. In the Update window, edit the IP address and the login credentials.
  4. Click Save.

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.

Copy a vEdge Router's Configuration

When you are replacing one router at a site with another router, you copy the old router's configuration to the new router. Then you remove the old router from the network and add the new one.

To copy the configuration from the old router to the new router:

  1. On the Configuration ► Certificates screen, mark the new vEdge router as invalid.
  2. On the Configuration ► Devices screen, in the vEdge List tab, select the old router.
  3. Click the More Actions icon to the right of the row and click Copy Configuration.
  4. From the List of invalid devices pop-up screen, select the new router.
  5. Click Update to confirm the copy of the configuration.

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. On the Configuration ► Certificates screen, mark the new router as valid.
  2. Click Send to Controller.

Delete a vEdge Router

Deleting a vEdge router removes its serial and chassis numbers from the vEdge serial number list and permanently removes the router's configuration from the vManage NMS.

  1. On the Configuration ► Certificates screen, mark the vEdge router as invalid.
  2. On the Configuration ► Devices screen, in the vEdge List tab, select the router.
  3. Click the More Actions icon to the right of the row and click Delete vEdge.
  4. Click OK to confirm deletion of the device.
  5. On the Configuration ► Certificates screen, click Send to Controller.

View a Device's Configuration

To view a device's configuration created using Configuration ► Templates:

  1. In the vEdge List or Controllers tab, select the device.
  2. Click the More Actions icon to the right of the row and click View Local Configuration.

View a Device's Running Configuration

To view a device's running configuration:

  1. In the vEdge List or Controllers tab, select the device.
  2. Click the More Actions icon to the right of the row and click View Running Configuration.

View Log of Template Activities

To view a log of activities related to creation of configuration templates and the status of attaching configuration templates to devices:

  1. In the vEdge List or Controllers tab, select the template.
  2. Click the More Actions icon to the right of the row and click View Template Log.

Update Variable Values for a Device

The feature templates that you create using the Configuration ► Templates screen 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, you create an Excel file that lists the variable values for each device and save the file in CSV format.

Once you push the configuration to a device, you can change the value assigned to any variables. To do so:

  1. In the vEdge List or Controllers tab, select the device.
  2. Click the More Actions icon to the right of the row and click Update Device Values.
  3. In the Update Device Values window, enter the new variable values for the selected device in one of the following ways:
  • Click the More Actions icon to the right of the row and click Edit Device Template. In the Update Device Template window, edit the values as needed and click Update. To see the currently set value, hover the cursor over the field name.
  • 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 the device.

Once you have provided the value for all variables, the Status column for each device row displays a green check mark.​​​​

  1. Click Next.
  2. 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 preview the difference between this configuration and the previously attached template, if applicable.
    Click the Back button to edit the variable values entered in the previous screen.
  3. 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.
  • Was this article helpful?