Nexfs Management API Documentation

Method Index

GetSystemStatus

Querying the Nexfs System Status using the Management API


Action: GetSystemStatus

Request the current status of the Nexfs server and services


Permissions

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


Request Parameters

A request must be made against the nexfs management console api with the GetSystemStatus Action.


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


Action

GetSystemStatus

Request Body

The request does not have a request body.


Response Syntax


HTTP1/1 200

{

"Status": {

"ServerStatus": "StatusString",

"Hostname": "string",

"Release": "string",

"SoftwareExpires": "string",

"License": "string",

"ManagedCapacity": "string",

"Process ID": "string",

"Uptime": "string",

"MountPoint": "string",

"OpenFiles": "string",

"StructureReplicationStatus": "StatusString",

"Tier1StructStatus": "StatusString",

"Tier2StructStatus": "StatusString",

"Tier1Status": "StatusString",

"Tier1ThresholdLevel": "StatusString",

"Tier1FloorLevel": "StatusString",

"Tier2Status": "StatusString",

"Tier2ThresholdLevel": "StatusString",

"Tier2FloorLevel": "StatusString",

"Tier3Status": "StatusString",

"iSCSIStatus": "StatusString",

"NFSStatus": "StatusString",

"MgmtWebServer": "StatusString",

"JobScheduler": "StatusString",

"BGMigrationScheduler": "StatusString",

"DeletionScheduler": "StatusString",

"ManualCommands": "StatusString"

}

}

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.


Status

Json tag enclosing the successful Get Session Status response


ServerStatus

A string representing the overall status of the nexfs server, see StatusString below for a list of possible status strings.

Hostname

A string that identifies the hostname of the server nexfs is running on

Release

A string that identifies the version of nexfs running


SoftwareExpires

A date/time formatted string if the nexfs software has a expiry date,

License

A string that identifies the type of license installed, or "Core xTB" if no valid license is installed.


ManagedCapacity

A string that shows the amount of data under nexfs management, shown in both TB and GB "xTB (xGB)".


Process ID

A string that shows the servers process id of the running nexfs instance.


Uptime

A string that shows how long the nexfs instance has been running, formatted "x days x hours x minutes x seconds.


MountPoint

A string that shows the fuse style mountpoint of the running nexfs instance on the underlying linux server.


OpenFiles

A string that shows the current number of open files and the high limit of allowed open files (x/y) x=current, y=high limit.

StructureReplicationStatus

A string representing the status of structure data replication, see StatusString below for a list of possible status strings.


Tier1StructStatus

A string representing the status of the primary structure data volume, see StatusString below for a list of possible status strings.


Tier2StructStatus

A string representing the status of the secondary (replication destination) structure data volume, see StatusString below for a list of possible status strings.

Tier1Status

A string representing the status of the volume configured for storing the most active data chunks, see StatusString below for a list of possible status strings.

Tier1ThresholdLevel

A string representing the current capacity level of the volume configured for storing the most active data, see StatusString below for a list of possible status strings.

Tier1FloorLevel

A string representing the lower current capacity target level of the volume configured for storing the most active data, see StatusString below for a list of possible status strings.


Tier2Status

A string representing the status of the volume configured for storing less active data, see StatusString below for a list of possible status strings.


Tier2ThresholdLevel

A string representing the current capacity level of the volume configured for storing less active data, see StatusString below for a list of possible status strings.

Tier2FloorLevel

A string representing the lower current capacity target level of the volume configured for storing less active data, see StatusString below for a list of possible status strings.


Tier3Status

A string representing the current status of the configured Tier3 object or Cloud Storage subsystem for storing the least active data, see StatusString below for a list of possible status strings.

iSCSIStatus

A string representing the current status of the iSCSI server (target) subsystem, see StatusString below for a list of possible status strings.


NFSStatus

A string representing the current status of the NFS management and configuration subsystem, see StatusString below for a list of possible status strings.


MgmtWebStatus

A string representing the current status of the Nexfs Web Management Console Service, see StatusString below for a list of possible status strings.


JobScheduler

A string representing the current status of the Nexfs Job Scheduler subsystem, see StatusString below for a list of possible status strings.


BGMigrationScheduler

A string representing the current status of the Nexfs Background Migration Scheduler subsystem, see StatusString below for a list of possible status strings.


BGMigrationScheduler

A string representing the current status of the Nexfs Background Deletion (Cleanup of deleted data chunks) Scheduler subsystem, see StatusString below for a list of possible status strings.


ManualCommands

A string detailing of Nexfs Manual Commands can be issued (normally using the nexfscli admin utility), see StatusString below for a list of possible status strings.


StatusString

The following strings can be returned

InERR

The service, subsystem or item is in a error state


Shutdown

The Service or subsystem is shutdown or Nexfs is in shutdown mode


OK

The service, subsystem or item is in good health

Idle

The service, subsystem or item is in expect health but not current serving any request

LowWaterMark

The data volume capacity has reach the configured low water mark, this status is generally not of concern


Enabled

The service or subsystem is enabled

FloorWaterMark

The data volume capacity has reach the configured floor water mark, this status is generally not of concern


Disabled

The service or subsystem is disabled

InWarn

The service, subsystem or item is in a warning state

Paused

The service, subsystem is paused


HighWaterMark

The data volume capacity has reach the configured high water mark, data chunk migration is triggered


Shutdown

The Service or subsystem is shutting down


Initialising

The Service or subsystem is initiating


Unknown

The Service or subsystem is in an unexpected state

InProgress:

The Job or action is active or service is processing


Degraded

The Service or subsystem is in a degraded state

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=GetSystemStatus

Authorization: AWS4-HMAC-SHA256 Credential=5c2ca3975e4c4468aec395f7a1bf4364/20220823/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=265e9511c911d7ed55039a897776b8fd2f42addcab74c6a8a97a0214e0204546

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

host: nexfs.example.com

x-amz-date: 20220823T095914Z

Example Response

{

"Status": {

"ServerStatus": "OK",

"Hostname": "dev01",

"Release": "0.95.02",

"SoftwareExpires": "Fri 2027-03-19 18:38:17",

"License": "Core 5TB",

"ManagedCapacity": "1TB (1587GB)",

"Process ID": "356456",

"Uptime": "2 days 21 hours 2 minutes 40 seconds",

"MountPoint": "/mnt/nexfs",

"OpenFiles": "2/7281",

"StructureReplicationStatus": "OK",

"Tier1StructStatus": "OK",

"Tier2StructStatus": "OK",

"Tier1Status": "OK",

"Tier1ThresholdLevel": "OK",

"Tier1FloorLevel": "OK",

"Tier2Status": "Disabled",

"Tier2ThresholdLevel": "OK",

"Tier2FloorLevel": "OK",

"Tier3Status": "OK",

"iSCSIStatus": "OK",

"NFSStatus": "Disabled",

"MgmtWebServer": "OK",

"JobScheduler": "Enabled",

"BGMigrationScheduler": "Enabled",

"DeletionScheduler": "Enabled",

"ManualCommands": "Enabled"

}

}