NetApp ONTAP Monitoring
Last updated on 30 April, 2025The NetApp ONTAP monitoring suite for LogicMonitor provides comprehensive visibility into the health, performance, and availability of NetApp ONTAP storage systems. By leveraging the ONTAP REST API, the suite delivers in-depth monitoring of system components including RAID configurations, volumes, aggregates, disks, network interfaces, sensors, and power supplies.
This monitoring suite helps IT teams detect and resolve issues proactively, optimize performance, and maintain high availability by tracking metrics such as cluster performance, latency, throughput, disk utilization, and system state. The modules integrate seamlessly into LogicMonitor’s platform, enabling automated discovery and alerting across NetApp ONTAP environments.
Important: Enabling ONTAP REST API may disable ZAPI functionality, preventing ZAPI-based modules from working. ONTAP versions 9.17 or later no longer support ZAPI-based modules. For more information on upgrading your modules, see Migrating from ZAPI-Based to REST API-Based NetApp ONTAP Modules.
The NetApp ONTAP monitoring suite is primarily classified under Storage Systems due to its focus on aggregates, RAID groups, volumes, and disk performance. Its support for system-wide metrics—such as power, temperature, and network interfaces—also makes it relevant to Server and Operations Hardware.
The suite uses the NetApp ONTAP REST API overHTTPS (port 443) to collect performance and health data efficiently and with minimal impact.
Key capabilities include the following:
- Clustered Storage Monitoring–Tracks performance across multiple nodes in a NetApp cluster.
- RAID and Disk Monitoring–Monitors health, utilization, and potential failures.
- Latency and Throughput Analysis–Captures IOPS, read/write rates, and system latency.
- Sensor-Based Alerts–Monitors environmental data like temperature and power supply status.
Together, these features provide a scalable, API-driven monitoring solution for enterprise storage environments.
Compatibility
Supported environments and features for NetApp ONTAP monitoring include the following:
- NetApp ONTAP Versions–9.13 or later
For more information, see ONTAP 9 from NetApp. - Supported Platforms–NetApp AFF, NetApp FAS, ONTAP Select.
- Operating Systems–Clustered ONTAP environments.
- API Access–REST API-based data collection.
- Monitoring Scope–Storage aggregates, volumes, RAID groups, disks, network interfaces, and hardware sensors.
Requirements for NetApp ONTAP Monitoring
To successfully deploy the NetApp ONTAP monitoring package, ensure the following compatibility and setup requirements are met:
- LogicMonitor Collector–Version 32.400 or later
For more information, see NetApp ONTAP. - API Access–Valid credentials (API key or service account) for REST API access.
- Network Access–Communication between LMCol and NetApp ONTAP over HTTPS (port 443).
- User Permissions–Account must haveread-only access.
- API Authentication–Valid NetApp ONTAP API key or service account with read-only access.
Security Considerations
To maintain security and limit access scope when using API credentials for NetApp ONTAP monitoring, keep the following in mind:
- If using a service account, ensure it has the minimum necessary privileges to access monitoring data.
- Do not use accounts with admin or elevated privileges.
- All API communication occurs over HTTPS (port 443) for secure data transmission.
- API users should have read-only permissions to prevent unintended modifications to NetApp ONTAP configurations.
Assigning Properties to Resources
To ensure proper functionality of the LogicModules in this suite, assign the following properties to your NetApp ONTAP resources:
Properties | Info |
netapp.api.username | Username for API authentication |
netapp.api.password | Password or API key for authentication |
Recommendation: Do not use admin accounts for monitoring. Use read-only roles with minimal privileges.
Considerations
Review the following considerations to ensure optimal performance and reliable data collection:
- Performance Impact–Excessive polling intervals or frequent API requests can introduce overhead on NetApp ONTAP systems. Adjust polling frequencies appropriately to balance data freshness and system performance.
- User Permissions–Ensure the monitoring account has the correct read-only permissions to avoid API authentication issues and incomplete data retrieval.
Adding Resources into Monitoring
To add your NetApp resources into monitoring, follow the standard process for adding devices in LogicMonitor. For more information, see Adding Resources.
Ensure that the necessary properties and credentials are configured for NetApp resources to enable proper monitoring and data collection. For more information, see Assigning Properties to Resources.
Import LogicModules
Install all NetApp ONTAP LogicModules from the Exchange. For more information, see LogicModules in Package. If these LogicModules are already present, ensure you have the most recent version of each module.
LogicModules in Package
LogicMonitor’s package for NetApp ONTAP consists of the following LogicModules. For full coverage, import the following LogicModules into your platform:
Display Name | Type | Description |
NetApp_ONTAP_Raid | DataSource | Monitors RAID performance metrics on NetApp servers. |
NetApp_ONTAP_FanSensors | DataSource | Monitors fan sensors for RPM values on NetApp servers. |
NetApp_ONTAP_Volumes | DataSource | Monitors volume storage and performance metrics on NetApp servers. |
NetApp_ONTAP_ShelfBayHealth | DataSource | Monitors shelf bay health status on NetApp servers. |
NetApp_ONTAP_Aggregate | DataSource | Monitors NetApp aggregate performance metrics. |
NetApp_ONTAP_ClusterPerformance | DataSource | Monitors total cluster performance using the NetApp ONTAP API. |
NetApp_ONTAP_PowerSensors | DataSource | Monitors power sensors for voltage, amperage, and wattage on NetApp servers. |
NetApp_ONTAP_Disks | DataSource | Monitors NetApp server disk performance metrics. |
addCategory_NetApp | PropertySource | Identifies the NetApp host, discovers SSL usage and mode, assigns a category. |
When setting static datapoint thresholds on the various metrics tracked by this package’s DataSources, LogicMonitor follows the technology owner’s best practice KPI recommendations.
Recommendation: If necessary, adjust these predefined thresholds to meet the unique needs of your environment. For more information on tuning datapoint thresholds, see Tuning Static Thresholds for Datapoints.
Migrating from ZAPI-Based to REST API-Based NetApp ONTAP Modules
To maintain compatibility and ensure continued data collection, you must migrate from ZAPI-based modules to the new REST API-based modules. For more information and details about , see Learn more about the ONTAP REST API from NetApp.
To understand the differences between ZAPI and REST API modules, see the following table:
Feature | ZAPI-Based Modules | REST API-Based Modules |
System Category | NetApp_ClusterMode | NetApp_ONTAP |
Authentication Properties | netapp.user / netapp.pass | netapp.rest.user / netapp.rest.pass |
API Compatibility | Deprecated in newer ONTAP versions | Required in ONTAP 9.13+; may disable ZAPI on enablement |
Note: Both system categories can coexist on the same device to support a phased migration.
Enabling REST API-Based Modules for NetApp ONTAP Monitoring
- In LogicMonitor, navigate to Resources and select the NetApp ONTAP resource you want to update.
- In the Info tab, do the following:
- Add the following authentication properties for REST API access:
netapp.rest.user: <Your REST API Username>
netapp.rest.pass: <Your REST API Password or API Key> - Add
NetApp_ONTAP
to ensure both ZAPI-based and REST API-based modules can collect data simultaneously. See the following example to enable REST API-based module discovery:system.categories: NetApp_ONTAP
- Add the following authentication properties for REST API access:
- Navigate to Modules > Exchange.
- Select Import LogicModules and import the latest REST API-based NetApp ONTAP modules.
- Assign the new modules to the appropriate resources by confirming that the
NetApp_ONTAP
category is present. - Verify REST API access on the NetApp ONTAP system:
- Confirm that the REST API is enabled and accessible.
- Use the REST API credentials added in Step 2 to test authentication.
- In LogicMonitor, verify that the new REST API-based modules are collecting data:
- Open a REST-based DataSource (For example,
NetApp_ONTAP_Volumes
). - Confirm that data points are populating correctly.
- Check for any authentication or communication errors.
- Open a REST-based DataSource (For example,
- Monitor the system for any impact to ZAPI-based modules:
- On some NetApp systems, enabling the REST API may automatically disable ZAPI.
- If ZAPI is disabled, data collection for legacy modules stops.
- Plan accordingly to ensure uninterrupted monitoring during the transition.
Note: By completing this procedure, both the old and new LogicModules can collect data in parallel, allowing for a seamless migration to REST API-based monitoring.
Disabling Legacy ZAPI-Based Modules for NetApp ONTAP Monitoring
- In LogicMonitor, navigate to Resources and select the NetApp ONTAP resources where REST-based monitoring is active.
- In the Info tab, remove the following ZAPI authentication properties:
netapp.user: Remove this property
netapp.pass: Remove this property - Confirm that REST API-based modules are collecting data as expected:
- Open a REST-based DataSource (for example,
NetApp_ONTAP_Aggregate
orNetApp_ONTAP_LUNs
). - Check for active data streams and verify that performance metrics are populating.
- Ensure there are no authentication or polling errors.
- Open a REST-based DataSource (for example,
- Monitor the transition to prevent any data collection gaps:
- Compare metric coverage between old and new modules.
- Verify that all required monitoring is fully handled by the REST API-based modules.
- Remove the old system category:
- In the Info tab, delete the following
NetApp_ClusterMode
fromsystem.categories:
system.categories: <Remove NetApp_ClusterMode>
- In the Info tab, delete the following
- Verify the following:
NetApp_ClusterMode
is no longer assigned to any resources.- No ZAPI-based modules are still collecting data.
- The monitoring environment is fully migrated to REST API-based modules.
The legacy module data collection is disabled data collection.