Endpoint Agent Installation on Cisco Webex Devices (RoomOS)
Cisco's RoomOS is the cloud-connected operating system that enables your Cisco devices to deliver great hybrid work experiences – enhancing productivity and collaboration. The Endpoint agents are natively incorporated into RoomOS devices and provide hop-by-hop network path visibility when these devices are part of the meetings. These agents can be activated explicitly using Control Hub, the same integration used for Windows and macOS clients. Therefore, network administrators will have familiar troubleshooting experience.
This document lets you learn how to set up the Endpoint agents on RoomOS devices.
Prerequisites
Activate the ControlHub integration by following all the steps mentioned here.
Get the connection string for the account group you want the agent on the device to register with. Ensure this account group corresponds to the one where Control Hub integration was enabled in the previous prerequisite step.
Disable Federal Information Processing Standards (FIPS) mode on each device before you register its Endpoint Agent. Keep FIPS mode disabled while you use the Endpoint Agent. You cannot disable FIPS mode in bulk.
Ensure sufficient Endpoint licenses (Advantage or Essentials) as this integration consumes one Endpoint license per device.
The version for RoomOS device firmware must be RoomOS 11.7.1.6 16945c93906 or higher.
Supported RoomOS Devices
Room Devices:
Room Bars and Kits:
Cisco Room Bar
Cisco Room Panorama
Cisco Room 55
Cisco Room 55 Dual
Cisco Room 70
Cisco Room 70 Panorama
Cisco Room 70 G2
Cisco Webex Room USB
Cisco Room Navigator
Cisco Room Bar Pro
Cisco Room Kit
Cisco Room Kit Pro
Cisco Room Kit Plus
Cisco Room Kit EQ
Cisco Room Kit Mini
Codecs:
Cisco Codec EQ
Cisco Codec Pro
Cisco Codec Plus
Boards:
Cisco Board Pro
Cisco Board 85S
Cisco Board 55
Cisco Board 55S
Cisco Board 70
Cisco Board Pro 55
Cisco Board Pro 75
Cisco Board 70S
Desks Devices:
Cisco Desk Mini
Cisco Desk Pro
Cisco Desk
You can find the complete list of supported devices here
Getting Started
To enable the Endpoint agent on select devices (you can skip this step if you intend to enable the agents for all the devices in the organization):
First, enable the feature for the organization:
Login to your ControlHub Admin Console.
On the left navigation bar, select Devices in the Management Section.
At the top of the screen, choose Settings.
In the ThousandEyes section, turn on the Enable ThousandEyes Agent toggle.
Do not click the Add button for the Connection String. That needs to be done on the individual device configuration shown in the next steps.
To activate a single device:
Login to your ControlHub Admin Console.
On the left navigation bar, select Devices in the Management Section.
Search for the device that you intend to enable.
On the right-hand side, in the Configuration Section, select All Configurations.
In the search bar, type ThousandEyes Connection String.
Enter the connection string you obtained in the first step.
Select Next, then Apply, and then Review.
Repeat the steps for the devices you would like to enable.
To enable the Endpoint agents on all the devices:
Login to your ControlHub Admin Console.
On the left navigation bar, select Devices in the Management Section.
At the top of the screen, choose Settings.
In the ThousandEyes section, turn on the Enable ThousandEyes Agent toggle.
Click the Add button.
Enter the connection string you obtained in the first step.
Save the changes to activate all the devices. Also, any new devices added in the future will get activated automatically.
After activating the agents, go to Endpoint Experience > Agent Settings and confirm that the agent is registered.
Naming RoomOS Agents
By default, when a RoomOS Endpoint Agent first registers, ThousandEyes uses the device hostname as the agent name. If the device does not have a hostname, ThousandEyes uses its SEPMAC address. Later changes to the RoomOS device name in Control Hub do not update the agent name automatically, and you can edit the name in Endpoint Experience > Agent Settings.
To sync RoomOS agent names with their device names in Control Hub, enable Obtain RoomOS name from ControlHub on the Advanced Agent Settings tab under Endpoint Experience > Agent Settings. This setting requires RoomOS version 11.39.0.0 or later, or version 26.7.0.0 or later. After you enable the setting, supported RoomOS Endpoint Agents use the Control Hub device name on their next check-in. The agent name becomes read-only in the ThousandEyes platform, and later device-name changes in Control Hub sync on subsequent check-ins.
If you disable Obtain RoomOS name from ControlHub, ThousandEyes stops syncing names but does not revert names that were synced previously. The agent name becomes editable again in Endpoint Experience > Agent Settings.
Configuring Endpoint Agent Tests
Once you have installed the agent, you should enable the appropriate test set. The ThousandEyes Endpoint Agent offers Synthetic Tests, which are a combination of scheduled and dynamic tests. Synthetic tests provide ThousandEyes-certified templates that allow you to quickly configure tests for commonly used applications and services.
To access the synthetic tests, navigate (within the ThousandEyes application) to the Endpoint Experience > Test Settings section and click the Monitor Application button in the Tests tab, nested in the Synthetic Tests tab.
You can select the pre-configured template for the desired application. For example, Webex, Webex calling, and Webex Video Integration with Microsoft Teams (VIMT)/ Video Mesh Node(VMN) calls can be monitored with the Webex template. Similarly, Microsoft Teams Rooms can be monitored using the Microsoft Teams template.
These templates can further be configured and customized. For detailed instructions on test configuration, see Configuration Options for Synthetic Tests.
How to verify Endpoint Agents are sending data?
Once the agents are activated and devices have participated in a few meetings you can go to the ControlHub troubleshooting page to verify the integration is working and that agents are sending data.
Deleting the Endpoint Agent
You can delete an agent from the ThousandEyes application within the Endpoint Experience > Agent Settings section. See Uninstall or Delete the Endpoint Agent on Windows for detailed instructions.
The Agent Status Settings offer configuration options to manage and handle the statuses of endpoint agents automatically. It's important to note that, unlike Windows and macOS, it's not possible to uninstall the endpoint agent installed on Cisco RoomOS devices.
For deletion of Endpoint Agents:
Endpoint agents deleted via the ThousandEyes dashboard can be recovered only if the agent version is 1.166.0 or higher. Also, it may take the agents up to one hour to start functioning again post-recovery.
Endpoint agents with the version below 1.166.0 cannot be recovered if deleted.
If you cannot recover the Endpoint agent, you can use ControlHub to reactivate it. However, it might show up as a duplicate of the previously removed agent in filters until the data produced by the deleted agent becomes obsolete.
Limitations
This installation works only on the current portfolio RoomOS-11 devices and does not support DX/SX/MX.
Next Steps
After completing this integration, the following links will help you in getting the most out of the ThousandEyes Endpoint Agents:
Last updated