EMC ViPR REST API

Search (SHIFT+S)

API Reference


Relink Target Volumes For Volume Group Session

POST /volume-groups/block/{id}/protection/snapshot-sessions/relink-targets

The method implements the API to re-link a target to either its current snapshot sessions or to a different snapshot sessions of the same source in the volume group. - Re-links targets for all the array replication groups within this Application. - If partial flag is specified, it re-links targets only for set of array replication groups. A snapshot session from each array replication group can be provided to indicate which array replication groups's sessions needs to be linked.

idThe URI of the volume group.

Required Roles

  • TENANT_ADMIN

Prerequisites

These conditions must be met before calling this operation.

  • The target volumes are linked to a snapshot session of the same source object.

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<volume_group_snapshot_session_relink_targets>
<ids> Gets the URIs of the linked targets to be re-linked.
<id> URI 0-* Elements
</ids>
<target_name> String
<partial> Boolean which indicates whether we need to operate on snapshot session for the entire Application or for set of array replication groups. By default it is set to false, and consider that snapshots to be operated for all array replication groups in an Application. If set to true, sessions list should be provided with session URIs one from each Array replication group. In any case, minimum of one session URI needs to be specified in order to identify the session set. Boolean
<snapshot_sessions>
<snapshot_session> URI 0-* Elements
</snapshot_sessions>
<copy_set_name> String
<subgroups>
<subgroup> String 0-* Elements
</subgroups>
</volume_group_snapshot_session_relink_targets>

Response Body

TaskList

This is an asychronous operation that returns a task object. For information on working with tasks, see Asynchronous Operations.

Field Description Type Notes
<tasks>
<task>     0-* Elements
<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>      
</tasks>