Nexfs Management API Documentation

Method Index

GetConfig

Retrieving Nexfs Configuration Information


Action: GetConfig

Request the value of a Nexfs Configuration setting

Permissions


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


To find out if Nexfs is administrator paused (NEXFSPAUSED) the requesting session must have the nexfs/PauseServer role enabled.


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

To request the value of iSCSIENABLED the requesting session must have the nexfs/GetIScsiSubSystem role enabled.


To retrieve any other configuration value the requesting session must have the nexfs/GetNexfsConfiguration role enabled.


Request Parameters


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

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

Action

GetConfig

Mode

Mode must be set to 1 or 2

If the request mode is set to 1 then only the configuration values are returned


If the request mode is set to 2 then the configuration values and all configuration attributes are returned

RequestVar

Which Nexfs configuration setting to return the value of


Request Body

The request does not have a request body.

Response Syntax

Response for requests with Mode set to 1

HTTP1/1 200

{

"configurationsetting string": {

"LiveValue": "string",

"ConfigValue": "string"

}

}


Response for requests with Mode set to 2

HTTP1/1 200

{

"configurationsetting string": {

"LiveValue": "string",

"ConfigValue": "string"

,"Tag": "string"

,"Help": "string"

,"String": "string"

,"Min": "string"

,"Max": "string"

,"Restart": "string"

}

Response Elements

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


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


configurationsetting string

A string tag that matches the requested RequestVar


LiveValue

The active value, i.e. the value currently being used by the live nexfs server.


ConfigValue

The value stored in the nexfs startup configuration, this value will become active next time Nexfs starts

Tag

A short label for the configuration setting

Help

A short help description for the configuration setting


String

If the settings requires a string value "1" or a integer "0"


Min

If the settings requires a string value this is the minimum number of allowed character, if its requires a integer this is the smallest value allowed


Max

If the settings requires a string value this is the maximum number of allowed character, if its requires a integer this is the largest value allowed

Restart

If the returned value is "0" then the setting can be update live without restarting Nexfs, if "1" then Nexfs must be restarted before a updated value becomes active

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 InvalidArgument The Requested Configuration Label does not exist

There is no configuration that matches the RequestVar


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


GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=GetConfig&ConfigurationVarName=NEXFSLICENSEKEY&Mode=1

Authorization: AWS4-HMAC-SHA256 Credential=e01920da85cf44dfa1f670dc52073a28/20220823/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=d92d8e66b23619d5ea3c278b048bd2d1f63335928611c61b891db6a3e968ab02

host: nexfs.example.com

x-amz-date: 20220823T130753Z

Example Mode 1 Response

{

"NEXFSPAUSED": {

"LiveValue": "0",

"ConfigValue": "0"

}

}

Example Mode 2 Response


{

"NEXFSPAUSED": {

"LiveValue": "0",

"ConfigValue": "0"

,"Tag": "Nexfs Operations Paused"

,"Help": "When paused nexfs will stop accepting file opens/creates/reads and writes, does not effect the job scheduler or bg migrations"

,"String": "0"

,"Min": "0"

,"Max": "1"

,"Restart": "0"

}

}