Cisco RoomOS (xAPI) Integration Guide

This document serves as a comprehensive guide that outlines the prerequisites required to integrate Cisco collaboration devices using the xAPI (Room, Desk, and Board series) with the NetSpeek platform.

Prerequisites

Before beginning the integration, confirm the following:

  • Your Cisco collaboration device (Room, Desk, or Board series running RoomOS) is powered on and connected to a network that is routable to/from your NetSpeek Edge.
  • You have deployed a NetSpeek Edge VM as described here: https://docs.netspeek.ai/netspeek-edge-installation-guide/
    • Note: This integration requires an Edge running software version 1.1.1 or later.
  • The Cisco device is running Cisco RoomOS version 11.32.4.0 or newer.
  • The HTTP / HTTPS xAPI interface must be enabled on the device. From the device web UI or RoomOS configuration, set Network Services > HTTP > Mode to HTTPS.

Step 1. Add Device to NetSpeek Room Canvas

Device Provisioning Flow

  1. In the NetSpeek Console, navigate to Room Management
  2. Select the room you wish to add your Cisco device to
  3. Click Launch Room Canvas
  4. Click Add device to room
  5. Choose your desired device from the manufacturer → device model list.
  6. Configure the appropriate values, and in the “Integrations” section, select a previously created NetSpeek Edge VM integration. Ensure that the Edge VM is on a network that can reach the device’s configured IP address.
  7. In the configuration panel, enter the following fields:
    • Device IP Address (required) – The IP address of the Cisco device
    • User (required) – Username for a device-local account with xAPI access
    • Password (required) – Password for the above user account
    • Port (optional) – Communication port. Defaults to 443 (HTTPS) when TLS checkbox is enabled, or 80 (HTTP) when TLS is not enabled
    • TLS (optional) – Use Transport Layer Security (or disable)

Verification

Once the relevant settings described above are configured, to validate the integration:

  • Select a Cisco device in the NetSpeek console, open the Device Actions Tab, and select an available device action. It is generally advisable to test by dispatching a non-intrusive command such as a Get Status.
  • On the device, observe the selected action occurring.

Troubleshooting

Connection Issues

  • Confirm the IP address is correct and routable from the network segment where the NetSpeek Edge VM is deployed.
  • Ensure HTTPS (port 443) is not blocked by firewall rules on the machine running your NetSpeek Edge, or between the NetSpeek Edge VM and the Cisco device.

Authentication Failures (HTTP 401)

  • Verify the username and password and confirm the account has xAPI access enabled on the Cisco device.

Support

If you run into any issues during onboarding or have questions, contact NetSpeek Support at support@netspeek.com.