Configuration and Discovery

Download this manual as a PDF file

The following sections describe how to configure and discover NetApp appliances for monitoring in SL1 using the NetApp Base Pack PowerPack:

Prerequisites for Monitoring NetApp

Before you discover your NetApp appliances in your SL1 system, you must perform the following configuration tasks on each NetApp Appliance you want to discover:

  • Configure a user account on the NetApp device that SL1 will use to connect to the NetApp API. The user account must be assigned a role that includes the following allowed capabilities:
  • login-http-admin

  • api-system-get-*
  • api-aggr-list-info
  • api-lun-list-info
  • api-volume-list-info
  • api-perf-object-get-instances
  • api-storage-shelf-environment-list-info
  • api-net-config-get-active
  • api-vfiler-list-info
  • api-disk-list-info
  • api-snapshot-list-info

NOTE: For Clustered Data ONTAP 8.3 or later, the documentation for customizing the role of a user account is located in the Clustered Data ONTAP 8.3 System Administration Guide for Cluster Administrators in the section titled “Customizing an access-control role to restrict user access to specific commands”. To view the guide, go to https://library.netapp.com/ecm/ecm_get_file/ECMP1636037. You can download additional NetApp documentation from the NetApp Support Portal at http://mysupport.netapp.com.

If you are discovering a Clustered Data ONTAP system, the user account you use for the ScienceLogic credential should be given the built-in "readonly" role and access to the "ontapi" application. For example:

security login create [username] -application ontapi -role readonly -vserver [clustername]

  • Determine whether connections to the API on your NetApp device require SSL.
  • If you are discovering a NetApp v8 system, you must enable the NetApp multistore license. To do this, execute the following command on your NetApp appliance:
  • options licensed_feature.multistore.enable on

Configuring NetApp Credentials

To use the Dynamic Applications in the "NetApp Base Pack PowerPack, you must first define two or more NetApp credentials in SL1. These credentials allow SL1 to communicate with the NetApp appliances. The NetApp Base Pack PowerPack includes templates for the NetApp credentials.

The NetApp Base Pack PowerPack includes the following example credentials:

  • NetApp w/SSL Option. This SOAP/XML type credential allows you to retrieve data from a NetApp C-Mode device that uses SSL. In production, most NetApp C-Mode devices use SSL.
  • NetApp w/SSL Option Off. This SOAP/XML type credential allows you to retrieve data from a NetApp C-Mode device that does not use SSL.
  • NetApp w/SSL/TLS Option. This SOAP/XML type credential allows you to retrieve data from a NetApp C-Mode device that uses TLS.

NOTE: The user account configured for the credential must be assigned a role that includes "login-http-admin" and "api-system-get-*" as allowed capabilities.

Creating a SOAP/XML Credential for C-Mode

To use the Dynamic Applications in the "NetApp Base Pack" PowerPack, you must create a SOAP/XML credential to allow SL1 to communicate with the NetApp appliances.

To modify the example credentials for use with your NetApp C-Mode appliances:

  1. Go to theCredentials page (Manage > Credentials).
  2. On the Credentials page:
  • If you want SL1 to use SSL when connecting to the NetApp device, locate the "NetApp w/SSL Option" credential. Click its Actions icon () and select Duplicate. A copy of the credential appears.
  • If you do not want SL1 to use SSL or TLS when connecting to the NetApp device, locate the "NetApp w/SSL Option Off" credential. Click its Actions icon () and select Duplicate. A copy of the credential appears.
  • If you want SL1 to use TLS when conneting to the NetApp device, locate the "NetApp w/ SSL/TLS Option" credential. Click its Actions icon () and select Duplicate. A copy of the credential appears.
  1. Click the Actions icon () for the Example copy credential, and select Edit.
  2. SOAP/XML Credential editor

  3. Enter values for 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? dropdown field to align the credential with those specific organizations. This field is required.
  • Timeout. Keep the default value.
  • URL. Use the provided value of "https://%D".
  • HTTP Auth User. Type the username that SL1 will use to connect to the NetApp appliance.
  • HTTP Auth Password. Type the password for the username you entered in the HTTP Auth User field.
  • Embed Value [%1].
    • Type True if you want SL1 to use SSL or TLS when connecting to the NetApp device.
    • Type False if you do not want SL1 to use SSL or TLS when connecting to the NetApp device.
  • Embed Value [%2]. Type one of the following, depending on the version of TLS you use, if you want SL1 to use TLS when connecting to the NetApp device: "TLSv1.0", "TLSv1.1", or "TLSv1.2". Otherwise, keep this field blank.
  • CURL Options. Set SSLVERIFYPEER=1 to enable SSL verification. Otherwise, set it to SSLVERIFYPEER=0.
  • If you are updating the PowerPack to version 108, you must add the SSLVERIFYPEER option to your credential CURL options.

  1. Click Save.

