Nexfs Management API Documentation

Method Index

GetLicenseDetails

Retrieve the installed License using the Nexfs Management API


Action: GetLicenseDetails

Request details of the installed Nexfs License Key


Permissions

To retrieve the nexfs system status a requesting session must have the nexfs/GetLicenseDetails role enabled.

Request Parameters

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

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

Action

GetLicenseDetails

Request Body

The request does not have a request body.


Response Syntax


HTTP1/1 200

{

"License": {

"Version": "string",

"ID": "string",

"Expiry": "string",

"License": "string",

"Capacity": "string",

"FeatureTier2": "string",

"FeatureSmartTier": "string",

"FeatureSmartProtect": "string",

"FeatureSmartProtectOpenFiles": "string",

"FeatureSmartTierOpenFiles": "string",

"FeatureTier3Compression": "string",

"FeatureTier3Encryption": "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.


License

A JSON tag enclosing the successful Get License response


Version

The license version.

Expiry

A date/time formatted string if the license has a expiry date, or "n/a"

FeatureTier2

A string of either "Enabled" or "Disabled" depending if the license allows a Tier2 data volume to be enabled


FeatureSmartTier

A string of either "Enabled" or "Disabled" depending if the license allows Smart Tiering to be enabled

FeatureSmartProtect

A string of either "Enabled" or "Disabled" depending if the license allows Smart Protection to be enabled

FeatureSmartProtectOpenFiles

A string of either "Enabled" or "Disabled" depending if the license allows Smart Protection of openfiles to be enabled


FeatureSmartTierOpenFiles

A string of either "Enabled" or "Disabled" depending if the license allows Smart Tiering of openfiles to be enabled


FeatureTier3Compression

A string of either "Enabled" or "Disabled" depending if the license allows compression of Tier3 data chunks


FeatureTier3Encryption

A string of either "Enabled" or "Disabled" depending if the license allows encryption of Tier3 data chunks


Errors


Also See Rest Error Responses

401 Unauthorized The request cannot be authenticated


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


Example Request


GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=GetSLicenseDetails

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

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

host: nexfs.example.com

x-amz-date: 20220823T124614Z

Example Response


{

"License": {

"Version": "0",

"ID": "0",

"Expiry": "n/a",

"License": "Community",

"Capacity": "5TB",

"FeatureTier2": "Disabled",

"FeatureSmartTier": "Disabled",

"FeatureSmartProtect": "Enabled",

"FeatureSmartProtectOpenFiles": "Disabled",

"FeatureSmartTierOpenFiles": "Disabled",

"FeatureTier3Compression": "Disabled",

"FeatureTier3Encryption": "Disabled"

}

}