Skip to main content

HP StoreOnce 3.x Rest API

Pack Assets​

Templates​

The Centreon Pack HP StoreOnce brings a host template:

  • HW-Storage-Hp-Storeonce3-Restapi-custom

It brings the following service templates:

Service AliasService TemplateDefaultDiscovery
Cluster-UsageHW-Storage-Hp-Storeonce3-Cluster-Usage-RestapiX
Fcs-UsageHW-Storage-Hp-Storeonce3-Fcs-Usage-Restapi
Nas-UsageHW-Storage-Hp-Storeonce3-Nas-Usage-Restapi
Serviceset-UsageHW-Storage-Hp-Storeonce3-Serviceset-Usage-RestapiX

Collected metrics & status​

Metric nameDescriptionUnit
cluster statusCurrent overall cluster status
appliance_name#cluster.space.usage.bytesSpace used on the clusterB
appliance_name#cluster.deduplication.ratio.countDeduplication ratio on the cluster

Prerequisites​

The Pack only supports the version 3.x of HP StoreOnce. To monitor your HP StoreOnce, a user with read privileges is required. Please refer to their official documentation: https://support.hpe.com/hpesc/public/docDisplay?docId=c05273975

Setup​

  1. Install the Centreon plugin package on every Centreon poller expected to monitor HP StoreOnce 3.x Rest API resources:
yum install centreon-plugin-Hardware-Storage-Hp-Storeonce3-Restapi
  1. On the Centreon web interface, install the HP StoreOnce 3.x Rest API Centreon Pack on the Configuration > Plugin Packs page.

Configuration​

Host​

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias & IP Address / DNS fields according to your HP StoreOnce 3.x Rest API server settings.
  • Apply the HW-Storage-Hp-Storeonce3-Restapi-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryNameDescription
XSTOREONCEUSERNAMEApi username
XSTOREONCEPASSWORDApi password
STOREONCEEXTRAOPTIONSAny 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:

$CENTREONPLUGINS$/centreon_hp_storeonce3_restapi.pl \
--plugin=storage::hp::storeonce::3::restapi::plugin \
--mode=cluster-usage \
--hostname='10.0.0.1' \
--port='443' \
--proto='https' \
--username='my-username' \
--password='my-password' \
--verbose

The expected command output is shown below:

OK: Cluster 'TABZ37161Q01' status: ok, Usage Total: 62.17 TB Used: 59.78 TB (96.15%) Free: 2.39 TB (3.85%), Dedup Ratio: 14.51 | 'TABZ37161Q01#cluster.space.usage.bytes'=65731753164800B;;;0;68360696004608 'TABZ37161Q01#cluster.deduplication.ratio.count'=14.51;;;0;

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

$CENTREONPLUGINS$/centreon_hp_storeonce3_restapi.pl \
--plugin=storage::hp::storeonce::3::restapi::plugin \
--mode=cluster-usage \
--help

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

$CENTREONPLUGINS$/centreon_hp_storeonce3_restapi.pl \
--plugin=storage::hp::storeonce::3::restapi::plugin \
--list-mode

Troubleshooting​

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