Cisco Video VKM Configuration Guide
- 06 Jun 2022
- 16 Minutes to read
- Print
- DarkLight
- PDF
Cisco Video VKM Configuration Guide
- Updated on 06 Jun 2022
- 16 Minutes to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The Cisco Video Vendor Knowledge Module (VKM) is used to manage and monitor the Cisco video device endpoints. These endpoints can be collected by TelePresence Management Suite (TMS) and Cisco Unified Communications Manager (CUCM).
Leveraging the power of Nectar's Unified Communications Management Platform (UCMP), Nectar is able to deliver real-time visibility, map system interdependencies, and zero in on failed links, services, and components to minimize business interruption.
About this Document
This guide explains how to:
Audience
This document is intended for system administrators or engineers who have system administration access and technical knowledge of Cisco TMS and/or CUCM along with a familiarity with deploying Nectar Foundation.
Supported Software Versions
- Nectar UCMP v8.7
- Cisco TMS v14.x
- Cisco UCM v10.x and above
- Tandberg v9.x
- Tandberg MCU v4.3.x
Supported Hardware Versions
- Tandberg MXP 6000, 3000, 1700, 1000, 990, 880, 770, 95, 85, and 75
- Cisco TelePresence MX300, MX200, EX90, and EX60
- Tandberg MCU 4520, 4515, and 4510
Enable the Cisco Video VKM
Follow these steps to enable the Cisco Video VKM:
1. Navigate to RIG > Module Configuration.
The Module Configuration window appears.
2. Select Cisco Video.
Enable Cisco Video VKM 3. Click Apply.
4. To restart the RIG and apply the changes:
- Navigate to RIG > Admin > Restart.
- When the following message appears, click Yes.
Restart Configure the Cisco Video VKM
Configuring the Cisco Video VKM includes the following tasks:
- Discover TMS Endpoints
- Discover Endpoints from Cisco UCM
- Manually Add a Video Device
Discover TMS Endpoints
This section explains how to discover TMS endpoints, including how to:
- Add a Cisco TMS Device
- Discover from TMS
Add a Cisco TMS Device
Follow these steps to add a Cisco TMS device and auto discover endpoints:
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. Click the TMS Devices tab.
Cisco Video Setup - Video Devices3. Right-click in the TMS Devices pane and select Add.
TMS Devices - Add The Add TMS Device window appears.
Add TMS Device 4. Enter the following information about the new TMS device:
| Field | Description |
|---|---|
| Name | Enter the name of the TMS device. |
| TMS Host | Enter the IP address of the TMS device. |
TMS HTTP Authentication | Select this check box to use HTTP authentication to control access to the TMS device. |
TMS Username/Password | Enter the Username and Password for configuring the TMS device. |
TMS Secure Protocol | Select this check box to use a secure Internet channel for the TMS device. |
Endpoint SNMP Community | Enter the community string for the device, if the device uses SNMP. |
Endpoint Username/Password | Enter the Username and Password for each discovered endpoint. Note: If the endpoint devices have different user names and passwords, select the user name and password for one of the devices. For more information on how to edit a device, see Edit a Video Device. You can add other devices after the initial discovery is completed. For more information on adding other devices, see Discover from TMS. |
Endpoint Secure Protocol | Select to use HTTPS (HTTP Secure) versus HTTP to gather video device information. |
Channel To Rate Call | Select Audio from the following channels using the drop-down to categorize the call:
|
Table - Add a TMS Device
5. Click add.
The TMS device is added and can be viewed in the TMS Devices pane.
TMS Device After the TMS device is added, the endpoint discovery process automatically starts and creates a collection of endpoints configured on the TMS.
6. Click the Video Devices tab to view the collection of endpoints.
Endpoints NOTE
You can also manually execute/update the Collections. Select a TMS device; then right-click and select Execute Video Devices Collection. For more information, see Manually Update Video Devices Collection. (For more information on managing TMS devices, see Manage TMS Devices.)
7. Select an endpoint; then navigate to Health > Quality Management > Real Time QoS to view the related calls.
Real Time QoS For each call, an entry or session for Audio, Main, and Presentation is displayed. Notice the entry type in the Type 1 column.
Discover from TMS
Follow these steps to discover TMS endpoints:
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
Cisco Video Setup - Video Devices 2. Right-click in the Video Devices pane and select Discover from TMS.
The Choose TMS window appears.
Choose TMS 3. Perform one of the following actions:
- Select an existing TMS using the drop-down and click OK.
- Select and click OK. For more information, see Add a Cisco TMS Device above.
4. View the discovered endpoints in the Video Devices pane.
Discover Endpoints from Cisco UCM
Follow these steps to discover endpoints from Cisco UCM.
NOTE
You must have an onboarded CUCM cluster to access. If not, the following message appears.
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. Right-click in the Video Devices pane and select Discover from CUCM.
The Choose CUCM window appears.
3. Select a CUCM cluster using the drop-down; then click OK.
The Endpoint Information - Bulk Login window appears.
Endpoint Information 4. Enter the following information to assign the same credentials to all discovered endpoints for this device:
| Field | Description |
|---|---|
Username/Password | Enter the new Username and Password for each discovered endpoint. NOTE If the endpoint devices have different user names and passwords, select the user name and password for one of the devices. You can add the other devices after the initial discovery is completed. |
Community | Enter the community string. However, this field is not used at this time. |
| Secure Protocol | Select to use HTTPS (HTTP Secure) versus HTTP to gather video device information. |
| Channel To Rate Call | Select Audio from the following channels using the drop-down to categorize the call:
|
Table - Bulk Login
5. Click OK.
6. Click the Regex tab.
Regex Tab 7. Click Add RegEx to add an expression for endpoint discovery.
Add RegEx - Examples 8. Enter one or more RegEx expressions; then click OK.
NOTE
Click Remove to remove an expression.
Notice that the discovered endpoints appear in the Cisco Video Setup - Video Devices window.
Discovered Endpoints NOTE
The devices with Software Version and Serial Number information have been contacted and are responding.
If you receive a No Response, the Bulk Login username and password may not be the same. You can right-click and select Edit to update the video device/ username/password. For more information, see Edit a Video Device (under Manage Video Devices).
If you have a device with No Response, you can also select the device; then right-click and select Enable/Disable Monitoring. For more information, see Change Monitoring Status (under Manage Video Devices).
Manually Add a Video Device
When you add a TMS device, the associated video devices/endpoints for that TMS device are displayed in the Video Devices pane. When you discover endpoints from CUCM, the endpoints are displayed in the Video Devices pane.
This section explains how you can also manually add a stand-alone video device(s) to retrieve QoS information.
Follow these steps to manually add a video device:
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
Cisco Video Setup - Video Devices 2. Right-click in the Video Devices pane and select Add:
Add a Video Device
The Add Video Device window appears.
Add Video Device 3. Enter the following information for the new video device:
| Field | Description |
|---|---|
Name | Enter the name of the video device. |
IP Address | Enter the IP address of the video device. |
Community | Enter the community string for the video device. |
Username | Enter the username for the new video device. |
Password | Enter the password for the username you entered. |
Secure Protocol | Select check box to use a secure Internet channel for the video device. |
Channel to Rate Call | Select one of the following channels from the drop-down to categorize the call:
|
Table - Add a Video Device
4. Click Add.
Once the information is verified, the video device is added to the Video Devices pane.
NOTE
For more information on managing video devices, see Manage Video Devices.
Modify the VKM Options
Follow these steps to modify the VKM options:
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. Click VKM Options.
VKM Options The VKM Options pane appears with a list of options:
Option | Description |
callMonitorInterval | Identifies the frequency of retrieving the QOS information; default value is 5 seconds. NOTE Before changing the update interval for QOS, consider the number of calls occurring at any given time and the impact of the change. |
cloudQOS | Specifies whether or not to post QOS details to the cloud QOS tables; default value is false. |
cloudQOSRetention | Identifies the number of hours to keep cloud QOS data; default value is 24 days. |
cloudQOSRetentionFreq | Identifies how often to check cloud QOS data; default value is 4 hours. |
discoveryThreadCount | Identifies the number of threads designated for video device discovery; default value is 10. |
enableMcuRequest | Specifies whether or not to enable multipoint control unit (MCU); default value is false. |
EndpointCollectionCronString | Creates a collection of endpoints. This value is specified using a cron string. The default value is 0 0 0 * * ?, which means run collection every 24 hours at midnight. |
| endPointCronString | Checks the inventory. This value is specified using a cron string. The default value is 0 0 0 * * ?, which means run check every 24 hours at midnight. |
| endpointLookupInterval | Specifies the interval in seconds for discovering endpoints; default value is 5 seconds. |
| realTimeQOS | Specifies whether or not to post QOS details to the QOS thread; default value is true. |
| requestProcessorCount | Identifies the number of threads designated for request processing; default value is 10. |
| unreachableDelayInterval | Specifies the wait time in minutes for endpoint discovery; default value is 60 minutes. |
Table - Video VKM Properties
3. Right-click on a VKM option and select Edit.
The Edit VKM Option window appears with the value for that option.
Edit VKM Option
4. Make changes, as needed
5. Click Update.
The new value appears in the Value column for that VKM option.
Manage Inventory
After deploying the Cisco Video VKM, you can view all of the inventory discovered during the deployment process. This allows you to determine if all of the desired devices were added to Nectar Foundation. The listed video devices can be monitored.
NOTE
Currently, inventory is only available for SQL Collection configuration.
Managing inventory includes the following tasks:
- View Inventory
- Update Inventory
View Inventory
Follow these steps to view inventory:
1. Navigate to Reports > Inventory > Cisco > Video. The Video VKM Inventory window appears.
Video VKM Inventory 2. In the Video Devices pane, click on a device.
3. View the information about that device in the Configuration pane.
Configuration The following information appears for each device:
| Field | Provides ... |
|---|---|
Key | Property or parameter for the video device. |
Value | Value for the specified property or parameter for the associated video device. |
TMS Key | Property or parameter for the associated TMS device. |
TMS Value | Value for the specified property or parameter for the associated TMS device. |
Table - Examine Inventory - Data
Update Inventory
Follow these steps to update inventory:
1. Navigate to Reports > Inventory > Cisco > Video. The Video VKM Inventory window appears.
2. In the Video Devices pane, right-click on a device and select Run Device Collection. The updated information appears in the Configuration pane.
ConfigurationManage Cisco Video VKM
After you deploy the Cisco Video VKM, the module creates the following elements in Nectar Foundation:
- Agents
- Events
- Dependency Trees
Agents
The Cisco Video VKM adds each TMS and video device as agents to the list of elements monitored by Nectar Foundation.
Follow these steps to view the agents:
1. Navigate to Health > Elements. The Elements window appears.
2. Click on Agents.
The available agents appear in the All Agents pane.
NOTE
You can edit the poll functions and their corresponding thresholds for all endpoints.
For more information about polling functions, thresholds, and traps, see Nectar Foundation Remote Intelligence Gateway (RIG) Administration Guide.
Events
You can view any events reported for video devices. Follow these steps to view the events:
1. Navigate to Health > Events. The Events window appears.
2. View a list of events.
3. Right-click on an event and select View Event.
The View Event pane appears with the event details.
Dependency Trees
The Cisco Video VKM creates a dependency tree for each TMS and video device it discovers. Each dependency tree displays the following:
- Communication
- Pollers
- Services
- Traps
- Utilization
You can use dependency trees to monitor the status of each TMS and video device in your video network. You can also use it to troubleshoot any video network issues.
NOTE
The dependency tree name consists of a prefix and the device name, such as:
TMS_Device_ - for TMS
Video_Device_ - for endpoint
Follow these steps to view the dependency trees:
1. Navigate to Health > Events. The Events window appears.
2. Right-click on one of the events and select Goto Dependency. The View Dependency window appears.
View the dependency tree and related poll functions.
NOTE
For more information about dependency trees and how to customize, see
Nectar Foundation Remote Intelligence Gateway (RIG) Administration Guide.
Manage TMS Devices
This section explains how to:
- View TMS Devices
- Edit a TMS Device
- Remove a TMS Device
- Manually Update Video Devices Collection
- Update TMS Endpoint Credentials
NOTE
For information on adding a TMS device, see Add a Cisco TMS Device under Configure the Cisco Video VKM.
View TMS Devices
Follow these steps to view the onboarded TMS device(s):
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. Click the TMS Devices tab.
3. View the existing TMS device(s) in the TMS Devices pane.
Edit a TMS Device
Follow these steps to edit a TMS device:
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. Click the TMS Devices tab.
3. In the TMS Devices pane, double-click on a TMS device to change.
The Edit TMS Device window appears.
Edit TMS Device 4. Make changes, as needed.
NOTE
You cannot change the TMS Host field.
5. Click Update.
The update will take a few minutes.
Once completed, the TMS device is updated, and the point discovery process starts.
Remove a TMS Device
Follow these steps to remove a TMS device:
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. Click the TMS Devices tab.
3. Right-click on a TMS device in the TMS Devices pane and select Remove.
The Removal Confirmation window appears.
Removal Confirmation 4. Click Yes.
The TMS device is removed along with all of the agents, pollers, if applicable, and endpoints. All prior calls already in the real-time Quality of Service (QOS) module remain. However, you can no longer monitor any calls on the endpoints associated with the TMS that you removed.
Manually Update Video Devices Collection
Follow these steps to manually update and view the endpoints or video devices associated with a TMS device:
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. Click the TMS Devices tab.
3. Select a TMS device in the TMS Devices pane; then right-click and select Execute Video Devices Collection.
The endpoint or devices associated with the TMS device are updated and displayed in the
Video Devices pane.
Update TMS Endpoint Credentials
Follow these steps to update the endpoints for a specific TMS device with the same username and password:
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. Click the TMS Devices tab.
3. Select a TMS device in the TMS Devices pane; then right-click and select Bulk Video Device Parameters Update.
The Bulk Video Device Parameters Update window appears.
Bulk Video Device Parameters Update 4. Enter the following information to assign the same credentials to all discovered endpoints for a specific device:
| Field | Description |
|---|---|
Endpoint Username/Password | Enter the new Username and Password for each discovered endpoint. Note: If the endpoint devices have different user names and passwords, select the user name and password for one of the devices. You can add the other devices after the initial discovery is completed. |
Endpoint Secure Protocol | Select to use HTTPS (HTTP Secure) versus HTTP to gather video device information. |
Channel To Rate Call | Select Audio from the following channels using the drop-down to categorize the call:
|
Table - Bulk Video Device Parameters Update
5. Click Update.
Manage Video Devices
This section explains how to:
- Edit a Video Device
- View Video Devices
- Remove a Video Device
- Change Monitoring Status
- Check Endpoint Status
- View Endpoint Device Details
NOTE
For information on adding a video device, see Discover from TMS under Configure the Cisco Video VKM.
NOTE
It is not recommended that you add endpoints manually. The endpoint discovery process kicks off every night and removes all endpoints, if they are not configured at TMS.
Also, if the device type, software version, and serial number are not populated on the Video Devices pane, than supplied credentials are invalid.
Edit a Video Device
Follow these steps to edit a video device.
NOTE
You can also use this procedure to edit the user name and password for the video device(s) that were added during the deployment of the Cisco Video VKM. You will know if you need to edit the user name and password, if the device data does not display in the Video Devices pane.
After verifying that you do not have the correct user name and password, use this procedure to change the Username and Password for each device.
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. In the Video Devices pane, double-click on the endpoint device you want to edit.
The Edit Video Device window appears.
Edit Video Device 3. Make changes, as needed.
4. Click Update.
Nectar Foundation verifies the user name and password and adds or edits the endpoint device. Information, such as device type, software version, and serial number, are displayed in the Video Devices pane.
NOTE
If the device information does not display in the Video Devices pane, verify that you have the correct user name and password. If not, use this procedure to change the Username and Password for each device.
View Video Devices
Follow these steps to view the endpoint devices associated with the TMS devices:
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. View the endpoint devices in the Video Devices pane. The following information appears for each video device:
| Field | Description |
|---|---|
Name | Identifies the name of the video device. |
IP | Identifies the IP address of the configured video device. |
Community | Provides the community string for the video device, if applicable. |
Username | Identifies the username for the video device. |
Type | Indicates the type of video device. |
System Category | Identifies the type of device, such as MCU or endpoint. |
Software Version | Provides the software version for the video device. |
Serial Number | Identifies the serial number for the video device. |
| TMS Name | Identifies the name of the TMS associated with the video device in Nectar UCMP. |
| TMS IP | Identifies the IP address of the TMS associated with the video device in Nectar UCMP. |
| Monitor | Indicates the monitoring status of the video device:
|
| Status | Indicates the endpoint status (can be but not limited to):
|
| Secure Protocol | If selected, use a secure Internet channel for the video device. |
| Channel to Rate Call | Select one of the following channels from the drop-down to categorize the call:
|
Table - Video Devices - Data
Remove a Video Device
When you remove a video device, the agent created for the device is also removed. Follow these steps to remove a video device:
1. Navigate to Modules > Cisco > Video. The Cisco Video Setup window appears.
2. Click Video Devices, if not already selected.
3. In the Video Devices pane, select an endpoint device; then right-click and select Remove. The Removal Confirmation window appears:
Removal Confirmation 4. Click Yes.
The device, agent, and dependency tree associated with the video device are removed.
Change Monitoring Status
By default, this value is set to True, and all video endpoints are monitored. However, you can stop real-time QOS monitoring by disabling video monitoring.
Follow these steps to change the monitoring status for a video device:
1. Navigate to Modules > Cisco > Video.
The Cisco Video Setup - Video Devices window appears.
2. In the Video Devices pane, right-click on an endpoint device and select Enable/Disable Monitoring.
The monitoring status for the device is changed:
- If the status was set to True, then it changes to False. Monitoring is disabled.
- If the status was set to False, then it changes to True. Monitoring is enabled.
Check Endpoint Status
You can check the status of an endpoint to see if there is a call in progress.
It is recommended that you check the status of an endpoint before you edit or remove a device from the Nectar UCMP.
Follow these steps to check the endpoint status:
- Navigate to Modules > Cisco > Video. The Cisco Video Setup window appears.
- In the Video Devices pane, check the Status field:
- Idle - Indicates that the endpoint is not in use.
- In Call - Indicates that the endpoint has a call in progress.
- No Response - Indicates that the endpoint is not responding to HTTP commands.
View Endpoint Device Details
Follow these steps to view information about the endpoint device:
- Navigate to Modules > Cisco > Video. The Cisco Video Setup window appears.
- In the Video Devices pane, right-click on a video device and select View. The Endpoint Device Details window appears.
Endpoint Device Details 3. View the information about the endpoint device.
4. Click Close.
Troubleshooting
Verify Endpoints
Follow these steps to verify endpoints:
1. Enter the TMS IP address, such as:
10.65.0.240/tms
2. Access TMS using the appropriate TMS Admin credentials.
3. Navigate to Systems > Endpoints.
4. Notice if one of the endpoints is not registered with the Unified CM, as shown in the following Endpoint Example
Endpoint Example 5. Navigate to Systems interface and login using the appropriate TMS User credentials.
6. Navigate to Call Control; then make a call to another system to verify it works.
7. Return to the Cisco Video Setup - Video Devices window; the endpoint should be online. It may take a few minutes to view.
Was this article helpful?