Block Snapshot Session:Link Target Volumes

Search (SHIFT+S)

API Reference


New in this release

Link Target Volumes

POST /block/snapshot-sessions/{id}/link-targets

The method implements the API to create and link new target volumes to an existing BlockSnapshotSession instance.

idThe URI of the BlockSnapshotSession instance to which the new targets will be linked.

Required Roles

  • TENANT_ADMIN

Prerequisites

These conditions must be met before calling this operation.

  • The block snapshot session has been created and the maximum number of targets has not already been linked to the snapshot sessions for the source object.

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<snapshot_session_link_targets>
<new_linked_targets>    
<count> Get the number of new targets to create and link to the snapshot session. Integer
<target_name> Get the name to use for the targets. String
<copy_mode> Get the copy mode for the new target volumes to be linked to the block snapshot session. A volume that is linked to a snapshot session using "copy" copy_mode and achieves the "copied" state will contain a full, usable copy of the snapshot session source device upon being unlinked from the session. This is not true for volumes linked in "nocopy" copy-mode. Valid values: copy nocopy String
</new_linked_targets>      
</snapshot_session_link_targets>

Response Body

A TaskResourceRep representing the snapshot session task.

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 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>
Notes: