The NetApp SnapMirror sensor monitors SnapMirror relationships of a NetApp cDOT or ONTAP storage system accessing the application programming interface (API) via the Simple Object Access Protocol (SOAP).
NetApp SnapMirror Sensor
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
Sensor in Other Languages
Dutch: NetApp SnapMirror
French: NetApp SnapMirror
German: NetApp SnapMirror
Japanese: NetApp SnapMirror
Portuguese: NetApp SnapMirror
Russian: NetApp SnapMirror
Simplified Chinese: NetApp SnapMirror
Spanish: NetApp SnapMirror
Remarks
This sensor requires .NET 4.7.2 or later from Microsoft 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 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.
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 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.
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:
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
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. Defining 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.
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. 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).
If the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message.
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
SnapMirror
Select the SnapMirrors that you want to monitor. PRTG creates one sensor for each SnapMirror 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.
Basic Sensor Settings
Click the Settings tab of a sensor to change its settings.
If the name contains angle brackets (<>), PRTG replaces them with braces ({}) for security reasons. For more information, see the Knowledge Base: What security features does PRTG include?
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:
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 () 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.
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. Defining 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.
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. 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).
If the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message.
NetApp Specific
NetApp Specific
Setting
Description
SnapMirrors
Shows the SnapMirror that this sensor monitors.
PRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.
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].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.
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.
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.
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:
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. You 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 under the corresponding setting name to disable the inheritance and to display its options.
For more information, see section Root Group Settings, section Scanning Interval.
Schedules, Dependencies, and Maintenance Window
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.
Schedules, Dependencies, and Maintenance Window
For more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.
Access Rights
Access Rights
For more information, see section Root Group Settings, section Access Rights.
Channel List
Which channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.
Channel
Description
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
Healthy
If the system is healthy
Up status: Yes
Down status: No
This channel is the primary channel by default.
Lag
The lag transfer duration
Last Transfer Duration
The duration of the last transfer
Last Transfer Size
The size of the last transfer
Last Transfer Timestamp
The time stamp of the last transfer
Mirror State
The mirror state
Up status: Snapmirrored
Warning status: Uninitialized
Down status: Broken-Off, Unknown
Relationship Type
The relationship type
Up status: Mirror, Mirror and Vault, Vault
Down status: Unknown
Resync Fails
The number of resynchronization fails per second
Transfer Status
The transfer status (relationship status returned from the API)