Overview

Resources

Hardware_Status: Get hardware status

Get hardware status.

GET https://{device}/api/npm.hardware_status/1.0/hardware_status

Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

JSON

[
  {
    "fans": {
      "items": [
        {
          "sensorID": string,
          "entityID": string,
          "rpm": number,
          "status": string,
          "name": string
        }
      ]
    },
    "pwr": {
      "items": [
        {
          "sensorID": string,
          "entityID": string,
          "msg": string,
          "status": string,
          "name": string
        }
      ]
    },
    "temperature": {
      "items": [
        {
          "sensorID": string,
          "entityID": string,
          "temperature": string,
          "status": string,
          "name": string
        }
      ]
    },
    "ipaddr": string,
    "name": string,
    "dimm": {
      "items": [
        {
          "speed": number,
          "sn": string,
          "size": number,
          "name": string
        }
      ],
      "msg": string,
      "status": string
    },
    "cpus": {
      "items": [
        {
          "clock": number,
          "ncore": number,
          "name": string,
          "version": string
        }
      ],
      "msg": string,
      "status": string
    }
  }
]

Example:
[]

[
  {
    "fans": {
      "items": [
        {
          "sensorID": string,
          "entityID": string,
          "rpm": number,
          "status": string,
          "name": string
        }
      ]
    },
    "pwr": {
      "items": [
        {
          "sensorID": string,
          "entityID": string,
          "msg": string,
          "status": string,
          "name": string
        }
      ]
    },
    "temperature": {
      "items": [
        {
          "sensorID": string,
          "entityID": string,
          "temperature": string,
          "status": string,
          "name": string
        }
      ]
    },
    "ipaddr": string,
    "name": string,
    "dimm": {
      "items": [
        {
          "speed": number,
          "sn": string,
          "size": number,
          "name": string
        }
      ],
      "msg": string,
      "status": string
    },
    "cpus": {
      "items": [
        {
          "clock": number,
          "ncore": number,
          "name": string,
          "version": string
        }
      ],
      "msg": string,
      "status": string
    }
  }
]

Example:
[]

