Skip to main content

GET – Battery properties

Use the GET method to retrieve properties in Battery for a server.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/Batteries/{BatteryId}

Request body​

None

Response body​

Field

Type

Description

Description

String

This resource is used to represent a battery for a Redfish implementation.

CapacityRatedAmpHours

Number

The rated maximum capacity of this battery in amp-hour units.

CapacityRatedWattHours

Number

The rated maximum capacity of this battery in watt-hour units.

ChargeState

String

The charge state of this battery.

FirmwareVersion

String

The firmware version for this battery.

HotPluggable

Boolean

An indication of whether this device can be inserted or removed while the equipment is in operation.

Manufacturer

String

The manufacturer of this battery.

Model

String

The model number for this battery.

ProductionDate

String

The production or manufacturing date of this battery.

Replaceable

Boolean

An indication of whether this component can be independently replaced as allowed by the vendor's replacement policy.

SerialNumber

String

The serial number for this battery.

Name

String

Battery

Id

String

Battery

Links

Object

Expanded.

 

StorageControllers

Array

An array of links to the storage controllers to which this battery provides power during a power-loss event.

  

StorageControllers[1]

String

A reference link to a resource of this storage controller.

Status

Object

Expanded.

 

State

String

Enabled

 

Health

String

This represents the health state of this resource in the absence of its dependent resources.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "@odata.context": "/redfish/v1/$metadata#Battery.Battery",
    "@odata.etag": "\"02235624\"",
    "@odata.id": "/redfish/v1/Chassis/1/PowerSubsystem/Batteries/slot1_0x460000",
    "@odata.type": "#Battery.v1_2_0.Battery",
    "CapacityRatedAmpHours": 0.006043085362762213,
    "CapacityRatedWattHours": 0.041111111640930176,
    "ChargeState": "Idle",
    "FirmwareVersion": "3456-8GB",
    "HotPluggable": false,
    "Id": "slot1_0x460000",
    "Links": {
        "StorageControllers": [
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/controller_slot1"
            }
        ]
    },
    "Manufacturer": "LSI",
    "Model": "CVPM05",
    "Name": "Battery of the RAID Controller in slot 1",
    "Oem": {
        ...
        }
    },
    "ProductionDate": "2017-05-05",
    "Replaceable": true,
    "SerialNumber": "12017",
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    }
}