Switch Management
Manage switch firmware and NVOS system images, passwords, factory reset, and attestation.
For definitions of execution modes and job polling, refer to Async jobs.
ListSwitchFirmware
rack_manager.RackManager/ListSwitchFirmware
ListSwitchFirmware lists the firmware for switch. Returns version, update status, and health for switch firmware component.
Request: ListSwitchFirmwareRequest
Response: ListSwitchFirmwareResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
PushSwitchFirmware
rack_manager.RackManager/PushSwitchFirmware
PushSwitchFirmware pushes a firmware binary to target switch. Returns success or error_message
This call uploads the file to the switch and does not install it.
Request: PushSwitchFirmwareRequest
Response: PushSwitchFirmwareResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
ListSwitchSystemImages
rack_manager.RackManager/ListSwitchSystemImages
ListSwitchSystemImages retrieves the list of OS images available on the switch. Returns information about installed and staged images.
Request: ListSwitchSystemImagesRequest
Response: ListSwitchSystemImagesResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
UpdateSwitchSystemImage
rack_manager.RackManager/UpdateSwitchSystemImage
UpdateSwitchSystemImage initiates asynchronous switch system image updates on a caller-supplied list of switch nodes. Each node is identified by its NodeInfo. Returns a parent job ID for tracking overall batch status, along with individual node job IDs. Use GetSwitchSystemImageJobStatus to track progress.
Request: UpdateSwitchSystemImageRequest
Response: UpdateSwitchSystemImageResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
ApplySwitchSystemImage
rack_manager.RackManager/ApplySwitchSystemImage
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.
Request: ApplySwitchSystemImageRequest
Response: ApplySwitchSystemImageResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
ApplyStoredSwitchSystemImage
rack_manager.RackManager/ApplyStoredSwitchSystemImage
ApplyStoredSwitchSystemImage resolves a stored switch system image and starts updates for supplied switches.
Request: ApplyStoredSwitchSystemImageRequest
Response: ApplyStoredSwitchSystemImageResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
BatchResetSwitchFactoryDefault
rack_manager.RackManager/BatchResetSwitchFactoryDefault
BatchResetSwitchFactoryDefault submits asynchronous NVOS factory resets. All switches in the request use the same domain for NVUE mTLS material. Returns a parent job ID. Use GetJobStatus with child job states to track per-node progress. Unlike the SDN reset, this wipes NVOS configuration back to factory defaults.
A per-node job completes once the switch has rebooted after the reset and is reachable again via the default login; the factory default password is preserved, not rotated. If the supplied switch credentials do not work, RMS falls back to the factory default password to perform the reset, without assuming a switch was already reset just because the default login works. Set allow_ssh_fallback to permit reset submission over SSH when the reset cannot be submitted through NVUE. This fallback is disabled by default.
This operation is destructive. It wipes NVOS configuration.
Request: BatchResetSwitchFactoryDefaultRequest
Response: BatchResetSwitchFactoryDefaultResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
UpdateSwitchSystemPassword
rack_manager.RackManager/UpdateSwitchSystemPassword
UpdateSwitchSystemPassword initiates asynchronous OS-level password updates for a specific user on a caller-supplied list of switch nodes. The caller supplies both the current password and desired next password so retries can resume after a partial failure. Returns a parent job ID in response.job_id; use GetJobStatus to track progress.
The per-node results in the response report job admission only. Poll the jobs to learn whether each password change succeeded. The request sets only the new password for username and takes no current password. RMS reaches each switch with the credentials in that node’s endpoint, and those credentials can belong to a different user than username. On a retry, RMS probes password to detect an earlier partial success.
Request: UpdateSwitchSystemPasswordRequest
Response: UpdateSwitchSystemPasswordResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
BatchCollectSwitchSpdmAttestationEvidence
rack_manager.RackManager/BatchCollectSwitchSpdmAttestationEvidence
BatchCollectSwitchSpdmAttestationEvidence synchronously generates and retrieves fresh SPDM evidence from caller-supplied switch trays.
Request: BatchCollectSwitchSpdmAttestationEvidenceRequest
Response: BatchCollectSwitchSpdmAttestationEvidenceResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.