PRTG Manual: NetApp System Health Sensor

IMPORTANT INFORMATION

This sensor supports NetApp cDOT as of version 8.3 or ONTAP from versions 9.0 to 9.12. If you use ONTAP as of version 9.6, we recommend that you use the NetApp System Health v2 sensor.

The NetApp System Health sensor monitors the health of a NetApp cDOT or ONTAP storage system accessing the application programming interface (API) via the Simple Object Access Protocol (SOAP).

NetApp System Health Sensor

NetApp System Health 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 Systeemstatus
  • French: NetApp état du système
  • German: NetApp Systemzustand
  • Japanese: NetApp システム正常性
  • Portuguese: Saúde do sistema NetApp
  • Russian: Работоспособность системы NetApp
  • Simplified Chinese: NetApp 系统健康状况
  • Spanish: Salud de sistema NetApp

Remarks

Consider the following remarks and requirements for this sensor:

Remark

Description

Enabled ONTAPI access

The ONTAPI user account that you use with this sensor requires access to the DATA ONTAP API (ONTAPI) so that the sensor can request data from it. The access is enabled by default.

i_round_blueIf 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

i_round_blueThis sensor requires administrator rights 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

.NET 4.7.2 or later

This sensor requires .NET 4.7.2 or later from Microsoft on the probe system. In a cluster, install it on every cluster node.

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?

NetApp versions

This sensor supports NetApp cDOT as of version 8.3 and NetApp ONTAP as of version 9.0.

IPv6

This sensor supports IPv6.

Performance impact

This sensor has a very low performance impact.

Read-only

As an alternative to administrator rights, you can add a specific Role Attribute and use read-only rights.

Credentials

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.

Lookups

This sensor uses lookups to determine the status values of one or more channels.

Limits

This sensor has predefined limits for several metrics.

Basic Sensor Settings

Basic Sensor Settings

Basic Sensor Settings

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

  • cdot
  • netapp
  • ontap
  • soap

i_square_cyanFor more information about basic sensor settings, see section 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

System Nodes

The ID of the system node that this sensor monitors.

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

  • Discard result (default): Do not store the sensor result.
  • Store result: Store the sensor result and the last response in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file names are Result of Sensor [ID].txt, 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, PRTG displays the last value of the primary channel 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 this sensor shows different channels:

  • 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 select Stack channels on top of each other above.

Select a unit from the list. PRTG stacks all channels with this unit 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.

Permissions: Alternative to Administrator Rights

If you do not want to provide administrator rights for the ONTAPI user account that you use with the NetApp System Health sensor, you can add a new command to the selected role of the user that makes read-only rights sufficient.

  • Edit the Role of this user in the console under Cluster | ClusterX | Configuration | Security | Users.
  • Add the command storage aggregate check_spare_low with access control list (ACL) all to the Role Attributes.

With this role attribute, read-only rights are sufficient for the NetApp System Health sensor.

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

CPU

The CPU load (%)

i_round_blueThis channel is the primary channel by default.

i_round_blueThis channel has default limits:

  • Upper error limit: 90%
  • Upper warning limit: 80%

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.

Failed Fans

The number of failed fans

i_round_blueThis channel has default limits:

  • Upper error limit: 2
  • Upper warning limit: 1

Failed PSU

The number of failed power supplies

i_round_blueThis channel has default limits:

  • Upper error limit: 2
  • Upper warning limit: 1

Memory

The memory usage

Node Health

The node health

  • Up status: OK
  • Down status: Error

NVRAM Battery

The NVRAM battery status

  • Up status: OK
  • Down status: Error

Spare Disks #

The number of spare disks

Spare Disks Low

If spare disks are low as reported by the NetApp

  • Up status: No
  • Down status: Yes

Spare Size Usable

The usable spare size

Storage Configuration Path

The storage configuration path that describes the connection of a node

  • Up status: multi_path, multi_path_ha, quad_path, quad_path_ha, N/A
  • Warning status: single_path, single_path_ha, mixed_path, mixed_path_ha
  • Down status: unknown

i_round_blueIf no storage configuration path is returned, the sensor shows the Up status (N/A) because the availability of the configuration path depends on the NetApp version.

Temperature

The temperature status

  • Up status: OK
  • Down status: Error

Uptime

The uptime

More

i_square_blueKNOWLEDGE BASE

Which .NET version does PRTG require?

What security features does PRTG include?