Add EMC VNX for File Storage to ViPR using the ViPR REST API




This article provides ViPR System Administrators, using the ViPR REST API, the ViPR support requirements, and prerequisite information to prepare EMC VNX for File storage systems for ViPR integration, and the steps to add the storage to ViPR.

This article also describes how the storage is discovered, and registered after it is added to ViPR, and some of the important ViPR REST API calls that can be performed on 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:


VNX for File storage system support

Supported versions Supported protocols
EMC VNX OE for File:


ViPR configuration requirements for VNX for File storage systems

Before adding VNX for File storage to ViPR, configure the storage as follows.


Add VNX for File storage system

Before you begin

You need the following information:
  • For the VNX File Control Station:
    • The IP address of the Control Station.
    • The port number used to connect to the Control Station. The default is 443.
    • VNX File user credentials with storage system administrator privileges.
  • For the Onboard Storage Provider:
    • The storage provider host.
    • The port number used to connect to the VNX File Onboard Storage Provider. The default is 5988.
    • User credentials to access the Onboard Storage Provider.
    • Whether SSL is used to communicate with the Onboard Storage Provider.
  • The system type is vnxfile.
  • Authenticate with the ViPR REST API as a user with the System Administrator role.

The EMC ViPR REST API Reference provides a description and complete list of parameters for the REST API methods used in this article.


  1. Add the EMC VNX File storage system by sending a POST to /vdc/storage-systems.
    The request returns a task whose URI can be queried to determine the status of the task..

    POST https://<ViPR_VIP>:4443/vdc/storage-systems <storage_system_create> <name>file_west_1</name> <system_type>vnxfile</system_type> <ip_address></ip_address> <port_number>443</port_number> <user_name>administrator</user_name> <password>password</password> <smis_provider_ip></smis_provider_ip> <smis_port_number>5988</smis_port_number> <smis_user_name>sp_admin</smis_user_name> <smis_password>Password1</smis_password> <smis_use_ssl>false</smis_use_ssl> </storage_system_create>


    HTTP 202 Accepted <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <task> <associated_resources/> <description>DISCOVER_STORAGE_SYSTEM</description> <op_id>d12e0908-9742-4d55-80ab-1267d720778a</op_id> <resource> <id>urn:storageos:StorageSystem:bdb52521-7e48-4bcd-a65a-7cc876889e79:vdc1</id> <link rel="self" href="/vdc/storage-systems/urn:storageos:StorageSystem:bdb52521-7e48-4bcd-a65a-7cc876889e79:vdc1"/> <name>file_west_1</name> </resource> <link rel="self" href="/vdc/storage-systems/urn:storageos:StorageSystem:bdb52521-7e48-4bcd-a65a-7cc876889e79:vdc1/tasks/d12e0908-9742-4d55-80ab-1267d720778a"/> <start_time>1399986690229</start_time> <state>pending</state> </task>

  2. Repeat the query of the EMC VNX File creation task, using the task URL from the response body of the POST request, until the message attribute of the task is Operation completed successfully.

    GET https://<ViPR_URL>:4443/vdc/storage-systems/urn:storageos:StorageSystem:bdb52521-7e48-4bcd-a65a-7cc876889e79:vdc1/tasks/d12e0908-9742-4d55-80ab-1267d720778a


    HTTP 200 OK <task> <associated_resources/> <description>DISCOVER_STORAGE_SYSTEM</description> <end_time>1399986690952</end_time> <message>Operation completed successfully</message> <op_id>d12e0908-9742-4d55-80ab-1267d720778a</op_id> <resource> <id>urn:storageos:StorageSystem:bdb52521-7e48-4bcd-a65a-7cc876889e79:vdc1</id> <link rel="self" href="/vdc/storage-systems/urn:storageos:StorageSystem:bdb52521-7e48-4bcd-a65a-7cc876889e79:vdc1"/> <name>file_west_1</name> </resource> <link rel="self" href="/vdc/storage-systems/urn:storageos:StorageSystem:bdb52521-7e48-4bcd-a65a-7cc876889e79:vdc1/tasks/d12e0908-9742-4d55-80ab-1267d720778a"/> <start_time>1399986690229</start_time> <state>ready</state> </task>


Network configuration requirements for storage

After the storage system is added to ViPR, create the IP networks to include in the virtual array, and be sure to add the necessary storage and host ports to use to provision the storage to the hosts.

ViPR can discover the ports of IP connected storage systems and hosts, but it cannot discover the paths between then, so it is necessary to create IP networks, and then add the host, and storage system ports, which will be provisioned together, to the same IP network.

Refer to Create and configure a ViPR virtual array using the ViPR REST API for more details.


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.