Devices
CXTM Test Automation
  • Introduction
  • CXTM Basics
  • CXTM Projects
  • CXTM Test Cases
  • CXTM Test Automation
  • Revisit Imported Test Cases
  • CXTM Batches
  • NetDevOps
  • CXTM Reporting
  • CXTM References
  • Bonus: Project Users
  • Bonus: CXTM REST API

CXTM Devices

CXTM leverages the Unicon framework of device control libaries to define how connections should be established to the devices in the testbed, such as routers, switches, and servers. The unicon framework stores the device connection parameters (protocols, IP addresses, ports, etc) and credentials in a testbed file in YAML format.

The Devices page allows CXTM users the ability to easily generate these YAML testbed topology files without having to worry about the underlying YAML file structure expected by unicon. In addition, CXTM takes care to ensure that device credentials are properly protected.

CXTM offers multiple options to create this file. Users can use the provided CSV template to add the device inventory in bulk, create and import topology files programmatically, or add devices individually. In the following steps you will add the devices for your lab topology. In the upcoming Topologies section of the lab, you'll add the YAML file directly into CXTM.

Step 1 - Navigate to Project Devices

Within your project:

  1. If not already expanded, expand the left sidebar



  2. Scrolldown until you locate the heading Project Automation
  3. Under Project Automation, click Devices


Step 2 - Launch New Device Pop-Up


On your project Devices page:

  1. Click New Device to add a new device.



Step 3 - Review the default Device Details pop-up

  1. Notice the "*" beside Hostname

  2. The Hostname is a mandatory field, and as noted in the pop-up, it "must be unique for this project and it must match the device prompt exactly" or the connection will fail. For that reason, be sure to copy/paste the Hostnames from this lab guide into the Device Details pop-up exactly as provided.

  3. Notice that the Connector OS defaults to Linux

  4. The Connector OS maps to the "os:" value in the YAML topology file, and identifies the proper unicon plugin to use when creating a connection to the device. This will change dynamically based on your Device OS selections in subsequent steps.


Step 4 - Add CSR1Kv-01 Device

In the Device Details pop-up, enter the below information to add the CSR1Kv-01 device to your lab topology.

When entering the below information, notice that after selecting "ios" from the Device OS dropdown and "xe" from the Sub Category dropdown, that the Connector OS is automatically changed from "Linux (default)" to "IOSXE".

  1. Hostname: CSR1Kv-01
  2. Device OS: Select ios
  3. Sub Category: Select xe
  4. Connector OS: Select IOSXE
  5. Type: Select Router
  6. Click SUBMIT


Step 5 - For CSR1Kv-01 Device Select New Connection

Add a connection to your CSR1Kv-01 device:

  1. Click New Connection under the device hostname


Step 6 - Add CSR1Kv-01 Device SSH Connection

In the Connection Details pop-up, enter the below information to add an ssh connection to the CSR1Kv-01 device:

When entering in the device credentials, notice that the passwords are not displayed in clear text in the Connection Details menu.

  1. Connection Type: Standard Connection
  2. Connection Name: ssh
  3. Username: admin
  4. Uncheck Use Secret for Password
  5. Password: cisco.123
  6. Verify Password: cisco.123
  7. Protocol: ssh
  8. IP Address: 10.15.125.11
  9. Click the checkbox for Make this the default connection
  10. Click SUBMIT


Step 7 - Launch New Device Pop-Up


On your project Devices page:

  1. Click New Device to add a new device.



Step 8 - Add C8Kv-01 Device

In the Device Details pop-up, enter the below information to add the CSR1Kv device to your lab topology.

  1. Hostname: C8Kv-01
  2. Device OS: Select ios
  3. Sub Category: Select xe
  4. Connector OS: Select IOSXE
  5. Type: Select Router
  6. Click SUBMIT


Step 9 - For C8Kv-01 Device Select New Connection

Add a connection to your C8Kv-01 device:

  1. Click New Connection under the device hostname


Step 10 - Add C8Kv-01 Device SSH Connection

In the Connection Details pop-up, enter the below information to add an ssh connection to the C8Kv-01 device:

  1. Connection Type: Standard Connection
  2. Connection Name: ssh
  3. Username: admin
  4. Uncheck Use Secret for Password
  5. Password: cisco.123
  6. Verify Password: cisco.123
  7. Protocol: ssh
  8. IP Address: 10.15.125.12
  9. Click the checkbox for Make this the default connection
  10. Click SUBMIT


Step 11 - Launch New Device Pop-Up


On your project Devices page:

  1. Click New Device to add a new device.



Step 12 - Add XR9Kv-01 Device

In the Device Details pop-up, enter the below information to add the XR9Kv-01 device to your lab topology.

  1. Hostname: XR9Kv-01
  2. Device OS: Select ios
  3. Sub Category: Select xr
  4. Connector OS: Select IOSXR
  5. Type: Select Router
  6. Click SUBMIT


Step 13 - For XR9Kv-01 Device Select New Connection

Add a connection to your XR9Kv-01 device:

  1. Click New Connection under the device hostname


Step 14 - Add XR9Kv-01 Device SSH Connection

In the Connection Details pop-up, enter the below information to add an ssh connection to the XR9Kv-01 device:

  1. Connection Type: Standard Connection
  2. Connection Name: ssh
  3. Username: admin
  4. Uncheck Use Secret for Password
  5. Password: cisco.123
  6. Verify Password: cisco.123
  7. Protocol: ssh
  8. IP Address: 10.15.125.13
  9. Click the checkbox for Make this the default connection
  10. Click SUBMIT


Step 15 - Launch New Device Pop-Up


On your project Devices page:

  1. Click New Device to add a new device.



Step 16 - Add N9Kv-01 Device

In the Device Details pop-up, enter the below information to add the N9Kv-01 device to your lab topology.

  1. Hostname: N9Kv-01
  2. Device OS: Select nexus
  3. Sub Category: Select 9k
  4. Connector OS: Select NXOS
  5. Type: Select Switch
  6. Click SUBMIT


Step 17 - For N9Kv-01 Device Select New Connection

Add a connection to your N9Kv-01 device:

  1. Click New Connection under the device hostname


Step 18 - Add N9Kv-01 Device SSH Connection

In the Connection Details pop-up, enter the below information to add an ssh connection to the N9Kv-01 device:

  1. Connection Type: Standard Connection
  2. Connection Name: ssh
  3. Username: admin
  4. Uncheck Use Secret for Password
  5. Password: cisco.123
  6. Verify Password: cisco.123
  7. Protocol: ssh
  8. IP Address: 10.15.125.14
  9. Click the checkbox for Make this the default connection
  10. Click SUBMIT


Step 19 - Review devices added to your project


On your project Devices page:

  1. Review the Devices page after adding the CSR1kv, C8Kv, XR9Kv, and N9Kv devices

  2. The Devices page should now resemble the following example.


    Notice that most of the connection parameters entered in the preceeding steps (protocols, IP addresses, ports, etc) are visible on this page, but the device passwords are not displayed.


Step 20 - Preview the YAML topology file


On your project Devices page:

  1. Click Preview



  2. Review the YAML topology file displayed

  3. Take a moment to review how the data you entered on the devices page has been rendered in this output. The Robot Job Files you develop in the next sections will leverage the information collected in this file.

    Also, notice that the passwords entered in the preceeding steps are encrypted in this output.

  4. Click the X button to close the preview pane



Continue to the next section to learn how to create a topology.