NOTE: The user account configured for the credential must be assigned a role that includes "login-http-admin" and "api-system-get-*" as allowed capabilities.

Creating a Credential for C-Mode in the SL1 Classic User Interface

To modify the example credentials for use with your NetApp C-Mode appliances:

  1. Go to the Credential Management page (System > Manage > Credentials).
  2. On the Credential Management page:
  • If you want SL1 to use SSL when connecting to the NetApp device, click the wrench icon () for the NetApp w/SSL Option credential.
  • If you do not want SL1 to use SSL or TLS when connecting to the NetApp device, click the wrench icon () for the NetApp w/SSL Option Off credential.
  • If you want SL1 to use TLS when connecting to the NetApp device, click the wrench icon () for the NetApp w/SSL/TLS Option credential.
  1. The Credential Editor modal appears. Supply values in the following fields:
  • Profile Name. Type a new name for the credential.
  • URL. Use the provided value of "https://%D".
  • HTTP Auth User. Type the username that SL1 will use to connect to the NetApp appliance.
  • HTTP Auth Password. Type the password for the username you entered in the HTTP Auth User field.
  • Embed Value [%1].
    • Type True if you want SL1 to use SSL or TLS when connecting to the NetApp device.
    • Type False if you do not want SL1 to use SSL or TLS when connecting to the NetApp device.
  • Embed Value [%2]. Type one of the following, depending on the version of TLS you use, if you want SL1 to use TLS when connecting to the NetApp device: "TLSv1.0", "TLSv1.1", or "TLSv1.2". Otherwise, keep this field blank.
  • CURL Options. Set SSLVERIFYPEER=1 to enable SSL verification. Otherwise, set it to SSLVERIFYPEER=0.

If you are updating the PowerPack to version 108, you must add the SSLVERIFYPEER option to your credential CURL options.

NOTE: The user account configured for the credential must be assigned a role that includes "login-http-admin" and "api-system-get-*" as allowed capabilities.

  1. Click the Save As button.

Configuring the NetApp Device Template

The "NetApp Base Pack" PowerPack includes the "NetApp: Base Pack Template C-Mode Example" device template to save a device configuration and apply it to discover a NetApp appliance.

To configure the NetApp device template:

  1. Go to the Configuration Templates page (Devices > Templates or Registry > Devices > Templates in the SL1 classic user interface).
  2. Locate the "NetApp: Base Pack Template C-Mode Example" device template and click its wrench icon ( ). The Device Template Editor page appears.
  3. Click the Dyn Apps tab. The Editing Dynamic Application Subtemplates page appears.
  4. Click the "NetApp: Cluster Logical Interface Stats C-Mode" Dynamic Application listed in the Subtemplate Selection section on the left side of the page and then click the Credentials field label to enable editing.
  5. Select the NetApp credential you created in the Credentials section. Repeat this step to align all of your Dynamic Applications to the credentials you created.
  6. Enter a new name for the template in the Template Name field.
  7. Click Save As.

Discovering a NetApp Appliance

To create and run a discovery session hat will discover a NetApp appliance:

  1. Go to theDevices page () or the Discovery Session page (Devices > Discovery Sessions) and click the Add Devices button. The Select page appears.
  2. Click the Unguided Network Discovery Workflow button. Additional information about the requirements for discovery appears in the General Information pane to the right.
  3. Unguided Network Discovery workflow for NetApp appliances

  4. Click Select. The Add Devices page appears.
  5. Complete the following fields:
  • Discovery Session Name. Type a unique name for this discovery session. This name is displayed in the list of discovery sessions on the Discovery Session tab.
  • Description. Optional. Type a short description of the discovery session. You can use the test in this description to search for the discovery session on the Discovery Session tab.
  • Select the organization to add discovered devices to. Select the name of the organization to which you want to add the discovered devices.
  1. Click Next. The Credentials page of the Add Devices wizard appears.
  2. On the Credentials page, locate and select the SOAP/XML credential you created for NetApp appliances.
  3. Click Next. The Discovery Session page of the Add Devices wizard appears.
  4. Complete the following fields:
  • List of IP/Hostnames. Type the IP address for the NetApp appliance.
  • Which collector will monitor these devices?. Required. Select an existing collector to monitor the discovered devices.
  • Run after save. Select this option to run this discovery session as soon as you save the session.
  • Advanced options. Click the down arrow () to complete the following fields:
    • Discover Non-SNMP. Enable this setting.
    • Model Devices. Enable this setting.
    • Select Device Template. If you configured a NetApp device template, select it here. Otherwise, leave the default selection.
  1. If you enabled the Run after save option, click the Save and Run button. The discovery session will run and the Discovery Logs page will display any relevant log messages. If the discovery session locates and adds any devices, the Discovery Logs page will include a link to the Device Investigator page for the discovered device.
  2. If you did not enable the Run after save option, click the Save and Close button. The Discovery Session page (Devices > Discovery Sessions) will display the new discovery session.

