Skip to navigation

ApplySwitchSystemImage

View as MarkdownOpen in Claude

ApplySwitchSystemImage ingests a firmware object from SOT JSON, downloads required artifacts, resolves the switch system image artifact from the ingested firmware object, and starts updates for supplied switches.

RMS treats the ingested firmware object as ephemeral for this request. It uses access_token only for artifact download and does not persist the token or object.

ApplySwitchSystemImageRequest

Request
This endpoint expects an object.
_access_tokenstring
rack_idstring
config_jsonstring
SOT JSON containing the firmware object ID and switch image
software_typestring
"dev" or "prod"
hardware_typestring
nodesobject

Caller-supplied switch nodes

allow_onie_recoveryboolean
Allow recovery in cases where NVOS is not installed

ApplySwitchSystemImageResponse

Response
This endpoint returns an object.
responseobject

response.job_id is parent job id

object_idstring
image_filenamestring
jobslist of objects