Skip to navigation

Firmware Updates

View as MarkdownOpen in Claude

Start firmware updates on one node, many nodes, or from a firmware object.

RPCExecutionSummary
UpdateFirmwareAsynchronous, one jobUpdateFirmware initiates a firmware update on a specific node asynchronously.
BatchUpdateFirmwareByNodeTypeAsynchronous, parent and child jobsBatchUpdateFirmwareByNodeType initiates firmware updates on all nodes of a specific type in a rack asynchronously.
BatchUpdateFirmwareAsynchronous, parent and child jobsBatchUpdateFirmware initiates firmware updates on a specified list of nodes asynchronously.
ApplyStoredFirmwareObjectAsynchronous, parent and child jobsApplyStoredFirmwareObject resolves stored firmware targets and starts firmware updates for supplied nodes.
ApplyFirmwareObjectAsynchronous, parent and child jobsApplyFirmwareObject ingests a firmware object from JSON, downloads required artifacts, resolves firmware targets, and starts firmware updates for supplied nodes.

For definitions of execution modes and job polling, refer to Async jobs.

UpdateFirmware

rack_manager.RackManager/UpdateFirmware

UpdateFirmware initiates a firmware update on a specific node asynchronously. Returns a job ID immediately. Use GetFirmwareJobStatus to track progress. Works for all node types (compute, powershelf, switch).

PropertyValue
ExecutionAsynchronous, one job. The response returns a job ID and the work continues after the call returns.
Job trackingPoll GetFirmwareJobStatus with the job ID in job_id.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceUpdateFirmware

Request: UpdateFirmwareRequest

FieldTypeDescription
node_idstringTarget node identifier
filenamestringSingle firmware filename (used when firmware_targets is empty)
targetstringSingle Redfish target URI (used when firmware_targets is empty)
activateboolWhether to immediately activate the firmware after installation
rack_idstringRack containing the target node
firmware_targetsrepeated FirmwareTargetMultiple (target, filename) pairs for batch component updates
force_updateboolForce the BMC to accept the firmware even if it’s a downgrade

Response: UpdateFirmwareResponse

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if update completed, RETURN_CODE_FAILURE otherwise
messagestringHuman-readable status or error message
error_codeFirmwareUpdateErrorDetailed error code for troubleshooting
job_idstringJob ID for async operations (use with GetFirmwareJobStatus to track progress)

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 '{
"node_id": "<node_id>",
"filename": "<filename>",
"target": "<target>",
"activate": false,
"rack_id": "<rack_id>",
"firmware_targets": [
{
"target": "<target>",
"filename": "<filename>"
}
],
"force_update": false
}' \
"$RMS_ADDR" rack_manager.RackManager/UpdateFirmware

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> update_firmware <rack_id> <node_id> <target:filename>...

BatchUpdateFirmwareByNodeType

rack_manager.RackManager/BatchUpdateFirmwareByNodeType

BatchUpdateFirmwareByNodeType initiates firmware updates on all nodes of a specific type in a rack asynchronously. Returns a parent job ID for tracking overall batch status, along with individual node job IDs. Use GetFirmwareJobStatus to track progress.

PropertyValue
ExecutionAsynchronous, parent and child jobs. The response returns a parent job ID and the work continues after the call returns.
Job trackingPoll GetFirmwareJobStatus with the job ID in response.job_id. Per-node child job IDs are in jobs.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceBatchUpdateFirmwareByNodeType

Request: BatchUpdateFirmwareByNodeTypeRequest

FieldTypeDescription
node_typeNodeTypeType of nodes to update; non-UNSPECIFIED values override node_descriptor
filenamestringSingle firmware filename (used when firmware_targets is empty)
targetstringSingle Redfish target URI (used when firmware_targets is empty)
rack_idstringTarget rack identifier
firmware_targetsrepeated FirmwareTargetMultiple (target, filename) pairs for batch component updates
activateboolWhether to activate firmware after all targets are flashed
force_updateboolForce the BMC to accept the firmware even if it’s a downgrade
node_descriptoroptional NodeDescriptorFlexible node identity used when node_type is NODE_TYPE_UNSPECIFIED

