Status in source: mandatory.
Technical details
{
"smi_kind": "OBJECT-TYPE",
"definition": [
"hpiResourcePowerState",
"OBJECT-TYPE",
"SYNTAX",
"INTEGER",
"{",
"undefined",
"(",
"0",
")",
",",
"off",
"(",
"1",
")",
",",
"on",
"(",
"2",
")",
",",
"cycle",
"(",
"3",
")",
",",
"unsupported",
"(",
"4",
")",
"}",
"ACCESS",
"read-write",
"STATUS",
"mandatory",
"DESCRIPTION",
"\"This function gets the power state of an entity, allowing the HPI User to determine if the entity is currently powered on or off. If a resource manages multiple entities, this function will address the entity which is identified in the RPT entry for the resource. cycle(3) is a pulsed power operation and is not a valid return for the power state. This function controls the hardware power on a FRU entity regardless of what hot-swap state the resource is in. For example, it is legal (and may be desirable) to cycle power on the FRU even while it is in ACTIVE state in order to attempt to clear a fault condition. Similarly, a resource could be instructed to power on a FRU even while it is in INACTIVE state, for example, in order to run off-line diagnostics. Not all resources supporting hot swap will necessarily support this function. In particular, resources that use the simplified hot swap model may not have the ability to control FRU power. This function may also be supported for non-FRU entities if power control is available for those entities. Note: Enumerated values are increased by one value compared to SAI-HPI-B spec.\"",
"::=",
"{",
"hpiResourceEntry",
"23",
"}"
],
"syntax_tree": [
[
"SimpleSyntax",
"INTEGER",
[
"enumSpec",
[
[
"undefined",
0
],
[
"off",
1
],
[
"on",
2
],
[
"cycle",
3
],
[
"unsupported",
4
]
]
]
],
null,
[
"MaxAccessPart",
"read-write"
],
[
"Status",
"mandatory"
],
[
"DESCRIPTION",
"This function gets the power state of an entity, allowing the HPI User to determine if the entity is currently powered on or off. If a resource manages multiple entities, this function will address the entity which is identified in the RPT entry for the resource. cycle(3) is a pulsed power operation and is not a valid return for the power state. This function controls the hardware power on a FRU entity regardless of what hot-swap state the resource is in. For example, it is legal (and may be desirable) to cycle power on the FRU even while it is in ACTIVE state in order to attempt to clear a fault condition. Similarly, a resource could be instructed to power on a FRU even while it is in INACTIVE state, for example, in order to run off-line diagnostics. Not all resources supporting hot swap will necessarily support this function. In particular, resources that use the simplified hot swap model may not have the ability to control FRU power. This function may also be supported for non-FRU entities if power control is available for those entities. Note: Enumerated values are increased by one value compared to SAI-HPI-B spec."
],
null,
null,
null,
null
]
}