Power

Schema Definition

This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting.

Properties

PropertyTypeNullableRequiredPermissionDescription
@odata.contextStringread-onlyThe OData description of a payload.
Format: uri
@odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
@odata.typeStringread-onlyThe type of a resource.
Actions {Objectread-writeThe available actions for this resource.
    Oem { }Objectread-writeThe available OEM specific actions for this resource.
}
DescriptionStringYesread-onlyProvides a description of this resource and is used for commonality in the schema definitions.
IdStringGETread-onlyUniquely identifies the resource within the collection of like resources.
NameStringGETread-onlyThe name of the resource or array element.
Oem {Objectread-writeThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
    EID_47597 {Objectread-writeRECS|Box Power extension
        LastSensorUpdateInt64Yesread-onlyThe timestamp of the last sensor update expressed as milliseconds since the time 00:00:00 UTC on January 1, 1970.
    }
}
PowerControl [ {Array[Object]read-writeThis is the definition for power control function (power reading/limiting).
    Actions {Objectread-writeThe available actions for this resource.
        Oem { }Objectread-writeThe available OEM specific actions for this resource.
    }
    MemberIdStringread-onlyThis is the identifier for the member within the collection.
    NameStringYesread-onlyPower Control Function name.
    Oem { }Objectread-writeThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
    PowerConsumedWattsDecimalYesread-onlyThe actual power being consumed by the chassis.
Unit: W
Minimum: 0
    PowerMetrics {Objectread-writePower readings for this chassis.
        AverageConsumedWattsDecimalYesread-onlyThe average power level over the measurement window (the last IntervalInMin minutes).
Unit: W
Minimum: 0
        IntervalInMinInt64Yesread-onlyThe time interval (or window) in which the PowerMetrics are measured over.
Unit: min
Minimum: 0
        MaxConsumedWattsDecimalYesread-onlyThe highest power consumption level that has occured over the measurement window (the last IntervalInMin minutes).
Unit: W
Minimum: 0
        MinConsumedWattsDecimalYesread-onlyThe lowest power consumption level over the measurement window (the last IntervalInMin minutes).
Unit: W
Minimum: 0
    }
} ]
PowerControl@odata.countInt32read-onlyThe number of items in a collection.
Voltages [ {Array[Object]read-writeThis is the definition for voltage sensors.
    Actions {Objectread-writeThe available actions for this resource.
        Oem { }Objectread-writeThe available OEM specific actions for this resource.
    }
    LowerThresholdCriticalDecimalYesread-onlyBelow normal range but not yet fatal.
Unit: V
    LowerThresholdFatalDecimalYesread-onlyBelow normal range and is fatal.
Unit: V
    LowerThresholdNonCriticalDecimalYesread-onlyBelow normal range.
Unit: V
    MaxReadingRangeDecimalYesread-onlyMaximum value for this Voltage sensor.
Unit: V
    MemberIdStringread-onlyThis is the identifier for the member within the collection.
    MinReadingRangeDecimalYesread-onlyMinimum value for this Voltage sensor.
Unit: V
    NameStringYesread-onlyVoltage sensor name.
    Oem { }Objectread-writeThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
    ReadingVoltsDecimalYesread-onlyThe present reading of the voltage sensor.
Unit: V
    SensorNumberInt64Yesread-onlyA numerical identifier to represent the voltage sensor.
    Status {Objectread-writeThis type describes the status and health of a resource and its children.
        HealthStringYesread-onlyThis represents the health state of this resource in the absence of its dependent resources.
Possible Values:
  • OK: Normal.
  • Warning: A condition exists that requires attention.
  • Critical: A critical condition exists that requires immediate attention.
        HealthRollupStringYesread-onlyThis represents the overall health state from the view of this resource.
Possible Values:
  • OK: Normal.
  • Warning: A condition exists that requires attention.
  • Critical: A critical condition exists that requires immediate attention.
        Oem { }Objectread-writeOem extension object.
        StateStringYesread-onlyThis indicates the known state of the resource, such as if it is enabled.
Possible Values:
  • Enabled: This function or resource has been enabled.
  • Disabled: This function or resource has been disabled.
  • StandbyOffline: This function or resource is enabled, but awaiting an external action to activate it.
  • StandbySpare: This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it.
  • InTest: This function or resource is undergoing testing.
  • Starting: This function or resource is starting.
  • Absent: This function or resource is not present or not detected.
  • UnavailableOffline: This function or resource is present but cannot be used.
  • Deferring: The element will not process any commands but will queue new requests.
  • Quiesced: The element is enabled but only processes a restricted set of commands.
  • Updating: The element is updating and may be unavailable or degraded.
    }
    UpperThresholdCriticalDecimalYesread-onlyAbove normal range but not yet fatal.
Unit: V
    UpperThresholdFatalDecimalYesread-onlyAbove normal range and is fatal.
Unit: V
    UpperThresholdNonCriticalDecimalYesread-onlyAbove normal range.
Unit: V
} ]
Voltages@odata.countInt32read-onlyThe number of items in a collection.

Operations

GET

Request

GET /redfish/v1/Chassis/Chassis1/Power
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/Power",
    "@odata.type": "String",
    "Actions": {
        "Oem": { }
    }
    "Description": "String",
    "Id": "String",
    "Name": "String",
    "Oem": {
        "EID_47597": {
            "LastSensorUpdate": 0
        }
    }
    "PowerControl": [{
        "Actions": {
            "Oem": { }
        }
        "MemberId": "String",
        "Name": "String",
        "Oem": { },
        "PowerConsumedWatts": 0,
        "PowerMetrics": {
            "AverageConsumedWatts": 0,
            "IntervalInMin": 0,
            "MaxConsumedWatts": 0,
            "MinConsumedWatts": 0
        }
    }]
    "PowerControl@odata.count": 1,
    "Voltages": [{
        "Actions": {
            "Oem": { }
        }
        "LowerThresholdCritical": 0,
        "LowerThresholdFatal": 0,
        "LowerThresholdNonCritical": 0,
        "MaxReadingRange": 0,
        "MemberId": "String",
        "MinReadingRange": 0,
        "Name": "String",
        "Oem": { },
        "ReadingVolts": 0,
        "SensorNumber": 0,
        "Status": {
            "Health": "OK",
            "HealthRollup": "OK",
            "Oem": { },
            "State": "Enabled"
        }
        "UpperThresholdCritical": 0,
        "UpperThresholdFatal": 0,
        "UpperThresholdNonCritical": 0
    }]
    "Voltages@odata.count": 1
}

POST

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

PATCH

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

DELETE

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed