WXP Collaboration Endpoint Monitoring Deployment Guide

  • Published on Oct 31, 2025
  • 5 minute(s) read
  • s
  • s
 Prev Next

Introduction

The WXP Collaboration Endpoint Monitoring service gives additional insight into your organization’s video infrastructure.

This guide helps you install Endpoint Monitoring in your environment. Follow the steps in order to complete the installation.

Note: The Prerequisite for performing any steps in this guide is the completion of the Infrastructure setup steps described in the Tech Insights Deployment Guide - Infrastructure Setup document.

Supported endpoints

WXP Collaboration Endpoint Monitoring supports almost all current Cisco endpoints and most newer Polycom video endpoints. For best results, install the latest firmware on all devices.

For the latest support information, refer to the article Vendor Support Matrix.

Endpoint Registration and Selection

There are two methods for adding endpoints for monitoring.

Note: Use the administrator service account you created for the WXP Collaboration Data Collector in the steps below.

  1. Automatic endpoint assignment from TMS or CUCM

  • Tech Insights can automatically include endpoints managed by Cisco TelePresence Management Suite (TMS) or Cisco Unified Communications Manager (CUCM). This method is recommended for most environments to ensure endpoints are loaded correctly. The nightly TMS/CUCM synchronization process imports endpoint names and addresses.

  • This feature is enabled by default. You should see results after the initial import (up to 24 hours).

    • It is recommended to review endpoints in TMS/CUCM and in the Admin Portal to ensure accuracy.

    • After endpoints are loaded, enter admin credentials for each endpoint in the Admin Portal (details are covered later in this guide).

For any assistance, contact your WXP Collaboration Enablement Specialist.

Important: Endpoints deleted in TMS will continue to appear in the WXP Collaboration Application Portal unless you also purge them from TMS.

  1. Add endpoints manually

    Use this method for endpoints not managed by Cisco TelePresence Management Suite or Cisco Unified Communications Manager.

    To add :

    1. Sign in to the WXP Collaboration Admin Portal. The Home page is displayed.

    2. From the left menu click Endpoints. The Endpoints page is displayed.

    3. Click New endpoint displayed at the bottom of the page and enter the following details:

      1. Name and Host address

      2. (Optional) Alias. It will be discovered once the endpoint monitor connects to the system.

      3. Login and Password:  Enter credentials only if the endpoint uses different credentials than the Monitoring Group defaults.

    4. Review for accuracy and click Save.

Note: Do not add endpoints to the Public group. Ensure the Public group contains no endpoints.

Creating and Managing a Monitoring Group

Monitoring Groups let you segment endpoints for various administration purposes. For example, by region or business unit.

  1. From the left menu of WXP Collaboration Admin Portal, click Monitoring Groups. The Monitoring Groups page is displayed.

  2. On the Monitoring Groups page, click New Monitoring Group. A new page is displayed to enter:

    1. Name

    2. (Optional) Description

    3. Service Account

  3. Click Add endpoints.

  4. Select the check box for each endpoint that must be included in the Monitoring Group.

  5. Once all endpoints are selected, click Add Selected Endpoints.

  6. Review the Monitoring Group to confirm all necessary endpoints are added.

  7. Click Save.

  8. On the Monitoring Groups page, select the lock icon for the new group.

  9. Enter the login credentials for the endpoints in this group and click Save.

    Note: This stores credentials for Endpoint Monitoring and does not reset them on your video endpoints or infrastructure.

Do not add unsupported legacy endpoints to Monitoring Groups. They may cause connectivity errors.

Preparation Notes for the Endpoint Monitoring Server

Server Requirements

Endpoint Monitoring should be installed on the same server or VM as the WXP Collaboration Data Collector. This stores credentials for Endpoint Monitoring and does not reset them on your video endpoints or infrastructure.

If you require a separate server, contact support@vyopta.com for details.

Supporting Workspace Insights

The Workspace Insights module depends on Endpoint Monitoring to capture both in-call and out-of-call activity data.

