/mgmt/status/default/CurrentSensors GET

Use the HTTP GET method with the /mgmt/status/default/CurrentSensors resource to request status information about the power supplied to the appliance, derived from sensors that read electrical currents, from the power supplies and other components of the appliance.

Resource URL

https://host:port/mgmt/status/default/CurrentSensors
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Status information retrieved successfully.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes the status for the various voltages supplied to the appliance that is reported by the current sensors. Each object contains the following fields:
Name
String.
The name of the current sensor that is being monitored.
Value
Integer.
The most recent reading of the current sensor in milliamperes. There are only three significant digits.
UpperCriticalThreshold
Integer.
The maximum allowable reading of the current sensor in milliamperes.
ReadingStatus
String.
An indicator of whether the current reading is OK, or if the reading exceeds the upper critical threshold. The following status strings might be reported:
lowerNonRecoverable
The current sensor reading value is below the lower non-recoverable threshold, which indicates that there is a risk of damaging the hardware if the device is allowed to remain in this state. If you cannot diagnose and fix the cause of this reading, you should power down the device.
lowerCritical
The current sensor reading value is below the lower critical threshold, which indicates that the system is faulty, and might not be operating properly.
lowerNonCritical
The current sensor reading value is below the lower non-critical threshold, which is a warning that it is getting close to too low. The system should operate normally, but the cause of the sensor value should be investigated.
ok
The current sensor reading value is OK, and is within all limits.
upperNonCritical
The current sensor reading value is above the upper non-critical threshold, which is a warning that it is getting close to too high. The system should operate normally, but the cause of the sensor value should be investigated. This is commonly used on temperature sensors, where the investigation would be checking ambient air temperature and air flow.
upperCritical
The current sensor reading value is above the upper critical threshold, which indicates that the system is faulty, and might not be operating properly.
upperNonRecoverable
The current sensor reading value is above the upper non-recoverable threshold, which indicates that there is a risk of damaging the hardware if the device is allowed to remain in this state. If you cannot diagnose and fix the cause of this reading, you should power down the device.
failure
The reading indicates a failure. Used for non-numeric readings.
noReading
The attempt to read the sensor failed, so the status cannot be checked.
invalid
An internal software error has been detected checking the status.

Examples

The following example requests the power supply status of the appliance.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/CurrentSensors
The following listing shows the received response:
    "self": {
      "href": "/mgmt/status/default/CurrentSensors"
    },
    "doc": {
      "href": "/mgmt/docs/status/CurrentSensors"
    }
  },
  "CurrentSensors": [
    {
      "Name": "Current PU +12V 1",
      "Value": 8400,
      "UpperCriticalThreshold": 44800,
      "ReadingStatus": "ok"
    },
    {
      "Name": "Current PU +3.3V",
      "Value": 2000,
      "UpperCriticalThreshold": 16000,
      "ReadingStatus": "ok"
    },
    {
      "Name": "Current PU +5V",
      "Value": 2400,
      "UpperCriticalThreshold": 16000,
      "ReadingStatus": "ok"
    }
  ]
}