1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    Implement to schedule Epoch time to power on/off the Host.
3b1b4d261SWilliam A. Kennington IIIproperties:
4b1b4d261SWilliam A. Kennington III    - name: ScheduledTime
5b1b4d261SWilliam A. Kennington III      type: uint64
6b1b4d261SWilliam A. Kennington III      default: 0
7b1b4d261SWilliam A. Kennington III      description: >
8*a1347418SPatrick Williams          ScheduledTime is a date time when the host will be powered on/off. The
9*a1347418SPatrick Williams          time is the Epoch time, number of seconds since 1 Jan 1970 00::00::00
10*a1347418SPatrick Williams          UTC.
11b1b4d261SWilliam A. Kennington III
12*a1347418SPatrick Williams          When ScheduledTime is 0, it means the functionality is disabled. When
13*a1347418SPatrick Williams          ScheduledTime is smaller than current time, error InvalidTime will be
14*a1347418SPatrick Williams          thrown. When the controller detects the ScheduledTime has passed, it
15*a1347418SPatrick Williams          will execute the ScheduledTransition and reset the value to 0. Once
16*a1347418SPatrick Williams          the transition starts, there won't be any retries. When the real time
17*a1347418SPatrick Williams          changes, the controller shall check if the time is still in the
18*a1347418SPatrick Williams          future. If so, it will stop the existing timer and restart it with new
19*a1347418SPatrick Williams          wait time. Otherwise, stop the existing timer and execute the
20*a1347418SPatrick Williams          ScheduledTransition. When ScheduledTime is reached, but the host is
21*a1347418SPatrick Williams          not ready to power on/off, e.g. when BMC is rebooting, BMC shall set
22*a1347418SPatrick Williams          the host ScheduledTransition after it is ready.
23b1b4d261SWilliam A. Kennington III      errors:
24b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.ScheduledTime.Error.InvalidTime
25b1b4d261SWilliam A. Kennington III
26b1b4d261SWilliam A. Kennington III    - name: ScheduledTransition
27b1b4d261SWilliam A. Kennington III      type: enum[xyz.openbmc_project.State.Host.Transition]
288da396caSPatrick Williams      default: "On"
29b1b4d261SWilliam A. Kennington III      description: >
30*a1347418SPatrick Williams          The desired power transition to support scheduled power on/off. The
31*a1347418SPatrick Williams          default operation supports scheduled power on.
32