Storage - NetApp Data ONTAP Extractor Service

Configuring Data ONTAP

To monitor a NetApp storage system in Cluster mode, you need to create a user with read-only access to the DATA ONTAP API.

When using Data ONTAP v7.x and 8.x

Copy-paste the following command lines into the NetApp CLI:

When using Data ONTAP v9

Copy-paste the following command lines into the NetApp CLI:

or add a user in NetApp OnCommand System Manager with the following login methods:

A. Configuring the basic properties

Some of the basic properties display default values. You can modify these values if required.

To configure the basic properties:

1. In the Helix Continuous Optimization console, navigate to Administration > ETL & SYSTEM TASKS > ETL tasks.
2. On the ETL tasks page, under the Last run tab, click Add > Add ETL. The Add ETL.The Add ETL page displays the configuration properties. You must configure properties in the following tabs: Run configuration, Entity catalog, and ETL additional settings.
3. On the Run configuration tab, select Storage - NetApp Data ONTAP Extractor Service from the ETL Module list. The name of the ETL is displayed in the ETL task name field. You can edit this field to customize the name.
   
4. Click the Entity catalog tab, and select one of the following options:
   

   • Shared Entity Catalog:

     Select if other ETLs access the same entities that are used by the NetApp Data ONTAP ETL.

     • From the Sharing with Entity Catalog list, select the entity catalog name that is shared between ETLs.
   • Private Entity Catalog: Select if this is the only ETL that extracts data from the NetApp Data ONTAP resources.

5. Click the Connection Settings tab, and configure the following properties:

   Property	Description
   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 (default port is 80 for HTTP, 443 for HTTPS).

6. 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  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  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. 
7. Locate the ETL in the ETL tasks table and click  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 Helix Continuous Optimization database. You can see the entity hierarchy in the left Navigation pane, under Workspace.
8. Click the ETL additional settings tab, and configure the following properties:

(Optional) B. Configuring the advanced properties

You can configure the advanced properties to change the way the ETL works or to collect additional metrics.

To configure the advanced properties:

Click Save. The ETL tasks page shows the details of the newly configured NetApp Data ONTAP ETL.

Complete the procedure by performing steps 6 to 8 from the Configuring the basic properties procedure.

After you configure the ETL, you can run it to collect data. You can run the ETL in the following modes:

A. Simulation mode: Only validates connection to the data source, does not collect data. Use this mode when you want to run the ETL for the first time or after you make any changes to the ETL configuration.

B. Production mode: Collects data from the data source.

A. Running the ETL in the simulation mode

To run the ETL in the simulation mode:

1. In the Helix Continuous Optimization console, navigate to Administration > ETL & System Tasks, and select ETL tasks.
2. On the ETL tasks page, click the ETL. The ETL details are displayed.

1. In the Run configurations table, click Edit to modify the ETL configuration settings.
2. On the Run configuration tab, ensure that the Execute in simulation mode option is set to Yes, and click Save.
3. Click Run active configuration. A confirmation message about the ETL run job submission is displayed.
4. On the ETL tasks page, check the ETL run status in the Last exit column. 
   OK Indicates that the ETL ran without any error. You are ready to run the ETL in the production mode.
5.  If the ETL run status is Warning, Error, or Failed:
   1. On the ETL tasks page, click  in the last column of the ETL name row.
   2. Check the log and reconfigure the ETL if required.
   3. Run the ETL again.
   4. Repeat these steps until the ETL run status changes to OK.

B. Running the ETL in the production mode

You can run the ETL manually when required or schedule it to run at a specified time.

a. Running the ETL manually

1. On the ETL tasks page, click the ETL. The ETL details are displayed.
2. In the Run configurations table, click Edit  to modify the ETL configuration settings. The Edit run configuration page is displayed.
3. On the Run configuration tab, select No for the Execute in simulation mode option, and click Save.
4. To run the ETL immediately, click Run active configuration. A confirmation message about the ETL run job submission is displayed.
   When the ETL is run, it collects data from the source and transfers it to the BMC Helix Continuous Optimization database.

b. Scheduling the ETL run

By default, the ETL is scheduled to run daily. You can customize this schedule by changing the frequency and period of running the ETL.

To configure the ETL run schedule:

1. On the ETL tasks page, click the ETL, and click Edit. The ETL details are displayed.
   
   
2. On the Edit task page, do the following, and click Save:
   • Specify a unique name and description for the ETL task.
   • In the Maximum execution time before warning field, specify the duration for which the ETL must run before generating warnings or alerts, if any.
   • Select a predefined or custom frequency for starting the ETL run. The default selection is Predefined.
   • Select the task group and the scheduler to which you want to assign the ETL task.
3. Click Schedule. A message confirming the scheduling job submission is displayed.
   When the ETL runs as scheduled, it collects data from the source and transfers it to the BMC Helix Continuous Optimization database.

A. Testing the connection to the NetApp Data ONTAP API

The ETL relies on the 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.

B. 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 Helix Continuous Optimization environment.

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

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.

C. Running the Extractor Service task

D. Setting the collect frequency