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

# Switch Management


Manage switch firmware and NVOS system images, passwords, factory reset, and attestation.

| RPC | Execution | Summary |
| --- | --- | --- |
| [`ListSwitchFirmware`](#listswitchfirmware) | Synchronous | ListSwitchFirmware lists the firmware for switch. |
| [`PushSwitchFirmware`](#pushswitchfirmware) | Synchronous | PushSwitchFirmware pushes a firmware binary to target switch. |
| [`ListSwitchSystemImages`](#listswitchsystemimages) | Synchronous | ListSwitchSystemImages retrieves the list of OS images available on the switch. |
| [`UpdateSwitchSystemImage`](#updateswitchsystemimage) | Asynchronous, parent and child jobs | UpdateSwitchSystemImage initiates asynchronous switch system image updates on a caller-supplied list of switch nodes. |
| [`ApplySwitchSystemImage`](#applyswitchsystemimage) | Asynchronous, parent and child jobs | ApplySwitchSystemImage ingests a firmware object from SOT JSON, downloads required artifacts, resolves the switch system image artifact from the ingested firmware object, and starts updates for supplied switches. |
| [`ApplyStoredSwitchSystemImage`](#applystoredswitchsystemimage) | Asynchronous, parent and child jobs | ApplyStoredSwitchSystemImage resolves a stored switch system image and starts updates for supplied switches. |
| [`BatchResetSwitchFactoryDefault`](#batchresetswitchfactorydefault) | Asynchronous, parent and child jobs | BatchResetSwitchFactoryDefault submits asynchronous NVOS factory resets. |
| [`UpdateSwitchSystemPassword`](#updateswitchsystempassword) | Asynchronous, parent and child jobs | UpdateSwitchSystemPassword initiates asynchronous OS-level password updates for a specific user on a caller-supplied list of switch nodes. |
| [`BatchCollectSwitchSpdmAttestationEvidence`](#batchcollectswitchspdmattestationevidence) | Synchronous | BatchCollectSwitchSpdmAttestationEvidence synchronously generates and retrieves fresh SPDM evidence from caller-supplied switch trays. |

For definitions of execution modes and job polling, refer to [Async jobs](/rms/api-reference/async-jobs).

## ListSwitchFirmware

`rack_manager.RackManager/ListSwitchFirmware`

ListSwitchFirmware lists the firmware for switch. Returns version, update status, and health for switch 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/switch-management) |
| Protobuf reference | [`ListSwitchFirmware`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-list-switch-firmware) |

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

| Field | Type | Description |
| --- | --- | --- |
| `rack_id` | `string` | Rack ID for inventory lookup |
| `node_id` | `string` | Node ID for inventory lookup |
| `component_type` | [`SwitchFirmwareComponentType`](/rms/api-reference/types/rack-manager#switchfirmwarecomponenttype) | Required: Firmware component type enum |

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

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise |
| `result_json` | `string` | JSON object containing firmware inventory result |
| `error_message` | `string` | Error details if retrieval failed |

**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>",
  "node_id": "<node_id>",
  "component_type": "SWITCH_FIRMWARE_COMPONENT_TYPE_UNKNOWN"
}' \
  "$RMS_ADDR" rack_manager.RackManager/ListSwitchFirmware
```

</Accordion>

## PushSwitchFirmware

`rack_manager.RackManager/PushSwitchFirmware`

PushSwitchFirmware pushes a firmware binary to target switch. Returns success or error_message

<Warning>
This call uploads the file to the switch and does not install it.
</Warning>

| 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/switch-management) |
| Protobuf reference | [`PushSwitchFirmware`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-push-switch-firmware) |

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

| Field | Type | Description |
| --- | --- | --- |
| `rack_id` | `string` | Required: Rack ID for inventory lookup |
| `node_id` | `string` | Required: Node ID for inventory lookup |
| `component_type` | [`SwitchFirmwareComponentType`](/rms/api-reference/types/rack-manager#switchfirmwarecomponenttype) | Required: Firmware component type enum |
| `filename` | `string` | Required: Desired filename on the switch (used as-is, no suffix modification) |
| `local_file_path` | `string` | Required: Local file path on rackmanager host (file must be at least 1KB) |

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

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if pushed, RETURN_CODE_FAILURE otherwise |
| `result_json` | `string` | JSON object containing push result |
| `error_message` | `string` | Error details if push failed |

**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>",
  "node_id": "<node_id>",
  "component_type": "SWITCH_FIRMWARE_COMPONENT_TYPE_UNKNOWN",
  "filename": "<filename>",
  "local_file_path": "<local_file_path>"
}' \
  "$RMS_ADDR" rack_manager.RackManager/PushSwitchFirmware
```

</Accordion>

## ListSwitchSystemImages

`rack_manager.RackManager/ListSwitchSystemImages`

ListSwitchSystemImages retrieves the list of OS images available on the switch. Returns information about installed and staged images.

| 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/switch-management) |
| Protobuf reference | [`ListSwitchSystemImages`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-list-switch-system-images) |

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

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

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

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise |
| `images_json` | `string` | JSON array containing image information |
| `error_message` | `string` | Error details if query failed |

**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>",
  "node_id": "<node_id>"
}' \
  "$RMS_ADDR" rack_manager.RackManager/ListSwitchSystemImages
```

</Accordion>

## UpdateSwitchSystemImage

`rack_manager.RackManager/UpdateSwitchSystemImage`

UpdateSwitchSystemImage initiates asynchronous switch system image updates on a caller-supplied list of switch nodes. Each node is identified by its NodeInfo. Returns a parent job ID for tracking overall batch status, along with individual node job IDs. Use GetSwitchSystemImageJobStatus to track progress.

| Property | Value |
| --- | --- |
| Execution | **Asynchronous, parent and child jobs.** The response returns a parent job ID and the work continues after the call returns. |
| Job tracking | Poll [`GetSwitchSystemImageJobStatus`](/rms/api-reference/rpcs/utility-jobs#getswitchsystemimagejobstatus) with the job ID in `response.job_id`. Per-node child job IDs are in `jobs`. |
| 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/switch-management) |
| Protobuf reference | [`UpdateSwitchSystemImage`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-update-switch-system-image) |

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

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Switch nodes to update |
| `image_filename` | `string` | Binary filename as it should exist on the switch |
| `local_file_path` | `string` | Local file path on the RMS host |
| `allow_onie_recovery` | `bool` | Allow recovery in cases where NVOS is not installed |

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

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`NodeBatchResponse`](/rms/api-reference/types/rack-manager#nodebatchresponse) | - |
| `jobs` | repeated [`SwitchSystemImageUpdateJobInfo`](/rms/api-reference/types/rack-manager#switchsystemimageupdatejobinfo) | Individual job ID per switch |

**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>"
              }
            }
          }
        ]
      }
    ]
  },
  "image_filename": "<image_filename>",
  "local_file_path": "<local_file_path>",
  "allow_onie_recovery": false
}' \
  "$RMS_ADDR" rack_manager.RackManager/UpdateSwitchSystemImage
```

</Accordion>

## ApplySwitchSystemImage

`rack_manager.RackManager/ApplySwitchSystemImage`

ApplySwitchSystemImage ingests a firmware object from SOT JSON, downloads required artifacts, resolves the switch system image artifact from the ingested firmware object, and starts updates for supplied switches.

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.

| Property | Value |
| --- | --- |
| Execution | **Asynchronous, parent and child jobs.** The response returns a parent job ID and the work continues after the call returns. |
| Job tracking | Poll [`GetSwitchSystemImageJobStatus`](/rms/api-reference/rpcs/utility-jobs#getswitchsystemimagejobstatus) with the job ID in `response.job_id`. Per-node child job IDs are in `jobs`. |
| 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 | [`ApplySwitchSystemImage`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-apply-switch-system-image) |

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

| Field | Type | Description |
| --- | --- | --- |
| `rack_id` | `string` | - |
| `config_json` | `string` | SOT JSON containing the firmware object ID and switch image |
| `access_token` | optional `string` | Used only for artifact download; RMS does not persist it |
| `software_type` | `string` | "dev" or "prod" |
| `hardware_type` | `string` | - |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Caller-supplied switch nodes |
| `allow_onie_recovery` | `bool` | Allow recovery in cases where NVOS is not installed |

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

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`NodeBatchResponse`](/rms/api-reference/types/rack-manager#nodebatchresponse) | response.job_id is parent job id |
| `object_id` | `string` | - |
| `image_filename` | `string` | - |
| `jobs` | repeated [`SwitchSystemImageUpdateJobInfo`](/rms/api-reference/types/rack-manager#switchsystemimageupdatejobinfo) | - |

**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>",
  "config_json": "<config_json>",
  "access_token": "<access_token>",
  "software_type": "<software_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>"
              }
            }
          }
        ]
      }
    ]
  },
  "allow_onie_recovery": false
}' \
  "$RMS_ADDR" rack_manager.RackManager/ApplySwitchSystemImage
