> 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 Object Catalog


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

| RPC | Execution | Summary |
| --- | --- | --- |
| [`AddFirmwareObject`](#addfirmwareobject) | Synchronous, with background work | AddFirmwareObject adds a firmware object catalog entry. |
| [`GetFirmwareObject`](#getfirmwareobject) | Synchronous | GetFirmwareObject retrieves one firmware object catalog entry. |
| [`ListFirmwareObjects`](#listfirmwareobjects) | Synchronous | ListFirmwareObjects lists firmware object catalog entries. |
| [`DeleteFirmwareObject`](#deletefirmwareobject) | Synchronous | DeleteFirmwareObject removes one firmware object catalog entry and its local cache. |
| [`SetDefaultFirmwareObject`](#setdefaultfirmwareobject) | Synchronous | SetDefaultFirmwareObject marks one firmware object as default for its hardware type. |
| [`GetFirmwareObjectHistory`](#getfirmwareobjecthistory) | Synchronous | GetFirmwareObjectHistory lists firmware object apply history. |

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

<Warning>
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.
</Warning>

| Property | Value |
| --- | --- |
| Execution | **Synchronous, with background work.** The response carries the result of the call, and RMS keeps working in the background. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`AddFirmwareObject`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-add-firmware-object) |

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

| Field | Type | Description |
| --- | --- | --- |
| `config_json` | `string` | - |
| `access_token` | optional `string` | Used only for immediate/background artifact download; RMS does not persist this token. |
| `hardware_type` | `string` | - |
| `set_default` | `bool` | If true, mark this object as default for hardware_type after add. |

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

| Field | Type | Description |
| --- | --- | --- |
| `object` | [`FirmwareObject`](/rms/api-reference/types/rack-manager#firmwareobject) | - |

**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>",
  "access_token": "<access_token>",
  "hardware_type": "<hardware_type>",
  "set_default": false
}' \
  "$RMS_ADDR" rack_manager.RackManager/AddFirmwareObject
```

</Accordion>

## GetFirmwareObject

`rack_manager.RackManager/GetFirmwareObject`

GetFirmwareObject retrieves one firmware object catalog entry.

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`GetFirmwareObject`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-get-firmware-object) |

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

| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` | - |

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

| Field | Type | Description |
| --- | --- | --- |
| `object` | [`FirmwareObject`](/rms/api-reference/types/rack-manager#firmwareobject) | - |

**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 '{
  "id": "<id>"
}' \
  "$RMS_ADDR" rack_manager.RackManager/GetFirmwareObject
```

</Accordion>

## ListFirmwareObjects

`rack_manager.RackManager/ListFirmwareObjects`

ListFirmwareObjects lists firmware object catalog entries.

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`ListFirmwareObjects`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-list-firmware-objects) |

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

| Field | Type | Description |
| --- | --- | --- |
| `only_available` | `bool` | - |
| `hardware_type` | `string` | - |

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

| Field | Type | Description |
| --- | --- | --- |
| `objects` | repeated [`FirmwareObject`](/rms/api-reference/types/rack-manager#firmwareobject) | - |

**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 '{
  "only_available": false,
  "hardware_type": "<hardware_type>"
}' \
  "$RMS_ADDR" rack_manager.RackManager/ListFirmwareObjects
```

</Accordion>

## DeleteFirmwareObject

`rack_manager.RackManager/DeleteFirmwareObject`

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

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`DeleteFirmwareObject`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-delete-firmware-object) |

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

| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` | - |

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

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`OperationResponse`](/rms/api-reference/types/rack-manager#operationresponse) | - |

**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 '{
  "id": "<id>"
}' \
  "$RMS_ADDR" rack_manager.RackManager/DeleteFirmwareObject
```

</Accordion>

## SetDefaultFirmwareObject

`rack_manager.RackManager/SetDefaultFirmwareObject`

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

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`SetDefaultFirmwareObject`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-set-default-firmware-object) |

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

| Field | Type | Description |
| --- | --- | --- |
| `object_id` | `string` | Default scope is determined by the hardware_type stored on this object. |

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

| Field | Type | Description |
| --- | --- | --- |
| `object` | [`FirmwareObject`](/rms/api-reference/types/rack-manager#firmwareobject) | - |

**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 '{
  "object_id": "<object_id>"
}' \
  "$RMS_ADDR" rack_manager.RackManager/SetDefaultFirmwareObject
```

</Accordion>

## GetFirmwareObjectHistory

`rack_manager.RackManager/GetFirmwareObjectHistory`

GetFirmwareObjectHistory lists firmware object apply history.

| Property | Value |
| --- | --- |
| Execution | **Synchronous.** The response carries the full result. |
| Target | **Not node-specific.** Acts on the service, the firmware catalog, or a job. |
| Behavior details | [Operations guide](/rms/documentation/operations/firmware) |
| Protobuf reference | [`GetFirmwareObjectHistory`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-get-firmware-object-history) |

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

| Field | Type | Description |
| --- | --- | --- |
| `object_id` | `string` | Empty means no object filter |
| `rack_ids` | repeated `string` | Empty means all racks |

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

| Field | Type | Description |
| --- | --- | --- |
| `records` | repeated [`FirmwareObjectHistoryRecord`](/rms/api-reference/types/rack-manager#firmwareobjecthistoryrecord) | - |

**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 '{
  "object_id": "<object_id>",
  "rack_ids": [
    "<rack_ids>"
  ]
}' \
  "$RMS_ADDR" rack_manager.RackManager/GetFirmwareObjectHistory
```

</Accordion>