Nexfs Management API Documentation

Method Index

PutNFSExports

Update the NFS export configuration through the Nexfs Management API

Action: PutNFSExports

Put a new NFS exports configuration


Permissions

To update the nexfs nfs export configuration a requesting session must have the nfs/UpdateNFSConfiguration role enabled.

Request Parameters

A request must be made against the nexfs management console api with the PutNFSExports action.

The request must be signed with a valid AWS V4 style Signature using an active temporary session security token.


Action

PutNFSExports


RequestJson

A URI encoded json string containing the new NFS export configuration


RequestJson Format

{

"nfsexports": [{

"exportdir": "string",

"enabled": integer,

"auth": "string",

"secsys": integer,

"seckrb5": integer,

"seckrb5i": integer,

"seckrb5p": integer,

"rw": integer,

"async": integer,

"nowdelay": integer,

"squash": integer,

"anonuid": integer,

"anongid": integer,

"securelocks": integer,

"subtree_check": integer,

"rootexport": integer

}

, ...

}


RequestJson Elements

See the NFS Export Configuration Parameters section of NFS Configuration and Management for a description of request elements and accepted values.


Request Body

The request does not have a request body.


Response Syntax

HTTP1/1 200

<?xml version="1.0" encoding="UTF-8"?>

<RequestCompleted>

<Code>string</Code>

<Message>string</Message>

<Resource>string</Resource>

<RequestId>integer</RequestId>

</RequestCompleted>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.


The following data is returned in XML format by the service.


RequestCompleted

Root Level tag for the successful response


Code

OK


Message

Request Completed


Resource

/nexfsconsoleapi

RequestId

A requestid number that identifies the request made against the management api


Errors

Also See Rest Error Responses


400 BadRequest The request was Malformed

A BadRequest will be returned if RequestJson is missing from the request

A BadRequest will also be returned if RequestJson is incorrectly formatted


401 Unauthorized The request cannot be authenticated

403 Forbidden Session does not have the rights to perform the requested action


500 InternalServerError An Internal Error was encountered


Example Request


The RequestJSON in the following example request is:


{

"nfsexports": [

{

"exportdir": "/glen/glen1/glen2/glen3/glen4/glentop",

"enabled": 1,

"rootexport": 0,

"auth": "0",

"secsys": 0,

"seckrb5": 0,

"seckrb5i": 0,

"seckrb5p": 0,

"rw": 0,

"async": 0,

"nowdelay": 0,

"squash": 0,

"anonuid": 0,

"anongid": 0,

"securelocks": 0,

"subtree_check": 0

},

{

"exportdir": "/",

"enabled": 1,

"rootexport": 1,

"auth": "1",

"secsys": 1,

"seckrb5": 1,

"seckrb5i": 1,

"seckrb5p": 1,

"rw": 1,

"async": 1,

"nowdelay": 1,

"squash": 1,

"anonuid": 1,

"anongid": 1,

"securelocks": 1,

"subtree_check": 1

},

{

"exportdir": "/bfolder",

"enabled": 1,

"rootexport": 0,

"auth": "*",

"secsys": 1,

"seckrb5": 0,

"seckrb5i": 0,

"seckrb5p": 0,

"rw": 0,

"async": 0,

"nowdelay": 0,

"squash": 0,

"anonuid": -1,

"anongid": -1,

"securelocks": 1,

"subtree_check": 1

}

]

}

GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=PutNFSExports&RequestJSON={%20%22nfsexports%22:%20[{%20%22exportdir%22:%20%22/glen/glen1/glen2/glen3/glen4/glentop%22,%20%22enabled%22:%201,%20%22rootexport%22:%200,%20%22auth%22:%20%220%22,%20%22secsys%22:%200,%20%22seckrb5%22:%200,%20%22seckrb5i%22:%200,%20%22seckrb5p%22:%200,%20%22rw%22:%200,%20%22async%22:%200,%20%22nowdelay%22:%200,%20%22squash%22:%200,%20%22anonuid%22:%200,%20%22anongid%22:%200,%20%22securelocks%22:%200,%20%22subtree_check%22:%200},{%20%22exportdir%22:%20%22/%22,%20%22enabled%22:%201,%20%22rootexport%22:%201,%20%22auth%22:%20%221%22,%20%22secsys%22:%201,%20%22seckrb5%22:%201,%20%22seckrb5i%22:%201,%20%22seckrb5p%22:%201,%20%22rw%22:%201,%20%22async%22:%201,%20%22nowdelay%22:%201,%20%22squash%22:%201,%20%22anonuid%22:%201,%20%22anongid%22:%201,%20%22securelocks%22:%201,%20%22subtree_check%22:%201},{%20%22exportdir%22:%20%22/bfolder%22,%20%22enabled%22:%201,%20%22rootexport%22:%200,%20%22auth%22:%20%22*%22,%20%22secsys%22:%201,%20%22seckrb5%22:%200,%20%22seckrb5i%22:%200,%20%22seckrb5p%22:%200,%20%22rw%22:%200,%20%22async%22:%200,%20%22nowdelay%22:%200,%20%22squash%22:%200,%20%22anonuid%22:%20-1,%20%22anongid%22:%20-1,%20%22securelocks%22:%201,%20%22subtree_check%22:%201}%20%20]%20%20}

Authorization: AWS4-HMAC-SHA256 Credential=884a267e3d024d9fb13e4f8bf88913da/20220823/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=577758f32f9efeac06572af8d0e867b66a2c6dfd77203156d948827af7cc4b66

content-type: application/x-www-form-urlencoded; charset=utf-8

host: nexfs.example.com

x-amz-date: 20220823T180356Z

Example Response


<?xml version="1.0" encoding="UTF-8"?>

<RequestCompleted>

<Code>Ok</Code>

<Message>Request Completed</Message>

<Resource>/nexfsconsoleapi</Resource>

<RequestId>309</RequestId>

</RequestCompleted>