```

</Accordion>

## ApplyStoredSwitchSystemImage

`rack_manager.RackManager/ApplyStoredSwitchSystemImage`

ApplyStoredSwitchSystemImage resolves a stored switch system image and starts updates for supplied switches.

| Property | Value |
| --- | --- |
| Execution | **Asynchronous, parent and child jobs.** The response returns a parent job ID and the work continues after the call returns. |
| Job tracking | Poll [`GetSwitchSystemImageJobStatus`](/rms/api-reference/rpcs/utility-jobs#getswitchsystemimagejobstatus) with the job ID in `response.job_id`. Per-node child job IDs are in `jobs`. |
| 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 | [`ApplyStoredSwitchSystemImage`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-apply-stored-switch-system-image) |

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

| Field | Type | Description |
| --- | --- | --- |
| `rack_id` | `string` | - |
| `object_id` | `string` | Empty means use default for hardware_type |
| `software_type` | `string` | "dev" or "prod" |
| `hardware_type` | `string` | - |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Caller-supplied switch nodes |
| `allow_onie_recovery` | `bool` | Allow recovery in cases where NVOS is not installed |

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

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`NodeBatchResponse`](/rms/api-reference/types/rack-manager#nodebatchresponse) | response.job_id is parent job id |
| `object_id` | `string` | - |
| `image_filename` | `string` | - |
| `jobs` | repeated [`SwitchSystemImageUpdateJobInfo`](/rms/api-reference/types/rack-manager#switchsystemimageupdatejobinfo) | - |

**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>",
  "object_id": "<object_id>",
  "software_type": "<software_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>"
              }
            }
          }
        ]
      }
    ]
  },
  "allow_onie_recovery": false
}' \
  "$RMS_ADDR" rack_manager.RackManager/ApplyStoredSwitchSystemImage
```

