NetApp Data ONTAP ETL for TrueSight Capacity Optimization


This topic contains the following sections:

Compatibility details

BMC TrueSight Capacity Optimization

BMC TrueSight Capacity Optimization v10.7

NetApp Filers

  • In 7-mode (traditional mode): By default, all NetApp storage filers with Data ONTAP 7.3.3 (certified version)
  • In C-mode (cluster mode): By default, all NetApp storage filers with Data ONTAP 8.3 (v8.3P1 has been certified)

Data ONTAP

We recommend using Data ONTAP version 8.3. The following versions of Data ONTAP are however supported:

  • In 7-Mode (traditional mode): Data ONTAP 7.3.3
  • In Cluster-Mode: Data ONTAP 8.3

Note

Data ONTAP 9 is compatible with NetApp Data ONTAP ETL Level 105 or higher. Click here to download a compatible package.

Prerequisites

Before installing NetApp Data ONTAP ETL for BMC TrueSight Capacity, you must ensure that the following prerequisites are met:


To monitor a NetApp storage system in 7-mode, you need to:

  • Create a user with read-only access to the DATA ONTAP API 
  • Enable TLS on NetAPP

Creating a user with read-only access

To create a user with read-only access to the DATA ONTAP API, copy-paste the following command lines into the NetApp CLI:

  1. Create a new role to access the Data ONTAP API used by NetApp Data ONTAP ETL for TrueSight Capacity Optimization:
     

    > useradmin role add newrole -a login-http-admin,api-license-list-info,api-system-get-version,api-perf-object-get-instances,api-aggr-list-info,api-volume-list-info,api-lun-list-info,api-lun-map-list-info,api-qtree-list,api-system-get-info,api-storage-adapter-get-adapter-list,api-storage-adapter-get-adapter-info,api-net-config-get-active,api-fcp-adapter-list-info,api-fcp-adapter-stats-list-info,api-cifs-list-config,api-iscsi-service-status,api-iscsi-adapter-list-info,api-nfs-status,api-sis-status,api-snapmirror-get-status,api-snapvault-primary-destinations-list-info,api-storage-shelf-list-info,api-disk-list-info,api-storage-shelf-environment-list-info,api-vfiler-list-info,api-cifs-status,api-vfiler-get-status,api-snapvault-primary-get-relationship-status,api-quota-report,api-snapshot-volume-info 
  2. Create a new group using the previously created role:
     

    > useradmin group add newgroup -c "adding group for newuser" -r newrole
  3. Create a new user in the previously created group:

    > useradmin user add newuser -g newgroup

Enabling TLS on NetAPP

Data ONTAP supports SSLv3 and TLS (disabled by default) to secure its  connection with NetApp Data ONTAP ETL for TrueSight Capacity Optimization. From version 10.3 of BMC TrueSight CO, SSLv3 is disabled by default, which prevents NetApp Data ONTAP ETL for TrueSight Capacity Optimization to connect to Data ONTAP. To guarantee the correct operation of NetApp Data ONTAP ETL for TrueSight Capacity Optimization,  you will have to first enable TLS. For more information, see NetApp documentation.


To monitor a NetApp storage system in Cluster mode, you need to create a user with read-only access to the DATA ONTAP API. Please copy-paste the following command lines into the NetApp CLI:

>::security >login create -username newuser -application http -authmethod password -role readonly
>::security >login create -username newuser -application ontapi -authmethod password -role readonly


Deploying the ETL module

Complete the following steps to deploy the ETL Module:

  1. Navigate to Administration > SYSTEM > Maintenance.
  2. Verify the installation status of the already uploaded packages. If their status is "READY" or "RUNNING", wait for the installation to complete before proceeding.
  3. At the bottom of the Maintenance page, locate the Upload patch or additional package file section.
  4. Click Browse.
  5. Locate and select the ETL installation package.
  6. Click Upload.
  7. Read the Overview and click Next to continue.
  8. Read and accept the End User License Agreement.
  9. Select the server on which the operation must be executed; that is the server on which the package will be saved. Click Proceed to continue.
  10. A successful installation will result in a green line in the Additional Packages table.

    Note

     In case of unsuccessful outcome (e.g. a yellow WARNING line), click the View_Deployment_Log.png icon to inspect the deployment log.

Configuring the ETL module