Response: BatchUpdateFirmwareByNodeTypeResponse

FieldTypeDescription
responseNodeBatchResponse-
jobsrepeated NodeFirmwareJobInfoIndividual job ID per node

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 '{
"node_type": "COMPUTE_GB200_NVIDIA",
"filename": "<filename>",
"target": "<target>",
"rack_id": "<rack_id>",
"firmware_targets": [
{
"target": "<target>",
"filename": "<filename>"
}
],
"activate": false,
"force_update": false,
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
}
}' \
"$RMS_ADDR" rack_manager.RackManager/BatchUpdateFirmwareByNodeType

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> batch_update_firmware_by_node_type <rack_id> <node_type> <target:filename>...

BatchUpdateFirmware

rack_manager.RackManager/BatchUpdateFirmware

BatchUpdateFirmware initiates firmware updates on a specified list of nodes asynchronously. Each node is identified by its NodeInfo. Separate firmware targets are provided for compute trays, switch trays, and power shelves, and the appropriate target is applied to each node based on its node type. Returns a parent job ID for tracking overall batch status, along with individual node job IDs. Use GetFirmwareJobStatus to track progress.

PropertyValue
ExecutionAsynchronous, parent and child jobs. The response returns a parent job ID and the work continues after the call returns.
Job trackingPoll GetFirmwareJobStatus with the job ID in response.job_id. Per-node child job IDs are in jobs.
TargetCaller-supplied nodes. The request carries each node’s endpoints and credentials, and RMS does not store them.
Behavior detailsOperations guide
Protobuf referenceBatchUpdateFirmware

Request: BatchUpdateFirmwareRequest

FieldTypeDescription
nodesNodeSetNodes to update
firmware_targetsmap of int32 to FirmwareTargetListFirmware targets keyed by NodeType enum value
activateboolWhether to activate firmware after installation
force_updateboolForce the BMC to accept the firmware even if it’s a downgrade
node_descriptor_firmware_targetsrepeated NodeDescriptorFirmwareTargetListFirmware targets keyed by flexible node identity

Response: BatchUpdateFirmwareResponse

FieldTypeDescription
responseNodeBatchResponse-
jobsrepeated NodeFirmwareJobInfoIndividual job ID per node

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 '{
"nodes": {
"nodes": [
{
"node_id": "<node_id>",
"rack_id": "<rack_id>",
"type": "COMPUTE_GB200_NVIDIA",
"bmc_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"host_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"additional_host_endpoints": [
{
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
}
]
}
]
},
"firmware_targets": {
"<key>": {
"targets": [
{
"target": "<target>",
"filename": "<filename>"
}
]
}
},
"activate": false,
"force_update": false,
"node_descriptor_firmware_targets": [
{
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"firmware_targets": {
"targets": [
{
"target": "<target>",
"filename": "<filename>"
}
]
}
}
]
}' \
"$RMS_ADDR" rack_manager.RackManager/BatchUpdateFirmware

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> batch_update_firmware <nodes.csv> <targets.csv>

ApplyStoredFirmwareObject

rack_manager.RackManager/ApplyStoredFirmwareObject

ApplyStoredFirmwareObject resolves stored firmware targets and starts firmware updates for supplied nodes.

PropertyValue
ExecutionAsynchronous, parent and child jobs. The response returns a parent job ID and the work continues after the call returns.
Job trackingPoll GetFirmwareJobStatus with the job ID in response.job_id. Per-node child job IDs are in jobs.
TargetCaller-supplied nodes. The request carries each node’s endpoints and credentials, and RMS does not store them.
Behavior detailsOperations guide
Protobuf referenceApplyStoredFirmwareObject