</Accordion>

## BatchResetSwitchFactoryDefault

`rack_manager.RackManager/BatchResetSwitchFactoryDefault`

BatchResetSwitchFactoryDefault submits asynchronous NVOS factory resets. All switches in the request use the same domain for NVUE mTLS material. Returns a parent job ID. Use GetJobStatus with child job states to track per-node progress. Unlike the SDN reset, this wipes NVOS configuration back to factory defaults.

A per-node job completes once the switch has rebooted after the reset and is reachable again via the default login; the factory default password is preserved, not rotated. If the supplied switch credentials do not work, RMS falls back to the factory default password to perform the reset, without assuming a switch was already reset just because the default login works. Set allow_ssh_fallback to permit reset submission over SSH when the reset cannot be submitted through NVUE. This fallback is disabled by default.

<Warning>
This operation is destructive. It wipes NVOS configuration.
</Warning>

| Property | Value |
| --- | --- |
| Execution | **Asynchronous, parent and child jobs.** The response returns a parent job ID and the work continues after the call returns. |
| Job tracking | Poll [`GetJobStatus`](/rms/api-reference/rpcs/utility-jobs#getjobstatus) with the job ID in `response.job_id`. Set `include_child_job_states` on `GetJobStatus` to read per-node child jobs. |
| 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/switch-management) |
| Protobuf reference | [`BatchResetSwitchFactoryDefault`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-batch-reset-switch-factory-default) |

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

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Target switch identities and direct connection information |
| `domain` | optional `string` | Optional domain for the target switch group; defaults to configured switch domain when unset |
| `allow_ssh_fallback` | `bool` | Allow SSH fallback when the reset cannot be submitted through NVUE; defaults to false |

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

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`NodeBatchResponse`](/rms/api-reference/types/rack-manager#nodebatchresponse) | response.job_id is the parent job ID for GetJobStatus |

**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>"
              }
            }
          }
        ]
      }
    ]
  },
  "domain": "<domain>",
  "allow_ssh_fallback": false
}' \
  "$RMS_ADDR" rack_manager.RackManager/BatchResetSwitchFactoryDefault