Complete the following steps to configure an ETL service and add it as an ETL task to extract capacity and performance metrics:

  1. Navigate to Administration > ETL & SYSTEM TASKS > ETL tasks.
  2. In the ETL tasks page, under the Last run tab, click Add > Add ETL. The Add ETL page is displayed.
  3. In the Run configuration tab, in the ETL module property, select Storage - NetApp Data ONTAP Extractor Service.
    107NetApp_Config_RunConfiguration_Tab.png
  4. Specify values for the common and advanced properties that are listed under the expandable tabs. To view or configure advanced properties, click Advanced. For details about the common properties, see Common configuration properties. The following table lists the properties that are specific to the NetApp Data ONTAP ETL module:


    Note

     Basic properties that are displayed by default in the Add ETL page are the most common properties that you can set for an ETL.

    Property

    Description

    Connection settings

    Hostname

    Hostname of the NetApp Filer in Cluster Mode or the IP address of the first controller in 7-Mode.

    Port

    Port number to connect to the NetApp Filer (Default: 443).

    Connect As

    Username to connect to the NetApp Filer.

    Password

    Password to connect to the NetApp Filer.

    Partner Hostname

    Partner hostname or IP address of the second controller of the NetApp Filer (7-mode only).

    Transport Protocol

    Transport protocol used to connect to the NetApp Filer (for HTTP, the default port is 80; for HTTPS the default port is 443).

      ETL additional settings

    Entity types

    This property allows you to specify the terminology to be used for entity types. Select:

    • Storage - Vendor Agnostic (Recommended) if you are using several storage ETLs and the Storage Capacity Views and Reports for TrueSight Capacity Optimization.
    • NetApp Specific Terminology if you want your entity types to use the NetApp terminology. Please note that this configuration is not compatible with the Storage Capacity Views and Reports for TrueSight Capacity Optimization and requires NetApp Capacity Views for TrueSight Capacity Optimization to be installed to benefit from the data analysis functionalities. This configuration should therefore only be selected if you are not using other storage ETLs.

     Shares

    This property allows you to fine-tune the creation of shares entities in the BMC TrueSight Capacity Optimization environment. For more information, refer to the section "Customizing Volumes and Shares Monitoring" below.

     Volumes

    This property allows you to disable or enable volumes monitoring and fine-tune the creation of volume entities in the BMC TrueSight Capacity Optimization environment. For more information, refer to the section "Customizing Volumes and Shares Monitoring" below.


    Note

     To view or configure Advanced properties, click Advanced. You do not need to set or modify these properties unless you want to change the way the ETL works. These properties are for advanced users and scenarios only.

    Property

    Description

    Collection level

    Levels up to

    By default, extended level metrics are not imported by the ETL. To import them, you will have to customize the collection level and set it to [4] Extended.
    For more information about Aging Class Mapping, refer to the topic Adding and modifying metric profiles.

     

  5. Click Save. You are returned to the Last run tab under the ETL tasks page.
  1. Validate the results in simulation mode: In the ETL tasks table under ETL tasks > Last run, locate your ETL (ETL task name), click Button_Run.png to run the ETL.
    • OK: the ETL executed without any error in simulation mode.
    • WARNING: The ETL execution returned some warnings in simulation mode. Check the ETL log.
    • ERROR: The ETL execution returned errors and was unsuccessful. Edit the active Run configuration and try again.
  1. Switch the ETL to production mode: Perform the following steps:
    1. In the ETL tasks table under ETL tasks > Last run, click the ETL under the Name column.
    2. In the Run configuration table in the ETL details page, click Edit_Icon.png to edit the active Run configuration.
    3. In the Edit run configuration page, navigate to the Run configuration expandable tab and set Execute in simulation mode to No.
    4. Click Save.
  1. Locate the ETL in the ETL tasks table and click Button_Run.png to run it, or schedule an ETL run.
    After you run the ETL, or schedule the ETL for a run, it will extract the data from the source and transfer it to BMC TrueSight Capacity Optimization database. You can see the entity hierarchy in the left Navigation pane, under Workspace.

Post-configuration steps

Testing the connection to the NetApp Data ONTAP API

The ETL relies on NetApp Data ONTAP API to collect information about NetApp Filers. Because some connectivity issues may exist and cause the ETL to fail, it is highly recommended to test the connection to this specific component. The procedure is as follows:

  1. Download the troubleshooting tool from EPD.
  2. Run the command java –jar <Troubleshooting_Tool_Name.jar> to launch the tool.
  3. Enter the information required to connect to the system and click Test Connection.
  4. Wait for the test to complete.
  5. If a connectivity issue is detected, an error message will appear. In this case, the issue encountered does not concern the ETL. Check your configuration to diagnose the source of the issue.
  6. Click Save As to export the connection test results into a txt file.

