| Carol Wang | 79064a8 | 2019-12-24 13:34:03 +0800 | [diff] [blame^] | 1 | description: > |
| 2 | Implement to schedule Epoch time to power on/off the Host. |
| 3 | properties: |
| 4 | - name: ScheduledTime |
| 5 | type: uint64 |
| 6 | default: 0 |
| 7 | description: > |
| 8 | ScheduledTime is a date time when the host will be |
| 9 | powered on/off. The time is the Epoch time, number |
| 10 | of seconds since 1 Jan 1970 00::00::00 UTC. |
| 11 | |
| 12 | When ScheduledTime is 0, it means the functionality |
| 13 | is disabled. |
| 14 | When ScheduledTime is smaller than current time, |
| 15 | error InvalidTime will be thrown. |
| 16 | When the controller detects the ScheduledTime has passed, |
| 17 | it will execute the RequestedTransition and reset the |
| 18 | value to 0. Once the transition starts, there won't be |
| 19 | any retries. |
| 20 | When the real time changes, the controller shall check if |
| 21 | the time is still in the future. If so, it will stop the |
| 22 | existing timer and restart it with new wait time. Otherwise, |
| 23 | stop the existing timer and check the state of host. If the |
| 24 | state is not the same as required, set it as |
| 25 | RequestedTransition. |
| 26 | When ScheduledTime is reached, but the host is not ready |
| 27 | to power on/off, e.g. when BMC is rebooting, BMC shall |
| 28 | set the host RequestedTransition after it is ready. |
| 29 | errors: |
| 30 | - xyz.openbmc_project.ScheduledTime.Error.InvalidTime |
| 31 | |
| 32 | - name: RequestedTransition |
| 33 | type: enum[xyz.openbmc_project.State.Host.Transition] |
| 34 | default: 'On' |
| 35 | description: > |
| 36 | The desired power transition to support scheduled power on/off. |
| 37 | The default operation supports scheduled power on. |
| 38 | |
| 39 | # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 |