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

Table of Contents

Overview

As a ViPR System Administrator, learn 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.

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 is also described.

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

Add Hitachi Data Systems storage to ViPR

Add Hitachi Data Systems storage to ViPR using the REST API.

Before you begin

The following steps describe how to add Hitachi Data System storage to ViPR using the REST API. To use the ViPR UI to add Hitachi Data System storage to ViPR, see the Add Storage Systems Using the ViPR UI article.

Procedure

  1. Add the Hitachi Data Systems 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>
        <creation_time>1422996419083</creation_time>
        <global>false</global>
        <id>urn:storageos:Task:83b36945-6c96-442c-a137-602eb8eb0c3c:vdc1</id>
        <inactive>false</inactive>
        <internal>false</internal>
        <link rel="self" href="/vdc/tasks/urn:storageos:Task:83b36945-6c96-442c-a137-602eb8eb0c3c:vdc1"/>
        <name>SCAN STORAGE PROVIDER</name>
        <remote>false</remote>
        <tags/>
        <vdc>
            <id>urn:storageos:VirtualDataCenter:99c5c185-ebb0-468a-8fe7-3ea6e65b7b57:vdc1</id>
            <link rel="self" href="/vdc/urn:storageos:VirtualDataCenter:99c5c185-ebb0-468a-8fe7-3ea6e65b7b57:vdc1"/>
        </vdc>
        <associated_resources/>
        <description>scan storage provider</description>
        <op_id>c3fd0faf-fa92-438e-ba89-694e22f7707b</op_id>
        <progress>0</progress>
        <resource>
            <id>urn:storageos:StorageProvider:79f2885f-98ea-4974-875c-991f2a1410ae:vdc1</id>
            <link rel="self" href="/vdc/storage-providers/urn:storageos:StorageProvider:79f2885f-98ea-4974-875c-991f2a1410ae:vdc1"/>
            <name>hdsdevicemgr</name>
        </resource>
        <start_time>1422996419081</start_time>
        <state>pending</state>
    </task>
    
    
  2. Query the Hitachi Data Systems 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/tasks/urn:storageos:Task:83b36945-6c96-442c-a137-602eb8eb0c3c:vdc1
    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>
        <creation_time>1422996419083</creation_time>
        <global>false</global>
        <id>urn:storageos:Task:83b36945-6c96-442c-a137-602eb8eb0c3c:vdc1</id>
        <inactive>false</inactive>
        <internal>false</internal>
        <link rel="self" href="/vdc/tasks/urn:storageos:Task:83b36945-6c96-442c-a137-602eb8eb0c3c:vdc1"/>
        <name>SCAN STORAGE PROVIDER</name>
        <remote>false</remote>
        <tags/>
        <vdc>
            <id>urn:storageos:VirtualDataCenter:99c5c185-ebb0-468a-8fe7-3ea6e65b7b57:vdc1</id>
            <link rel="self" href="/vdc/urn:storageos:VirtualDataCenter:99c5c185-ebb0-468a-8fe7-3ea6e65b7b57:vdc1"/>
        </vdc>
        <associated_resources/>
        <description>scan storage provider</description>
        <end_time>1422996605639</end_time>
        <message>Operation completed successfully</message>
        <op_id>c3fd0faf-fa92-438e-ba89-694e22f7707b</op_id>
        <progress>100</progress>
        <resource>
            <id>urn:storageos:StorageProvider:79f2885f-98ea-4974-875c-991f2a1410ae:vdc1</id>
            <link rel="self" href="/vdc/storage-providers/urn:storageos:StorageProvider:79f2885f-98ea-4974-875c-991f2a1410ae:vdc1"/>
            <name>hdsdevicemgr</name>
        </resource>
        <start_time>1422996419081</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.

Back to Top