system_update_status

Returns information about the current target release and the progress of system software updates.

get/v1/system/update/status

Responses

200

successful operation

Object

Count of components running each release version

Keys will be either:

  • Semver-like release version strings * "install dataset", representing the initial rack software before any updates * "unknown", which means there is no TUF repo uploaded that matches the software running on the component)
Key
String
Value
integer
suspended

Whether automatic update is suspended due to manual update activity

After a manual support procedure that changes the system software, automatic update activity is suspended to avoid undoing the change. To resume automatic update, first upload the TUF repository matching the manually applied update, then set that as the target release.

Current target release of the system software

This may not correspond to the actual system software running at the time of request; it is instead the release that the system should be moving towards as a goal state. The system asynchronously updates software to match this target release.

Will only be null if a target release has never been set. In that case, the system is not automatically attempting to manage software versions.

View of a system software target release

Object
time_requested

Time this was set as the target release

version

The specified release of the rack's system software

time_last_step_planned

Time of most recent update planning activity

This is intended as a rough indicator of the last time something happened in the update planner.

4XX

Error

Object
message
request_id
5XX

Error

Object
message
request_id