Add Hitachi Data System (HDS) storage to ViPR using the REST API

Table of Contents

Back to Top

Overview

This article provides ViPR System Administrators the ViPR support requirements, and prerequisite information to prepare Hitachi Data Systems (HDS) for ViPR integration, and the steps to add the storage to ViPR using the REST API.

This article also describes how the storage is discovered after it is added to ViPR, and the important REST API calls to manage and configure the storage after it has been added, and discovered in ViPR.

This article applies to EMC ViPR 2.0.

This article is part of a series

Storage systems can be added to to ViPR at anytime. If, however, you are setting up the ViPR Controller virtual data center for the first time, before you continue to provision storage, complete the following steps.
  1. Authenticate with the ViPR REST API
  2. Add physical assets to ViPR:
  3. Create ViPR virtual assets:
    1. Create and configure a virtual array
    2. Create virtual pools:

Back to Top

Hitachi Data Systems support

For supported versions, see the EMC ViPR Support Matrix on the EMC Community Network (community.emc.com).

Back to Top

Collect Hitachi HiCommand Device Manager information

Hitachi HiCommand Device Manager is required to use HDS storage with ViPR. You need to obtain the following information to configure and add the Hitachi HiCommand Device manager to ViPR.

Back to Top

Preconfiguration requirements

Before you add Hitachi Data Systems storage to ViPR, configure the storage as follows.

Back to Top

Add the Hitachi Data Systems storage to ViPR

Before you begin

  • Authenticate with the ViPR REST API as a System Administrator.
  • Hitachi Data System storage is added to ViPR by adding the Hitachi HiCommand Device Manager storage provider to the ViPR Physical Assets. When the storage provider is added, all the storage systems managed by the storage provider will be added to ViPR. If you do not want all the storage systems on an storage provider to be managed by ViPR :
    • Before adding the storage provider to ViPR, configure it to only manage the storage systems that will be added to ViPR. Move the storage systems that will not be managed to ViPR onto a different storage provider.
    • Or, after adding the storage provider to ViPR deregister or delete the storage systems that will not be used as a ViPR resource.
  • Interface Type - hicommand.
  • use_ssl - false
  • IP Address of the Hitachi HiCommand Device Manager.
  • Port Number - The port number used to communicate with the Hitachi HiCommand Device Manager. The default is2001.
  • user_name - user name with the HiCommand storage provider. Storage system administrator privileges are required.
  • password - password associated with the user_name.
  • The EMC ViPR REST API Reference provides a description and complete list of parameters for the REST API methods used in this article.

Procedure

  1. Add the Hitachi Data System storage to ViPR by sending a POST /vdc/storage-providers request. The request returns a task whose URI can be queried to determine the status of the task.
    Request

    POST https://<ViPR_VIP>:4443/vdc/storage-providers Content-Type: application/xml X-SDS-AUTH-TOKEN: <AUTH_TOKEN> <storage_provider_create> <name>hdsdevicemgr</name> <interface_type>hicommand</interface_type> <ip_address>192.168.0.0</ip_address> <port_number>2001</port_number> <user_name>user1</user_name> <password>Password1</password> <use_ssl>false</use_ssl> </storage_provider_create>

    Response

    HTTP 202 Accepted Content-Type: application/xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <task> <associated_resources/> <description>SCAN_STORAGEPROVIDER</description> <op_id>a0104371-8330-44da-86b1-d8a6ee16b910</op_id> <resource> <id>urn:storageos:StorageProvider:21a9cfb5-23ca-4db7-b4d7-bee13e49633d:vdc1</id> <link rel="self" href="/vdc/storage-providers/urn:storageos:StorageProvider:21a9cfb5-23ca-4db7-b4d7-bee13e49633d:vdc1"/> <name>hdsdevicemgr</name> </resource> <link rel="self" href="/vdc/storage-providers/urn:storageos:StorageProvider:21a9cfb5-23ca-4db7-b4d7-bee13e49633d:vdc1/tasks/a0104371-8330-44da-86b1-d8a6ee16b910"/> <start_time>1401811932846</start_time> <state>pending</state> </task>

  2. Query the Hitachi Data System create task, using the task URL from the response body of the POST request. When the message attribute of the task is Operation completed successfully, the operation has completed.
    Request

    GET https://<ViPR_VIP>:4443/vdc/storage-providers/{StorageProvider_urn}/tasks/a0104371-8330-44da-86b1-d8a6ee16b910 Content-Type: application/xml X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

    Response

    HTTP 200 OK Content-Type: application/xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <task> <associated_resources/> <description>SCAN_STORAGEPROVIDER</description> <end_time>1401811995781</end_time> <message>Operation completed successfully</message> <op_id>a0104371-8330-44da-86b1-d8a6ee16b910</op_id> <resource> <id>urn:storageos:StorageProvider:21a9cfb5-23ca-4db7-b4d7-bee13e49633d:vdc1</id> <link rel="self" href="/vdc/storage-providers/urn:storageos:StorageProvider:21a9cfb5-23ca-4db7-b4d7-bee13e49633d:vdc1"/> <name>hdsdevicemgr</name> </resource> <link rel="self" href="/vdc/storage-providers/urn:storageos:StorageProvider:21a9cfb5-23ca-4db7-b4d7-bee13e49633d:vdc1/tasks/a0104371-8330-44da-86b1-d8a6ee16b910"/> <start_time>1401811932846</start_time> <state>ready</state> </task>

Back to Top

Important REST API calls to manage and configure storage systems

The table shows some important APIs that are used to manage and configure storage systems.

Back to Top

Network configuration requirements for storage

After the storage system is added to ViPR, it is recommended to add the corresponding SAN switch using POST /vdc/network-systems.

When a SAN switch is added to ViPR, the Fibre Channel networks (Brocade Fabrics or Cisco VSANs), are automatically discovered and registered in ViPR. Additionally, through discovery of the SAN switch topology, ViPR discovers, and registers the host initiators for hosts on the network, and identifies which storage systems are associated with the SAN switch.

Refer to Add network systems (fabric managers) and SAN networks to ViPR for more information.