Storage System:Create Storage System

Search (SHIFT+S)



Create Storage System

POST /vdc/storage-systems

Manually create a storage system that cannot be discovered using a SMI-S provider. By default the storage system will be auto-registered upon its creation. For the Block type storage system, the method would add a new system to the SMIS provider. The SMIS provider field in the input parameter file is ignored for file type storage systems (VNX file and Isilon )


Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • RESTRICTED_SYSTEM_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<storage_system_create>
<name> Name of the storage system String Valid Values:
  •  Length: 2..128
<system_type> Type of the storage system allowed on POST Possible values: isilon,vnxfile,netapp,rp String Valid Values:
  •  isilon
  •  vnxfile
  •  netapp
  •  rp
<ip_address> IP Address of the storage system String
<port_number> Port Number used to connect to the storage system Integer
<user_name> Username to connect to storage system String
<password> Password to connect to storage system String
<serial_number> Serial ID of the storage system String
<smis_provider_ip> IP Address of SMIS Provider This field is required for storage systems of type 'vnxfile'. It is ignored for other storage system types and can be null. String
<smis_port_number> Port number of SMIS Provider to connect to This field is required for storage systems of type 'vnxfile'. It is ignored for other storage system types and can be null. Integer
<smis_user_name> Username to connect to SMIS Provider This field is required for storage systems of type 'vnxfile'. It is ignored for other storage system types and can be null. String
<smis_password> Password to connect to SMIS provider This field is required for storage systems of type 'vnxfile'. It is ignored for other storage system types and can be null. String
<smis_use_ssl> Determines the protocol used for connection purposes. If HTTPS, then set true, else false. This field is required for storage systems of type 'vnxfile'. It is ignored for other storage system types and can be null. Boolean Valid Values:
  •  true
  •  false
</storage_system_create>

Response Body

An asynchronous task corresponding to the discovery job scheduled for the new Storage System.

This is an asychronous operation that returns a task object. For information on working with tasks, see Asynchronous Operations.

Field Description Type Notes
<task>
<op_id> The task operation id String
<resource>    
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</resource>      
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<associated_resources> A list of links for associated resources
<associated_resource>     0-* Elements
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</associated_resource>      
</associated_resources>
<state> The state of the task String Valid Values:
  •  pending = task is pending
  •  ready = task succeed
  •  error = task fails
<message> The task detail message String
<description> The description of the task String
<service_error>    
<code> The numerical code associated with the error encountered when processing a service request Integer
<description> The description of the error String
<details> Detailed information concerning the error String
</service_error>      
<start_time> The date and time of when the task was started DateTime
<end_time> The date and time of when the task ended DateTime
<progress> Integer
<workflow>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</workflow>      
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
  •  urn:storageos:resource-type:UUID:
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean Valid Values:
  •  true
  •  false
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean Valid Values:
  •  true
  •  false
</task>

Examples

Request
POST https://192.168.0.0:4443/vdc/storage-systems HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<storage_system_create>
   <ip_address>192.168.0.0</ip_address>
   <name>VNX-2</name>
   <password>admin</password>
   <port_number>80</port_number>
   <serial_number>APM00120701245</serial_number>
   <smis_password>#1Password</smis_password>
   <smis_port_number>5988</smis_port_number>
   <smis_provider_ip>192.168.0.0</smis_provider_ip>
   <smis_use_ssl>false</smis_use_ssl>
   <smis_user_name>admin</smis_user_name>
   <system_type>vnxblock</system_type>
   <user_name>admin</user_name>
</storage_system_create>
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<task>
   <link href="/vdc/storage-systems/urn:storageos:StorageSystem:7bade78c-bcfb-4f75-bcca-397a589657e6:/tasks/436cc6fa-688d-42c2-b230-22b4e8915a9f"
      rel="self">
   </link>
   <op_id>436cc6fa-688d-42c2-b230-22b4e8915a9f</op_id>
   <resource>
      <id>urn:storageos:StorageSystem:7bade78c-bcfb-4f75-bcca-397a589657e6:</id>
      <link href="/vdc/storage-systems/urn:storageos:StorageSystem:7bade78c-bcfb-4f75-bcca-397a589657e6:"
         rel="self"
      </link>
   </resource>
   <start_time>1380199087999</start_time>
   <state>pending</state>
</task>
Notes: