Aller au contenu principal

Pexip Infinity ManagementAPI

Vue d'ensemble​

Pexip Infinity est une application d’entreprise dans le Cloud qui permet la compatibilité de vidéoconférence et de visoconférence d’entreprise à toutes les plates-formes de collaboration. Le logiciel fonctionne comme une passerelle entre les plates-formes et connecte de manière transparente les solutions de communication et de collaboration d’entreprise dans les salles de réunion virtuelles.

Pexip Infinity comprend une API de gestion qui permet à des tiers de contrôler, de configurer et d'obtenir des informations sur l'état de la plate-forme Pexip Infinity.

Contenu du connecteur de supervision​

Objets supervisés​

  • Alarmes
  • Conférences

Métriques collectées​

Vous pouvez vous renseigner en détails sur les métriques présentées ci-après sur la documentation officielle de Pexip Infinity ManagementAPI : https://docs.pexip.com/api_manage/management_intro.htm

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

Prérequis​

Tous les accès à l'API de gestion sont effectués via HTTPS. Si vous n'utilisez pas de base de données LDAP pour l'authentification, l'accès se fait via les informations d'identification de l'utilisateur administrateur Web. Le nom d'utilisateur par défaut de ce compte est admin. Si vous utilisez une base de données LDAP, il est recommandé de créer un compte spécifiquement à l'usage de l'API.

Plus d'informations sont disponible sur la documentation officielle de Pexip Infinity ManagementAPI : https://docs.pexip.com/admin/integrate_api.htm

Installation​

  1. Installer le Plugin sur tous les collecteurs Centreon supervisant des ressources Pexip Infinity ManagementAPI :
yum install centreon-plugin-Hardware-Devices-Pexip-Infinity-Managementapi.noarch
  1. Sur l'interface Web de Centreon, installer le connecteur de supervision Pexip Infinity ManagementAPI depuis la page Configuration > Gestionnaire de connecteurs de supervision

Configuration​

Ce connecteur de supervision est conçu de manière à avoir dans Centreon un hôte par environnement Pexip Infinity ManagementAPI Lorsque vous ajoutez un hôte à Centreon, appliquez-lui le modèle HW-Device-Pexip-Infinity-Managementapi-custom. Une fois celui-ci configuré, certaines macros doivent être renseignées:

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

FAQ​

Comment puis-je tester le Plugin et que signifient les options des commandes ?​

Une fois le Plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon avec l'utilisateur centreon-engine (Les paramètres tels que api-username ou api-password doivront être ajustés):

/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

La commande ci-dessus contrôle le statut d'une alarme de l'application Pexip Infinity via Managementapi (--mode=alarms) nommée mycall1.centreon.com (--filter-name='mycall1.centreon.com'). Le Plugin utilise l'api-username (--api-username='myapiusername'), l'api-password (--api-password='myapipassword') et il se connecte à l'hôte mypexipinfnitapi.com (--hostname='mypexipinfnitapi.com') sur le port 443 (--port='443') utilisant le protocol https (--proto='https').

Cette commande déclenchera une alarme WARNING i le statut retourné de l'alarme est égale de /warning|minor/i (--warning-status='%{level} =~ /warning|minor/i') et une alarme CRITICAL si l'alarme est égale de /critical|major|error/i (--critical-status='%{level} =~ /critical|major|error/i').

Toutes les options et leur utilisation peuvent être consultées avec le paramètre --help ajouté à la commande:

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

J'obtiens le message d'erreur suivant:​

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

Lors du déploiement de mes contrôles, j'obtiens le message suivant UNKNOWN: 500 Can't connect to mypexipinfnitapi.com:443 |. Cela signifie que Centreon n'a pas réussi à se connecter à Pexip Infinity ManagementAPI (mypexipinfnitapi.com). La plupart du temps, il faut préciser le proxy à utiliser pour requêter l'URL mypexipinfnitapi.com en utilisant l'option --proxyurl='http://proxy.mycompany:8080'.

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

Suite à la mise en place du proxy, j'obtiens le message suivant UNKNOWN: 501 Protocol scheme 'connect' is not supported | Cela signifie que le protocole de connexion au proxy n'est pas supporté par la libraire LWP utlisée par défaut par le Plugin Centreon. Cette erreur peut être résolue en utilisant le backend HTTP curl. Pour ce faire, ajoutez l'option --http-backend='curl' à la commande.

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

Ce message d'erreur indique qu'une librairie Perl est maquante pour utiliser le backend curl.

Pour corriger ce problème, installer la librairie Perl Net::Curl::Easy à l'aide de la commande suivante :

yum install perl-Net-Curl