Configuration and Discovery

Download this manual as a PDF file

The following sections describe how to configure and discover NetApp ONTAP devices for monitoring in SL1 using the "NetApp: ONTAP REST" PowerPack.

Prerequisites for Monitoring NetApp: ONTAP REST

Before monitoring NetApp ONTAP REST devices using the "NetApp: ONTAP REST" PowerPack, you must have the following information about the ONTAP REST API:

  • ONTAP version 9.14.1 or later
  • Username and password for a user with read privileges for the ONTAP REST API
  • IP address and port for the ONTAP REST API

Configuring NetApp: ONTAP REST Credentials

To use the Dynamic Applications in the "NetApp: ONTAP REST" PowerPack, you must first define credentials in SL1. These credentials allow SL1 to communicate with the NetApp appliances.

Creating a Credential for NetApp Guided Discovery

To allow SL1 to discover NetApp ONTAP devices with guided discovery, you must first create a NetApp REST credential. This credential allows the Dynamic Applications in the "NetApp: ONTAP REST" PowerPack to connect with the ONTAP REST API.

To configure a credential for guided discovery:

  1. Go to the Credentials page (Manage>Credentials).
  2. Click the Create New button and select NetApp REST V100 Credential. The Create Credential modal appears.
  3. NetApp v100 REST  Create Credential modal

  4. Enter values in the following fields:
  • Name. Type a name for the credential.
  • All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.
  • Authentication Type. This field supports different authentication mechanisms, for more information see REST Authentication. Select Basic Authentication as it is the simplest form of authentication, using only a username and password and is built into the HTTP protocol.
  • URL. Type the NETAPP IP Address and the port in the appropriate place in the URL provided in the sample credential.
  • HTTP Headers (JSON input). If applicable add a header value in the form of JSON. Example: {"header1":"key1", "header2":"key2"}
  • Username. Type the username for a user with read privileges for the REST API.
  • Password. Type the password for the user you specified in the Username field.
  • SSL Peer Verify. If your SL1 environment is configured with self-signed or self-generated certificates you should set this to Enable. Select True to enable, or False to disable.
  • Logging Debug. The default for “Logging Debug” is False. To Enable the logging authentication debug select True.
  1. Click Save & Close.

Creating a SOAP/XML Credential

To allow SL1 to discover NetApp ONTAP devices with guided discovery, you can also use a SOAP/XML credential. This credential allows the Dynamic Applications in the "NetApp: ONTAP REST" PowerPack to connect with ONTAP REST API.

To create the SOAP/XML credential:

  1. Go to the Credentials page (Manage > Credentials).
  2. Locate the NetApp Credential Example, click its Actions icon (), and select Duplicate. A copy of the credential, called NetApp Credential Example copy appears.
  3. Click the Actions icon () for the NetApp Credential Example copy and select Edit. The Edit Credential page appears.
  4. NetApp REST SOAP/XML credential

  5. Enter values in the following fields:
  • Name. Type a name for the credential.
  • All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.
  • Timeout. Keep the default value.
  • URL. Type the NETAPP IP Address and the port in the appropriate place in the URL provided in the sample credential.
  • HTTP Auth User. Type the username for a user with read privileges for the REST API.
  • HTTP Auth Password. Type the password for the user you specified in the Username field.
  1. For all remaining fields, use the default values.
  2. Click Save & Close.

Creating a SOAP/XML Credential in the Classic User Interface

To allow SL1 to discover NetApp ONTAP devices with guided discovery, you can also use a SOAP/XML credential. This credential allows the Dynamic Applicationsin the "NetApp: ONTAP REST" PowerPack to connect with ONTAP REST API.

To create the SOAP/XML credential:

  1. Go to the Credential Management page (System > Management > Credentials).
  2. Locate the NetApp Credential Example credential, and click its wrench icon (). The Edit SOAP/XML Credential page appears.
  3. Enter values in the following fields:
  • Profile Name. Type a new name for the credential.
  • URL. Type the NETAPP IP Address and the port in the appropriate place in the URL provided in the sample credential.
  • HTTP Auth User. Type the username for a user with read privileges for the REST API.
  • HTTP Auth Password. Type the password for the user you specified in the Username field.
  • Timeout. Keep the default value.
  1. Click Save & Close.

Running NetApp: ONTAP REST Guided Discovery

On the Devices page ( ) or the Discovery Sessions page (Devices > Discovery Sessions), you can add or "discover" new devices for monitoring in SL1. You add devices by creating a discovery session, which searches for devices on the network you specify.

