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

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
2.0.1
  • Added Metric Labels support.
  • Missing component alerts.
2.0.0Full discovery Support added.
1.0.1Custom macros support in the alert subject & description.
Click here to view the earlier version updates
Application VersionBug fixes / Enhancements
1.0.0Initial sdk2.0 app discovery & monitoring implementation.

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 14.0.0 and above.
  • OpsRamp NextGen Gateway 14.0.0 and above.
    Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

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 Poly VOIP Phone Integration

  1. From All Clients, select a client.
  2. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed. If there are no installed applications, it will navigate to the Available Integrations and Apps page.
  5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
  6. Search for the application using the search option available. Alternatively, 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.
  • Host Name / IP Address and Port should be accessible from Gateway.
  • Select App Failure Notifications; if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
  1. Select the below mentioned Custom Attribute:
FunctionalityDescription
Custom AttributeSelect the custom attribute from the drop down list box.
ValueSelect the value from the drop down list box.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  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.

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.

  1. Click NEXT.

  2. Below are the optional steps you can perform on the Installation page.

  • Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

    Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

Cisco FirePower
  • Click +ADD to create a new collector by providing a name or use the pre-populated name.
Aruba Airwave Integrations
  1. Select an existing registered profile.
Aruba Airwave Integrations
  1. Click FINISH.

The integration 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 Alert Custom Macros

Customize the alert subject and description with below macros then it will generate alert based on customisation.
Supported macros keys:

Click here to view the alert subject and description with macros

                                ${resource.name}

                                ${resource.ip}

                                ${resource.mac}

                                ${resource.aliasname}

                                ${resource.os}

                                ${resource.type}

                                ${resource.dnsname}

                                ${resource.alternateip}

                                ${resource.make}

                                ${resource.model}

                                ${resource.serialnumber}

                                ${resource.systemId}

                                ${Custome Attributes in the resource}

                                ${parent.resource.name}

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameDisplay NameUnitApplication VersionDescription
Poly VOIP Phonepoly_voip_phone_current_CPU_UtilizationCurrent CPU Utilization%1.0.0Current CPU utilization of the device.
poly_voip_phone_average_CPU_UtilizationAverage CPU Utilization%1.0.0Average CPU utilization of the device
poly_voip_phone_Free_MemoryFree Memory in MbytesMB1.0.0Provides device free memory details
poly_voip_phone_Memory_UtilizationMemory Utilization%1.0.0Provides device memory usage details
poly_voip_phone_Used_MemoryMemory Used in MbytesMB1.0.0Provides the amount of memory used
poly_voip_phone_SIP_StatusSIP Status1.0.0Provides line info Registration Status. Possible outcomes are - 0 - Unregistered, 1 - Registered
poly_voip_phone_Packets_LostData Packets Lostcount1.0.0Provides packets lost information while transmission
poly_voip_phone_TxMOSLQLocal Conversational MOS Scorecount1.0.0The ranking/score of the quality of voice and video sessions obtained from local listening quality tests
poly_voip_phone_RxMOSLQRemote Conversational MOS Scorecount1.0.0The ranking/score of the quality of voice and video sessions obtained from remote listening quality tests
poly_voip_phone_TxMOSCQLocal Listening MOS Scorecount1.0.0The ranking/score of the quality of voice and video sessions obtained from local conversational quality tests
poly_voip_phone_RxMOSCQRemote Listening MOS Scorecount1.0.0The ranking/score of the quality of voice and video sessions obtained from remote conversational quality tests
poly_voip_phone_LatencyLatencyms1.0.0The time it takes for some data to get to its destination across the network
poly_voip_phone_Max_JitterMax Jitter Timems1.0.0Maximum Variation in time delay between when a signal is transmitted and when it's received over a network connection
poly_voip_phone_JitterJitter Timems1.0.0Variation in time delay between when a signal is transmitted and when it's received over a network connection
poly_voip_phone_AppStateAppState1.0.0Provides 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 send any duplicate/repeat failure alert notification for every 6 hours.
  • Latest snapshot metric is available from Gateway version 14.0.0.
  • Support for Macro replacement for threshold breach alerts (i.e, customisation for threshold breach alert’s 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.
  • No support of showing activity log and applied time.
  • This application supports both Classic Gateway and NextGen Gateway.