blob: 4b3e08885073bf85a0eef9642efcaa30da47d59b [file] [log] [blame]
Patrick Williams3350f3e2016-11-23 07:27:01 -06001description: >
2 The priority, for redundancy purposes, of the associated
3 xyz.openbmc_project.Software.Version.
4properties:
5 - name: Priority
Patrick Williams4eb52352017-01-25 09:16:59 -06006 type: byte
Patrick Williams3350f3e2016-11-23 07:27:01 -06007 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -05008 The priority order specified for the associated Software.Version,
9 represented as a value between 0 (High) and 127 (Low). Any value
10 above 127 has implementation-specific purpose.
Patrick Williams3350f3e2016-11-23 07:27:01 -060011
Patrick Williams8da396c2022-03-14 14:21:02 -050012 Only one Software.Version, per associated device, may be at any
13 particular priority. A requested priority change may cause other
14 Software.Versions to change priority.
Patrick Williams3350f3e2016-11-23 07:27:01 -060015
Patrick Williams8da396c2022-03-14 14:21:02 -050016 A dual-sided redundancy model could be represented by two
17 Software.Version associations, one of which is at priority 0 and the
18 other at priority 1. When a new image is Activated, the old
19 priority-1 association is deleted, the old priority-0 association
20 becomes priority-1, and the new image is assigned priority-0.
21
Patrick Williams3350f3e2016-11-23 07:27:01 -060022# TODO: Specify "EAGAIN" type error when priority is unable to be modified
23# due to current system state. Currently, sdbusplus does not support
24# errors on properties.