EMC ViPR REST API

Search (SHIFT+S)

API Reference


Create Cluster

POST /tenants/{id}/clusters

Creates a new host cluster for the tenant organization.

idthe tenant organization id

Required Roles

  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<cluster_create>
<name> The name label for this cluster. It must be unique within the tenant. String
<vcenter_data_center> The name of data center in vCenter for an ESX cluster. URI
<project> This field is currently not used. Any values passed into it will be ignored. URI
<auto_export_enabled> Boolean
</cluster_create>

Response Body

The host discovery async task representation.

Field Description Type Notes
<cluster>
<project>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</project>      
<vcenter_data_center>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vcenter_data_center>      
<auto_export_enabled> If discovery will auto export to this cluster. Boolean
<volume_groups>
<volume_group>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</volume_group>      
</volume_groups>
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<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
</cluster>

Examples

Request
POST https://192.168.0.0:4443/tenants/urn:storageos:TenantOrg:79600b60-eb8e-4073-802d-7ef9be620893:/clusters HTTP/1.1

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

<cluster_create>
  <name>clustername</name>
</cluster_create>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
 
<cluster>
     <creation_time>1379960786878</creation_time>
     <id>urn:storageos:Cluster:9fab32b5-ccff-42e6-9df2-448311e4fafa:</id>
     <inactive>false</inactive>
     <link href="/compute/clusters/urn:storageos:Cluster:9fab32b5-ccff-42e6-9df2-448311e4fafa:" rel="self"/>
     <name>clustername</name>
     <tags/>
     <tenant>
          <id>urn:storageos:TenantOrg:79600b60-eb8e-4073-802d-7ef9be620893:</id>
          <link href="/tenants/urn:storageos:TenantOrg:79600b60-eb8e-4073-802d-7ef9be620893:" rel="self"/>
     </tenant>
</cluster>