Skip to main content

NetApp Ontap Rest API

Overview

ONTAP or Data ONTAP or Clustered Data ONTAP (cDOT) or Data ONTAP 7-Mode is NetApp's proprietary operating system used in storage disk arrays such as NetApp FAS and AFF, ONTAP Select and Cloud Volumes ONTAP

Plugin-Pack assets

Monitored objects

  • Aggregates
  • Cluster
  • Hardware
  • Luns
  • Quotas
  • Snapmirrors
  • Volumes

Discovery rules

Rule nameDescription
HW-Storage-Netapp-Ontap-Restapi-Volume-NameDiscover volumes attached to your storage

Monitored metrics

Metric NameUnit
aggregate_name#aggregate.space.usage.bytesB
aggregate_name#aggregate.space.free.bytesB
aggregate_name#aggregate.space.usage.percentage%
aggregate_name#aggregate.io.read.usage.bytespersecondB/s
aggregate_name#aggregate.io.write.usage.bytespersecondB/s
aggregate_name#aggregate.io.other.usage.bytespersecondB/s
aggregate_name#aggregate.io.total.usage.bytespersecondB/s
aggregate_name#aggregate.io.read.usage.iopsiops
aggregate_name#aggregate.io.write.usage.iopsiops
aggregate_name#aggregate.io.other.usage.iopsiops
aggregate_name#aggregate.io.total.usage.iopsiops
aggregate_name#aggregate.io.read.latency.microsecondsµs
aggregate_name#aggregate.io.write.latency.microsecondsµs
aggregate_name#aggregate.io.other.latency.microsecondsµs
aggregate_name#aggregate.io.total.latency.microsecondsµs

Prerequisites

NetApp ONTAP configuration

A read-only account (login/password) is required.

Setup

  1. Install the Centreon Plugin package on every Centreon poller expected to monitor NetApp ONTAP ressources:
yum install centreon-plugin-Hardware-Storage-Netapp-Ontap-Restapi
  1. On the Centreon Web interface, install the 'NetApp Ontap Rest API' Centreon Plugin-Pack on the "Configuration > Plugin Packs > Manager" page

Configuration

  • Log into Centreon and add a new Host through "Configuration > Hosts".
  • Apply the template HW-Storage-NetApp-Ontap-Restapi-custom and configure all the Macros:
MandatoryNomDescription
XAPIPORTPort used. Default is 443
XAPIPROTOProtocol used. Default is https
XAPIUSERNAMEUsername to access to the API.
XAPIPASSWORDPassword to access to the API.
APIEXTRAOPTIONSAny extra option you may want to add to the command

FAQ

How do I test my configuration through the CLI and what do the main parameters stand for ?

Once the Centreon plugin installed, you can test it logging with the centreon-engine user:

/usr/lib/centreon/plugins/centreon_netapp_ontap_restapi.pl \    
--plugin=storage::netapp::ontap::restapi::plugin \
--hostname=netapp.centreon.com \
--port=443 \
--proto=https \
--api-username='admin' \
--api-password='xxxx' \
--mode=volumes \
--verbose

The command above checks the status of the volumes (--mode=volumes) of the NetApp storage netapp.centreon.com (--hostname=netapp.centreon.com) using the API username admin and the related password (--api-username='admin' --api-password='xxxx'). The API connection uses the HTTPS protocol (--proto=https) on the port 443 (--port=443).