EMC ViPR REST API

Search (SHIFT+S)

API Reference


Register SMIS Provider

POST /vdc/smis-providers
This call has been deprecated and will be removed in future versions

Register an SMI-S provider to create storage systems of type vnxblock and vmax. This call is not used to create SMI-S providers for vnxfile.

The method is deprecated. Use /vdc/storage-providers instead.


Required Roles

  • SYSTEM_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<smis_provider_create>
<name> Name of the SMIS Provider String Valid Values:
  •  Length: 2..128
<ip_address> IP address of the SMIS provider. String
<port_number> The port number of the SMIS provider Integer
<user_name> User name of the SMIS provider String
<password> Password of the SMIS provider String
<use_ssl> Specifies whether to use SSL (Secure Sockets Layer) as the authentication method. Boolean
</smis_provider_create>

Response Body

Newly registered SMIS-Provider details

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 Valid values: queued = task is queued pending = task is pending ready = task succeed error = task fails suspended_error = task is suspended due to an error suspended_no_error = task is suspended due to config/request String
<allowed_operations> The allowed operations of the task String
<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
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<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
<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
</task>

Examples

Request
POST https://192.168.0.0:4443/vdc/smis-providers HTTP/1.1

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

<smis_provider_create>
    <ip_address>192.168.0.10</ip_address>
    <name>mysmis</name>
    <password>#1Password</password>
    <port_number>5988</port_number>
    <use_ssl>false</use_ssl>
    <user_name>admin</user_name>
</smis_provider_create>
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<task>
    <link href="/vdc/smis-providers/urn:storageos:SMISProvider:dce4a4c4-334b-4353-9484-c7b225f413d5:/tasks/e393ece4-44eb-42d2-9d8a-33e28b436daf" rel="self"/>
    <op_id>e393ece4-44eb-42d2-9d8a-33e28b436daf</op_id>
    <resource>
        <id>urn:storageos:SMISProvider:dce4a4c4-334b-4353-9484-c7b225f413d5:</id>
        <link href="/vdc/smis-providers/urn:storageos:SMISProvider:dce4a4c4-334b-4353-9484-c7b225f413d5:" rel = "self"/>
        <name>mysmis</name>
    </resource>
    <start_time>1379202542423</start_time>
    <state>pending</state>
</task>