PRTG Manual: NetApp Volume Sensor
The NetApp Volume sensor monitors volumes on a NetApp cDOT or ONTAP storage system accessing the application programming interface (API) via the Simple Object Access Protocol (SOAP).
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: NetApp Volume
- French: NetApp volume de stockage
- German: NetApp Volume
- Japanese: NetApp ボリューム
- Portuguese: NetApp Volume
- Russian: Том NetApp
- Simplified Chinese: NetApp 卷
- Spanish: Volumen de NetApp
- This sensor requires Microsoft .NET 4.7.2 or later on the probe system.
- The ONTAPI user account that you use with this sensor requires access to DATA ONTAP API (ONTAPI) so that the sensor can request data from it. The access is enabled by default.
- For this sensor, read-only user rights are sufficient for the ONTAPI user account that you use to access ONTAPI. Modify or add this user with a suitable role in the console under Cluster | ClusterX | Configuration | Security | Users
- This sensor supports NetApp cDOT as of version 8.3 and NetApp ONTAP as of version 9.0.
- This sensor supports the IPv6 protocol.
- This sensor has a very low performance impact.
- You can define NetApp API credentials (User Name and Password) in the credentials for Windows systems settings of the parent device. This way, you do not need to individually enter credentials for each NetApp sensor that you add to the same device.
Requirement |
Description |
---|---|
.NET 4.7.2 or later |
This sensor requires .NET 4.7.2 or later to be installed on the probe system (on every cluster node, if on a cluster probe). If the framework is missing, you cannot create this sensor. For more information, see the Knowledge Base: Which .NET version does PRTG require? |
Enabled ONTAPI access |
NetApp sensors require access to ONTAPI for the utilized user account. This is enabled by default. If access is disabled, locally use the following command on the cluster console to enable ONTAPI access for the user: services web> modify -vserver clusterd -name ontapi -enabled true |
The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. Therefore, you do not see all settings in this dialog. You can change nearly all settings on the sensor's Settings tab after creation.
PRTG performs a meta-scan before you can add this sensor and requires basic information in advance. Provide the required information in the dialog box that appears. PRTG then recognizes all items that are available for monitoring based on your input.
NetApp Connection
Setting |
Description |
---|---|
NetApp Credentials |
Specify which credentials you want to use to connect to the NetApp API:
|
User Name |
This setting is only visible if you select Use explicit credentials above. Enter a user name for access to the NetApp API. Enter a string. Read-only rights for this ONTAP user account are sufficient. |
Password |
This setting is only visible if you select Use explicit credentials above. Enter the password of the user for access to the NetApp API. Enter a string. |
Port |
Enter a port number on which you can access the NetApp API. Enter an integer value. The default port is 443. |
Connection Security |
Define if the connection to the NetApp API is Secure Sockets Layer (SSL)/Transport Layer Security (TLS) secured:
|
Timeout (Sec.) |
Enter a timeout in seconds for the request. Enter an integer value. The maximum timeout value is 900 seconds (15 minutes). If the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message. Click OK to define the sensor settings. |
The settings that you select in the Add Sensor dialog are valid for all sensors that you create when you finish the dialog.
Setting |
Description |
---|---|
Volumes |
Select the volumes that you want to monitor. PRTG creates one sensor for each volume that you select. Enable check boxes in front of the respective lines to select the items. Use the check box in the table header to select all items or to cancel the selection. In large tables, use the search function in the upper-right corner. Volumes that are offline do not appear in this list. |
Click the Settings tab of a sensor to change its settings.
Setting |
Description |
---|---|
Sensor Name |
Enter a meaningful name to identify the sensor. |
Parent Tags |
Shows tags that the sensor inherits from its parent device, parent group, and parent probe. This setting is for your information only. You cannot change it. |
Tags |
Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited. It is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>). For performance reasons, it can take some minutes until you can filter for new tags that you added. The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
|
Priority |
Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority () to the highest priority (). |
Usually, a sensor connects to the IP Address/DNS Name of the parent device. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings.
Setting |
Description |
---|---|
NetApp Credentials |
Specify which credentials you want to use to connect to the NetApp API:
|
User Name |
This setting is only visible if you select Use explicit credentials above. Enter a user name for access to the NetApp API. Enter a string. Read-only rights for this ONTAP user account are sufficient. |
Password |
This setting is only visible if you select Use explicit credentials above. Enter the password of the user for access to the NetApp API. Enter a string. |
Port |
Enter a port number on which you can access the NetApp API. Enter an integer value. The default port is 443. |
Connection Security |
Define if the connection to the NetApp API is Secure Sockets Layer (SSL)/Transport Layer Security (TLS) secured:
|
Timeout (Sec.) |
Enter a timeout in seconds for the request. Enter an integer value. The maximum timeout value is 900 seconds (15 minutes). If the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message. |
NetApp Specific
Setting |
Description |
---|---|
Volumes |
Shows the volume that this sensor monitors. PRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew. |
Setting |
Description |
---|---|
Result Handling |
Define what PRTG does with the sensor result:
This option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance. In a cluster, PRTG stores the result in the PRTG data directory of the master node. |
Setting |
Description |
---|---|
Primary Channel |
Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor. You can set a different primary channel later by clicking below a channel gauge on the sensor's Overview tab. |
Graph Type |
Define how different channels are shown for this sensor:
|
Stack Unit |
This setting is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are stacked on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so. |
By default, all of the following settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click under the corresponding setting name to disable the inheritance and to display its options.
For more information, see section Inheritance of Settings.
Click to interrupt the inheritance.
Setting |
Description |
---|---|
Scanning Interval |
Select a scanning interval from the dropdown list. The scanning interval determines the amount of time that the sensor waits between two scans. Choose from:
You can change the available intervals in the system administration of PRTG Network Monitor. |
If a Sensor Query Fails |
Select the number of scanning intervals that the sensor has time to reach and to check a device again if a sensor query fails. Depending on the option that you select, the sensor can try to reach and to check a device again several times before the sensor shows the Down status. This can avoid false alarms if the monitored device only has temporary issues. For previous scanning intervals with failed requests, the sensor shows the Warning status. Choose from:
Sensors that monitor via Windows Management Instrumentation (WMI) always wait at least one scanning interval before they show the Down status. It is not possible to immediately set a WMI sensor to the Down status, so the first option does not apply to these sensors. All other options can apply. If you define error limits for a sensor's channels, the sensor immediately shows the Down status. None of the interval options apply. If a channel uses lookup values, the sensor immediately shows the Down status. None of the interval options apply. |
Schedules, Dependencies, and Maintenance Windows
You cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.
Setting |
Description |
---|---|
Schedule |
Select a schedule from the list. You can use schedules to monitor during a certain time span (days or hours) every week. Choose from:
You can create schedules, edit schedules, or pause monitoring for a specific time span. For more information, see section Schedules. |
Maintenance Window |
Select if you want to set up a one-time maintenance window. During a maintenance window, monitoring stops for the selected object and all child objects. They show the Paused status instead. Choose between:
To terminate an active maintenance window before the defined end date, change the time entry in Maintenance Ends to a date in the past. |
Maintenance Begins |
This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the start date and time of the one-time maintenance window. |
Maintenance Ends |
This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the end date and time of the one-time maintenance window. |
Dependency Type |
Select a dependency type. You can use dependencies to pause monitoring for an object depending on the status of a different object. You can choose from:
To test your dependencies, select Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later, all dependent objects are paused. You can check all dependencies under Devices | Dependencies in the main menu bar. |
Dependency |
This setting is only visible if you enable Select a sensor above. Click and use the object selector to select a sensor on which the current object will depend. |
Dependency Delay (Sec.) |
This setting is only visible if you select Select a sensor above. Define a time span in seconds for the dependency delay. After the master sensor for this dependency returns to the Up status, PRTG additionally delays the monitoring of the dependent objects by the time span you define. This can prevent false alarms, for example, after a server restart or to give systems more time for all services to start. Enter an integer value. This setting is not available if you set this sensor to Use parent or to be the Master sensor for parent. In this case, define delays in the parent device settings or in its parent group settings. |
Click to interrupt the inheritance.
Setting |
Description |
---|---|
User Group Access |
Define the user groups that have access to the sensor. You see a table with user groups and group access rights. The table contains all user groups in your setup. For each user group, you can choose from the following group access rights:
For more details on access rights, see section Access Rights Management. |
Which channels the sensor actually shows might depend on the monitored device, the available components, and the sensor setup.
Channel |
Description |
---|---|
Busy Snapshots % |
The number of busy snapshots in percent |
Compression Savings % |
The compression savings in percent |
Compression Savings Bytes |
The compression savings in bytes |
Deduplication Savings % |
The deduplication savings in percent |
Deduplication Savings Bytes |
The deduplication savings in bytes |
Downtime |
In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status in percent. |
Files Free |
The free files in total |
Files Free % |
The free files in percent |
Latest Snapshot |
The age of the last snapshot |
Oldest Snapshot |
The age of the oldest snapshot |
Physical Bytes Free |
The free physical bytes in total |
Physical Bytes Free % |
The free physical bytes in percent |
Size Free |
The free size in total |
Size Free % |
The free size in percent This channel is the primary channel by default. |
Size Free For Snapshots |
The free size for snapshots |
Snapshot Reserve Free % |
The free snapshot reserve in percent |
Snapshots # |
The number of snapshots |
Total Savings % |
The total savings in percent |
Total Savings Bytes |
The total savings in bytes |
Knowledge Base
Which .NET version does PRTG require?
What security features does PRTG include?
For more information about sensor settings, see the following sections: