<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: NetApp Volume Sensor

IMPORTANT INFORMATION

This sensor supports NetApp cDOT as of version 8.3 or ONTAP from version 9.0 to version 9.5. If you want to use ONTAP as of version 9.6, use the NetApp Volume v2 sensor instead. The NetApp Volume v2 sensor is currently part of the Beta Sensors experimental feature of PRTG. For more information, see the Knowledge Base: What are beta sensors and how can I use them?

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).

NetApp Volume Sensor

NetApp Volume Sensor

i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

  • 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

Remarks

  • 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.

Detailed Requirements

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).

i_round_redIf the framework is missing, you cannot create this sensor.

i_square_cyanFor 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

Add Sensor

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. 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

NetApp Connection

NetApp Connection

Setting

Description

NetApp Credentials

Specify which credentials you want to use to connect to the NetApp API:

  • Use explicit credentials: Use individual NetApp API credentials.
  • Use Windows credentials from parent device: Use the credentials (User Name and Password) in the parent device settings in section Credentials for Windows Systems.
    i_round_blueDefining credentials in the parent device is useful if you add several NetApp sensors to this device because you do not need to individually enter credentials for each NetApp sensor.

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.

i_round_blueRead-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. 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:

  • HTTP: Use an unsecured HTTP connection.
  • HTTPS: Use a secure connection to the defined port to send the query.

Timeout (Sec.)

Enter a timeout in seconds for the request. Enter an integer. The maximum timeout value is 900 seconds (15 minutes).

i_round_blueIf 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.

NetApp Specific

i_round_blueThe 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.

i_round_blueEnable 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.

i_round_blueVolumes that are offline do not appear in this list.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

Sensor Name

Enter a name to identify the sensor.

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe.

i_round_blueThis 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.

i_round_blueIt is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).

i_round_blueFor 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:

  • netapp
  • cdot
  • ontap
  • soap

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 (i_priority_1) to the highest priority (i_priority_5).

i_round_blueUsually, 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.

NetApp Connection

NetApp Connection

NetApp Connection

Setting

Description

NetApp Credentials

Specify which credentials you want to use to connect to the NetApp API:

  • Use explicit credentials: Use individual NetApp API credentials.
  • Use Windows credentials from parent device: Use the credentials (User Name and Password) in the parent device settings in section Credentials for Windows Systems.
    i_round_blueDefining credentials in the parent device is useful if you add several NetApp sensors to this device because you do not need to individually enter credentials for each NetApp sensor.

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.

i_round_blueRead-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. 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:

  • HTTP: Use an unsecured HTTP connection.
  • HTTPS: Use a secure connection to the defined port to send the query.

Timeout (Sec.)

Enter a timeout in seconds for the request. Enter an integer. The maximum timeout value is 900 seconds (15 minutes).

i_round_blueIf the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message.

NetApp Specific

NetApp Specific

NetApp Specific

Setting

Description

Volumes

Shows the volume that this sensor monitors.

i_round_bluePRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

  • Discard result: Do not store the sensor result.
  • Store result: Store the last sensor result in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file names are Result of Sensor [ID].Data.txt and Result of Sensor [ID].log. This setting is for debugging purposes. PRTG overwrites these files with each scanning interval.

i_podThis option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.

i_round_blueIn a cluster, PRTG stores the result in the PRTG data directory of the master node.

Sensor Display

Sensor Display

Sensor Display

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.

i_round_blueYou can set a different primary channel later by clicking b_channel_primary below a channel gauge on the sensor's Overview tab.

Graph Type

Define how different channels are shown for this sensor:

  • Show channels independently (default): Show a graph for each channel.
  • Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
    i_round_redYou cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).

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.

Inherited Settings

By default, all of these 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 b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

Scanning Interval

Scanning Interval

i_square_cyanFor more information, see section Root Group Settings, section Scanning Interval.

Schedules, Dependencies, and Maintenance Window

i_round_blueYou 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.

Schedules, Dependencies, and Maintenance Window

Schedules, Dependencies, and Maintenance Window

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:

  • None
  • Saturdays
  • Sundays
  • Weekdays
  • Weekdays Eight-To-Eight (08:00 - 20:00)
  • Weekdays Nights (17:00 - 09:00)
  • Weekdays Nights (20:00 - 08:00)
  • Weekdays Nine-To-Five (09:00 - 17:00)
  • Weekends

i_round_blueYou 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:

  • Do not set up a one-time maintenance window: Do not set up a one-time maintenance window. Monitoring is always active.
  • Set up a one-time maintenance window: Set up a one-time maintenance window and pause monitoring. You can define a time span for the pause below.

i_round_blueTo 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:

  • Use parent: Use the dependency type of the parent object.
  • Select a sensor: Use the dependency type of the parent object. Additionally, pause the current object if a specific sensor is in the Down status or in the Paused status because of another dependency.
  • Master sensor for parent: Make this sensor the master object for its parent device. The sensor influences the behavior of its parent device: If the sensor is in the Down status, the device is paused. For example, it is a good idea to make a Ping sensor the master object for its parent device to pause monitoring for all other sensors on the device in case the device cannot even be pinged. Additionally, the sensor is paused if the parent group is paused by another dependency.

i_round_blueTo 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 b_search_light 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.

i_round_redThis 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.

Access Rights

Access Rights

Access Rights

i_square_cyanFor more information, see section Root Group Settings, section Access Rights.

Channel List

i_round_blueWhich channels the sensor actually shows might depend on the target 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

i_round_blueThis 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

More

i_square_blueKnowledge Base

Which .NET version does PRTG require?

What security features does PRTG include?