Skip to navigation

Firmware Inventory

View as MarkdownOpen in Claude

Read installed firmware versions and compare them with a firmware manifest.

RPCExecutionSummary
GetNodeFirmwareInventorySynchronousGetNodeFirmwareInventory retrieves all firmware component information for a node.
BatchGetFirmwareInventorySynchronousBatchGetFirmwareInventory retrieves firmware information for caller-supplied nodes without requiring them to be registered in RMS.
CompareFirmwareObjectSynchronousCompareFirmwareObject compares the versions in a proposed firmware manifest with firmware currently installed on caller-supplied nodes.
GetRackFirmwareInventorySynchronousGetRackFirmwareInventory retrieves firmware information for all nodes in a rack.

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

GetNodeFirmwareInventory

rack_manager.RackManager/GetNodeFirmwareInventory

GetNodeFirmwareInventory retrieves all firmware component information for a node. Returns version, update status, and health for each firmware component.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceGetNodeFirmwareInventory

Request: GetNodeFirmwareInventoryRequest

FieldTypeDescription
node_idstringTarget node identifier
rack_idstringRack containing the target node

Response: GetNodeFirmwareInventoryResponse

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise
firmware_listrepeated FirmwareInventoryInfoList of firmware components on the 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_id": "<node_id>",
"rack_id": "<rack_id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/GetNodeFirmwareInventory

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> firmware_inventory_node <rack_id> <node_id>

BatchGetFirmwareInventory

rack_manager.RackManager/BatchGetFirmwareInventory

BatchGetFirmwareInventory retrieves firmware information for caller-supplied nodes without requiring them to be registered in RMS.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetCaller-supplied nodes. The request carries each node’s endpoints and credentials, and RMS does not store them.
Behavior detailsOperations guide
Protobuf referenceBatchGetFirmwareInventory

Request: BatchGetFirmwareInventoryRequest

FieldTypeDescription
nodesNodeSetCaller-supplied node connection details

Response: BatchGetFirmwareInventoryResponse

FieldTypeDescription
responseNodeBatchResponse-
nodesrepeated NodeFirmwareInventoryInventory for each successfully queried 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>"
}
}
}
]
}
]
}
}' \
"$RMS_ADDR" rack_manager.RackManager/BatchGetFirmwareInventory

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> batch_get_firmware_inventory <nodes.csv>

CompareFirmwareObject

rack_manager.RackManager/CompareFirmwareObject

CompareFirmwareObject compares the versions in a proposed firmware manifest with firmware currently installed on caller-supplied nodes. It is read-only and does not download firmware artifacts or start update jobs.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetCaller-supplied nodes. The request carries each node’s endpoints and credentials, and RMS does not store them.
Behavior detailsOperations guide
Protobuf referenceCompareFirmwareObject

Request: CompareFirmwareObjectRequest

FieldTypeDescription
config_jsonstringProposed JSON firmware manifest
firmware_typestringArtifact channel/profile, e.g. “dev” or “prod”
nodesNodeSetCaller-supplied node connection details. A concrete NodeInfo.type takes precedence; NodeInfo.node_descriptor is used to resolve the node type when type is unspecified.
component_filtersmap of int32 to FirmwareObjectComponentFilterIf non-empty, compare only listed node types and components. An empty component list for a listed node type selects all eligible components.
node_descriptor_component_filtersrepeated NodeDescriptorFirmwareObjectComponentFilterDescriptor filters are resolved to node types and supplement component_filters. A component_filters entry wins when both selectors resolve to the same node type.

Response: CompareFirmwareObjectResponse

FieldTypeDescription
responseNodeBatchResponse-
object_idstring-
matches_manifestboolTrue only when every requested node succeeds and fully matches
nodesrepeated NodeFirmwareManifestComparison-

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>",
"firmware_type": "<firmware_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>"
}
}
}
]
}
]
},
"component_filters": {
"<key>": {
"components": [
"<components>"
]
}
},
"node_descriptor_component_filters": [
{
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"component_filter": {
"components": [
"<components>"
]
}
}
]
}' \
"$RMS_ADDR" rack_manager.RackManager/CompareFirmwareObject

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> compare_firmware_object <nodes.csv> <manifest.json> <firmware_type>

GetRackFirmwareInventory

rack_manager.RackManager/GetRackFirmwareInventory

GetRackFirmwareInventory retrieves firmware information for all nodes in a rack. Provides a comprehensive view of firmware versions across the rack.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceGetRackFirmwareInventory

Request: GetRackFirmwareInventoryRequest

FieldTypeDescription
rack_idstringTarget rack identifier

Response: GetRackFirmwareInventoryResponse

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise
nodesrepeated NodeFirmwareInventoryFirmware inventory grouped by 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 '{
"rack_id": "<rack_id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/GetRackFirmwareInventory