NetApp ONTAP Monitoring

Last updated on 04 October, 2023

Important: This package provides support for the transition from NetApp ONTAP (ZAPI) to NetApp ONTAP REST API. For more information, see the ONTAP REST API information and the End of availability: ONTAPI information from NetApp.

LogicMonitor’s NetApp ONTAP monitoring package leverages the NetApp ONTAP REST API to monitor and alert on the health and performance of NetApp storage systems. This package provides monitoring of your NetApp Cluster, ensuring the reliability and efficiency of your storage environment.

Technology Type

  • Storage Systems
  • Data Management
  • Data Protection
  • Storage Efficiency
  • Storage Virtualization
  • Unified Architecture

Technology Notes

The NetApp Cluster REST API allows monitoring of various aspects of NetApp storage systems, including volumes, aggregates, nodes, and other performance metrics. For more information about the NetApp ONTAP REST API, refer to the official documentation.

Unsupported Datapoints in REST API 9.11

LogicModuleUnsupported Datapoints
ADT*_adapter types


Important: This package provides support for the transition from NetApp ONTAP (ZAPI) to NetApp ONTAP REST API. For more information, see the ONTAP REST API information and the End of availability: ONTAPI information from NetApp.

As of March 2023, LogicMonitor’s NetApp ONTAP monitoring package is known to be compatible with NetApp ONTAP 9.11 or later.

Note: NetApp ONTAPI remains enabled if usage is detected. If usage is not detected, ONTAPI is disabled and can be manually reenabled. For concerns about transitioning to REST API, contact [email protected]. In addition, you can check the Software Version Support page for ONTAP support details.

Setup Requirements

Import the LogicMonitor_Collector_Snippets DataSource to ensure that your collector supports the code in this monitoring suite, or update to EA Collector 32.100 or later.

Satisfy Dependencies

Ensure the LogicMonitor Collector has access to the NetApp Cluster REST API endpoints.

Add Resources into Monitoring

Add your NetApp Cluster hosts into monitoring. For more information on adding resources into monitoring, see Adding Devices.

Obtain Credentials

LogicMonitor must provide the appropriate credentials to successfully access the NetApp Cluster REST API resource’s data. These credentials must belong to a user account that has been assigned the following minimum permissions:

Read-onlyAllows read access to the NetApp Cluster REST API

Assign Properties to Resources

The following custom properties must be set on the NetApp Cluster resource within LogicMonitor. For more information on setting properties, see Resource and Instance Properties.

PropertyValue API username API password


The NetApp REST API typically uses port 443 (HTTPS) for secure communication.

NetApp can support SSL if it is set up using the How to renew a Self-Signed SSL certificate in ONTAP 9 documentation from NetApp.

Import LogicModules

From the LogicMonitor public repository, import all NetApp Cluster REST API LogicModules. If these LogicModules are already installed, ensure you have the latest versions.

After the LogicModules are imported, data collection automatically begins.​

Other Requirements

  • Ensure you have a supported NetApp ONTAP version (9.12 or later) with REST API capabilities. 
    Use the cluster management LIF for accessing the REST API. This provides load balancing and avoids offline or connectivity issue affected nodes. Ensure the selected LIF supports the HTTPS management protocol and that the firewall configuration allows HTTPS traffic.

Important: Ensure the assigned user account has the appropriate permissions to access the NetApp Cluster REST API.

  • Test the ONTAP REST API endpoint.
    You can  use various tools (for example, Curl or Postman) or programming languages (for example, Python or PowerShell) to test the REST API endpoint.
    • Use the following base URL format to access the most recent version of the API, replacing <cluster_mgmt_ip_address> with your cluster management LIF IP address:
    • Use a GET request to retrieve cluster information with Curl, replace <username> and <password> with the appropriate credentials that have read access to the NetApp Cluster REST API:
      curl -k -u <username>:<password> -X GET https://<cluster_mgmt_ip_address>/api/cluster
      This command returns cluster information in JSON format if the setup is correct and the provided credentials have the required access.

You can access the ONTAP API online documentation page by navigating to the following URL: 

This documentation provides detailed information about the available API calls, including input parameters and options, organized into functional categories.

Important: API rate limits may apply, so be cautious when configuring the monitoring frequency. This only matters if there is other automation associated with the REST API.


  • Verify that the assigned user account has the correct permissions for accessing the NetApp ONTAP REST API.
  • Ensure that the Collector has network access to the NetApp ONTAP REST API endpoints.
  • Check if the custom properties are set correctly on the NetApp Cluster resource.

LogicModules in Package

LogicMonitor’s package for NetApp ONTAP monitoring consists of the following LogicModules. For full coverage, import all of the following LogicModules into your LogicMonitor platform:

Display NameTypeDescription
addCategory_NetAppPropertySourceIdentifies the NetApp host, discovers if SSL is being used, what mode its running in (7 mode or Cluster mode), and assigns a system category of either ‘NetApp_7Mode’ or ‘NetApp_ClusterMode’. In addition discovers REST API functionality and properties.
NetApp_Cluster_CIFSDataSourceMonitors NetApp CIFS (Common Internet File System) performance metrics.
NetApp_Cluster_GlobalPerformanceDataSourceMonitors NetApp global performance.
NetApp_Cluster_InterfacesDataSourceNetApp interface statistics using 64 bit counters
NetApp_Cluster_NodesDataSourceMonitors NetApp cluster nodes uptime, environment temperature status and failed components.
NetApp_Cluster_PSUDataSourceMonitors NetApp power supply unit operating status.
NetApp_Cluster_QTreeDataSourceMonitors the current operating state of the QTree.
NetApp_Cluster_StorageAdaptersDataSourceMonitors the NetApp host storage adapters health and performance metrics.
NetApp_Cluster_SVMDataSourceMonitors the storage virtual machines (SVM) operating status.
NetApp_Cluster_SVMPeersDataSourceMonitors the SVM peer relationship state.
NetApp_Cluster_VolumesDataSourceMonitors NetApp volumes storage and performance metrics.

LogicModules Pending Review

Display NameTypeDescription
NetApp_Cluster_VoltageSensorsDataSourceMonitors environmental voltage sensor readings and operating status.
NetApp_Cluster_CurrentSensorsDataSourceMonitors NetApp current sensor operating status and amperage readings.
NetApp_Cluster_TemperatureSensorsDataSourceMonitors environmental temperature value and sensor operating status.
NetApp_Cluster_PolicyGroupsDataSourceMonitors the NetApp Policy Group performance metrics.
NetApp_Cluster_iSCSIDataSourceMonitors iSCSI interface performance metrics such as IOPS, throughput, latency, SCSI commands, login activity and errors.
NetApp_Cluster_BatteryLifeSensorsDataSourceMonitors battery life metrics and associated sensor statuses.
NetApp_Cluster_FanSensorsDataSourceMonitors fan speeds, health, and operating statuses of cluster fans.
NetApp_Cluster_ShelfBayHealthDataSourceMonitors the health and performance metrics of individual shelf bays in a NetApp cluster.

In This Article