Skip to main content

EMC Vplex Rest API

Pack Assets​

Monitored Objects​

The Centreon Pack EMC VPLEX brings a host template:

  • HW-Storage-EMC-Vplex-Restapi-custom

It brings the following service templates:

Service AliasService TemplateDescriptionDefault
Cluster-CommunicationHW-Storage-EMC-Vplex-Cluster-Communication-RestapiCheck cluster communication stateX
Cluster-DevicesHW-Storage-EMC-Vplex-Cluster-Devices-RestapiCheck cluster devicesX
DirectorsHW-Storage-EMC-Vplex-Directors-RestapiCheck directorsX
Distributed-DevicesHW-Storage-EMC-Vplex-Distributed-Devices-RestapiCheck distributed devicesX
FansHW-Storage-EMC-Vplex-Fans-RestapiCheck fansX
PsusHW-Storage-EMC-Vplex-Psus-RestapiCheck power suppliesX
Storage-VolumesHW-Storage-EMC-Vplex-Storage-Volumes-RestapiCheck storage volumesX

Collected metrics & status​

Metric nameUnit
operational state

Prerequisites​

To control your EMC VPLEX, the Rest API must be configured.

The Centreon Pack supports the Rest APIv1 and APIv2. Services Fans and Psus are not supported by the Rest APIv2.

Setup​

  1. Install the Centreon plugin package on every Centreon poller expected to monitor EMC VPLEX resources:
yum install centreon-plugin-Hardware-Storage-Emc-Vplex-Restapi
  1. On the Centreon web interface, install the EMC Vplex 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 and IP Address / DNS fields according to your EMC VPLEX equipment settings.
  • Apply the HW-Storage-EMC-Vplex-Restapi-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryNameDescription
XVPLEXCUSTOMMODEAPI version used (Default: 'apiv1'. Can be: 'apiv2')
XAPIPORTPort used (Default: 443)
XAPIPROTOSpecify https if needed (Default: 'https')
XVPLEXUSERNAMEAPI username
XVPLEXPASSOWRDAPI password
VPLEXEXTRAOPTIONSAny 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_emc_vplex.pl \
--plugin=storage::emc::vplex::restapi::plugin \
--custommode='apiv1' \
--mode=cluster-communication \
--hostname='10.30.2.79' \
--port='443' \
--proto='https' \
--vplex-username='myusername' \
--vplex-password='mypassword' \
--verbose

The expected command output is shown below:

All cluster witness components are ok
Cluster witness component 'cluster-1' operational state: 'in-contact' [admin: enabled]
Cluster witness component 'cluster-2' operational state: 'in-contact' [admin: enabled]
Cluster witness component 'server' operational state: 'clusters-in-contact' [admin: enabled]

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

/usr/lib/centreon/plugins/centreon_emc_vplex.pl \
--plugin=storage::emc::vplex::restapi::plugin \
--custommode='apiv1' \
--mode=cluster-communication \
--help

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

/usr/lib/centreon/plugins/centreon_emc_vplex.pl \
--plugin=storage::emc::vplex::restapi::plugin \
--custommode='apiv1' \
--list-mode

Troubleshooting​

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