diff options
author | Jayashankar Padath <jayashankar.padath@in.ibm.com> | 2019-03-27 12:49:37 +0530 |
---|---|---|
committer | Brad Bishop <bradleyb@fuzziesquirrel.com> | 2019-04-11 17:52:04 +0000 |
commit | 633d8c7c44ea35deaf1b06d6b53bdfa49d86d04b (patch) | |
tree | d8cdd4ffcf32b40828d47dd824704b8d069c3d5f /xyz/openbmc_project | |
parent | 393530883ad5b93e90af0b669a95bf97e5c4d058 (diff) | |
download | phosphor-dbus-interfaces-633d8c7c44ea35deaf1b06d6b53bdfa49d86d04b.tar.gz phosphor-dbus-interfaces-633d8c7c44ea35deaf1b06d6b53bdfa49d86d04b.zip |
Redfish Code Update : New property for ApplyTime
Defining a new property which can control when to apply the
newly uploaded software image. This maps to the ApplyTime property defined
in the UpdateService redfish schema:
http://redfish.dmtf.org/schemas/v1/UpdateService.v1_4_0.json
"ApplyTime": {
"enum": [
"Immediate",
"OnReset",
"AtMaintenanceWindowStart",
"InMaintenanceWindowOnReset"
],
As of now the values "Immediate" and "OnReset" are supported and the value
can be supplied through HttpPushUriApplyTime object.
Signed-off-by: Jayashankar Padath <jayashankar.padath@in.ibm.com>
Change-Id: I43350f028f90575b0f88d5e5ddc4004ae96f5556
Diffstat (limited to 'xyz/openbmc_project')
-rw-r--r-- | xyz/openbmc_project/Software/ApplyTime.interface.yaml | 22 | ||||
-rw-r--r-- | xyz/openbmc_project/Software/README.md | 14 |
2 files changed, 36 insertions, 0 deletions
diff --git a/xyz/openbmc_project/Software/ApplyTime.interface.yaml b/xyz/openbmc_project/Software/ApplyTime.interface.yaml new file mode 100644 index 0000000..0fff06a --- /dev/null +++ b/xyz/openbmc_project/Software/ApplyTime.interface.yaml @@ -0,0 +1,22 @@ +description: > + To implement the apply time of a newly updated software image. + The apply time property is global to all firmware update packages + and the default value of the property is OnReset. +properties: + - name: RequestedApplyTime + type: enum[self.RequestedApplyTimes] + description: > + This property indicates when the software image update should be + applied. +enumerations: + - name: RequestedApplyTimes + description: > + The possible values of this property indicate when the newly + updated software image will be activated. + values: + - name: Immediate + description: > + Apply immediately. + - name: OnReset + description: > + Apply on a reset. diff --git a/xyz/openbmc_project/Software/README.md b/xyz/openbmc_project/Software/README.md index 65c8a38..89077ca 100644 --- a/xyz/openbmc_project/Software/README.md +++ b/xyz/openbmc_project/Software/README.md @@ -93,6 +93,20 @@ be in the following states: 6. *Failed* - The `Software.Version` or the storage medium on which it is stored has failed. An event may be recorded with additional details. +### Image Apply Time + +`xyz.openbmc_project.Software.ApplyTime` has a property called +RequestedApplyTime that indicates when the newly applied software image will +be activated. RequestedApplyTime is a D-Bus property that maps to the +"ApplyTime" property in the Redfish UpdateService schema. Below are the +currently supported values and the value can be supplied through +HttpPushUriApplyTime object: + +1. *Immediate* - Indicating that the `Software.Version` needs to be activated + immediately. +2. *OnReset* - Indicating that the `Software.Version` needs to be activated + on the next reset. + ### Blocking State Transitions It is sometimes useful to block a system state transition while activations |