Skip to main content

Aruba Orchestrator Rest API

Pack Assets

Monitored Objects

The Centreon Pack Aruba Orchestrator brings a host template:

  • Net-Aruba-Orchestrator-Restapi-custom

It brings the following service templates:

Service AliasService TemplateDescriptionDefault
AlarmsNet-Aruba-Orchestrator-Alarms-RestapiCheck alarmsX
AppliancesNet-Aruba-Orchestrator-Appliances-RestapiCheck appliancesX

Discovery rules

Rule NameDescription
Aruba Orchestrator ApplianceDiscover appliances

More information about discovering hosts automatically is available on the dedicated page.

Collected metrics & status

Metric nameUnit
alerms.problems.current.count
alarms.severity.minor.count
alarms.severity.warning.count
alarms.severity.major.count
alarms.severity.critical.count

Prerequisites

To control your Aruba Orchestrator, the Rest API must be configured.

Setup

  1. Install the Centreon package on every Centreon poller expected to monitor Aruba Orchestrator resources:
yum install centreon-plugin-Network-Aruba-Orchestrator-Restapi
  1. On the Centreon web interface, install the Aruba Orchestrator Rest API Centreon Pack on the Configuration > Monitoring Connector Manager page.

Configuration

Host

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias and IP Address / DNS fields according to your Aruba Orchestrator equipment settings.
  • Apply the Net-Aruba-Orchestrator-Restapi-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryNameDescription
XAPIPORTPort used (Default: 443)
XAPIPROTOSpecify https if needed (Default: 'https')
XAPIACCESSTOKENAPI token
APIEXTRAOPTIONSAny extra option you may want to add to the command (eg. a --verbose flag)

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

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine) and test the plugin by running the following command:

/usr/lib/centreon/plugins/centreon_aruba_orchestrator_restapi.pl \
--plugin=network::aruba::orchestrator::restapi::plugin \
--mode=appliances \
--hostname='10.30.2.79' \
--port='443' \
--proto='https' \
--api-token='mytoken' \
--verbose

The expected command output is shown below:

OK: appliances detected: 2 - All appliances are ok | 'appliances.detected.count'=2;;;0;
appliance 'EU-FRA-IDF-PARIS-ARCHIVES-SP2' [group: Network > France > Paris] state: normal
appliance 'EU-FRA-IDF-SPATHUS-ARCHIVES-SP2' [group: Network > France > Saint-Pathus] state: normal

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_aruba_orchestrator_restapi.pl \
--plugin=network::aruba::orchestrator::restapi::plugin \
--mode=appliances \
--help

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins/centreon_aruba_orchestrator_restapi.pl \
--plugin=network::aruba::orchestrator::restapi::plugin \
--list-mode

Troubleshooting

Please find the troubleshooting documentation for the API-based plugins in this chapter.