The guided discovery process lets you select a discovery type specific to the type of devices you want to monitor. The guided discovery wizard provides a filtered list of relevant credentials, the ability to create new credentials, and a reduced set of application-specific fields to help you efficiently discover the devices you need.

To run a guided discovery:

  1. On the Devices page ( ) or the Discovery Sessions page (Devices > Discovery Sessions), click the Add Devices button. The Select page appears.
  2. NetApp ONTAP REST Guided Discovery
  3. Select the NetApp button. Additional information regarding the requirements for device discovery appears in the General Information pane on the right.
  4. Click Select. The Credential Selection page appears.

You can select either a NetApp Universal credential or a SOAP/XML credential. However, only credentials created for guided discovery (Universal credentials) can be edited on the Credential Selection page. You can only edit SOAP/XML credentials for NetApp in Manage > Credentials or System > Manage > Credential in the classic SL1 user interface.

List of NetApp Credentials to start discovery.

During the guided discovery process, you cannot click Next until the required fields are completed on the page, nor can you skip to future steps. However, you can revisit previous steps that you have already completed.

  1. On the Credential Selection page of the guided discovery process, select the NetApp: ONTAP REST credential radio button that you configured, and then click Next. The Root Device Details page appears.

NetApp ONTAP REST Root Device modal for guided discovery.

  1. Complete the following fields:
  • Root Device Name.Type the name of the cluster you want to monitor. Ensure you provide a unique cluster name to help identify the specific cluster being monitored, especially if you have multiple clusters. ScienceLogic does not recommend that you use the default 'NetApp: Cluster Device' name provided by the guided discovery.
  • Select the organization to add discovered devices to. Select the name of the organization to which you want to add the discovered device.
  • Collector Group Name. Collector Group Name. Select an existing collector group to communicate with the discovered device.
  1. Click Next. SL1 creates the NetApp: ONTAP REST root device with the appropriate Device Class assigned to it and aligns the relevant Dynamic Applications. The Final Summary page appears.

NetApp REST Guided Discovery completed.

  1. Click Close.

The results of a guided discovery do not display on the Discovery Sessions page (Devices > Discovery Sessions).

Verifying Discovery and Dynamic Applications

To verify that SL1 has automatically aligned the correct Dynamic Applications during discovery:

  1. After discovery has completed, go to the Devices page, or the Device Manager (Registry>Devices>Device Manager) in the SL1 classic user interface, and find the device(s) you discovered. When you have located your device, click on its name, or click on its Edit ( ) icon in the classic user interface.
  2. Click the Collections tab.
  3. All applicable Dynamic Applications for the NetApp ONTAP devices are automatically aligned during discovery.

You should see the following Dynamic Applications aligned to the NetApp REST Cluster (root device):

  • NetApp: Cluster Configuration
  • NetApp: Cluster Performance
  • NetApp: Storage Pool Performance
  • NetApp: Nodes Container Discovery
  • NetApp: SVM Container Discovery

You should see the following Dynamic Applications aligned to the NetApp Nodes Container:

  • NetApp: Node Discovery

You should see the following Dynamic Applications aligned to the NetApp SVMs Container:

  • NetApp: Storage Virtual Machine (SVM) Discovery

You should see the following Dynamic Applications aligned to the NetApp Nodes:

  • NetApp: Node Configuration
  • NetApp: Node Performance

You should see the following Dynamic Applications aligned to the NetApp Data SVM:

  • NetApp: Storage Virtual Machine (SVM) Configuration
  • NetApp: CIFS Protocol for SVM Performance

The “NetApp: CIFS Protocol for SVM Performance” Dynamic Application will align by the run book action policy only if the Protocol CIFS is Enabled in the NetApp device.

Viewing NetApp Component Devices

In addition to the Device Manager page (Devices > Classic Devices, or Registry > Devices > Device Manager in the classic SL1 user interface), you can view NetApp component devices in the following places in the user interface:

  • The Device Components page (Devices > Device Components) displays a list of all root devices and component devices discovered by SL1 in an indented view, so you can easily view the hierarchy and relationships between child devices, parent devices, and root devices. To view the component devices associated with a NetApp cluster, find the NetApp cluster and click its plus icon (+).

  • The Component Map page (Classic Maps > Device Maps > Components) allows you to view devices by root node and view the relationships between root nodes, parent components, and child components in a map. This makes it easy to visualize and manage root nodes and their components. SL1 automatically updates the Component Map as new component devices are discovered. The platform also updates each map with the latest status and event information. To view the map for a NetApp cluster, go to the Component Map page and select the map from the list in the left NavBar. To learn more about the Component Map page, see the section on Views.