Request: ApplyStoredFirmwareObjectRequest

FieldTypeDescription
rack_idstring-
object_idstringEmpty means use default for hardware_type
firmware_typestring”dev” or “prod”
hardware_typestring-
componentsrepeated stringDeprecated: global component filter for all node types
nodesNodeSetCaller-supplied nodes
force_updatebool-
component_filtersmap of int32 to FirmwareObjectComponentFilterComponent filters keyed by NodeType. If non-empty, only listed node types are updated. A listed node type with an empty components list means all components for that node type.
node_descriptor_component_filtersrepeated NodeDescriptorFirmwareObjectComponentFilterComponent filters keyed by flexible node identity

Response: ApplyStoredFirmwareObjectResponse

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is parent job id
object_idstring-
jobsrepeated NodeFirmwareJobInfo-

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 '{
"rack_id": "<rack_id>",
"object_id": "<object_id>",
"firmware_type": "<firmware_type>",
"hardware_type": "<hardware_type>",
"nodes": {
"nodes": [
{
"node_id": "<node_id>",
"rack_id": "<rack_id>",
"type": "COMPUTE_GB200_NVIDIA",
"bmc_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"host_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"additional_host_endpoints": [
{
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
}
]
}
]
},
"force_update": false,
"component_filters": {
"<key>": {
"components": [
"<components>"
]
}
},
"node_descriptor_component_filters": [
{
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"component_filter": {
"components": [
"<components>"
]
}
}
]
}' \
"$RMS_ADDR" rack_manager.RackManager/ApplyStoredFirmwareObject

ApplyFirmwareObject

rack_manager.RackManager/ApplyFirmwareObject

ApplyFirmwareObject ingests a firmware object from JSON, downloads required artifacts, resolves firmware targets, and starts firmware updates for supplied nodes.

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.

PropertyValue
ExecutionAsynchronous, parent and child jobs. The response returns a parent job ID and the work continues after the call returns.
Job trackingPoll GetFirmwareJobStatus with the job ID in response.job_id. Per-node child job IDs are in jobs.
TargetCaller-supplied nodes. The request carries each node’s endpoints and credentials, and RMS does not store them.
Behavior detailsOperations guide
Protobuf referenceApplyFirmwareObject

Request: ApplyFirmwareObjectRequest

FieldTypeDescription
rack_idstring-
config_jsonstringSOT JSON containing the firmware object ID and artifacts
access_tokenoptional stringUsed only for artifact download; RMS does not persist it
firmware_typestring”dev” or “prod”
hardware_typestring-
nodesNodeSetCaller-supplied nodes
force_updatebool-
component_filtersmap of int32 to FirmwareObjectComponentFilterComponent filters keyed by NodeType. If non-empty, only listed node types are updated. A listed node type with an empty components list means all components for that node type.
node_descriptor_component_filtersrepeated NodeDescriptorFirmwareObjectComponentFilterComponent filters keyed by flexible node identity

Response: ApplyFirmwareObjectResponse

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is parent job id
object_idstring-
jobsrepeated NodeFirmwareJobInfo-

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 '{
"rack_id": "<rack_id>",
"config_json": "<config_json>",
"access_token": "<access_token>",
"firmware_type": "<firmware_type>",
"hardware_type": "<hardware_type>",
"nodes": {
"nodes": [
{
"node_id": "<node_id>",
"rack_id": "<rack_id>",
"type": "COMPUTE_GB200_NVIDIA",
"bmc_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"host_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"additional_host_endpoints": [
{
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
}
]
}
]
},
"force_update": false,
"component_filters": {
"<key>": {
"components": [
"<components>"
]
}
},
"node_descriptor_component_filters": [
{
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"component_filter": {
"components": [
"<components>"
]
}
}
]
}' \
"$RMS_ADDR" rack_manager.RackManager/ApplyFirmwareObject