Skip to Content

Deploying and Configuring Hitachi Device Manager ETL 11.5.00 for TrueSight Capacity Optimization

This topic contains the following sections:

Compatibility details

TrueSight Capacity Optimization

TrueSight Capacity Optimization v11.5.00

Hitachi storage systems

 Hardware

Supported Versions

Hitachi Device Manager v7.31

Hitachi Device Manager v8.1.41

Embedded SMI-S Provider

Hitachi Configuration Manager REST API2

Hitachi Adaptable Modular Storage 2000 family (AMS)

supported.png

supported.png

unsupported.png

unsupported.png

Hitachi Unified Storage (HUS)

supported.png

supported.png

unsupported.png

unsupported.png

Hitachi Unified Storage VM (HUS VM)3

unsupported.png

unsupported.png

supported.png

supported.png

Hitachi Universal Storage Platform (USP, USP-V/USP-VM)

supported.png

supported.png

unsupported.png

unsupported.png

Hitachi Virtual Storage Platform (VSP) - Systems with Basic Operating System (BOS)

supported.png

supported.png

unsupported.png

supported.png

Hitachi VSP G Series (VSP G200, G400, G600, G800 and G1000)4

unsupported.png

unsupported.png

supported.png

unsupported.png

VSP Gx00, VSP G1000, VSP G1500, VSP Fx00, and VSP F1500

unsupported.png

unsupported.png

unsupported.png

supported.png

HP XP P9000

supported.png

supported.png

unsupported.png

supported.png

HP XP P9500

supported.png

supported.png

unsupported.png

supported.png

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

2 Only required to collect the ST_POOL_CONFIGURATION_LIMIT_PCT metric.

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

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


Prerequisites

Monitoring Hitachi AMS, HUS, USP, VSP Systems

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

Installing Hitachi Device Manager

Click here to expand...
Prerequisites

Before installing the Hitachi Device Manager, make sure that:

  • The server’s definitive name has been set. The installation of this software sets configuration variables based on the server’s DNS Name.
Installing the Hitachi Command Suite

The installation files are contained on the Hitachi Device Manager Server DVD.

  1. Double-click the Index.html file.
  2. Click Install to launch the Hitachi Command Suite installer.
  3. Click Next.
  4. Choose the installation folder and click Next.
  5. Click Install.
  6. When the installation is complete, click Finish.
  7. Open the Hitachi Command Suite: http://<IP_Address>:22015/DeviceManagerWebService/index.jsp.
  8. Click on License and Install License.
Installing the Device Manager Agent
  1. Log into the Hitachi Command Suite Console: http://<IP_Address>:22015/DeviceManagerWebService/index.jsp.
  2. Click Install to launch the Device Manager agent installer.
  3. Click Next.
  4. Select the I accept the terms of the License Agreement option and click Next.
  5. Choose the install folder and click Next. A screen will appear to ask you permission to add a firewall exception even if your server’s firewall is not enabled.
  6. Select YES and click Next.
  7. Select the user account to be used for launching the agent service. Selecting NO will use the Local System Account (recommended). Click Next.
  8. Click Install.
  9. When the installation is complete, click Yes to setup the Device Manager agent. The agent will then check connection to Device Manager (Hitachi’s Name for Command View Advanced Edition).
  10. Select YES to specify the Device Manager server Information, change the IP address to 127.0.0.1 and click Next.
  11. Click OK.
  12. Select YES to enable the Execution Period of the HiScan Command. Select pre-determined or random hour (do not use the default 2:30am) to prevent agent conflict. Click Next.
  13. Select NO in order not to set up the RAID Manager and click Next.
  14. A message "The Device Manager agent setup has completed successfully" appears. Click OK to finish the installation.
