EMC ViPR REST API

Search (SHIFT+S)

API Reference


Create Volume Group

POST /volume-groups/block

Create a volume group


Required Roles

This call has no restrictions.


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<volume_group_create>
<name> volume group unique name Valid values: minimum of 2 characters maximum of 128 characters String Valid Values:
  •  Length: 2..128
<description> volume group description String
<roles>
<role> String 0-* Elements
</roles>
<parent> String
<migration_type> String
<migration_group_by> String
</volume_group_create>

Response Body

Created volume group

Field Description Type Notes
<volume_group>
<description> String
<roles>
<role> String 0-* Elements
</roles>
<parent>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</parent>      
<migrationType> Migration type for the mobility group String
<migrationGroupBy> Migration group by type for the mobility group String
<replication_group_names>
<replication_group_name> String 0-* Elements
</replication_group_names>
<virtual_arrays>
<virtual_array>     0-* Elements
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</virtual_array>      
</virtual_arrays>
<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
</volume_group>