Storage - Hitachi Device Manager Extractor Service

Refer to the table below to know which version of the Hitachi Device Manager should be used to collect information about your Hitachi storage systems.

¹ Tested and validated with Hitachi Device Manager v7.3 Build 0730-06 and v8.1.4 Build 0814-06. For more recent versions, please contact our support team.

² Only required to collect the ST_POOL_CONFIGURATION_LIMIT_PCT metric.

³ Tested and validated with the Hitachi embedded SMI-S with Microcode 73-03-50-00/00 for the Storage system.

⁴ Tested and validated with the Hitachi embedded SMI-S provider v1.5.0; with Microcode 83-03-22-20/00 for the Storage system.

A. Monitoring Hitachi AMS, HUS, USP, VSP Systems

Before installing Hitachi Device Manager ETL for BMC Helix Continuous Optimization, you must ensure that Hitachi Device Manager is properly installed and statistics are enabled.

Installing Hitachi Device Manager

Enabling statistics

B. Monitoring Hitachi VSP Gxxxx Series and Hitachi Unified Storage VM

Before installing Hitachi Device Manager ETL for BMC Helix Continuous Optimization to collect metrics about Hitachi VSP Gxxxx series and Hitachi Unified Storage VM, you must ensure that the embedded SMI-S provider is properly configured.

Before installing Hitachi Device Manager ETL for BMC Helix Continuous Optimization to collect metrics about Hitachi VSP Gxxxx series and Hitachi Unified Storage VM, you must ensure that the embedded SMI-S provider is properly configured.

Configuring the Hitachi Embedded SMI-S provider

C. Collecting the ST_POOL_CONFIGURATION_LIMIT_PCT and Tiering metrics

To be able to collect the ST_POOL_CONFIGURATION_LIMIT_PCT metric, as well as Tiering metrics, you need to install the Hitachi Configuration Manager REST API as follows:

1. Install the REST API:

   1. Log on to the management server as a user with Administrator rights

   2. Insert the integrated installation media

   3. Execute the installer (setup.exe) located in %ProgramFiles%\HiCommand\ConfManager
   4. Follow the instructions of the installation wizard and specify the required information in each window
   5. When the installation completes, click Finish. 
2. Create a command device on the storage system and assign it to the management server:
   1. Log on to Hitachi Storage Navigator
   2. Create a command device
   3. Assign the path to the management server to the created command device
   4. For an iSCSI connection, set up the iSCSI initiator in the management server

   5. In the management server, confirm that the command device is assigned.

3. Set the HORCM_CONF (HORCM configuration file) and HORCMINST (instance number) environment variables

4.  Modify the lines below in the file defined in HORCM_CONF:

   HORCM_MON
   
   
   #ip_address     service       poll(10ms)   timeout(10ms)
   127.0.0.1       11004         1000         3000
   
   
   HORCM_CMD
   #dev_name       devname     dev_name  
   \\.\Volume{ff59cdfa-1fd5-11e9-80bf-001f29c99b2d}

   
   You can run the following command to obtain the volume name:

   C:\HORCM\etc>raidscan -x findcmddev 0,X

5. Use the following command to start the horcm service:

   C:\Horcm\etc\horcmstart.exe

6. Register the storage system to be managed by the REST API:

   1. Create a json file that specifies at least the IP address of the SVP that will manage the storage system to be registered, the serial number and model name:

      {
        "svpIp": "10.197.74.6",
        "serialNumber": 492017,
        "model": "VSP G400",
        "changeNotificationSetting": {
          "isNotifiable": true,
          "mappWebServerHttpsPort": 443
        }
      }

   2. Run the following command:

      curl -v -H "Accept:application/json" -H "Content-Type:application/json" -u rest-test:rest-api -X POST --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages

D. 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  icon to inspect the deployment log.

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 - Hitachi Device Manager 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 Hitachi Device Manager 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 Hitachi resources.

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

   Property	Description
   Hostname	Hostname or IP address of the embedded SMI-S provider or of the server where Hitachi Device Manager is running.
   Port	Port number used by the embedded SMI-S provider or by Hitachi Device Manager (Default: 5989).
   Connect As	Username to connect to the embedded SMI-S provider or to the Hitachi Device Manager. (Default: system).
   Password	Password to connect to the embedded SMI-S provider or to the Hitachi Device Manager.
   Refresh Hitachi Device Manager	Hitachi Device Manager does not automatically take into account configuration changes. Therefore, it is recommended to periodically trigger a procedure of refresh. Warning: This operation is resource and time consuming in large environment.
   Transport Protocol	Transport protocol used by the embedded SMI-S provider or by the Hitachi Device Manager (for HTTP, the default port is 5988, for HTTPS the default port is 5989).

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.
   2. 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.

(Optional) B. Configuring the advanced properties

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

Click Save. The ETL tasks page shows the details of the newly configured Hitachi Device Manager 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 Hitachi Device Manager

The ETL relies on Hitachi Device Manager to collect information about Hitachi storage systems. 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 monitoring

Discovering volumes 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 monitoring at will and fine-tune the creation of volume 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 monitoring

1. Edit the ETL Run Configuration.
2. Expand the ETL additional settings menu.

3. From the Volumes pull-down lists, select one of the following options:

   Option	Result
   Disabled	Volumes are not discovered. Volumes-related metrics are not loaded in the console. Note Use this configuration if the number of volumes to manage significantly slows down the system performance. Disabling the volumes 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 are discovered and their metrics are collected and processed. Volumes-related metrics are not loaded in the console.   Note Use this configuration if you wish to collect and process volume-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 are discovered and their metrics are collected and processed. Volumes-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