Skip to main content

Dell ME4 Rest API

Pack Assets​

Monitored Objects​

The Pack Dell ME4 collects metrics for:

  • Controllers
  • Hardware
  • Interfaces
  • Volumes

Discovery rules​

Rule nameDescription
HW-Storage-Dell-Me4-Restapi-Controller-Statistics-NameDiscover controllers and monitor statistics
HW-Storage-Dell-Me4-Restapi-Volume-Statistics-NameDiscover volumes and monitor statistics

Collected Metrics​

Metric nameDescriptionUnit
controller_id#controller.data.read.bytespersecondAmount of data readB/s
controller_id#controller.data.written.bytespersecondAmount of data writtenB/s
controller_id#controller.reads.persecondFor the controller whose host ports had I/O activity, the number of read operations
controller_id#controller.writes.persecondFor the controller whose host ports had I/O activity, the number of write operations
controller_id#controller.data.transfer.bytespersecondThe data transfer rateB/s
controller_id#controller.iops.countInput/output operations per second
controller_id#controller.commands.forwarded.countThe current count of commands that are being forwarded or are queued to be forwarded to the partner controller for processing
controller_id#controller.cache.write.usage.percentagePercentage of write cache in use%
controller_id#controller.cache.write.hits.persecondFor the controller that owns the volume, the number of times the block written to is found in cache
controller_id#controller.cache.write.misses.persecondFor the controller that owns the volume, the number of times the block written to is not found in cache
controller_id#controller.cache.read.hits.persecondFor the controller that owns the volume, the number of times the block to be read is found in cache
controller_id#controller.cache.read.misses.persecondFor the controller that owns the volume, the number of times the block to be read is not found in cache
controller_id#controller.cpu.utilization.percentagePercentage of time the CPU is busy%

Prerequisites​

To control your Dell ME4, the Rest API must be configured.

E.g: https://www.dell.com/support/manuals/fr-fr/powervault-me4024/me4_series_cli_pub/using-a-script-to-access-the-cli?guid=guid-9ae5ccd6-a207-42df-b2f3-1e02a487a354&lang=en-us

Setup​

  1. Install the Centreon Plugin on every Poller:
yum install centreon-plugin-Hardware-Storage-Dell-Me4-Restapi
  1. On the Centreon Web interface in Configuration > Monitoring Connector Manager, install the Dell Me4 Rest API Pack

Host configuration​

  • Add a new Host and fill the IP Address/FQDN, SNMP Version and SNMP Community fields according to the device's configuration
  • Apply the HW-Storage-Dell-Me4-Restapi-custom Host Template

Once the template applied, some Macros have to be configured:

MandatoryNameDescription
XAPIPORTPort used (Default: 443)
XAPIPROTOSpecify https if needed (Default: 'https')
XAPIUSERNAMEApi username
XAPIPASSWORDApi password
APIEXTRAOPTIONSAny 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 Centreon Poller CLI using the centreon-engine user account and test the Plugin by running the following command (Parameters such as api-username or api-passwordhave to be adjusted):

/usr/lib/centreon/plugins/centreon_dell_me4_restapi.pl \
    --plugin=storage::dell::me4::restapi::plugin \
    --mode=interfaces \
    --hostname='10.30.2.79' \
    --port='443' \
    --proto='https' \
    --api-username='myapiusername' \
    --api-password='myapipassword' \
    --filter-port-name='A0' \
    --verbose

Expected command output is shown below:

OK: port 'A0' status: up [health: ok], read iops: 94.52, write iops: 161.11, read traffic: 1.29 Mb/s - All interfaces are ok | 'A0#port.io.read.usage.iops'=94.52iops;;;0; 'A0#port.io.write.usage.iops'=161.11iops;;;0; 'A0#port.traffic.read.usage.bitspersecond'=1287234b/s;;;0; 'A0~0#port.interface.disparity.errors.count'=0;;;0; 'A0~0#port.interface.lost.dwords.count'=0;;;0; 'A0~0#port.interface.invalid.dwords.count'=0;;;0; 'A0~1#port.interface.disparity.errors.count'=0;;;0; 'A0~1#port.interface.lost.dwords.count'=0;;;0; 'A0~1#port.interface.invalid.dwords.count'=0;;;0; 'A0~2#port.interface.disparity.errors.count'=0;;;0; 'A0~2#port.interface.lost.dwords.count'=0;;;0; 'A0~2#port.interface.invalid.dwords.count'=0;;;0; 'A0~3#port.interface.disparity.errors.count'=0;;;0; 'A0~3#port.interface.lost.dwords.count'=0;;;0; 'A0~3#port.interface.invalid.dwords.count'=0;;;0;
checking port 'A0'
    status: up [health: ok], read iops: 94.52, write iops: 161.11, read traffic: 1.29 Mb/s
    interface '0' disparity errors: 0, lost dwords: 0, invalid dwords: 0
    interface '1' disparity errors: 0, lost dwords: 0, invalid dwords: 0
    interface '2' disparity errors: 0, lost dwords: 0, invalid dwords: 0
    interface '3' disparity errors: 0, lost dwords: 0, invalid dwords: 0

The command above monitors interfaces statistics (--mode=interfaces).

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 443 (--port='443') using https (--proto='https').

All the options as well as all the available thresholds can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_dell_me4_restapi.pl \
    --plugin=storage::dell::me4::restapi::plugin \
    --mode=interfaces \
    --help

Troubleshooting​

Troubleshooting plugins