File System:Update FS Export Rules

Search (SHIFT+S)

API Reference


Update FS Export Rules

PUT /file/filesystems/{id}/export

Existing file system exports may have their list of export rules updated.

idthe URN of a ViPR fileSystem

Query Parameters

subDirsub-directory within a filesystem

Required Roles

  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<filesystem_export_update>
<add>    
<exportRules> List of exportRules to be modified
<exportRule>     0-* Elements
<fsID> URI
<snapShotID> URI
<exportPath> String
<readOnlyHosts>
<endPoint> String 0-* Elements
</readOnlyHosts>
<readWriteHosts>
<endPoint> String 0-* Elements
</readWriteHosts>
<rootHosts>
<endPoint> String 0-* Elements
</rootHosts>
<secFlavor> Security flavor of an export e.g. sys, krb, krbp or krbi String
<anon> Anonymous root user mapping e.g. "root", "nobody" or "anyUserName" String
<mountPoint> String
<deviceExportId> String
<comments> String
</exportRule>      
</exportRules>
</add>      
<delete>    
<exportRules> List of exportRules to be modified
<exportRule>     0-* Elements
<fsID> URI
<snapShotID> URI
<exportPath> String
<readOnlyHosts>
<endPoint> String 0-* Elements
</readOnlyHosts>
<readWriteHosts>
<endPoint> String 0-* Elements
</readWriteHosts>
<rootHosts>
<endPoint> String 0-* Elements
</rootHosts>
<secFlavor> Security flavor of an export e.g. sys, krb, krbp or krbi String
<anon> Anonymous root user mapping e.g. "root", "nobody" or "anyUserName" String
<mountPoint> String
<deviceExportId> String
<comments> String
</exportRule>      
</exportRules>
</delete>      
<modify>    
<exportRules> List of exportRules to be modified
<exportRule>     0-* Elements
<fsID> URI
<snapShotID> URI
<exportPath> String
<readOnlyHosts>
<endPoint> String 0-* Elements
</readOnlyHosts>
<readWriteHosts>
<endPoint> String 0-* Elements
</readWriteHosts>
<rootHosts>
<endPoint> String 0-* Elements
</rootHosts>
<secFlavor> Security flavor of an export e.g. sys, krb, krbp or krbi String
<anon> Anonymous root user mapping e.g. "root", "nobody" or "anyUserName" String
<mountPoint> String
<deviceExportId> String
<comments> String
</exportRule>      
</exportRules>
</modify>      
<subDir> String
</filesystem_export_update>

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