Barco ClickShare Rest API
Contenu du connecteur de supervision​
Objets supervisés​
Le Pack Barco ClickShare collecte les données pour différents types de matériel (CSE 100, CSE-200+, CSE-800, ...).
Métriques collectées​
- Device
| Metric name | Description | Unit |
|---|---|---|
| device status | Status of the device | |
| cpu#hardware.temperature.celsius | Cpu sensor temperature | C |
| pcie#hardware.temperature.celsius | Pcie sensor temperature | C |
| sio#hardware.temperature.celsius | Sio sensor temperature | C |
| cpu#hardware.fan.speed.rpm | Cpu fan speed (supported since api v1.11) | rpm |
| process status | Status of processes |
Prérequis​
Afin de contrôler l'équipement Barco ClickShare, l'API Rest doit être configuré (cf: https://www.barco.com/en/support/knowledge-base/kb11350)
Installation​
- Online License
- Offline License
- Installer le Plugin sur tous les Collecteurs Centreon :
yum install centreon-plugin-Hardware-Devices-Barco-Cs-Restapi
- Sur l'interface Web de Centreon, installer le Pack Barco ClickShare Rest API depuis la page Configuration > Gestionnaire de connecteurs de supervision
- Installer le Plugin sur tous les Collecteurs Centreon :
yum install centreon-plugin-Hardware-Devices-Barco-Cs-Restapi
- Sur le serveur Central Centreon, installer le Pack via le RPM:
yum install centreon-pack-hardware-devices-barco-cs-restapi
- Sur l'interface Web de Centreon, installer le Pack Barco ClickShare Rest API 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 équipement Barco ClickShare. Lorsque vous ajoutez un hôte à Centreon, appliquez-lui le modèle HW-Device-Barco-Cs-Restapi-custom. Une fois celui-ci configuré, certaines macros doivent être renseignées:
| Mandatory | Name | Description |
|---|---|---|
| X | BARCOCSAPIPORT | Port used (Default: 4001) |
| X | BARCOCSAPIPROTO | Specify https if needed (Default: 'https') |
| X | BARCOCSAPIUSERNAME | Api username |
| X | BARCOCSAPIPASSWORD | Api password |
| BARCOCSAPIEXTRAOPTIONS | Any extra option you may want to add to the command (eg. a --verbose flag) |
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_barco_cs_restapi.pl \
--plugin=hardware::devices::barco::cs::restapi::plugin \
--mode=device \
--hostname='10.30.2.79' \
--port='4001' \
--proto='https' \
--api-username='myapiusername' \
--api-password='myapipassword' \
--warning-cpu-temperature='55' \
--critical-cpu-temperature='60' \
--verbose
Exemple de sortie:
OK: device is ok | 'cpu#hardware.temperature.celsius'=52C;0:55;0:60;; 'pcie#hardware.temperature.celsius'=50C;0:55;0:60;;
checking device
status: ok
temperature cpu 52 C, pcie 50 C
process 'Button Agent' status is running
process 'ClickShare Server' status is running
process 'Config Manager' status is running
process 'DBus Daemon' status is running
process 'DHCP Server' status is running
process 'Device Daemon' status is running
process 'Graphics Server' status is running
process 'Job Scheduler' status is running
process 'LED Control' status is running
process 'Miracast Server' status is running
process 'Process Monitor' status is running
process 'System Logging' status is running
process 'WebUI Server' status is running
process 'Wifi Access Point Daemon' status is running
La commande ci-dessus contrôle statistiques mails (--mode=mail).
Le Plugin utilise l'api-username (--api-username='myapiusername'), l'api-password (--api-password='myapipassword')
et il se connecte à l'hôte 10.30.2.79 (--hostname='10.30.2.79') sur le port 8006 (--port='8006') utilisant le protocol https (--proto='https').
Toutes les options et leur utilisation peuvent être consultées avec le paramètre --help ajouté à la commande:
/usr/lib/centreon/plugins/centreon_barco_cs_restapi.pl \
--plugin=hardware::devices::barco::cs::restapi::plugin \
--mode=device \
--help