| Andrew Geissler | 2477d9a | 2016-11-22 12:09:21 -0600 | [diff] [blame] | 1 | description: > |
| 2 | Implement to provide host state management |
| 3 | |
| 4 | properties: |
| 5 | - name: RequestedHostTransition |
| 6 | type: enum[self.Transition] |
| 7 | default: 'Off' |
| 8 | description: > |
| 9 | The desired host transition. This will be preserved across AC |
| 10 | power cycles of the BMC. |
| 11 | |
| 12 | - name: CurrentHostState |
| 13 | type: enum[self.HostState] |
| 14 | description: > |
| 15 | A read-only property describing the current state of the host |
| 16 | firmware. A user can determine if a system is in transition by |
| 17 | comparing the CurrentHostState and the RequestedHostTransition |
| 18 | properties. |
| 19 | |
| 20 | enumerations: |
| 21 | - name: Transition |
| 22 | description: > |
| 23 | The desired transition for host firmware |
| 24 | values: |
| 25 | - name: 'Off' |
| 26 | description: > |
| 27 | Host firmware should be off |
| 28 | - name: 'On' |
| 29 | description: > |
| 30 | Host firmware should be on |
| 31 | - name: 'Reboot' |
| 32 | description: > |
| Andrew Geissler | 7adacdc | 2020-01-29 10:38:09 -0600 | [diff] [blame] | 33 | Host firmware should be rebooted. Chassis power will be cycled from |
| 34 | off to on during this reboot |
| 35 | - name: 'GracefulWarmReboot' |
| 36 | description: > |
| 37 | Host firmware be will notified to shutdown and once complete, the |
| 38 | host firmware will be rebooted. Chassis power will remain on |
| 39 | throughout the reboot |
| 40 | - name: 'ForceWarmReboot' |
| 41 | description: > |
| 42 | Host firmware will be rebooted without notification and chassis |
| 43 | power will remain on throughout the reboot |
| Andrew Geissler | 2477d9a | 2016-11-22 12:09:21 -0600 | [diff] [blame] | 44 | |
| 45 | - name: HostState |
| 46 | description: > |
| 47 | The current state of the host firmware |
| 48 | values: |
| 49 | - name: 'Off' |
| 50 | description: > |
| 51 | Host firmware is not running |
| 52 | - name: 'Running' |
| 53 | description: > |
| 54 | Host firmware is running |
| Saqib Khan | b0360fa | 2017-02-16 13:56:51 -0600 | [diff] [blame] | 55 | - name: 'Quiesced' |
| 56 | description: > |
| 57 | Host firmware is quiesced |
| Andrew Geissler | 688ed12 | 2019-12-04 11:14:41 -0600 | [diff] [blame] | 58 | - name: 'DiagnosticMode' |
| 59 | description: > |
| 60 | Host firmware is capturing debug information. Powering off your |
| 61 | system while the host is in this state will prevent the debug data |
| 62 | from being properly collected. The host will move to one of the |
| 63 | other states once complete. |