| 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 | |
| Vijay Khemka | 6bcf4ff | 2020-03-03 15:20:08 -0800 | [diff] [blame] | 20 | - name: RestartCause |
| 21 | type: enum[self.RestartCause] |
| 22 | default: 'Unknown' |
| 23 | description: > |
| 24 | A property to define restart cause of a host. |
| 25 | |
| Andrew Geissler | 2477d9a | 2016-11-22 12:09:21 -0600 | [diff] [blame] | 26 | enumerations: |
| 27 | - name: Transition |
| 28 | description: > |
| 29 | The desired transition for host firmware |
| 30 | values: |
| 31 | - name: 'Off' |
| 32 | description: > |
| 33 | Host firmware should be off |
| 34 | - name: 'On' |
| 35 | description: > |
| 36 | Host firmware should be on |
| 37 | - name: 'Reboot' |
| 38 | description: > |
| Andrew Geissler | 7adacdc | 2020-01-29 10:38:09 -0600 | [diff] [blame] | 39 | Host firmware should be rebooted. Chassis power will be cycled from |
| 40 | off to on during this reboot |
| 41 | - name: 'GracefulWarmReboot' |
| 42 | description: > |
| 43 | Host firmware be will notified to shutdown and once complete, the |
| 44 | host firmware will be rebooted. Chassis power will remain on |
| 45 | throughout the reboot |
| 46 | - name: 'ForceWarmReboot' |
| 47 | description: > |
| 48 | Host firmware will be rebooted without notification and chassis |
| 49 | power will remain on throughout the reboot |
| Andrew Geissler | 2477d9a | 2016-11-22 12:09:21 -0600 | [diff] [blame] | 50 | |
| 51 | - name: HostState |
| 52 | description: > |
| 53 | The current state of the host firmware |
| 54 | values: |
| 55 | - name: 'Off' |
| 56 | description: > |
| 57 | Host firmware is not running |
| Andrew Geissler | 9f65dfe | 2020-11-05 13:57:51 -0600 | [diff] [blame] | 58 | - name: 'TransitioningToOff' |
| 59 | description: > |
| 60 | Host firmware is transitioning to an Off state |
| Andrew Geissler | 4461e14 | 2021-01-25 14:56:08 -0600 | [diff] [blame] | 61 | - name: 'Standby' |
| 62 | description: > |
| 63 | Host firmware is in a standby state. It is awaiting a Transition |
| 64 | request to On to move to Running. This is an intermediate state |
| 65 | that some implementations of this object may move to between Off |
| 66 | and Running. |
| Andrew Geissler | 2477d9a | 2016-11-22 12:09:21 -0600 | [diff] [blame] | 67 | - name: 'Running' |
| 68 | description: > |
| 69 | Host firmware is running |
| Andrew Geissler | 9f65dfe | 2020-11-05 13:57:51 -0600 | [diff] [blame] | 70 | - name: 'TransitioningToRunning' |
| 71 | description: > |
| 72 | Host firmware is transitioning to a Running state |
| Saqib Khan | b0360fa | 2017-02-16 13:56:51 -0600 | [diff] [blame] | 73 | - name: 'Quiesced' |
| 74 | description: > |
| Andrew Geissler | 3a77dc4 | 2021-01-25 14:36:47 -0600 | [diff] [blame] | 75 | Host firmware is quiesced. The host firmware is enabled but either |
| 76 | unresponsive or only processing a restricted set of commands. This |
| 77 | state can be a result of the host entering an error state or booting |
| 78 | into a BIOS setup environment. The BootProgress property will |
| 79 | provide details on which it is. |
| Andrew Geissler | 688ed12 | 2019-12-04 11:14:41 -0600 | [diff] [blame] | 80 | - name: 'DiagnosticMode' |
| 81 | description: > |
| 82 | Host firmware is capturing debug information. Powering off your |
| 83 | system while the host is in this state will prevent the debug data |
| 84 | from being properly collected. The host will move to one of the |
| 85 | other states once complete. |
| Vijay Khemka | 6bcf4ff | 2020-03-03 15:20:08 -0800 | [diff] [blame] | 86 | |
| 87 | - name: RestartCause |
| 88 | description: > |
| 89 | The reason for host restart. |
| 90 | values: |
| 91 | - name: 'Unknown' |
| 92 | description: > |
| 93 | Reason Unknown |
| 94 | - name: 'RemoteCommand' |
| 95 | description: > |
| 96 | Remote command issued |
| 97 | - name: 'ResetButton' |
| 98 | description: > |
| 99 | Reset button pressed |
| 100 | - name: 'PowerButton' |
| 101 | description: > |
| 102 | Power button pressed |
| 103 | - name: 'WatchdogTimer' |
| 104 | description: > |
| 105 | Watchdog Timer expired |
| 106 | - name: 'PowerPolicyAlwaysOn' |
| 107 | description: > |
| 108 | Power Policy Host Always on |
| 109 | - name: 'PowerPolicyPreviousState' |
| 110 | description: > |
| 111 | Power Policy Previous State of Host |
| 112 | - name: 'SoftReset' |
| 113 | description: > |
| 114 | Soft reset of Host |
| Andrew Geissler | ab2ce4e | 2021-10-28 15:50:57 -0500 | [diff] [blame] | 115 | - name: 'ScheduledPowerOn' |
| 116 | description: > |
| 117 | The restart was scheduled via the |
| 118 | xyz.openbmc_project.State.ScheduledHostTransition interface |
| Andrew Geissler | e0764cf | 2021-10-28 16:10:46 -0500 | [diff] [blame] | 119 | - name: 'HostCrash' |
| 120 | description: > |
| 121 | The host firmware crashed and the BMC has automatically initiated a |
| 122 | restart of the host firmware |