Barco ClickShare Rest API
Monitoring Connector Assets​
Monitored Objects​
The Barco ClickShare Pack collects metrics and status from various Barco hardware devices (CSE 100, CSE-200+, CSE-800,...).
Collected Metrics​
- 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 |
Prerequisites​
To control your Barco ClickShare, the Rest API must be configured.
E.g: https://www.barco.com/en/support/knowledge-base/kb11350
Setup​
- Online License
- Offline License
- Install the Centreon Plugin on every Poller:
yum install centreon-plugin-Hardware-Devices-Barco-Cs-Restapi
- On the Centreon Web interface in Configuration > Monitoring Connector Manager, install the Barco ClickShare Rest API Pack
- Install the Centreon Plugin on every Poller:
yum install centreon-plugin-Hardware-Devices-Barco-Cs-Restapi
- On the Centreon Central server, install the Centreon Pack from the RPM:
yum install centreon-pack-hardware-devices-barco-cs-restapi
- On the Centreon Web interface in Configuration > Monitoring Connector Manager, install the Barco ClickShare Rest API Pack
Host configuration​
- Add a new Host and apply the HW-Device-Barco-Cs-Restapi-custom Host Template
Once the template applied, some Macros have to be configured:
| 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) |
How to test the Plugin 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-password have to be adjusted):
/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
Output example:
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
The command above monitors device (--mode=device).
It uses api-username (--api-username='myapiusername'), an api-password (--api-password='myapipassword')
and it connects to the host 10.30.2.79 (--hostname='10.30.2.79')
on the port 4001 (--port='4001') using https (--proto='https').
All the options that can be used with this plugin can be found over the --help command:
/usr/lib/centreon/plugins/centreon_barco_cs_restapi.pl \
--plugin=hardware::devices::barco::cs::restapi::plugin \
--mode=device \
--help