Skip to navigation

Firmware Object Catalog

View as MarkdownOpen in Claude

Store, list, and manage firmware objects, and read their apply history.

RPCExecutionSummary
AddFirmwareObjectSynchronous, with background workAddFirmwareObject adds a firmware object catalog entry.
GetFirmwareObjectSynchronousGetFirmwareObject retrieves one firmware object catalog entry.
ListFirmwareObjectsSynchronousListFirmwareObjects lists firmware object catalog entries.
DeleteFirmwareObjectSynchronousDeleteFirmwareObject removes one firmware object catalog entry and its local cache.
SetDefaultFirmwareObjectSynchronousSetDefaultFirmwareObject marks one firmware object as default for its hardware type.
GetFirmwareObjectHistorySynchronousGetFirmwareObjectHistory lists firmware object 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.

PropertyValue
ExecutionSynchronous, with background work. The response carries the result of the call, and RMS keeps working in the background.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceAddFirmwareObject

Request: AddFirmwareObjectRequest

FieldTypeDescription
config_jsonstring-
access_tokenoptional stringUsed only for immediate/background artifact download; RMS does not persist this token.
hardware_typestring-
set_defaultboolIf true, mark this object as default for hardware_type after add.

Response: AddFirmwareObjectResponse

FieldTypeDescription
objectFirmwareObject-

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"config_json": "<config_json>",
"access_token": "<access_token>",
"hardware_type": "<hardware_type>",
"set_default": false
}' \
"$RMS_ADDR" rack_manager.RackManager/AddFirmwareObject

GetFirmwareObject

rack_manager.RackManager/GetFirmwareObject

GetFirmwareObject retrieves one firmware object catalog entry.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceGetFirmwareObject

Request: GetFirmwareObjectRequest

FieldTypeDescription
idstring-

Response: GetFirmwareObjectResponse

FieldTypeDescription
objectFirmwareObject-

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"id": "<id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/GetFirmwareObject

ListFirmwareObjects

rack_manager.RackManager/ListFirmwareObjects

ListFirmwareObjects lists firmware object catalog entries.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceListFirmwareObjects

Request: ListFirmwareObjectsRequest

FieldTypeDescription
only_availablebool-
hardware_typestring-

Response: ListFirmwareObjectsResponse

FieldTypeDescription
objectsrepeated FirmwareObject-

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"only_available": false,
"hardware_type": "<hardware_type>"
}' \
"$RMS_ADDR" rack_manager.RackManager/ListFirmwareObjects

DeleteFirmwareObject

rack_manager.RackManager/DeleteFirmwareObject

DeleteFirmwareObject removes one firmware object catalog entry and its local cache.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceDeleteFirmwareObject

Request: DeleteFirmwareObjectRequest

FieldTypeDescription
idstring-

Response: DeleteFirmwareObjectResponse

FieldTypeDescription
responseOperationResponse-

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"id": "<id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/DeleteFirmwareObject

SetDefaultFirmwareObject

rack_manager.RackManager/SetDefaultFirmwareObject

SetDefaultFirmwareObject marks one firmware object as default for its hardware type.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceSetDefaultFirmwareObject

Request: SetDefaultFirmwareObjectRequest

FieldTypeDescription
object_idstringDefault scope is determined by the hardware_type stored on this object.

Response: SetDefaultFirmwareObjectResponse

FieldTypeDescription
objectFirmwareObject-

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"object_id": "<object_id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/SetDefaultFirmwareObject

GetFirmwareObjectHistory

rack_manager.RackManager/GetFirmwareObjectHistory

GetFirmwareObjectHistory lists firmware object apply history.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetNot node-specific. Acts on the service, the firmware catalog, or a job.
Behavior detailsOperations guide
Protobuf referenceGetFirmwareObjectHistory

Request: GetFirmwareObjectHistoryRequest

FieldTypeDescription
object_idstringEmpty means no object filter
rack_idsrepeated stringEmpty means all racks

Response: GetFirmwareObjectHistoryResponse

FieldTypeDescription
recordsrepeated FirmwareObjectHistoryRecord-

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"object_id": "<object_id>",
"rack_ids": [
"<rack_ids>"
]
}' \
"$RMS_ADDR" rack_manager.RackManager/GetFirmwareObjectHistory