NetApp ONTAP Monitoring

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
• ONTAP REST API
• 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

LogicModule	Unsupported Datapoints
NetApp_Cluster_Volumes	junction_path compression_space_saved deduplication_space_saved deduplication_space_shared percentage_compression_space_saved percentage_deduplication_space_saved percentage_total_space_saved total_space_saved
NetApp_Cluster_StorageAdapters	auto.adapter.part_number auto.adapter.serial_number ADT*_adapter types
NetApp_Cluster_GlobalPerformance	http_ops partner_ops system_ops
NetApp_Cluster_PSU	psu-location
NetApp_Cluster_Interfaces	broadcast_domain

Compatibility

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

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:

Role	Description
Read-only	Allows 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.

Property	Value
netapp.rest.user	REST API username
netapp.rest.pass	REST API password

Ports

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.

• 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:
    https://<cluster_mgmt_ip_address>/api
  • 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: 
https://<cluster_mgmt_ip_address>/docs/api

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

Troubleshooting

• 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 Name	Type	Description
addCategory_NetApp	PropertySource	Identifies 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_CIFS	DataSource	Monitors NetApp CIFS (Common Internet File System) performance metrics.
NetApp_Cluster_GlobalPerformance	DataSource	Monitors NetApp global performance.
NetApp_Cluster_Interfaces	DataSource	NetApp interface statistics using 64 bit counters
NetApp_Cluster_Nodes	DataSource	Monitors NetApp cluster nodes uptime, environment temperature status and failed components.
NetApp_Cluster_PSU	DataSource	Monitors NetApp power supply unit operating status.
NetApp_Cluster_QTree	DataSource	Monitors the current operating state of the QTree.
NetApp_Cluster_StorageAdapters	DataSource	Monitors the NetApp host storage adapters health and performance metrics.
NetApp_Cluster_SVM	DataSource	Monitors the storage virtual machines (SVM) operating status.
NetApp_Cluster_SVMPeers	DataSource	Monitors the SVM peer relationship state.
NetApp_Cluster_Volumes	DataSource	Monitors NetApp volumes storage and performance metrics.

LogicModules Pending Review

Display Name	Type	Description
NetApp_Cluster_VoltageSensors	DataSource	Monitors environmental voltage sensor readings and operating status.
NetApp_Cluster_CurrentSensors	DataSource	Monitors NetApp current sensor operating status and amperage readings.
NetApp_Cluster_TemperatureSensors	DataSource	Monitors environmental temperature value and sensor operating status.
NetApp_Cluster_PolicyGroups	DataSource	Monitors the NetApp Policy Group performance metrics.
NetApp_Cluster_iSCSI	DataSource	Monitors iSCSI interface performance metrics such as IOPS, throughput, latency, SCSI commands, login activity and errors.
NetApp_Cluster_BatteryLifeSensors	DataSource	Monitors battery life metrics and associated sensor statuses.
NetApp_Cluster_FanSensors	DataSource	Monitors fan speeds, health, and operating statuses of cluster fans.
NetApp_Cluster_ShelfBayHealth	DataSource	Monitors the health and performance metrics of individual shelf bays in a NetApp cluster.