Property Name	Type	Description	Notes
SystemHardwareStatus	<array of <object>>	Hardware status.
SystemHardwareStatus[HardwareStatus]	<object>	Hardware status of one System Module.	Optional
SystemHardwareStatus[HardwareStatus]. fans	<object>	Fans status.	Optional
SystemHardwareStatus[HardwareStatus]. fans.items	<array of <object>>	Fan status per module.
SystemHardwareStatus[HardwareStatus]. fans.items[HardwareFan]	<object>	Fan status.	Optional
SystemHardwareStatus[HardwareStatus]. fans.items[HardwareFan].sensorID	<string>	Fan sensorID.
SystemHardwareStatus[HardwareStatus]. fans.items[HardwareFan].entityID	<string>	Fan entityID.
SystemHardwareStatus[HardwareStatus]. fans.items[HardwareFan].rpm	<number>	Fan revolutions (per minute).
SystemHardwareStatus[HardwareStatus]. fans.items[HardwareFan].status	<string>	Fan status.	Values: ok, failure
SystemHardwareStatus[HardwareStatus]. fans.items[HardwareFan].name	<string>	Fan name.
SystemHardwareStatus[HardwareStatus].pwr	<object>	Power Supply Status.	Optional
SystemHardwareStatus[HardwareStatus].pwr. items	<array of <object>>	Power Supply per modules.	Optional
SystemHardwareStatus[HardwareStatus].pwr. items[HardwarePSU]	<object>	Power Supply status.	Optional
SystemHardwareStatus[HardwareStatus].pwr. items[HardwarePSU].sensorID	<string>	Power Supply sensorID.
SystemHardwareStatus[HardwareStatus].pwr. items[HardwarePSU].entityID	<string>	Power Supply entityID.
SystemHardwareStatus[HardwareStatus].pwr. items[HardwarePSU].msg	<string>	Power Supply status message.
SystemHardwareStatus[HardwareStatus].pwr. items[HardwarePSU].status	<string>	Power Supply status.	Values: ok, failure
SystemHardwareStatus[HardwareStatus].pwr. items[HardwarePSU].name	<string>	Power Supply name.
SystemHardwareStatus[HardwareStatus]. temperature	<object>	Temperature status.	Optional
SystemHardwareStatus[HardwareStatus]. temperature.items	<array of <object>>	Harware Temperatures per module.
SystemHardwareStatus[HardwareStatus]. temperature.items[HardwareTemperature]	<object>	Harware Temperatures per module.	Optional
SystemHardwareStatus[HardwareStatus]. temperature.items[HardwareTemperature]. sensorID	<string>	Harware Temperature sensorID.
SystemHardwareStatus[HardwareStatus]. temperature.items[HardwareTemperature]. entityID	<string>	Harware Temperature entityID.
SystemHardwareStatus[HardwareStatus]. temperature.items[HardwareTemperature]. temperature	<string>	Harware Temperature degrees C.
SystemHardwareStatus[HardwareStatus]. temperature.items[HardwareTemperature]. status	<string>	Harware Temperature status.	Values: ok, failure
SystemHardwareStatus[HardwareStatus]. temperature.items[HardwareTemperature]. name	<string>	Harware Temperature name.
SystemHardwareStatus[HardwareStatus]. ipaddr	<string>	Module IP address.	Optional
SystemHardwareStatus[HardwareStatus]. name	<string>	Mudule host name.	Optional
SystemHardwareStatus[HardwareStatus]. dimm	<object>	Memory status.	Optional
SystemHardwareStatus[HardwareStatus]. dimm.items	<array of <object>>	Memory status per medule.
SystemHardwareStatus[HardwareStatus]. dimm.items[HardwareDimm]	<object>	Memory status.	Optional
SystemHardwareStatus[HardwareStatus]. dimm.items[HardwareDimm].speed	<number>	Memory speed (MHz).
SystemHardwareStatus[HardwareStatus]. dimm.items[HardwareDimm].sn	<string>	Memory serial number.
SystemHardwareStatus[HardwareStatus]. dimm.items[HardwareDimm].size	<number>	Memory size (MB).
SystemHardwareStatus[HardwareStatus]. dimm.items[HardwareDimm].name	<string>	Memory slot name.
SystemHardwareStatus[HardwareStatus]. dimm.msg	<string>	Overall status message.
SystemHardwareStatus[HardwareStatus]. dimm.status	<string>	Overall status.	Values: ok, failure
SystemHardwareStatus[HardwareStatus]. cpus	<object>	CPUs status.	Optional
SystemHardwareStatus[HardwareStatus]. cpus.items	<array of <object>>	CPUs per module.
SystemHardwareStatus[HardwareStatus]. cpus.items[HardwareCPU]	<object>	CPU information.	Optional
SystemHardwareStatus[HardwareStatus]. cpus.items[HardwareCPU].clock	<number>	CPU clock.
SystemHardwareStatus[HardwareStatus]. cpus.items[HardwareCPU].ncore	<number>	Number of cores.
SystemHardwareStatus[HardwareStatus]. cpus.items[HardwareCPU].name	<string>	CPU name.
SystemHardwareStatus[HardwareStatus]. cpus.items[HardwareCPU].version	<string>	CPU version.
SystemHardwareStatus[HardwareStatus]. cpus.msg	<string>	Overall CPUs status message.
SystemHardwareStatus[HardwareStatus]. cpus.status	<string>	Overall CPUs status.	Values: ok, failure

Error Codes

In the event that an error occurs while processing a request, the server will respond with appropriate HTTP status code and additional information in the response body:

{
     "error_id":   "{error identifier}",
     "error_text": "{error description}",
     "error_info": {error specific data structure, optional}
}

The table below lists the possible errors and the associated HTTP status codes that may returned.

Error ID	HTTP Status	Comments
INTERNAL_ERROR	500	Internal server error.
AUTH_REQUIRED	401	The requested resource requires authentication.
AUTH_INVALID_CREDENTIALS	401	Invalid username and/or password.
AUTH_INVALID_SESSION	401	Session ID is invalid.
AUTH_EXPIRED_PASSWORD	403	The password must be changed. Access only to password change resources.
AUTH_DISABLED_ACCOUNT	403	Account is either temporarily or permanently disabled.
AUTH_FORBIDDEN	403	User is not authorized to access the requested resource.
AUTH_INVALID_TOKEN	401	OAuth access token is invalid.
AUTH_EXPIRED_TOKEN	401	OAuth access token is expired.
AUTH_INVALID_CODE	401	OAuth access code is invalid.
AUTH_EXPIRED_CODE	401	OAuth access code is expired.
RESOURCE_NOT_FOUND	404	Requested resource was not found.
HTTP_INVALID_METHOD	405	Requested method is not available for this resource.
HTTP_INVALID_HEADER	400	An HTTP header was malformed.
REQUEST_INVALID_INPUT	400	Malformed input structure.
URI_INVALID_PARAMETER	400	URI parameter is not supported or malformed.
URI_MISSING_PARAMETER	400	Missing required parameter.