Workspace Insights requires Endpoint Monitor version 4.0 or later. Download the latest compatible build from the WXP Collaboration Admin Portal.

Deploying Tech Insights Endpoint Monitoring in Your Environment

After preparing your video environment, deploy using the WXP Collaboration Endpoint Monitor configuration utility. The process includes downloading the software, installing it on the server, signing in to the Application Management Portal with the service account, and starting the service.

Downloading and Installing Endpoint Monitoring

  1. Download the latest WXP Collaboration collector from the Admin Portal.

  2. Place the XML and executable files from step 1 in C:\Vyopta.

  3. Open a command prompt as an administrator, navigate to the folder where both files are located, and run the command vyoptacollector.exe -install.

  4. Accept the install for Java runtime and any local firewall restrictions if prompted.

  5. Check the install for errors. You should see “Install Completed Successfully.”

  6. Verify whether the “WXP Collaboration Tech Insights Data Collector” service is running. If it is not, click Start the service.

  7. In the Admin Portal, verify the relevant services show green. The username should match the one in the vyoptacollector.xml file.

Congratulations! You have now successfully installed and activated Tech Insights Endpoint Monitoring within your environment. Now, you can see real-time data for endpoints populate into the Tech Insights Monitoring module.

Viewing Endpoint Monitor Status

After the initial endpoint list loads for the assigned Monitoring Group, you can view status on the Endpoints tab.

Possible Monitoring Statuses

  • Blank: The endpoint is not part of the Monitoring Group.

  • Login failed: The credentials in the Applications Portal are incorrect.

  • Encryption error: The endpoint codec uses an algorithm not supported by Endpoint Monitoring.

  • No credentials: Credentials were not provided in the Applications Portal.

  • Not responding: Endpoint Monitoring cannot connect to the endpoint. The following are the possible causes:

    • The IP address in the portal does not match the device.

    • SSH is not enabled on the device.

    • A firewall or other network issue is blocking connectivity.

    • The device is too slow to respond.

Inside Endpoint Monitor

Loading endpoints

On startup, Endpoint Monitoring loads all endpoints in the Monitoring Group for the service account. Loading time depends on endpoint count and network performance.

Rule of thumb: 100–200 endpoints per hour for initial load.

If loading fails for an endpoint, the monitor retries every 10 minutes.

Endpoint Monitoring Performance

Performance Characteristics

The operating characteristics for Endpoint Monitoring are highly variable – network topology, bandwidth, endpoint location, endpoint model/type, and utilization are all factors that will affect performance. Endpoint Monitoring attempts to connect to all endpoints that are within a specified access group. Any endpoints in remote locations or in locations with spotty network performance may experience disruptions in connection. Although a best effort is made to reconnect to these endpoints, these disruptions may cause loss of data.

For best results, we recommend initiating your use of Endpoint Monitoring with endpoints with optimal proximity and connectivity to your WXP Collaboration Data Collector server, and then adding endpoints in an organized, incremental fashion thereafter. The recommended threshold for endpoints is 2,000 for a standard server deployment with dual CPUs, with another 1,000 being supported for each additional CPU.

Initial Scale Processing and Network Impact

  • Active Monitoring Performance per Endpoint  CPU: 0.1% of a 2.4 GHz CPU  Bandwidth: 10 - 20 Kb every 10 seconds

  • Idle Monitoring Performance per Endpoint  CPU: 0.08% of a 2.4 GHz CPU  Bandwidth: 10 - 20 Kb every 60 seconds

  • Rough Network Impact Estimate given 50 In Call Endpoints  5% of a 2.4 GHz CPU  400 - 800 kbps bandwidth

  • Rough Network Impact Estimate given 50 Idle Endpoints  4% of a 2.4 GHz CPU  65 - 130 kbps bandwidth

If you have questions during deployment, contact your WXP Collaboration Enablement Specialist or support@vyopta.com.

Related articles