Supported Versions
Poly studio X30, X50 series devices

Introduction

Poly AV Studio series device is a premium all-in-one video conference camera & sound bar system that helps your team connect & come up with bright ideas

Prerequisites

  • OpsRamp Classic Gateway 12.0.1 and above.

Default monitoring configurations

Poly AV Studio Series Device application has default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. Users can customize these default monitoring configurations as per their 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-AV-STUDIO-SERIES. 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-av-studio-series Poly AV Studio Series - 1 (i.e, appName = poly-av-studio-series, nativeType = Poly AV Studio Series, version = 1

  2. Default Global Templates

    OpsRamp has a Global Template for each Native Type of POLY-AV-STUDIO-SERIES. 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-av-studio-series Poly AV Studio Series Template - 1 (i.e, appName = poly-av-studio-series, nativeType = Poly AV Studio Series, version = 1)

  3. Default Global Monitors

    OpsRamp has a Global Monitor 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 AV Studio Series Monitor poly-av-studio-series Poly AV Studio Series 1 (i.e, monitorKey = Poly AV Studio Series Monitor, appName = poly-av-studio-series nativeType = Poly AV Studio Series, 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.
Polycom studio 1
  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.
Polycom studio 1
  1. Click ADD in the Poly AV Studio Series application.
  2. In the Configurations page, click + ADD. The Add Configuration page appears.
  3. Enter the below mentioned BASIC INFORMATION:
FuntionalityDescription
NameEnter the name for the configuration.
Host Name/IP AddressIP address/host name of the target.
Resource Instance NameEnter a value.
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 Custom Attributes section, select the custom attribute key and value from the dropdown boxes.
    Note:

    • The custom attribute that you add here will be assigned to all the resources that are created by the configuration.
    • You can add a maximum of 5 custom attributes (key and value pair).
    • The custom attribute that you add should be created at the client level.
  2. 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.
  3. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:

    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  4. 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. In the Installation page, select an existing registered gateway profile, and click FINISH.
Polycom studio 1

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 AV Studio Series device details

The Poly AV Studio Series application 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 AV Studio series.

Polycom studio 1
Polycom studio 1

Supported Alert Custom Macros

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

                                ${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

Metric NameMetric Display NameUnitDescription
polycom_studio_Provisioning_StatusProvisioning Statusstudio device provisioning status. Registered -1, Unregistered-0
polycom_studio_Controller_StatusController Statuspoly studio device controller status. Connected-1, Disconnected-0
polycom_studio_Calendar_Connection_StatusCalendar Connection Statuspoly studio device calendar connection status. Valid status strings -> DISABLED -0, OFFLINE -1, ONLINE -2, CONNECTING -3,ERR_AUTHENTICATION -4, and ERR_UNKNOWN -5
polycom_studio_Device_Paired_StatusDevices Paired StatusPoly studio device paired status. Valid outcomes are - paired -2, Connected -1, Disconnected -0.
polycom_studio_SIP_StatusSIP Server Statuspoly studio device SIP server status. Valid status strings -> DOWN -0, UP -1, ON -2, OFF -3, and ERR_UNKNOWN -4

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.
  • Application cannot control monitoring pause/resume actions based on above alerts
  • Metrics can be used to monitor polycom studio series resources and can generate alerts based on the threshold values.
  • Support for Macro replacement for threshold breach alerts (i.e, customisation for threshold breach alert’s subject, description).
  • Component level thresholds can be configured on each resource level.
  • No support of showing activity log and applied time.
  • Support for the option to get Latest snapshot metric.
  • Applications do not have support for below metrics due to the reason that the rest API gives empty data in all the cases.
    • Jitter
    • Latency
    • Packet Loss