The Vyopta Endpoint Monitoring application service provides additional insight into your organization’s investment in video infrastructure.
This guide is designed to help you install Endpoint Monitoring successfully into your environment. Please follow the subsequent steps in order to complete the installation process.
Note: The Prerequisite for performing any steps in this guide is the completion of the Infrastructure setup steps described in the CPM Deployment Guide - Infrastructure Setup document.
Vyopta Endpoint Monitoring supports almost all current Cisco endpoints and most newer Polycom video endpoints. However, it is always best to have the latest firmware installed on these endpoint devices to ensure maximum compatibility of all monitoring features supported.
For the very latest information on Endpoints supported, please refer to this article:
Endpoint Registration and Selection
There are two methods for adding endpoints for monitoring.
Note: In the subsequent steps, please use the administrator service account you defined for use with the Vyopta Data Collector.
- Automatic Endpoint Assignment from TMS or CUCM Managed Endpoints
- CPM can automatically include endpoints managed by Cisco TelePresence Management Suite (TMS) or Cisco Unified Communications Manager (CUCM). This method is recommended for most customer environments to ensure endpoints are properly loaded. The Vyopta TMS/CUCM synchronization process imports endpoint name and address information on a nightly basis.
- This feature is enabled by default, so you should begin seeing results after the initial import (which can take up to 24 hours. It is recommended that you review the endpoints in TMS/CUCM and the Vyopta Applications Management Portal in order to ensure endpoint accuracy. Once the endpoints are loaded you will need to enter the admin credentials for each endpoint in the Vyopta Applications Management Portal. This is covered in the latter half of section 1.3 of this guide.
- If you need any assistance with this, please feel free to reach out to your Vyopta Enablement Specialist.
- Please note: Endpoints that are deleted in TMS will continue to appear in the Vyopta Application Portal. When you delete endpoints from TMS, you will need to also manually delete them in the Vyopta Application Portal.
- Adding Endpoints Manually -
- This method is suitable for environments that have endpoints that are not managed by Cisco TelePresence Management Suite.
- To add endpoints, log into the Applications Management Portal and click first on the vControl® menu followed by the Endpoints submenu. Click the + icon in the upper-right corner of the screen to add a new endpoint and fill out the information for it.
- Adding Registration Alias is not required, as Vyopta Endpoint Monitor service adds registration information after successfully connecting to the endpoint for the first time. Model and Serial Number are also populated automatically upon the first connection to the endpoint in the Miscellaneous Data field. When data entry is complete, click the save icon (disk) at right.
- Note: Do not add an endpoint to the Public group. Make sure that there are no endpoints added to the Public Group.
Step 1 - Create and manage an Access Group
Creating and assigning Access Groups allows you to segment and manage groups for different application users in your organization. It also allows you to create global endpoint groupings for various reasons such as geographic or business structure. To create an Access Group, perform the following:
- Navigate to vControl® > Access Group.
- Click on the plus icon.
- Provide a name for the Access Group. Example "Endpoint Monitor Access Group."
- Select the desired endpoints (or select All) by checking the box to the left of the endpoint.
- Move the available endpoints into the Member Endpoints Section using the Arrow buttons.
- Check the "Uniform Control" box to allow for bulk password assignment.
- Click Save.
- Click the "Endpoint Passwords" button next to the newly created Access Group
- Enter the Login and Password for your endpoints (if your endpoints have distinct credentials, multiple access groups will have to be leveraged)
- Click the button in the upper right corner of the screen.
Do not add any unsupported legacy endpoints to your access groups
as it will cause connectivity issues resulting in errors.
Note: This stores credentials for Endpoint Monitoring and does not reset them on your video endpoints or infrastructure.
Step 2 - Associate the Service Account to the Access Group
To associate users with an Access Group, perform the following:
- Navigate to Admin > Users
- Find the Service Account using the search parameters.
- Edit the Service Account by clicking the pencil icon on the right.
- Move the new Access Group created in the previous step from 'Available Groups' to 'Assigned Groups' using the 'Add' button
- Remove the 'PUBLIC GROUP' from 'Assigned Groups' using the 'Remove' button
- Click the save icon in the upper right corner of the screen.
Preparation Notes for the Vyopta Endpoint Monitoring Server
Endpoint Monitoring should be installed on the same Server or VM as the Vyopta Data Collector. Endpoint Monitoring will communicate with your video endpoints in your internal environment over SSH/HTTPS (port 22/443 for Cisco) or Telnet (port 24 for Polycom). If a separate server is required, please contact email@example.com for more information.
Supporting Workspace Insights
The Workspace Insights module leans heavily on Endpoint Monitoring to capture both in-call and non-call activity data. Workspace Insights requires V3.6 or greater of the Endpoint Monitor, and the latestWorkspace Insights compatible build can be downloaded from the Vyopta support site at https://www.vyopta.com/support.
Deploying CPM Endpoint Monitoring in your Environment
After completing the preparations for your video environment, you are now ready to begin the deployment using the Vyopta Endpoint Monitor Configuration Utility. This process includes downloading the CPM Endpoint Monitoring software, installation on the server, logging into the Application Management Portal with the service account, and starting the Vyopta Endpoint Monitor Service.
Step 1 - Download and Install CPM Endpoint Monitoring
The latest build of the Endpoint Monitor can be found here: https://www.vyopta.com/support/
After downloading the installer, please perform the following on your Vyopta Data Collector server instance:
- Run the software installer as administrator to start the installation process.
- Follow the installation wizard’s instructions to complete the installation.
Note: When upgrading Endpoint Monitor from a previous version,
we recommend stopping the current Endpoint Monitor service on the server
instance, uninstalling it from Windows
(Control Panel → Programs and Features), and then performing
the above installation process.
Step 2 - Connect to the Vyopta Cloud from CPM Endpoint Monitoring
Once the installation of the Vyopta Endpoint Monitoring Configuration Utility is completed, please use the following directions to complete the configuration:
- Go to Start > All Programs > Vyopta > Vyopta Endpoint Monitor and open the Vyopta Endpoint Monitor Config application
- Once the Vyopta Endpoint Monitor Config application has opened, fill out the form using the Vyopta service account used previously, typically: firstname.lastname@example.org
- Enter HTTP Proxy information only if required.
- Press “Verify” to connect to the Vyopta Cloud.
- Once verified press “Save and Exit” to save the current configuration and close the application.
If you forget your organization’s Service Account username or password, you can log into the Vyopta Applications Manager at apps.vyopta.com to view the name of the account and/or change the password.
Step 3 - Starting the Service for the First Time
Once configuration is complete you will need to manually start the Vyopta Endpoint Monitor Service from the services console by performing the following:
- On the Vyopta Data Collector Server, navigate to Start > Control Panel > Administrative Tools > Services
- Scroll down and locate the “Vyopta Endpoint Monitor Service”
- Right click on the “Vyopta Endpoint Monitor Service”
- Select Start
Congratulations! You have now successfully installed and activated CPM Endpoint Monitoring within your Environment. You will now be able to see real-time data for endpoints populate into the CPM Monitoring Module.
Viewing Endpoint Monitor Status
Once Endpoint Monitor has finished loading the initial list of endpoints specified in the access group, you can check the monitoring status of those endpoints. The monitor status is located on the vControl ->Endpoints Tab.
Possible values for Monitoring Status
- Blank Value: The endpoint is not part of the access group used for monitoring.
- “Login Failed”: Incorrect credentials were specified in the Applications Portal.
- “Encryption error”: The endpoint’s codec is using an encryption algorithm that is not supported by Endpoint Monitoring.
- “No credentials”: No credentials were specified in the Applications Portal.
- “Not Responding”: Endpoint Monitoring cannot establish a connection with the endpoint for one of the following reasons:
- The IP address specified in the Applications Portal does not match the IP address of the endpoint.
- SSH is not enabled on the endpoint.
- A firewall or other network issue is blocking connectivity.
- The endpoint cannot respond in a timely fashion.
Inside Endpoint Monitor
Loading of Endpoints
When Endpoint Monitoring loads, it will load the entire list of endpoints specified in the access group assigned to the user account that Endpoint Monitoring is using. Depending on the number of endpoints in this list and the performance characteristics of your network, it may take some time. (A rough rule of thumb: you can expect an initial load rate of roughly 100 to 200 endpoints per hour.)
If Endpoint Monitoring is unable to load an endpoint, it will subsequently try to reload that endpoint every 10 minutes.
Endpoint Monitoring Performance
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 Vyopta Data Collector server, and then adding endpoints in an organized, incremental fashion thereafter.
Initial Scale Processing and Network Impact Information
Active Monitoring Performance per Endpoint
- CPU: 0.31% of a 2.4 GHz CPU
- Bandwidth: 1200 bytes every 10 seconds
Idle Monitoring Performance per Endpoint
- CPU: 0.19% of a 2.4 GHz CPU
- Bandwidth: 500 bytes every 10 seconds
Rough Network Impact Estimate given 50 In Call Endpoints
- 15% of a 2.4 GHz CPU
- 48 kbps bandwidth (equivalent to less than a single audio call)
Rough Network Impact Estimate given 50 Idle Endpoints
- 10% of a 2.4 GHz CPU
- 20 kbps bandwidth
A review of the above metrics, if projected linearly, would suggest an upper limit somewhere between 300 and 500 endpoints that is below our experience in the field. Again, there are many factors at work in determining this sort of threshold, but Vyopta customers with over 600 endpoints are using Endpoint Monitoring to yield call quality insights, which suggests that the above benchmarks flatten out as the number of endpoints scales.