ViPR 2.4 REST API

Storage Provider:Register Storage Provider

EMC ViPR REST API

Search (SHIFT+S)

API Reference

API Changes

Register Storage Provider

POST /vdc/storage-providers

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
RESTRICTED_SYSTEM_ADMIN

Request Payload

<storage_provider_create>
   <name></name>
   <ip_address></ip_address>
   <port_number></port_number>
   <user_name></user_name>
   <password></password>
   <use_ssl></use_ssl>
   <interface_type></interface_type>
   <sio_cli></sio_cli>
   <secondary_username></secondary_username>
   <secondary_password></secondary_password>
   <element_manager_url></element_manager_url>
</storage_provider_create>

{
  "name": "",
  "ip_address": "",
  "port_number": "",
  "user_name": "",
  "password": "",
  "use_ssl": "",
  "interface_type": "",
  "sio_cli": "",
  "secondary_username": "",
  "secondary_password": "",
  "element_manager_url": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
<storage_provider_create>
<name>	Name of the Storage Provider	String	Valid Values: Length: 2..128
<ip_address>	IP address of the Storage provider.	String	Valid Values: example: 10.247.99.87
<port_number>	The port number of the Storage provider	Integer	Valid Values: example: 2001
<user_name>	User name of the Storage provider	String	Valid Values: example: system
<password>	Password of the Storage provider	String	Valid Values: example: none
<use_ssl>	Specifies whether to use SSL (Secure Sockets Layer) as the authentication method.	Boolean
<interface_type>	Interface type of the Storage Provider	String	Valid Values: example: hicommand,smis,vplex,cinder,scaleio,ddmc,ibmxiv
<sio_cli>	A command prefix to invoke the ScaleIO CLI. This is an optional parameter and is only applicable for a ScaleIO StorageProvider.	String
<secondary_username>	Secondary credentials that may be required for management	String
<secondary_password>		String
<element_manager_url>	URL of the Element Management system that is associated with the Provider.	String
</storage_provider_create>

Response Body

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: queued = task is queued 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>
<queuedStartTime>		DateTime
<queueName>		String
<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>