Discovering a NetApp Appliance in the SL1 Classic User Interface

To create and run a discovery session that will discover a NetApp appliance, perform the following steps:

  1. Go to the Discovery Control Panel page (System > Manage > Classic Discovery).
  2. Click the Create button to create a new discovery session. The Discovery Session Editor window appears:
  3. Enter values in the following fields:
  • IP Address/Hostname Discovery List. Enter the IP address for the NetApp appliance.
  • Other Credentials. Select theSOAP/XML credential that you created.
  • Discover Non-SNMP. Select this checkbox.
  • Model Devices. Select this checkbox.
  • Apply Device Template. If you configured a NetApp device template, select it here. Otherwise, leave the default selection.
  1. You can enter values in the other fields on this page, but are not required to and can simply accept the default values. For more information about the other fields on this page, see the Discovery & Credentials section.
  2. Click the Save button and then close the Discovery Session Editor window.
  3. The discovery session you created will appear at the top of the Discovery Control Panel page. Click its lightning-bolt icon () to run the discovery session.
  4. The Discovery Session window will be displayed.
  5. When the NetApp appliance is discovered, click its device icon () to view the Device Properties page for the NetApp appliance.

Verifying Discovery and Dynamic Applications

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

  1. From the Device Properties page for the NetApp appliance, click the Collections tab. The Dynamic Application Collections page appears.
  2. The following Dynamic Applications should be displayed in the list of Dynamic Applications aligned to the NetApp C-mode appliance:
  • NetApp: Cache C-Mode
  • NetApp: Cache C-Mode Volume Snapshot
  • NetApp: Cache vServer Node C-Mode
  • NetApp: Cluster Configuration C-Mode
  • NetApp: Cluster Logical Interface Config C-Mode
  • NetApp: Cluster Logical Interface Stats C-Mode
  • NetApp: Cluster Performance C-Mode
  • NetApp: Disk Count C-Mode
  • NetApp: Hardware Count C-Mode
  • NetApp: System C-Mode
  • NetApp: Topology Cache C-Mode
  • NetApp: Volume LUN Config Cache C-Mode
  • NetApp: vServer Data Discovery C-Mode
  • NetApp: vServer Node Discovery C-Mode
  1. If one or more of these Dynamic Applications are not automatically aligned with each NetApp device, follow the instructions in the section on Manually Aligning the Dynamic Applications or discover using the device template.

Manually Aligning the Dynamic Applications

If the Dynamic Applications have not been automatically aligned, you can align them manually:

  1. From the Device Properties page for the NetApp appliance, click the Collections tab. The Dynamic Application Collections page appears.
  2. Click the Action button and then click Add Dynamic Application. The Dynamic Application Alignment page appears.
  3. In the Dynamic Applications field, select the Dynamic Application you want to align.
  4. In the Credentials field, select the credential you created for this NetApp appliance.
  5. Click the Save button.
  6. Repeat steps 2-5 for the remaining Dynamic Applications to align with the C-mode NetApp appliance.
  7. After aligning the Dynamic Applications, click the Reset button and then click the plus icon (+) for the Dynamic Application. If collection for the Dynamic Application was successful, the graph icons () for the Dynamic Application are enabled.
  8. Click a graph icon () to view the collected data. The Configuration Report page will display the number of components of each type and the total number of components managed by the NetApp appliance.

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.

Relationships with Other Types of Component Devices

SL1 can automatically build relationships between NetApp component devices and other associated devices. If you discover a vCenter device using the Dynamic Applications in the VMware: vSphere Base Pack PowerPack, SL1 will automatically create relationships between NetApp LUNs and VMware Datastores, where appropriate.