Configuring the Hitachi Device Manager
  1. Log into the Hitachi Command Suite Console: http://<IP_Address>:22015/DeviceManagerWebService/index.jsp
  2. Click the Add Storage System button located under the Administration > Storage Systems tabs.
  3. Create a user account which is a member of the Storage Administrator (View Only) group and has a Storage Administrator (View Only) role.
  4. Select the Storage System Type.
    1. For Hitachi Series Storage System (VSP / USP-V),  provide the IP address and Credentials.
    2. For Hitachi Series Storage System (AMS), provide the Controller’s IP addresses and Credentials.
  5. Click OK. A Data Collection Task will be generated to add the Storage System. Click View Task Status for details.
  6. Wait for the Data Collect Task to complete successfully.
  7. (USP-V and VSP only) Create the Administrative LUN:
    1. Click the Resources tab.
    2. Expand all storage systems and select the recently added storage system.
    3. Select Volumes.
    4. Under General Tasks, select Allocate Volume and fill the fields as follows:
      1. Host: for Physical Servers, the name of the host where CVAE is installed; for Virtual Servers on ESX host, the name of the ESX host server.
      2. Size: Can be as small as 50MB since this LUN will not actually have data.
      3. VolumeType: Basic Volume.
      4. Location: Internal.
      5. Click Show Plan.
      6. Verify that the allocation task has completed correctly.
  8. Make the Volume/LUN a Command Device:
    1. Log into the Storage System.
    2. Expand the Storage System folder and select Logical Devices.
    3. Select the Logical Device (LUN / Volume) that you want to make a Command Device.
    4. Click More Actions > Edit Command Devices.
  9. Enable the logical device as a Command Device.
  10. (Virtual Machines on ESX hosts only / For physical hosts, skip this section) Raw Device Mapping or LUN allocation will not work for Virtual Machines on ESX Hosts. The HBA port or HBA Card must be allocated directly to the VM. The server needs to be vt-d compatible and have sufficient free HBA ports for each instance of the SMI-S provider you require. To allocate a port for passthrough:
    1. Under the ESX Host’s Configuration tab, select Advanced Settings and click Configure Passthrough.
    2. Select the HBA port(s) that you wish to allocate to VMs.
    3. Click OK.
    4. Restart the ESX Server.
    5. Add the HBA ports to the Virtual Machine.
    6. Once the VM or Physical server sees the LUN, Windows should find a new hard drive.
    7. Click OK to create an MBR (Master Boot Record).

    8. Run the following command:

      C:\Program Files (x86)\HDVM\HBaseAgent\bin>perf_findcmddev.exe view

    9. If the Storage System does not appear, run:

      C:\Program Files (x86)\HDVM\HBaseAgent\bin\hldutil
    10. Refer to the RAID ID Translation Table below to find the OPEN-V-CM (command device LUN) for the storage system:
      1. R700 for VSP
      2. R600 for USP-V
      3. R601 for USP-VM
  11. Edit the file: C:\Program Files (x86)\HDVM\HBaseAgent\mod\hdvm\config\type perf_cmddev.properties

  12. Translate the information from hldutil to perf_cmddev.properties

    Disk1     HITACHI  OPEN-V-CM        CL1-A 0     0    00:8C 14EAE

    R700   0-0   2100001B3284D3DD  2000001B3284D3DD

    R700.85678.0.140 : \\.\PhysicalDrive1

    The Disk Number and Model number can be copied directly.

    The Serial, CU, and LDEV Number need to be translated from HEX to Decimal.

    • Run perf_findcmddev view to check configuration.
    • Run perf_findcmddev verify to ensure configuration is valid.
    • The verify command will highlight any invalid or non-functional lines in the configuration.
    • If the configuration is valid, use the perf_findcmddev write command to save the configuration. Any invalid configuration lines (such as PhysicalDrive2 in the example above will be removed from the configuration by the write command.
  13. Configure the Hitachi Command View server to use the agent:
    1. Edit Hitachi\HiCommandServer\config\server.properties

    2. Search for the following line:

      # host name for the CIM agent
      server.cim.agent= 

  14. Add the hostname for the CIM agent.  The hostname should be the short, non-FQDN of the server:

    # host name for the CIM agent
    server.cim.agent=Hitachi-SMIS

  15. If the server is the same as the agent (by default), take the hostname from the server variable:

    server.http.host= Hitachi-SMIS 
  16. Restart the Server (or restart all Hitachi Services).
  17. Log into Hitachi Command View Server after reboot to ensure that it is working.

Enabling statistics

Click here to expand...

Statistics should be enabled on Hitachi storage systems to allow the Hitachi Device Manager ETL to collect performance information. To do so, you can use the Hitachi Storage Navigator Modular console:

  1. Log on to the Hitachi Storage Navigator Modular console with the administrator’s account.
  2. Edit the Monitoring Switch window.
  3. Select Enable.
  4. Set the Sample Interval to 5 minutes.
  5. Click Finish.

Monitoring Hitachi VSP Gxxxx Series and Hitachi Unified Storage VM

Before installing Hitachi Device Manager ETL for TrueSight Capacity 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

Click here to expand...

Since Hitachi Device Manager ETL for TrueSight Capacity Optimization leverages the embedded SMI-S provider to collect metrics about Hitachi VSP Gxxxx series, there is no need to install a separate SMI-S provider. The only steps to follow are:

Starting the Embedded SMI-S provider

To start the embedded SMI-S Provider:

  1. Click Start > All Programs > Hitachi Device Manager - Storage Navigator > StorageDeviceList
  2. Click Start Service
  3. Run the netstat -ano|findstr 5989 command to verify that a process is actually listening on port 5989.
Creating a User with "storage administrator View-only" Role

To create a user with the “storage administrator View-only” role:

  1. Log on to the Hitachi Device Manager - Storage Navigator console
  2. In the left pane, click Administration > Storage Administrator (View Only) User Group
  3. In the right pane, select the Users tab and click Create User
  4. Enter the required information and click Finish.
Enabling Statistics

Statistics need to be enabled to allow Hitachi Device Manager ETL for TrueSight Capacity Optimization to collect performance metrics. The procedure is as follows:

  1. Log on to the Hitachi Storage Navigator Modular console with the administrator’s account.
  2. In the left pane, click Analytics > Performance Monitor
  3. Click Edit Monitoring Switch
  4. In the Edit Monitoring Switch window, select Enable and click Finish.


Collecting the ST_POOL_CONFIGURATION_LIMIT_PCT metric

To be able to collect the ST_POOL_CONFIGURATION_LIMIT_PCT metric, 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
Information

For more information about the Hitachi Configuration Manager REST API, refer to the reference guide. 


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.

    Warning

    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 - Hitachi Device Manager Extractor Service.
    115Hitachi_RunConfiguration_Tab.png

      1. 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 ETL common configuration properties. The following table lists the properties that are specific to the Hitachi Device Manager ETL module:


        Warning

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

          ETL additional settings

         Volumes

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


        Warning

        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 managing metrics profile.

        Loader configuration

        Leave domain suffix to system name

        By default, Hitachi Device Manager ETL for TrueSight Capacity Optimization displays the system name without the domain name, which can cause several storage pools to appear with the same name. This default behavior can however be modified by setting the option Leave domain suffix to system name to true.

        Additional properties

        Add the properties below to configure the access to the Hitachi REST API server to collect the ST_POOL_CONFIGURATION_LIMIT_PCT metric. Please note that this metric is only available for the VSP Gx00, VSP G1000, VSP G1500, VSP Fx00, VSP F1500, Virtual Storage Platform, and Unified Storage VM models.

        restHostname

        Hostname or IP address of the Hitachi REST API server.

        restPort

        Port number used by the Hitachi REST API server (Default: 23451).

        restProtocol

        Transport protocol used by the Hitachi REST API server (for HTTPS, the default port is 23451; for HTTP, the default port is 23450).

        restUsername

        Username to connect to the Hitachi REST API server.

        rest.password

        Password to connect to the Hitachi REST API server.

  2. Click Save. You are returned to the Last run tab under the ETL tasks page.  
  3. 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.
  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 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.
  3. Locate the ETL in the ETL tasks table. Click Button_Run.png to run the ETL 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 TrueSight Capacity Optimization database. You can see the entity hierarchy in the left Navigation pane, under Workspace.

Post-configuration steps

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.

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 TrueSight Capacity Optimization environment.

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

Dataset

Metrics

STOGLB

  • ST_AVAILABLE_CAPACITY (Available Capacity)
  • ST_AVAILABLE_CAPACITY_PCT (Available Capacity Percentage)
  • ST_AVAILABLE_FOR_STORAGE_POOLS (Available Capacity for Storage Pools)
  • ST_CAPACITY (Storage Capacity)
  • ST_CONFIGURED_VOLUME_CAPACITY_PCT (Storage System Configured Capacity Percentage)
  • ST_CONSUMED_CAPACITY (Storage Consumed Capacity)
  • ST_CONSUMED_CAPACITY_PCT (Storage Consumed Capacity Percentage)
  • ST_DEVICECOUNT (Storage Devices Number)
  • ST_DEVICE_TOTAL (Device Space)
  • ST_HOSTCNT (Attached Hosts Number)
  • ST_OVERSUBSCRIBED_CAPACITY (Storage Oversubscribed Capacity)
  • ST_POOL_DEV_COUNT (Pool Devices Count)
  • ST_POOL_OVERSUBSCRIPTION_SITUATION (Pool Oversubscription Situation)
  • ST_POOL_SUBSCRIBED_CAPACITY (Pool Subscribed Capacity)
  • ST_POOL_SUBSCRIBED_CAPACITY_PCT (Pool Subscribed Capacity Percentage)
  • ST_PRIMARY_ALLOCATED (Primary Allocated Usable Space)
  • ST_SYSTEM_SUBSCRIBED_CAPACITY (Storage Subscribed Capacity)
  • ST_VOLUME_CONSUMED_CAPACITY (Volume Consumed Capacity)
  • ST_VOLUME_CONSUMED_CAPACITY_PCT (Volume Consumed Capacity Percentage)
  • ST_VOLUME_HOST_VISIBLE_CAPACITY (Host Volume Visible Capacity)
  • ST_VOLUME_MAPPED (Volume Mapped)
  • ST_VOLUME_RAID_LEVEL (Volume RAID Level)
  • ST_VOLUME_TIME_SINCE_LAST_ACTIVITY (Volume Time Since Last Activity)
  • ST_VOLUME_TRANSFER_BYTE_RATE (Volume Transfer Byte Rate)

STOHOST

  • BYHOST_ALLOCATED (Allocated Space by Host)
  • BYHOST_SIZE (By Host Physical Size)

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

    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.

     

    Warning

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

    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.

Warning

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

Hitachi Device Manager ETL for TrueSight Capacity Optimization defines the following lookup fields:

Entity type

Lookup fields

Storage System

DEFAULT

Storage Pool

DEFAULT

Storage Volume

DEFAULT

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

Operations and Automation