Customizing volumes and shares monitoring

Discovering volumes and/or shares and collecting their performance metrics are resource-intensive actions that can create extra workload on the system. To reduce the system resource consumption, administrators can disable or enable the volumes and/or shares monitoring at will and fine-tune the creation of volume and/or share entities into the BMC TrueSight Capacity Optimization environment.

The following metrics are no longer collected and displayed in the console when volumes monitoring is disabled:

Dataset

Metrics

STOGLB

7-Mode and Cluster-Mode:

  • ST_OVERSUBSCRIBED_CAPACITY (Storage Oversubscribed Capacity)
  • ST_POOL_SUBSCRIBED_CAPACITY (Pool Subscribed Capacity)
  • ST_POOL_SUBSCRIBED_CAPACITY_PCT (Pool Subscribed Capacity Percentage)
  • ST_SYSTEM_SUBSCRIBED_CAPACITY (Storage Subscribed Capacity

To customize volumes and shares monitoring

  1. Edit the NetApp Data ONTAP ETL Run Configuration.
  2. Expand the ETL additional settings menu.
  3. From the Shares/Volumes pull-down lists, select one of the following options:

    Option

    Result

    Disabled

    • Volumes/Shares are not discovered.
    • Volumes/shares-related metrics are not loaded in the console.

    Note

    Use this configuration if the number of volumes/shares to manage significantly slows down the system performance. Disabling the volumes/shares monitoring prevents the discovery of volumes and consequently does not allow the ETL to collect, save or process their data. Note that the calculation of metrics for other sources may be impacted.

    Collected for metric computation (Default)

    • All volumes/shares are discovered and their metrics are collected and processed.
    • Volumes/shares-related metrics are not loaded in the console.

    Note

    Use this configuration if you wish to collect and process volume/shares-related metrics without loading this information in the console. The collected data will however be used to calculate metrics for other sources, when required. This will reduce the resource consumption of your system.

    Collected and Imported

    • All volumes/shares are discovered and their metrics are collected and processed.
    • Volumes/shares-related metrics are saved in the database, processed and loaded in the console.

    Note

    Use this configuration if your system is powerful enough to manage all the volumes to monitor.

  4. Click Save.

Running the Extractor Service task

Click here to expand...

 An ETL task can be run manually to retrieve performance metrics. Please note that the steps listed in this section are not mandatory and are only required if the ETL is not already scheduled for execution.To run the ETL task:

  1. Access the TrueSight Capacity Optimization Console.
  2. In the Administration tab, select ETL & System Tasks > ETL Tasks.
  3. Click Button_Run.png to execute the ETL task.
When the execution is complete, the value of the Status column in the ETL tasks table changes to SERVICE_ON.

Setting the collect frequency

Click here to expand...

 The collect frequency is the rate at which data is collected. Collect frequency is set to 15 minutes by default, which means that it only applies to entities with an average duration of 900 seconds. It can however be modified to include more entities and performance metrics.

To know the average duration, under the Worskpace tab, select one entity, click the Metrics tab, and verify the Average duration column of the performance metrics.
To set the collect frequency:
  1. Edit the ETL Run Configuration:
    1. In the Administration tab, click ETL & System Tasks > ETL tasks.
    2. Click the link of the ETL task for which you wish to set the collect frequency.
    3. Click the Stop button to stop the service execution; then click the Edit_Icon.png Edit button available in the Run configuration section.
  2. Click the link You can manually edit ETL properties from this page provided at the bottom of the page to display a list of editable options.
  3. Locate the service.period option, and enter the number of milliseconds corresponding to the frequency at which data will be collected. If you want the collect frequency to include both storage systems and storage pools for example, you will have to set the collect frequency to 7200000 milliseconds (2 hours).
  4. Click Save.
  5. Start the ETL.

Lookup details

NetApp Data ONTAP ETL for TrueSight Capacity Optimization defines the following lookup fields:

Entity Types (Storage - Vendor Agnostic)

Entity Types (NetApp Specific Terminology)

Lookup fields

Storage System

NetApp HA Pair

DEFAULT

Storage System

NetApp Cluster

DEFAULT

Storage Filer

NetApp vFiler

DEFAULT

Storage Filer

NetApp Vserver

DEFAULT

Storage Pool

NetApp Aggregate

DEFAULT

Storage Share

NetApp Volume

DEFAULT

Storage Volume

NetApp LUN

DEFAULT