- Block Services
- File Services
- Object Service
- Compute Services
-
Virtual Data Center Services
- Authentication Provider
- Auto Tiering
- Block Virtual Pool
- File Virtual Pool
- Migration
- Fabric Manager
- Network
- Protection System
- Storage Provider
- SMIS Provider
- Storage Tier
- Storage System
- Storage Port
- Storage Pool
- Trust Store Resource
- UnManaged Volume
- Unmanaged File System
- UnManaged Export Mask
- Virtual Array
- Virtual Data Center Capacity
- Virtual Data Center
- User Group
- Virtual Nas
- Tenant Services
- Config Services
- UI Services
- UI Services (Deprecated)
- System Management Services
- Other Services
- API Error Codes

Export
Export file system.
NOTE: This is an asynchronous operation.
id | the URN of a ViPR File system |
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 | String |
Valid Values:
|
<comments> | Description of the operation | String | |
<permissions> | Permissions for the file export | String |
Valid Values:
|
<root_user> | User with root permissions | String |
Valid Values:
|
<protocol> | File system export protocol. | String |
Valid Values:
|
<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 | String |
Valid Values:
|
<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 |
Valid Values:
|
<link> | A hyperlink to the details for this resource | ||
<creation_time> | A timestamp that shows when this resource was created in ViPR | DateTime |
Valid Values:
|
<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 |
Valid Values:
|
<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 |
Valid Values:
|
</task> |
Examples
Request
POST https://192.168.0.0:4443/file/filesystems/urn:storageos:FileShare:7d6dc956-9a38-4c17-bd68-9b82ef6e7111:/exports HTTP/1.1 Content-Type: application/xml X-SDS-AUTH-TOKEN: <AUTH_TOKEN> <filesystem_export> <endpoints> <endpoint>www.ford.com</endpoint> <endpoint>www.gmc.com</endpoint> <endpoint>www.pontiac.com</endpoint> </endpoints> <permissions>rw</permissions> <protocol>NFS</protocol> <root_user>nobody</root_user> <type>sys</type> </filesystem_export>
Response
HTTP/1.1 200 OK Content-Type: application/xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <task> <op_id>0a309485-b1f7-407b-adea-1a57a9f5840a</op_id> <resource> <id>urn:storageos:FileShare:7d6dc956-9a38-4c17-bd68-9b82ef6e7111:</id> <link href="/file/filesystems/urn:storageos:FileShare:7d6dc956-9a38-4c17-bd68-9b82ef6e7111:" rel="self"/> <name>fs-sarav-test-xml-1</name></resource> <link href="/file/filesystems/urn:storageos:FileShare:7d6dc956-9a38-4c17-bd68-9b82ef6e7111:/tasks/0a309485-b1f7-407b-adea-1a57a9f5840a" rel="self"/> <start_time>1380046935718</start_time> <state>pending</state> </task>