What's New
Product Documentation

Enterprise Agent Installation for Cisco Catalyst 9000 Series Switches

This article details the steps to install the ThousandEyes Appliance on a Cisco Catalyst 9000 series switch running IOS XE. The Appliance is a pre-installed ThousandEyes Enterprise Agent with a web-based management UI, which can be quickly imported into a virtualization environment.



The installation process for an Appliance consists of three steps:

  1. Installing the Appliance

  2. Activating the Appliance

  3. Configuring the Appliance

The following example installs, activates and initializes the Appliance on a Cisco Catalyst 9300. In the example, the name of the virtual service is teva.

To assign the Appliance an IP address, either configure a DHCP server to provide the Appliance a lease, or use static addressing. We'll use DHCP for the example.

To connect the Appliance to the Internet, assign a VirtualPortGroup interface as the default gateway. Make sure the VirtualPortGroup interface IP address is within the same layer 3 network as the Appliance's IP address.

Installing the Appliance

  • Log in to the ThousandEyes application using a login belonging to the Account Group which will be associated with the Appliance.

  • Navigate to the Cloud & Enterprise Agents > Agent Settings and click the Add New Enterprise Agent button.

  • Download the TAR file with the ThousandEyes Appliance for Catalyst 9000 Series Switches.

  • Copy the file onto the switch via one of the following methods:

    • Secure Copy Protocol (SCP)

    • File Transfer Protocol (FTP)

    • Trivial File Transfer Protocol (TFTP)

    • USB storage device

  • Enable the IOx framework on the switch and wait until all the services are running:

    Enter configuration commands, one per line. End with CNTL/Z.
    Cat9k#show iox-service
    IOx Infrastructure Summary:
    IOx service (CAF) : Running
    IOx service (HA) : Running
    IOx service (IOxman) : Running
    Libvirtd : Running
  • Configure a single virtual network interface card (vNIC) for the Appliance.

    Both the management port and data port are supported for use as interfaces. In the case of the data port, you need to configure a VPG (Virtual Port Group) as well. The VPG will serve as the default gateway for the Appliance. If a DHCP server is present in the management network, the Appliance will obtain an IP address automatically from the DHCP server. Alternatively, use a static IP address.

Example of Configuration with Management Port

app-hosting appid teva
vnic management guest-interface 0

Example of Configuration with a Data Port with a DHCP Pool to Assign IP Addresses to the Appliance

interface VirtualPortGroup1
ip address
! >>> dhcp start
ip dhcp excluded-address
ip dhcp pool vpg1pool
domain-name example.com
! >>> dhcp end
app-hosting appid teva
vnic gateway0 virtualportgroup 1 guest-interface 0

Activating the Appliance

  • Install, activate and start the IOx package containing the ThousandEyes Appliance

    Cat9k# app-hosting install appid teva package usbflash0:thousandeyes-va.cisco.tar
    teva installed successfully
    Current state is: DEPLOYED
    Cat9k# app-hosting activate appid teva
    teva activated successfully
    Current state is: ACTIVATED
    Cat9k# app-hosting start appid teva
    teva started successfully
    Current state is: RUNNING
  • Use the sh app-hosting list command to verify the virtual machine has been installed and is in the running state:

    cat9k#sh app-hosting list
    App id State
    teva RUNNING
  • Verify the virtual machine details

    Cat9k#show app-hosting detail appid teva
    App id : teva
    Owner : ioxui
    State : RUNNING
    Type : vm
    Name : thousandeyes-va-64-16.04
    Version : 0.144
    Description : ThousandEyes Cisco Virtual Appliance
    Activated profile name : custom
    Resource reservation
    Memory : 2048 MB
    Disk : 20000 MB
    CPU : 1200 units
    Attached devices
    Type Name Alias
    serial/shell iox_console_shell serial0
    serial/aux iox_console_aux serial1
    serial/syslog iox_syslog serial2
    serial/trace iox_trace serial3
    Network interfaces
    MAC address : 52:54:dd:27:84:b0

Configuring the Appliance

  • Connect to the virtual machine console from the IOS XE command-line interface to configure Networking, if needed.

    Cat9k#app-hosting connect appid teva console
    Connected to appliance. Exit using ^c^c^c

  • The default Network configuration uses DHCP. If you want to assign a static IP address, press 'N'. After the hostname screen, select "Static configuration parameters" using the down-arrow key then the space bar. Use the Return key to select 'OK'

    NOTE: To exit the console, press "CTRL+C". 3 times

  • Once the network settings are applied, access the ThousandEyes Virtual Appliance interface through the URL in that screen and log in with the credentials shown in the virtual console.

  • Upon login, you will be prompted to change the Web Interface password.

  • Obtain your account group token, navigate to Cloud & Enterprise Agents > Agent Settings > Agents tab, click Add New Agent . Then scroll down and click Show Account Group Token for Installation to reveal the token.

  • Paste the account group token into the Account Token field.

  • Select Yes for Browserbot if you wish; this is required for Page Load and Transaction tests.

  • Click Continue to review agent diagnostic results, and then Complete the setup.

  • In the ThousandEyes application, check that your Agent appears on the Cloud & Enterprise Agents > Agent Settings > Agents tab.

That's it! You've installed an enterprise agent on your Catalyst 9000 Series Switch.