EMC ViPR REST API

Search (SHIFT+S)

API Reference


Migrate Volume

POST /block/migrations
This call has been deprecated and will be removed in future versions

Performs a non-disruptive migration for the passed VPLEX virtual volume. The backend volume of the VPLEX volume that is migrated is the backend volume on the passed source storage system. The volume is migrated to the passed target storage system, which must be connected to the same VPLEX cluster as the source storage system.


Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<migration_create>
<volume> The id of the VPlex virtual volume to be migrated. URI
<source_storage_system> The source storage system from which the volume is to be migrated. This identifies the storage system of the backend volume to be migrated. URI
<target_storage_system> The target storage system to which the volume is to be migrated. This identifies the storage system on which to create the new backend volume to which the source will be migrated. URI
<vpool> The virtual pool for the volume on the target storage system. URI
</migration_create>

Response Body

A TaskResourceRep for the volume being migrated.

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>