| Andrew Geissler | 2477d9a | 2016-11-22 12:09:21 -0600 | [diff] [blame] | 1 | description: |
| 2 | Implement to provide the chassis power management |
| 3 | |
| 4 | properties: |
| 5 | - name: RequestedPowerTransition |
| 6 | type: enum[self.Transition] |
| 7 | default: 'Off' |
| 8 | description: > |
| 9 | The desired power transition to start on this chassis. |
| 10 | This will be preserved across AC power cycles of the BMC. |
| 11 | |
| 12 | - name: CurrentPowerState |
| 13 | type: enum[self.PowerState] |
| 14 | description: > |
| 15 | A read-only property describing the current chassis power state. |
| 16 | A user can determine if a chassis is in transition by comparing |
| 17 | the CurrentPowerState and RequestedPowerTransition properties. |
| 18 | |
| Andrew Geissler | 9c91332 | 2021-11-08 16:09:45 -0600 | [diff] [blame] | 19 | - name: CurrentPowerStatus |
| 20 | type: enum[self.PowerStatus] |
| 21 | description: > |
| 22 | A read-only property describing the current chassis power status. |
| 23 | This property aggregates all available information about the status |
| 24 | of the power coming into the chassis. Note that this is different |
| 25 | then the CurrentPowerState in that it provides status of the power |
| 26 | coming into the chassis, not the actual state of the chassis power. |
| 27 | |
| Matt Spinler | e0c06d7 | 2018-07-09 11:15:21 -0500 | [diff] [blame] | 28 | - name: LastStateChangeTime |
| 29 | type: uint64 |
| 30 | description: > |
| 31 | The last time at which the chassis power changed state, as |
| 32 | tracked by the CurrentPowerState property, in epoch time, |
| 33 | in milliseconds. This can be used to tell when the chassis |
| 34 | was last powered on or off. |
| 35 | |
| Andrew Geissler | 2477d9a | 2016-11-22 12:09:21 -0600 | [diff] [blame] | 36 | enumerations: |
| 37 | - name: Transition |
| 38 | description: > |
| 39 | The desired power transition for the chassis |
| 40 | values: |
| 41 | - name: 'Off' |
| 42 | description: > |
| Jason M. Bills | 33e8e1d | 2019-06-03 16:31:29 -0700 | [diff] [blame] | 43 | Chassis power should be off |
| Andrew Geissler | 2477d9a | 2016-11-22 12:09:21 -0600 | [diff] [blame] | 44 | - name: 'On' |
| 45 | description: > |
| 46 | Chassis power should be on |
| Jason M. Bills | 33e8e1d | 2019-06-03 16:31:29 -0700 | [diff] [blame] | 47 | - name: 'PowerCycle' |
| 48 | description: > |
| 49 | Chassis power should be cycled from off to on. There will be a 5 |
| 50 | second delay between the off and the on. |
| Andrew Geissler | 2477d9a | 2016-11-22 12:09:21 -0600 | [diff] [blame] | 51 | |
| 52 | - name: PowerState |
| 53 | description: > |
| 54 | The current state of the chassis power |
| 55 | values: |
| 56 | - name: 'Off' |
| 57 | description: > |
| 58 | Chassis power is off |
| Andrew Geissler | 43341f5 | 2021-01-22 14:14:31 -0600 | [diff] [blame] | 59 | - name: 'TransitioningToOff' |
| 60 | description: > |
| 61 | Firmware is transitioning the chassis to an Off state |
| Andrew Geissler | 2477d9a | 2016-11-22 12:09:21 -0600 | [diff] [blame] | 62 | - name: 'On' |
| 63 | description: > |
| 64 | Chassis power is on |
| Andrew Geissler | 43341f5 | 2021-01-22 14:14:31 -0600 | [diff] [blame] | 65 | - name: 'TransitioningToOn' |
| 66 | description: > |
| 67 | Firmware is transitioning the chassis to an On state |
| Andrew Geissler | 9c91332 | 2021-11-08 16:09:45 -0600 | [diff] [blame] | 68 | |
| 69 | - name: PowerStatus |
| 70 | description: > |
| 71 | The current status of the chassis power |
| 72 | values: |
| 73 | - name: 'Undefined' |
| 74 | description: > |
| 75 | Chassis power status is unknown |
| 76 | - name: 'BrownOut' |
| 77 | description: > |
| 78 | Chassis power status is in a brownout condition. |
| 79 | - name: 'UninterruptiblePowerSupply' |
| 80 | description: > |
| 81 | Chassis power is being provided via an uninterruptible power |
| 82 | supply. Note that some systems may choose to continue to use this |
| 83 | status, even once power has returned to the system, to indicate the |
| 84 | uninterruptible power supply is charging or is below a certain |
| 85 | threshold of charged. This provides system owners the flexibility on |
| 86 | whether their system requires a certain level of charged |
| 87 | uninterruptible power supply to be in a 'Good' state or not. |
| 88 | - name: 'Good' |
| 89 | description: > |
| 90 | Chassis power status is in a good condition |