blob: 2491a863e4efcf72c2f0b9841c38012787a026ae [file] [log] [blame]
Patrick Williams8d97fa62020-04-21 10:27:40 -05001description: >
2 The requested priority, for redundancy purposes, of the associated
3 `xyz.openbmc_project.Software.Version` prior to its activation.
4properties:
5 - name: Priority
6 type: byte
7 default: 0
8 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -06009 Upon Activation of the software Version, the *ItemUpdater* should
10 attempt to activate the software version such that the resulting
11 `Software.RedundancyPriority.Priority` is Priority.
Patrick Williams8d97fa62020-04-21 10:27:40 -050012
13 See `Software.RedundancyPriority.Priority` for valid values and
14 definitions.
15
16 By default, any Activation should be done to the highest priority.
17 Some *ItemUpdater* implementations may be unable to apply this
18 `RequestedRedundancyPriority.Priority`, resulting in an
Patrick Williamsa1347412022-12-06 10:56:22 -060019 `ActivationState` which is either `Failed` or `Active` with `Priority`
20 of `0 (High)`.