EMC ViPR REST API

Search (SHIFT+S)

API Reference


Export

POST /file/snapshots/{id}/exports

Add file share snapshot export.

NOTE: This is an asynchronous operation.

idthe URN of a ViPR Snapshot

Required Roles

  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<filesystem_export>
<type> Security type for the file export Valid values: sys = Default UNIX security krb5 = Kerberos security option krb5i = Kerberos security option krb5p = Kerberos security option String
<comments> Description of the operation String
<permissions> Permissions for the file export Valid values: ro = read only rw = read and write root = full permission String
<root_user> User with root permissions Valid values: root = only root has special access permissions nobody = nobody has special access permissions String
<protocol> File system export protocol. Valid values: CIFS = Common Internet File System NFS = Network File System String
<mount_point> The path representing the point in the file system where the file share being exported is mounted. String
<endpoints>
<endpoint> String 0-* Elements
</endpoints>
<sub_directory> The specific sub-directory under the file system that is being exported. If sub-directory is "null", entire file system is exported. String
</filesystem_export>

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>

JSON Example

Request
POST https://192.168.0.0:4443/file/snapshots/urn:storageos:Snapshot:24c83321-55a4-40d3-8a8f-2f6edbd18d49:/exports.json HTTP/1.1

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

{
    "endpoints": [
        "www.ford.com", 
        "www.gmc.com", 
        "www.pontiac.com"
    ], 
    "permissions": "ro", 
    "protocol": "NFS", 
    "root_user": "nobody", 
    "type": "sys"
}
Response
HTTP/1.1 200 OK
Content-Type: application/json 
 
{
    "link": {
        "href": "/file/snapshots/urn:storageos:Snapshot:24c83321-55a4-40d3-8a8f-2f6edbd18d49:/tasks/aac817fa-72d1-4b8c-ae73-5b02e6553242", 
        "rel": "self"
    }, 
    "op_id": "aac817fa-72d1-4b8c-ae73-5b02e6553242", 
    "resource": {
        "id": "urn:storageos:Snapshot:24c83321-55a4-40d3-8a8f-2f6edbd18d49:", 
        "link": {
            "href": "/file/snapshots/urn:storageos:Snapshot:24c83321-55a4-40d3-8a8f-2f6edbd18d49:", 
            "rel": "self"
        }, 
        "name": "fs-cosnetappf-00:50:56:91:58:91-092313174649-2"
    }, 
    "start_time": 1379958442647, 
    "state": "pending"
}