File System:Create File System

Search (SHIFT+S)

API Reference


Modified since last release

Create File System

POST /file/filesystems

Creates file system. The VNX File array does not allow 'root' as the beginning of a file system name. If the generated file system name begins with 'root', then the VNX File array will return an error.

NOTE: This is an asynchronous operation.


Query Parameters

projectthe URN of a ViPR Project

Required Roles

  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<filesystem_create>
<name> User provided name or label assigned to the file system. String Valid Values:
  •  Length: 2..128
<size> Total capacity of the file system in Bytes. String
<vpool> URI representing the virtual pool supporting the file system. URI
<varray> URI representing the virtual array containing the file system. URI
<fs_id> User provided id for the file system String
<soft_limit> Integer
<soft_grace> Integer
<notification_limit> Integer
</filesystem_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 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?project=urn:storageos:Project:5e93a1ec-6a2c-457f-9ef6-16487265dc98: HTTP/1.1

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

<filesystem_create>
    <name>fs-sarav-test-xml-1</name>
    <size>20MB</size>
    <varray>urn:storageos:VirtualArray:8192a5e7-bb39-4f75-bdad-10f8fa1d105e:</varray> 
    <vpool>urn:storageos:VirtualPool:74cd5776-62fc-4972-ad10-da882db659b3:</vpool>
</filesystem_create>
Response
HTTP/1.1 200 OK 
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <task>
       <description>Filesystem create</description>
       <op_id>50ab3493-8896-423b-bc8a-24c01117caef</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/50ab3493-8896-423b-bc8a-24c01117caef" rel="self"/>
       <start_time>1380046335790</start_time>
       <state>pending</state>
  </task>
Notes: