Skip to main content

Dell VxRail Manager Rest API

Pack Assets

Templates

The Centreon Pack Dell VXM brings a host template:

  • HW-Server-Dell-Vxm-Restapi-custom

It brings the following service templates:

Service AliasService TemplateService DescriptionDefault
ChassisHW-Server-Dell-Vxm-Chassis-RestapiCheck chassisX
HostsHW-Server-Dell-Vxm-Hosts-RestapiCheck hostsX

Discovery rules

Rule NameDescription
Dell VxRail HostDiscover VxRail hosts

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

Collected metrics & status

Metric nameUnit
chassis.detected.count
chassis.unhealthy.count
chassis status
power supply status

Prerequisites

To monitor, a user with read privileges is required.

Please refer to their official documentation: https://developer.dell.com/apis/5538/versions/7.0.210/docs/Introduction.md

Setup

  1. Install the Centreon package on every Centreon poller expected to monitor Dell VxRail Manager resources:
yum install centreon-plugin-Hardware-Servers-Dell-Vxm-Restapi
  1. On the Centreon web interface, install the Dell VxRail Manager 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 & IP Address / DNS fields according to your Dell VxRail Manager server settings.
  • Apply the HW-Server-Dell-Vxm-Restapi-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryNameDescription
XVXMAPIPORTPort used (Default: 443)
XVXMAPIPROTOSpecify http if needed (default: 'https')
XVXMAPIUSERNAMEApi username
XVXMAPIPASSWORDApi password
VMXAPIEXTRAOPTIONSAny 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_dell_vxm_restapi.pl  \
--plugin=hardware::server::dell::vxm::restapi::plugin \
--mode=chassis \
--hostname='10.0.0.1' \
--port='443' \
--proto='https' \
--api-username='my-username' \
--api-password='my-password' \
--verbose

The expected command output is shown below:

OK: number of chassis detected: 6, unhealthy: 0 - All chassis are ok | 'chassis.detected.count'=6;;;0; 'chassis.unhealthy.count'=0;;;0;
checking chassis '53FT2T2'
status: Healthy
power supply 'Power Supply 1' status: Healthy
power supply 'Power Supply 2' status: Healthy
checking chassis '53FW2T2'
status: Healthy
power supply 'Power Supply 1' status: Healthy
power supply 'Power Supply 2' status: Healthy
checking chassis '53GN2T2'
status: Healthy
power supply 'Power Supply 1' status: Healthy
power supply 'Power Supply 2' status: Healthy
checking chassis '5JDXF13'
status: Healthy
power supply 'Power Supply 1' status: Healthy
power supply 'Power Supply 2' status: Healthy
checking chassis '6JDXF13'
status: Healthy
power supply 'Power Supply 1' status: Healthy
power supply 'Power Supply 2' status: Healthy
checking chassis '7JDXF13'
status: Healthy
power supply 'Power Supply 1' status: Healthy
power supply 'Power Supply 2' status: Healthy

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

/usr/lib/centreon/plugins/centreon_dell_vxm_restapi.pl  \
--plugin=hardware::server::dell::vxm::restapi::plugin \
--mode=chassis \
--help

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

/usr/lib/centreon/plugins/centreon_dell_vxm_restapi.pl  \
--plugin=hardware::server::dell::vxm::restapi::plugin \
--list-mode

Troubleshooting

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