NetApp E/EF-Series Monitoring

Last updated on 17 March, 2023

Overview

LogicMonitor’s NetApp E/EF-Series package ​monitors E and EF series storage arrays using SANtricity Web Services. It collects metrics for hardware health, performance, and space usage.

Technology notes:

Compatibility

As of January 2020, this package is compatible with all current E/EF-series devices. An embedded Web Services API server is available on the following devices:

  • E2800/EF280 running NetApp SANtricity 11.30 or later
  • E5700/EF570 running SANtricity 11.40 or later versions
  • EF600 running SANtricity 11.60 or later versions

In general, it is recommended that you use the Web Services Proxy (WSP) for networks with more than 10 storage systems. The proxy can handle numerous requests more efficiently than the embedded server.

Setup Requirements

As discussed in the following sections, several steps must be taken in order to set up monitoring of NetAPP E/EF-Series devices, including the installation of SANtricity Web Services Proxy.

Add Resources Into Monitoring

Add your NetAPP E/EF-Series devices into monitoring. For more information on adding resources into monitoring, see Adding Devices.

Obtain Credentials

​LogicMonitor must provide the appropriate credentials in order to successfully access the NetApp resource data. These credentials must belong to a SANtricity Web Services API user account that has been assigned the following minimum permissions:

Role

Description

storage.monitor Per the NetApp SANtricity documentation, this role is defined as “Read-only access to view storage system data”.

The predefined users “ro” and “monitor” are assigned the storage.monitor role; both accounts are disabled until a password is set.

To create a new account, follow the instructions under the “Configuring the users.properties File” section of the Web Services Proxy User Guide.

Assign Properties to Resources

The following properties must be set on the NetApp E/EF-Series resource within LogicMonitor. For more information on assigning properties to resources, see Resource and Instance Properties.

Property

Description

netapp.rest.user Username for the Web Services API.
netapp.rest.pass Password for the Web Services API.
netapp.rest.url The WSP/device IP address or FQDN including the listening port. By default, Web Services communicates over port 8080 (for HTTP) and port 8443 (for HTTPS). Note: The embedded Web Services API server only supports HTTPS connections.

Install and Configure SANtricity Web Services Proxy

  1. Visit the SANtricity Web Services Proxy product page to download the SANtricity Web Services Proxy. For installation instructions, see the SANtricity Web Services Proxy Installing and Using guide.
  2. Once you have the Web Services Proxy installed, verify that you can reach the REST API by loading the built-in documentation page:
    https:/[WSP IP or FQDN]:8443/devmgr/docs
  3. Scroll down to the line labeled Storage-Systems and click Show/Hide.
  4. Next, register your array(s) with the Web Services Proxy. You will need the IP addresses of your arrays (you only need one of the IPs for each). You can use the POST /storage-systems endpoint to do this conveniently from the built-in API documentation page, or with curl. You will need to pass a JSON object that looks like the following, of course, with the IP addresses changed to match your environment:
    {
      "controllerAddresses": [
        "10.0.0.31"
      ]
    }
    

    If you have a lot of arrays and need to automate this, here’s a curl snippet to get you started:

    URL="https://:/devmgr/v2/storage-systems"
    
    curl --request POST --cookie "cookies.txt" \
         --header "Accept: application/json" --header "Content-Type: application/json" \
         --data '{"controllerAddresses":["10.0.0.31, "10.0.0.32]} \
         --insecure $URL
  5. If the response comes back okay, you can confirm your arrays have been registered by using the GET /storage-systems endpoint. Click the Try it out! button and you should see your arrays in the JSON results window.
  6. The system.categories properties on your NetApp resources should include “SANtricityWebServices” as a value so that the DataSources are properly applied. This value will be assigned automatically via the PropertySource associated with this package, as long as the proper credentials are configured, or the default credentials are still valid.
  7. You should now start seeing data for your NetApp E/EF-Series devices.

Troubleshooting

424/404 Return Codes

If you receive a 424 or 404 HTTP return code when clicking on Poll Now, it is likely that your device is not registered with the Web Services Proxy. This can be verified using the GET /storage-systems endpoint.

HTTP Client Protocol Exception

If you get a ClientProtocol Exception when testing the script from the DataSource definitions page, double check that the value of the netapp.rest.url property is correct. This error is usually due to a malformed URL, specifically when an HTTP URL is provided with an HTTPS port.

LogicModules in Package

​LogicMonitor’s package for NetApp E/EF-Series consists of the following LogicModules. For full coverage, please ensure that all of these LogicModules are imported into your LogicMonitor platform.

Name

Type

Description

addCategory_NetApp_ESeries PropertySource Identifies NetApp E/EF-Series Devices and applies the system category of “SANtricityWebServices” to the system.categories property.
NetApp_ESeries_Chassis_Status DataSource Monitors the status of various chassis components.
NetApp_ESeries_Drive_Statistics DataSource Shows statistics for drives. SSDs are not included if they’re part of a SSD cache. They are included if part of a Volume Group or Disk Pool.
NetApp_ESeries_Dynamic_Disk_Pools_and_Volume_Groups DataSource Get health and capacity info for Dynamic Disk Pools and Volume Groups.
NetApp_ESeries_HDD_Status DataSource Shows status of spinning drives in a NetApp E or EF-Series array. Drives are identified by their slot number.
NetApp_ESeries_Repository_Volumes DataSource Repository volume performance and status info.
NetApp_ESeries_SSD_Read_Cache DataSource Status and capacity usage for the SSD Read Cache.
NetApp_ESeries_SSD_Status DataSource Shows status of SSDs in a NetApp E or EF-Series array. Drives are identified by their slot number.
NetApp_ESeries_Snapshot_Groups DataSource Monitors E-Series snapshot count, repository space utilization and state.
NetApp_ESeries_Snapshot_Volumes DataSource Monitors snapshot volume storage utilization and state.
NetApp_ESeries_Standard_Volumes DataSource Standard volume performance and status info.
NetApp_ESeries_Thin_Volumes DataSource Thin Volume performance and status data.
NetApp_ESeries_Troubleshooter DataSource Checks for proper device props and credentials, tests communication with the Web Services Proxy, and verifies that the host has been registered with the WSP.

​When setting static datapoint thresholds on the various metrics tracked by this package, LogicMonitor follows the technology owner’s best practice KPI recommendations. If necessary, we encourage you to adjust these predefined thresholds to meet the unique needs of your environment. For more information on tuning datapoint thresholds, see Tuning Static Thresholds for Datapoints.

In This Article