Supported Versions
REST API: Rest API versions v1 & v2
Poly VoIP phone vvx and ccx models

Introduction

The Polycom VVX business VoIP phone is a modern four-line basic VoIP desk phone that delivers reliable performance and an enterprise grade sound quality.

The Poly CCX Business Media Phone is an entry-level, open-SIP device with a color touch-screen display that is certified for use with Microsoft Teams and Skype.

Prerequisites

OpsRamp Classic Gateway 12.0.1 and above.

Default monitoring configurations

Poly VOIP Phone application has default Global Device Management Policies, Global Templates, Global Monitors, and Global Metrics in OpsRamp. You can customize these default monitoring configurations as your business use cases by cloning respective Global Templates, and Global Device Management policies. OpsRamp recommends doing this activity before installing the application to avoid noise alerts and data.

  1. Default Global Device Management Policies

    OpsRamp has a Global Device Management Policy for each Native Type of Poly VOIP Phone. You can find those Device Management Policies at Setup -> Resources -> Device Management Policies -> Search with suggested names in global scope. Each Device Management Policy follows below naming convention:

    {appName nativeType - version}

    Ex: poly-voip-phone Poly VOIP Phone - 1 (i.e, appName = poly-voip-phone, nativeType = Poly VOIP Phone, version = 1)

  2. Default Global Templates

    OpsRamp has a Global Template for each Native Type of Poly VOIP Phone. You can find those templates at Setup -> Monitoring -> Templates -> Search with suggested names in global scope. Each template follows below naming convention:

    {appName nativeType 'Template' - version}

    Ex: poly-voip-phone Poly VOIP Phone Template - 1 (i.e, appName = poly-voip-phone, nativeType = Poly VOIP Phone, version = 1)

  3. Default Global Monitors

    OpsRamp has a Global Monitors for each Native Type which has monitoring support. You can find those monitors at Setup -> Monitoring -> Monitors -> Search with suggested names in global scope. Each Monitors follows below naming convention:

    {monitorKey appName nativeType - version}

    Ex: Poly VOIP Phone Monitor poly-voip-phone Poly VOIP Phone 1 (i.e, monitorKey = Poly VOIP Phone Monitor, appName = poly-voip-phone, nativeType = Poly VOIP Phone, version = 1)

Configure and install the integration

  1. From All Clients, select a client.
  2. Go to Setup > Integrations and Apps.
  3. Click Manage Apps.
    Notes:
    • If there are already installed applications, it will redirect to the INSTALLED APPS page, where all the installed applications are displayed.
    • If there are no installed applications, it will navigate to the ADD APP page.
Poly VoIP Managed Apps
  1. Click + ADD on the INSTALLED APP page. The ADD APP page displays all the available applications along with the newly created application with the version.
    Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.
Poly VoIP
  1. Click ADD in the Poly VOIP Phone application.
  2. In the Configurations page, click + ADD. The Add Configuration page appears.
  3. Enter the below mentioned BASIC INFORMATION:
FunctionalityDescription
NameEnter the name for the configuration.
Host Name / IP AddressHost Name/IP address of the target.
Resource Instance NameEnter the resource instance name information.
PortPort

Note: By default 443 is added.
CredentialsSelect the credentials from the drop-down list.

Note: Click + Add to create a credential.

Notes:

  • By default the IsSecure checkbox is selected.
  • Select App Failure Notifications; if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
  1. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.
Poly VoIP
  1. Now the configuration is saved and displayed on the configurations page after you save it.

    Note: From the same page, you may Edit and Remove the created configuration.
  2. Click NEXT
  3. In the Installation page, select an existing registered gateway profile, and click FINISH.
Poly VoIP

The application is now installed and displayed on the Installed Integration page. Use the search field to find the installed application.

Modify the Configuration

View the Poly VoIP phones details

The Poly VoIP phones integration is displayed in the Infrastructure > Resources > Network Devices > VoIP. You can navigate to the Attributes tab to view the discovery details, and Metrics tab to view the metric details for Poly VoIP phones.

Poly VoIP
Poly VoIP

Supported metrics

Metric NameDisplay NameUnitDescription
polycom_vvx_ccx_current_CPU_UtilizationCurrent CPU Utilization%Current CPU utilization of the device.
polycom_vvx_ccx_average_CPU_UtilizationAverage CPU Utilization%Average CPU utilization of the device
polycom_vvx_ccx_Free_MemoryFree Memory in MbytesMBProvides device free memory details
polycom_vvx_ccx_Memory_UtilizationMemory Utilization%Provides device memory usage details
polycom_vvx_ccx_Used_MemoryMemory Used in MbytesMBProvides the amount of memory used
polycom_vvx_ccx_SIP_StatusSIP StatusProvides line info Registration Status. Possible outcomes are - 0 - Unregistered, 1 - Registered
polycom_vvx_ccx_Packets_LostData Packets LostcountProvides packets lost information while transmission
polycom_vvx_ccx_TxMOSLQLocal Conversational MOS ScorecountThe ranking/score of the quality of voice and video sessions obtained from local listening quality tests
polycom_vvx_ccx_RxMOSLQRemote Conversational MOS ScorecountThe ranking/score of the quality of voice and video sessions obtained from remote listening quality tests
polycom_vvx_ccx_TxMOSCQLocal Listening MOS ScorecountThe ranking/score of the quality of voice and video sessions obtained from local conversational quality tests
polycom_vvx_ccx_RxMOSCQRemote Listening MOS ScorecountThe ranking/score of the quality of voice and video sessions obtained from remote conversational quality tests
polycom_vvx_ccx_LatencyLatencymsThe time it takes for some data to get to its destination across the network
polycom_vvx_ccx_Max_JitterMax Jitter TimemsMaximum Variation in time delay between when a signal is transmitted and when it's received over a network connection
polycom_vvx_ccx_JitterJitter TimemsVariation in time delay between when a signal is transmitted and when it's received over a network connection
polycom_vvx_ccx_AppStateAppStateProvides polycom device state info. Possible outcomes are 0 - Unknown, 1 - AppStateMenu, 2 - AppStateCall

Risks, Limitations & Assumptions

  • Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration:
    • Connectivity Exception
    • Authentication Exception
  • Application will not send any duplicate/repeat failure alert notification until the already existed critical alert is recovered.
  • Macro replacement limitation (i.e, customisation for threshold breach alert subject, description).
  • Application cannot control monitoring pause/resume actions based on above alerts
  • Metrics can be used to monitor Poly VoIP phone resources and can generate alerts based on the threshold values.
  • Component level thresholds can be configured on each resource level.
  • No support of showing activity log and applied time.
  • No support for the option to get Latest snapshot metric.