EMC ViPR REST API

Search (SHIFT+S)

API Reference


Modified since last release

Snapshot

POST /file/filesystems/{id}/protection/snapshots

Create file system snapshot

NOTE: This is an asynchronous operation.

idthe URN of a ViPR File system

Required Roles

  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<filesystem_snapshot_create>
<name> User provided name/label for the snapshot. String
</filesystem_snapshot_create>

Response Body

Task resource representation

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>

Examples

Request
POST https://192.168.0.0:4443/file/filesystems/urn:storageos:FileShare:3f8891a8-9d99-45fb-9c5d-0b0f57da6bb9:/protection/snapshots HTTP/1.1

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

</FileSystemSnapshotParam>
    <name>forceDeleteTestNETAPP-092313174649</name>
</FileSystemSnapshotParam>
Response
HTTP/1.1 200 OK 
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <task>
  <description>Filesystem snapshot create</description>
  <op_id>60f2a6a5-8bd2-4123-8650-d1e732e1da67</op_id>
  <resource>
    <id>urn:storageos:Snapshot:44e0a6e0-1b06-4265-8876-fa4d4a612d18:</id>
    <link href="/file/snapshots/urn:storageos:Snapshot:44e0a6e0-1b06-4265-8876-fa4d4a612d18:" rel="self"/>
    <name>forceDeleteTestNETAPP-092313174649</name>
  </resource>
  <link href="/file/snapshots/urn:storageos:Snapshot:44e0a6e0-1b06-4265-8876-fa4d4a612d18:/tasks/60f2a6a5-8bd2-4123-8650-d1e732e1da67" rel="self"/>
  <start_time>1379958498780</start_time>
  <state>pending</state>
 </task>