Add EMC VPLEX storage to ViPR using the REST API

Table of Contents

Back to Top


This article provides ViPR System Administrators the ViPR support requirements and prerequisite information to prepare EMC VPLEX storage systems 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 and registered 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 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

EMC VPLEX storage system support

ViPR supports VPLEX in a Local or Metro configuration. VPLEX Geo configurations are not supported.

For supported versions, see the EMC ViPR Support Matrix on the EMC Community Network (

Back to Top

ViPR configuration requirements for VPLEX storage systems

Before adding VPLEX storage systems to ViPR, validate that the VPLEX environment is configured as follows:

Back to Top

Add VPLEX storage to ViPR

Add the VPLEX management server to ViPR using the REST API.

Before you begin

You need the following information:
  • The IP address of the VPLEX management server.
  • The username and password for connecting to the storage system. System administrator privileges are required.
  • The port number used to connect to the storage system. The default port number for a VPLEX management server is 443.
  • Authenticate with the ViPR REST API as a user with the System Administrator role.


  1. Add a VPLEX by sending a POST /vdc/storage-providers request.
    The request returns a task whose URI can be queried to determine when the task is complete.

    POST https://<ViPR_VIP>:4443/vdc/storage-providers Content-Type: application/xml X-SDS-AUTH-TOKEN: <AUTH_TOKEN> <storage_provider_create> <name>VPLEX_MET</name> <interface_type>vplex</interface_type> <ip_address></ip_address> <port_number>443</port_number> <user_name>admin</user_name> <password>Password1</password> <use_ssl>true</use_ssl> </storage_provider_create>


    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>fc877306-03df-470d-bc31-07457781d717</op_id> <resource> <id>urn:storageos:StorageProvider:4e6596f7-89c4-4103-bf28-d0b45b400c9f:vdc1</id> <link rel="self" href="/vdc/storage-providers/urn:storageos:StorageProvider:4e6596f7-89c4-4103-bf28-d0b45b400c9f:vdc1"/> <name>VPLEX_MET</name> </resource> <link rel="self" href="/vdc/storage-providers/urn:storageos:StorageProvider:4e6596f7-89c4-4103-bf28-d0b45b400c9f:vdc1/tasks/fc877306-03df-470d-bc31-07457781d717"/> <start_time>1400186174642</start_time> <state>pending</state> </task>

  2. Repeat the query of the VPLEX create task, using the task URL from the response body of the POST request, until the state attribute of the task is ready, and the message attribute of the task is Operation completed successfully.

    GET https://<ViPR_VIP>:4443/vdc/storage-providers/urn:storageos:StorageProvider:4e6596f7-89c4-4103-bf28-d0b45b400c9f:vdc1/tasks/fc877306-03df-470d-bc31-07457781d717 Content-Type: application/xml X-SDS-AUTH-TOKEN: <AUTH_TOKEN>


    HTTP 200 OK Content-Type: application/xml <task> <end_time>1400186222348</end_time> <message>Operation completed successfully</message> <op_id>fc877306-03df-470d-bc31-07457781d717</op_id> <resource> <id>urn:storageos:StorageProvider:4e6596f7-89c4-4103-bf28-d0b45b400c9f:vdc1</id> <link rel="self" href="/vdc/storage-providers/urn:storageos:StorageProvider:4e6596f7-89c4-4103-bf28-d0b45b400c9f:vdc1"/> <name>VPLEX_MET</name> </resource> <link rel="self" href="/vdc/storage-providers/urn:storageos:StorageProvider:4e6596f7-89c4-4103-bf28-d0b45b400c9f:vdc1/tasks/fc877306-03df-470d-bc31-07457781d717"/> <start_time>1400186174642</start_time> <state>ready</state> </task>

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

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.