Dbus: Add interfaces for Scheduled Host Transition
This yaml file is used to generate interfaces for Scheduled Host Transition.
Change-Id: I796d9b981749056cd24f69f83bd3767694f2382f
Signed-off-by: Carol Wang <wangkair@cn.ibm.com>
diff --git a/xyz/openbmc_project/State/ScheduledHostTransition.interface.yaml b/xyz/openbmc_project/State/ScheduledHostTransition.interface.yaml
new file mode 100644
index 0000000..ab581e8
--- /dev/null
+++ b/xyz/openbmc_project/State/ScheduledHostTransition.interface.yaml
@@ -0,0 +1,39 @@
+description: >
+ Implement to schedule Epoch time to power on/off the Host.
+properties:
+ - name: ScheduledTime
+ type: uint64
+ default: 0
+ description: >
+ ScheduledTime is a date time when the host will be
+ powered on/off. The time is the Epoch time, number
+ of seconds since 1 Jan 1970 00::00::00 UTC.
+
+ When ScheduledTime is 0, it means the functionality
+ is disabled.
+ When ScheduledTime is smaller than current time,
+ error InvalidTime will be thrown.
+ When the controller detects the ScheduledTime has passed,
+ it will execute the RequestedTransition and reset the
+ value to 0. Once the transition starts, there won't be
+ any retries.
+ When the real time changes, the controller shall check if
+ the time is still in the future. If so, it will stop the
+ existing timer and restart it with new wait time. Otherwise,
+ stop the existing timer and check the state of host. If the
+ state is not the same as required, set it as
+ RequestedTransition.
+ When ScheduledTime is reached, but the host is not ready
+ to power on/off, e.g. when BMC is rebooting, BMC shall
+ set the host RequestedTransition after it is ready.
+ errors:
+ - xyz.openbmc_project.ScheduledTime.Error.InvalidTime
+
+ - name: RequestedTransition
+ type: enum[xyz.openbmc_project.State.Host.Transition]
+ default: 'On'
+ description: >
+ The desired power transition to support scheduled power on/off.
+ The default operation supports scheduled power on.
+
+# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4