PRTG Manual: NetApp LIF Sensor

The NetApp LIF sensor monitors logical interfaces of a NetApp cDOT or ONTAP cluster accessing the application programming interface (API) via the Simple Object Access Protocol (SOAP).

The sensor can show the following:

  • Number of sent and received packets per second
  • Amount of sent and received data per second
  • Number of sent and received errors per second
  • Is home: the Up status when the logical interface (LIF) is on the home port, the Down status when it is not on the home port
NetApp LIF Sensor

NetApp LIF Sensor

Sensor in Other Languages

  • Dutch: NetApp LIF
  • French: LIF NetApp
  • German: NetApp LIF
  • Japanese: NetApp LIF
  • Portuguese: NetApp LIF
  • Russian: LIF NetApp
  • Simplified Chinese: NetApp LIF
  • Spanish: LIF de NetApp

Remarks

  • i_betaThis sensor is in beta status. The operating methods and the available settings can change at any time. Do not expect that all functions work properly, or that this sensor works as expected at all. Be aware that this sensor can be removed from PRTG at any time.
  • This sensor requires .NET 4.7.2 or later on the probe system.
  • The ONTAPI user account that you use with this sensor needs access to the 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 and Password) in the credentials for Windows systems settings of the parent device. This way, you do not have to individually enter credentials for each NetApp sensor that you add to the same device.
  • This sensor uses lookups to determine the status values of one or more channels. This means that possible states are defined in a lookup file. You can change the behavior of a channel by editing the lookup file that the channel uses. For details, see section Define Lookups.

Detailed Requirements

Requirement

Description

.NET Framework

This sensor requires the Microsoft .NET Framework. .NET 4.7.2 or later must 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.

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 setting fields that are required for creating the sensor. Therefore, you do not see all setting fields in this dialog. You can change (nearly) all settings in the sensor's Settings tab later.

PRTG performs a meta-scan before you can actually add this sensor and requires basic information for this scan in advance. Provide the requested information in the appearing dialog box. During the scan, PRTG recognizes all items available for monitoring based on your input. The following settings differ in comparison to the sensor's Settings tab.

Select the LIFs that you want to monitor. PRTG creates one sensor for each LIF that you select in the Add Sensor dialog. The settings you select are valid for all sensors that you create when you finish this dialog. The following settings in the Add Sensor dialog differ in comparison to the sensor's Settings tab.

NetApp Specific

Setting

Description

LIFs

Select the LIFs that you want to add a sensor for. You see a list with the names of all items that you can monitor. Add check marks in front of the respective lines to select the desired items. You can also use the check box in the table header to select all items or cancel the selection.

i_round_bluePRTG creates one sensor for each selection.

Basic Sensor Settings

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

i_round_blueUsually, a sensor connects to the IP Address or DNS Name of the parent device on which you created the sensor. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings. See below for details on available settings.

Setting

Description

Sensor Name

Enter a meaningful name to identify the sensor. By default, PRTG shows this name in the device tree, as well as in alarms, logs, notifications, reports, maps, libraries, and tickets.

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe. This setting is shown for your information only and cannot be changed here.

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

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

NetApp Connection

Setting

Description

NetApp Credentials

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

  • Use explicit credentials: Select this option if you want to use individual NetApp API credentials with this sensor.
  • Use Windows credentials from parent device: If you select this option, the sensor uses the credentials (User and Password) that you entered in the parent device settings in section Credentials for Windows Systems. Defining credentials in the parent device is useful if you add several NetApp sensors to this device because you do not have to individually enter credentials for each NetApp sensor.

Username

This setting is only visible if you select Use explicit credentials above. Enter a username for access to the NetApp API. Read-only rights for this ONTAP user account are sufficient. Enter a string.

Password

This setting is only visible if you select Use explicit credentials above. Enter the password of the user that you entered above 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:

  • 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. If the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message. Enter an integer value. The maximum value is 900 seconds (15 minutes).

NetApp Specific

Setting

Description

NetApp LIFs

Shows the ID of the LIF that this sensor monitors. Once you have created the sensor, you cannot change this value. It is shown for reference purposes only. If you need to change this value, add the sensor anew.

Debug Options

Setting

Description

Sensor Result

Define what PRTG does with the sensor results:

  • Discard sensor result: Do not store the sensor result.
  • Write sensor result to disk (file names: Result of Sensor [ID].*): Store the last result received from the sensor to the \Logs\sensors subfolder of the PRTG data directory on the probe system (master node, if in a cluster). File names: Result of Sensor [ID].* and Result of Sensor [ID].Data.*. This 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 by Paessler instance.

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 the following settings are inherited from objects that are higher in the hierarchy. You should 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. You then see the options described below.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

Click b_inherited_enabled 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:

  • 30 seconds
  • 60 seconds
  • 5 minutes
  • 10 minutes
  • 15 minutes
  • 30 minutes
  • 1 hour
  • 4 hours
  • 6 hours
  • 12 hours
  • 1 day

i_round_blueYou can change the available intervals in the system administration on PRTG on premises installations.

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:

  • Set sensor to down immediately: Set the sensor to the Down status immediately after the first request fails.
  • Set sensor to warning for 1 interval, then set to down (recommended): Set the sensor to the Warning status after the first request fails. If the second request also fails, the sensor shows the Down status.
  • Set sensor to warning for 2 intervals, then set to down: Set the sensor to the Down status only after the third request fails.
  • Set sensor to warning for 3 intervals, then set to down: Set the sensor to the Down status only after the fourth request fails.
  • Set sensor to warning for 4 intervals, then set to down: Set the sensor to the Down status only after the fifth request fails.
  • Set sensor to warning for 5 intervals, then set to down: Set the sensor to the Down status only after the sixth request fails.

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

i_round_blueIf you define error limits for a sensor's channels, the sensor immediately shows the Down status. None of the interval options apply.

i_round_blueIf a channel uses lookup values, the sensor immediately shows the Down status. None of the interval options apply.

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.

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

  • Not set (monitor continuously): 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 a 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 enable 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.

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

Click b_inherited_enabled 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:

  • Inherited: Inherit the access rights settings of the parent object.
  • No access: Users in this user group cannot see or edit the sensor. The sensor neither shows up in lists nor in the device tree.
  • Read access: Users in this group can see the sensor and view its monitoring results. They cannot edit any settings.
  • Write access: Users in this group can see the sensor, view its monitoring results, and edit its settings. They cannot edit its access rights settings.
  • Full access: Users in this group can see the sensor, view its monitoring results, edit its settings, and edit its access rights settings.

i_square_cyanFor more details on access rights, see section Access Rights Management.

More

i_square_blueKNOWLEDGE BASE

Which .NET version does PRTG require?

Sensor Settings Overview

For more information about sensor settings, see the following sections: