Skip to main content

Pexip Infinity ManagementAPI

Overview​

Pexip Infinity is a cloud enterprise application that enables enterprise video conferencing and collaboration across all devices and platforms. The software seamlessly connects enterprise communications and collaboration solutions in Virtual Meeting Rooms, or operates as a gateway between platforms.

Pexip Infinity includes a ManagementAPI that allows third parties to control, configure, and obtain status information on the Pexip Infinity platform.

Monitoring Connector Assets​

Monitored Objects​

  • Alarms
  • Conferences

Collected Metrics​

More information about collected metrics is available in the official Pexip Infinity ManagementAPI documentation : https://docs.pexip.com/api_manage/management_intro.htm

Metric nameDescriptionUnit
statusAlarms status
alerts.problems.current.countNumber of current alerts problemscount

Prerequisites​

Accesses to the ManagementAPI are performed via HTTPS. For authentication, if you do not use an LDAP database, access is via the login credentials of the Web administrator user. The default user name of this account is admin. If you are using an LDAP database, it is recommended to create an account specifically for the use of the API.

More information is available on the official documentation of Pexip Infinity ManagementAPI: https://docs.pexip.com/admin/integrate_api.htm

Setup​

  1. Install the Centreon Plugin on every poller monitoring Pexip Infinity ManagementAPI resources:
yum install centreon-plugin-Hardware-Devices-Pexip-Infinity-Managementapi.noarch
  1. On the Centreon Web interface in Configuration > Monitoring Connector Manager, install the Pexip Infinity ManagementAPI Monitoring Connector

Configuration​

The Monitoring Connector is designed to monitor resources based on one host per Pexip Infinity ManagementAPI environment. Adding a host into Centreon, link it to the template named HW-Device-Pexip-Infinity-Managementapi-custom. Once the template applied, some Macros have to be configured:

MandatoryNameDescription
XAPIPORTPort used (Default: 443)
XAPIPROTOSpecify https if needed (Default: 'https')
XAPIUSERNAMEPexip Infinity ManagementAPI username
XAPIPASSWORDPexip Infinity ManagementAPI password
APIEXTRAOPTIONSAny extra option you may want to add to the command (eg. a --verbose flag)

FAQ​

How to check in the CLI that the configuration is OK and what are the main options for ?​

Once the Plugin installed, log into your poller using the centreon-engine user account and test by running the following command (Parameters such as api-username or api-passwordhave to be adjusted):

/usr/lib/centreon/plugins/centreon_pexip_infinity_managementapi.pl \
    --plugin=hardware::devices::pexip::infinity::managementapi::plugin \
    --mode=alarms \
    --hostname='mypexipinfnitapi.com' \
    --port='443' \
    --proto='https' \
    --api-username='myapiusername' \
    --api-password='myapipassword' \
    --filter-name='mycall1.centreon.com' \
    --warning-status='%\{level\} =~ /warning|minor/i' \
    --critical-status='%\{level\} =~ /critical|major|error/i' \
    --verbose

The command above gets the status of alarms Pexip Infinity using ManagementAPI (--mode=alarms) named mycall1.centreon.com (--filter-name='mycall1.centreon.com'). It uses api-username (--api-username='myapiusername'), an api-password (--api-password='myapipassword') and it connects to the host mypexipinfnitapi.com (--hostname='mypexipinfnitapi.com') on the port 443 (--port='443') using https (--proto='https').

This command would trigger a WARNING alert if the returned status of the alarms level is equal to /warning|minor/i (--warning-status='%{level} =~ /warning|minor/i') and a CRITICAL alert if the returned status is equal to /critical|major|error/i (--critical-status='%{level} =~ /critical|major|error/i').

All the options that can be used with this plugin can be found over the --help command:

/usr/lib/centreon/plugins//centreon_pexip_infinity_managementapi.pl --plugin=hardware::devices::pexip::infinity::managementapi::plugin \
     --mode=alarms \
     --help

Why do I get the following error:​

UNKNOWN: 500 Can't connect to mypexipinfnitapi.com:443​

This error message means that the Centreon Plugin couldn't successfully connect to the Pexip Infinity ManagementAPI. Check that no third party device (such as a firewall) is blocking the request. A proxy connection may also be necessary to connect to the API. This can be done by using the --proxyurl='http://proxy.mycompany:8080' option in the command.

UNKNOWN: 501 Protocol scheme 'connect' is not supported​

When using a proxy to connect to the Pexip Infinity ManagementAPI, this error message means that the Centreon Plugin library does not support the proxy connection protocol.

In order to prevent this issue, use the curl HTTP backend by adding the following option to the command: --http-backend='curl'.

UNKNOWN: Cannot load module 'Net::Curl::Easy'​

This error message means that a Perl library required to use the curl backend is missing.

In order to fix this issue, install the Net::Curl::Easy Perl library using the following command:

yum install perl-Net-Curl