```

</Accordion>

## UpdateSwitchSystemPassword

`rack_manager.RackManager/UpdateSwitchSystemPassword`

UpdateSwitchSystemPassword initiates asynchronous OS-level password updates for a specific user on a caller-supplied list of switch nodes. The caller supplies both the current password and desired next password so retries can resume after a partial failure. Returns a parent job ID in response.job_id; use GetJobStatus to track progress.

<Warning>
The per-node results in the response report job admission only. Poll the jobs to learn whether each password change succeeded. The request sets only the new password for `username` and takes no current password. RMS reaches each switch with the credentials in that node's endpoint, and those credentials can belong to a different user than `username`. On a retry, RMS probes `password` to detect an earlier partial success.
</Warning>

| Property | Value |
| --- | --- |
| Execution | **Asynchronous, parent and child jobs.** The response returns a parent job ID and the work continues after the call returns. |
| Job tracking | Poll [`GetJobStatus`](/rms/api-reference/rpcs/utility-jobs#getjobstatus) with the job ID in `response.job_id`. Set `include_child_job_states` on `GetJobStatus` to read per-node child jobs. |
| 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/switch-management) |
| Protobuf reference | [`UpdateSwitchSystemPassword`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-update-switch-system-password) |

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

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Switch nodes to update |
| `username` | `string` | Target OS username whose password will be changed (mandatory) |
| `password` | `string` | New password to set for the user (mandatory) |

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

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`NodeBatchResponse`](/rms/api-reference/types/rack-manager#nodebatchresponse) | response.job_id is the parent job ID for GetJobStatus |

**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>"
              }
            }
          }
        ]
      }
    ]
  },
  "username": "<username>",
  "password": "<password>"
}' \
  "$RMS_ADDR" rack_manager.RackManager/UpdateSwitchSystemPassword
```

</Accordion>

## BatchCollectSwitchSpdmAttestationEvidence

`rack_manager.RackManager/BatchCollectSwitchSpdmAttestationEvidence`

BatchCollectSwitchSpdmAttestationEvidence synchronously generates and retrieves fresh SPDM evidence from caller-supplied switch trays.

| 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/switch-management) |
| Protobuf reference | [`BatchCollectSwitchSpdmAttestationEvidence`](/rms/api-reference/protobuf-reference/rack-manager/rack-manager/rack-manager-batch-collect-switch-spdm-attestation-evidence) |

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

| Field | Type | Description |
| --- | --- | --- |
| `targets` | repeated [`NodeInfo`](/rms/api-reference/types/rack-manager#nodeinfo) | Switch trays from which RMS collects evidence |
| `nonce` | `bytes` | Caller-generated nonce bound into every SPDM measurement |
| `domain` | optional `string` | Optional site selector; defaults to --default-switch-domain when unset |

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

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | SUCCESS only when every target and component succeeded |
| `message` | `string` | Batch collection summary |
| `results` | repeated [`SwitchSpdmAttestationTargetResult`](/rms/api-reference/types/rack-manager#switchspdmattestationtargetresult) | One entry per requested switch tray |

**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 '{
  "targets": [
    {
      "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>"
            }
          }
        }
      ]
    }
  ],
  "nonce": "",
  "domain": "<domain>"
}' \
  "$RMS_ADDR" rack_manager.RackManager/BatchCollectSwitchSpdmAttestationEvidence
```

</Accordion>