Firmware Object Catalog
Store, list, and manage firmware objects, and read their apply history.
For definitions of execution modes and job polling, refer to Async jobs.
AddFirmwareObject
rack_manager.RackManager/AddFirmwareObject
AddFirmwareObject adds a firmware object catalog entry.
RMS may download the referenced artifacts asynchronously after accepting the object. Use GetFirmwareObject or ListFirmwareObjects and check FirmwareObject.available before applying it.
The call returns after RMS stores the object. RMS downloads the referenced artifacts in the background. Call GetFirmwareObject or ListFirmwareObjects and wait for FirmwareObject.available before you apply the object.
Request: AddFirmwareObjectRequest
Response: AddFirmwareObjectResponse
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.
GetFirmwareObject
rack_manager.RackManager/GetFirmwareObject
GetFirmwareObject retrieves one firmware object catalog entry.
Request: GetFirmwareObjectRequest
Response: GetFirmwareObjectResponse
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.
ListFirmwareObjects
rack_manager.RackManager/ListFirmwareObjects
ListFirmwareObjects lists firmware object catalog entries.
Request: ListFirmwareObjectsRequest
Response: ListFirmwareObjectsResponse
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.
DeleteFirmwareObject
rack_manager.RackManager/DeleteFirmwareObject
DeleteFirmwareObject removes one firmware object catalog entry and its local cache.
Request: DeleteFirmwareObjectRequest
Response: DeleteFirmwareObjectResponse
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.
SetDefaultFirmwareObject
rack_manager.RackManager/SetDefaultFirmwareObject
SetDefaultFirmwareObject marks one firmware object as default for its hardware type.
Request: SetDefaultFirmwareObjectRequest
Response: SetDefaultFirmwareObjectResponse
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.
GetFirmwareObjectHistory
rack_manager.RackManager/GetFirmwareObjectHistory
GetFirmwareObjectHistory lists firmware object apply history.
Request: GetFirmwareObjectHistoryRequest
Response: GetFirmwareObjectHistoryResponse
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.