> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/rms/llms.txt.

# Firmware Inventory


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

| RPC | Execution | Summary |
| --- | --- | --- |
| [`GetNodeFirmwareInventory`](#getnodefirmwareinventory) | Synchronous | GetNodeFirmwareInventory retrieves all firmware component information for a node. |
| [`BatchGetFirmwareInventory`](#batchgetfirmwareinventory) | Synchronous | BatchGetFirmwareInventory retrieves firmware information for caller-supplied nodes without requiring them to be registered in RMS. |
| [`CompareFirmwareObject`](#comparefirmwareobject) | Synchronous | CompareFirmwareObject compares the versions in a proposed firmware manifest with firmware currently installed on caller-supplied nodes. |
| [`GetRackFirmwareInventory`](#getrackfirmwareinventory) | Synchronous | GetRackFirmwareInventory retrieves firmware information for all nodes in a rack. |

For definitions of execution modes and job polling, refer to [Async jobs](/rms/api-reference/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.

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Registered inventory.** Reads or changes nodes and racks stored in RMS inventory. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`GetNodeFirmwareInventory`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-get-node-firmware-inventory) |

**Request:** [`GetNodeFirmwareInventoryRequest`](/rms/api-reference/types/rack-manager#getnodefirmwareinventoryrequest)

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Target node identifier |
| `rack_id` | `string` | Rack containing the target node |

**Response:** [`GetNodeFirmwareInventoryResponse`](/rms/api-reference/types/rack-manager#getnodefirmwareinventoryresponse)

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise |
| `firmware_list` | repeated [`FirmwareInventoryInfo`](/rms/api-reference/types/rack-manager#firmwareinventoryinfo) | List of firmware components on the node |

**Errors:** Refer to [Conventions](/rms/api-reference/conventions#error-handling) for how RMS reports failures.

<Accordion title="Example request">

Replace each `<placeholder>` with a real value. Define `RMS_GRPCURL_FLAGS` and `RMS_ADDR` as described in [Getting started](/rms/api-reference/getting-started#call-an-rpc-with-grpcurl).

```bash
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:

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

</Accordion>

## BatchGetFirmwareInventory

`rack_manager.RackManager/BatchGetFirmwareInventory`

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

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Caller-supplied nodes.** The request carries each node's endpoints and credentials, and RMS does not store them. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`BatchGetFirmwareInventory`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-batch-get-firmware-inventory) |

**Request:** [`BatchGetFirmwareInventoryRequest`](/rms/api-reference/types/rack-manager#batchgetfirmwareinventoryrequest)

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Caller-supplied node connection details |

**Response:** [`BatchGetFirmwareInventoryResponse`](/rms/api-reference/types/rack-manager#batchgetfirmwareinventoryresponse)

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`NodeBatchResponse`](/rms/api-reference/types/rack-manager#nodebatchresponse) | - |
| `nodes` | repeated [`NodeFirmwareInventory`](/rms/api-reference/types/rack-manager#nodefirmwareinventory) | Inventory for each successfully queried node |

**Errors:** Refer to [Conventions](/rms/api-reference/conventions#error-handling) for how RMS reports failures.

<Accordion title="Example request">

Replace each `<placeholder>` with a real value. Define `RMS_GRPCURL_FLAGS` and `RMS_ADDR` as described in [Getting started](/rms/api-reference/getting-started#call-an-rpc-with-grpcurl).

```bash
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:

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

</Accordion>

## 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.

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Caller-supplied nodes.** The request carries each node's endpoints and credentials, and RMS does not store them. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`CompareFirmwareObject`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-compare-firmware-object) |

**Request:** [`CompareFirmwareObjectRequest`](/rms/api-reference/types/rack-manager#comparefirmwareobjectrequest)

| Field | Type | Description |
| --- | --- | --- |
| `config_json` | `string` | Proposed JSON firmware manifest |
| `firmware_type` | `string` | Artifact channel/profile, e.g. "dev" or "prod" |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Caller-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_filters` | map of `int32` to [`FirmwareObjectComponentFilter`](/rms/api-reference/types/rack-manager#firmwareobjectcomponentfilter) | If 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_filters` | repeated [`NodeDescriptorFirmwareObjectComponentFilter`](/rms/api-reference/types/rack-manager#nodedescriptorfirmwareobjectcomponentfilter) | Descriptor 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`](/rms/api-reference/types/rack-manager#comparefirmwareobjectresponse)

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`NodeBatchResponse`](/rms/api-reference/types/rack-manager#nodebatchresponse) | - |
| `object_id` | `string` | - |
| `matches_manifest` | `bool` | True only when every requested node succeeds and fully matches |
| `nodes` | repeated [`NodeFirmwareManifestComparison`](/rms/api-reference/types/rack-manager#nodefirmwaremanifestcomparison) | - |

**Errors:** Refer to [Conventions](/rms/api-reference/conventions#error-handling) for how RMS reports failures.

<Accordion title="Example request">

Replace each `<placeholder>` with a real value. Define `RMS_GRPCURL_FLAGS` and `RMS_ADDR` as described in [Getting started](/rms/api-reference/getting-started#call-an-rpc-with-grpcurl).

```bash
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:

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

</Accordion>

## 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.

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Registered inventory.** Reads or changes nodes and racks stored in RMS inventory. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`GetRackFirmwareInventory`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-get-rack-firmware-inventory) |

**Request:** [`GetRackFirmwareInventoryRequest`](/rms/api-reference/types/rack-manager#getrackfirmwareinventoryrequest)

| Field | Type | Description |
| --- | --- | --- |
| `rack_id` | `string` | Target rack identifier |

**Response:** [`GetRackFirmwareInventoryResponse`](/rms/api-reference/types/rack-manager#getrackfirmwareinventoryresponse)

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise |
| `nodes` | repeated [`NodeFirmwareInventory`](/rms/api-reference/types/rack-manager#nodefirmwareinventory) | Firmware inventory grouped by node |

**Errors:** Refer to [Conventions](/rms/api-reference/conventions#error-handling) for how RMS reports failures.

<Accordion title="Example request">

Replace each `<placeholder>` with a real value. Define `RMS_GRPCURL_FLAGS` and `RMS_ADDR` as described in [Getting started](/rms/api-reference/getting-started#call-an-rpc-with-grpcurl).

```bash
grpcurl $RMS_GRPCURL_FLAGS \
  -d '{
  "rack_id": "<rack_id>"
}' \
  "$RMS_ADDR" rack_manager.RackManager/GetRackFirmwareInventory
```

</Accordion>