Nexfs Management API Documentation

Method Index

UpdateConfigs

Update Multiple Nexfs Configurations with a single Management API request


Action: UpdateConfigs

Update the values of one or more Nexfs Configuration settings

Permissions

To replace the installed nexfs license key (NEXFSLICENSEKEY) the requesting session must have the nexfs/UpdateLicense role enabled.


To administration pause or unpause Nexfs (NEXFSPAUSED) the requesting session must have the nexfs/PauseServer role enabled.


To set the value of NFSENABLED or NFSSTARTSTOP the requesting session must have the nexfs/ManageNFSSubSystem role enabled.

To set the value of iSCSIENABLED the requesting session must have the nexfs/ManageIScsiSubSystem role enabled.

To set any other configuration value the requesting session must have the nexfs/UpateNexfsConfiguration role enabled.

Request Parameters

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


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

Action

UpdateConfigs

RequestJson

A URI encoded json string containing a list of Nexfs configurations to return


RequestJson Format


{

"Configs": [ {

"VarName": "configurationname",

"NewValue": "newalue",

"UpdateMode": "updatemode"

}

,....

}


RequestJson Elements


Configs

Root Level tag for the request


VarName

The name of a Nexfs configuration to be updated

NewName

The value to update the Nexfs configuration to

UpdateMode

Mode must be set to 1, 2 or 3

If the request mode is set to 1 then only the configuration value is update (a reboot is required for the new value to become active)


If the request mode is set to 2 then only the live (active) value is updated, on reboot the live value will revert to the configuration value


If the request mode is set to 3 then both the configuration and also the live (active) values are updated


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 Revoke Session 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 is generally returned if either RequestVar or Mode is missing from the request

400 BadRequest The Request Action is unknown

400 InvalidArgument The Request Update Configuration Tag is Unknown

There is no configuration that matches the ConfigurationVarName


400 InvalidArgument The Request new value does not validate against required constraints


401 Unauthorized The request cannot be authenticated

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

405 MethodNotAllowed The Requested Configuration cannot be live updated

The requested tried to live update a configuration than cannot only be changed on nexfs restart


500 InternalServerError An Internal Error was encountered


Example Request


GET http://dev01kedavpn:9200/nexfsconsoleapi?Action=UpdateConfigs&RequestJSON={%20%22Configs%22:%20[%20{%20%22VarName%22:%20%22CACHELOCKWAIT%22,%22NewValue%22:%20%2211%22,%22UpdateMode%22:%20%223%22},{%20%22VarName%22:%20%22MAXHANDLEPAGES%22,%22NewValue%22:%20%225%22,%22UpdateMode%22:%20%221%22}]%20}

Authorization: AWS4-HMAC-SHA256 Credential=617087001b0b4a8280dba21645a38f6b/20220829/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=4823a9b065cad7ebfcf1be8abf083caf2e929e166fcc7e6245750e28b32137e9

host: nexfs.example.com

x-amz-date: 20220829T104840Z

Example Response


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

<RequestCompleted>

<Code>Ok</Code>

<Message>Request Completed</Message>

<Resource>/nexfsconsoleapi</Resource>

<RequestId>38</RequestId>

</RequestCompleted>