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

# RackManager types


Messages and enums in the `rack_manager` protobuf package. Proto3 has no required fields, so a field that an RPC needs says so in its description. Refer to [Conventions](/rms/api-reference/conventions#node-identity) for how nodes are described.

## Messages

### AddFirmwareObjectRequest

AddFirmwareObjectRequest adds firmware object config and authorizes RMS artifact download.

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

### AddFirmwareObjectResponse

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

### ApplyFirmwareObjectRequest

| Field | Type | Description |
| --- | --- | --- |
| `rack_id` | `string` | - |
| `config_json` | `string` | SOT JSON containing the firmware object ID and artifacts |
| `access_token` | optional `string` | Used only for artifact download; RMS does not persist it |
| `firmware_type` | `string` | "dev" or "prod" |
| `hardware_type` | `string` | - |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Caller-supplied nodes |
| `force_update` | `bool` | - |
| `component_filters` | map of `int32` to [`FirmwareObjectComponentFilter`](/rms/api-reference/types/rack-manager#firmwareobjectcomponentfilter) | Component 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_filters` | repeated [`NodeDescriptorFirmwareObjectComponentFilter`](/rms/api-reference/types/rack-manager#nodedescriptorfirmwareobjectcomponentfilter) | Component filters keyed by flexible node identity |

### ApplyFirmwareObjectResponse

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

### ApplyStoredFirmwareObjectRequest

| Field | Type | Description |
| --- | --- | --- |
| `rack_id` | `string` | - |
| `object_id` | `string` | Empty means use default for hardware_type |
| `firmware_type` | `string` | "dev" or "prod" |
| `hardware_type` | `string` | - |
| `components` | repeated `string` | Deprecated: global component filter for all node types |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Caller-supplied nodes |
| `force_update` | `bool` | - |
| `component_filters` | map of `int32` to [`FirmwareObjectComponentFilter`](/rms/api-reference/types/rack-manager#firmwareobjectcomponentfilter) | Component 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_filters` | repeated [`NodeDescriptorFirmwareObjectComponentFilter`](/rms/api-reference/types/rack-manager#nodedescriptorfirmwareobjectcomponentfilter) | Component filters keyed by flexible node identity |

### ApplyStoredFirmwareObjectResponse

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

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

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

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

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

### BatchCollectSwitchSpdmAttestationEvidenceRequest

BatchCollectSwitchSpdmAttestationEvidenceRequest challenges one or more switch trays.

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

### BatchCollectSwitchSpdmAttestationEvidenceResponse

BatchCollectSwitchSpdmAttestationEvidenceResponse contains normalized switch evidence.

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

### BatchDisableSwitchMtlsRequest

BatchDisableSwitchMtlsRequest disables mTLS for selected services on supplied switches.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Target switch identities and direct connection information |
| `services` | repeated [`SwitchService`](/rms/api-reference/types/rack-manager#switchservice) | Switch services that should stop requiring mTLS |

### BatchDisableSwitchMtlsResponse

BatchDisableSwitchMtlsResponse reports asynchronous mTLS disable job submission status.

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

### BatchGetFirmwareInventoryRequest

BatchGetFirmwareInventoryRequest retrieves firmware for unregistered nodes.

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

### BatchGetFirmwareInventoryResponse

BatchGetFirmwareInventoryResponse returns firmware grouped by requested node.

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

### BatchGetNodeDeviceInfoRequest

BatchGetNodeDeviceInfoRequest retrieves device metadata for a specified list of nodes.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Nodes to query |

### BatchGetNodeDeviceInfoResponse

BatchGetNodeDeviceInfoResponse returns device metadata for the requested nodes.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if all requested nodes succeeded, RETURN_CODE_FAILURE otherwise |
| `message` | `string` | Batch summary; includes per-node failure details when any node fails |
| `node_device_details` | repeated [`NodeDeviceInfo`](/rms/api-reference/types/rack-manager#nodedeviceinfo) | Successful device metadata details |
| `stats` | [`NodeOperationStats`](/rms/api-reference/types/rack-manager#nodeoperationstats) | Aggregate query counts |

### BatchGetPowerStateRequest

BatchGetPowerStateRequest queries power state for unregistered nodes.

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

### BatchGetPowerStateResponse

BatchGetPowerStateResponse reports per-node power state results.

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`NodeBatchResponse`](/rms/api-reference/types/rack-manager#nodebatchresponse) | - |
| `node_power_states` | repeated [`NodePowerState`](/rms/api-reference/types/rack-manager#nodepowerstate) | Power state for each successfully queried node |

### BatchGetScaleUpFabricServiceStatusRequest

BatchGetScaleUpFabricServiceStatusRequest checks cluster health and fabric manager status on caller-supplied switches.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Switch nodes to query |

### BatchGetScaleUpFabricServiceStatusResponse

BatchGetScaleUpFabricServiceStatusResponse reports per-switch results keyed by node_id.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise |
| `service_statuses` | map of `string` to [`ScaleUpFabricServiceStatusEntry`](/rms/api-reference/types/rack-manager#scaleupfabricservicestatusentry) | key = node_id |
| `stats` | [`NodeOperationStats`](/rms/api-reference/types/rack-manager#nodeoperationstats) | Aggregate query counts |

### BatchResetSwitchFactoryDefaultRequest

BatchResetSwitchFactoryDefaultRequest submits NVOS factory-default resets for caller-supplied switches.

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

### BatchResetSwitchFactoryDefaultResponse

BatchResetSwitchFactoryDefaultResponse reports asynchronous reset submission status.

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

### BatchResetSwitchSdnFactoryDefaultRequest

BatchResetSwitchSdnFactoryDefaultRequest submits SDN factory-default resets for caller-supplied switches.

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

### BatchResetSwitchSdnFactoryDefaultResponse

BatchResetSwitchSdnFactoryDefaultResponse reports asynchronous reset submission status.

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

### BatchSetPowerStateRequest

BatchSetPowerStateRequest controls power for unregistered nodes.

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

### BatchSetPowerStateResponse

BatchSetPowerStateResponse reports per-node power operation results.

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

### BatchSetScaleUpFabricStateRequest

BatchSetScaleUpFabricStateRequest performs synchronous ScaleUpFabric state update and config save across caller-supplied switches.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Switch nodes to update |
| `enabled` | `bool` | true = enabled, false/unset = disabled |

### BatchSetScaleUpFabricStateResponse

BatchSetScaleUpFabricStateResponse reports the synchronous per-switch result.

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`NodeBatchResponse`](/rms/api-reference/types/rack-manager#nodebatchresponse) | response.job_id is unused and left empty for this synchronous RPC |

### BatchUpdateFirmwareByNodeTypeRequest

BatchUpdateFirmwareByNodeTypeRequest updates firmware on all nodes of a type. Supports single target (filename + target fields) or multiple targets (firmware_targets list). If firmware_targets is non-empty, it takes precedence over the single filename/target fields.

| Field | Type | Description |
| --- | --- | --- |
| `node_type` | [`NodeType`](/rms/api-reference/types/rack-manager#nodetype) | Type of nodes to update; non-UNSPECIFIED values override node_descriptor |
| `filename` | `string` | Single firmware filename (used when firmware_targets is empty) |
| `target` | `string` | Single Redfish target URI (used when firmware_targets is empty) |
| `rack_id` | `string` | Target rack identifier |
| `firmware_targets` | repeated [`FirmwareTarget`](/rms/api-reference/types/rack-manager#firmwaretarget) | Multiple (target, filename) pairs for batch component updates |
| `activate` | `bool` | Whether to activate firmware after all targets are flashed |
| `force_update` | `bool` | Force the BMC to accept the firmware even if it's a downgrade |
| `node_descriptor` | optional [`NodeDescriptor`](/rms/api-reference/types/rack-manager#nodedescriptor) | Flexible node identity used when node_type is NODE_TYPE_UNSPECIFIED |

### BatchUpdateFirmwareByNodeTypeResponse

BatchUpdateFirmwareByNodeTypeResponse reports the created async jobs.

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

### BatchUpdateFirmwareRequest

BatchUpdateFirmwareRequest initiates firmware updates on a specified list of nodes. Firmware targets are provided per node type. The appropriate firmware targets are applied to each node based on its node type.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Nodes to update |
| `firmware_targets` | map of `int32` to [`FirmwareTargetList`](/rms/api-reference/types/rack-manager#firmwaretargetlist) | Firmware targets keyed by NodeType enum value |
| `activate` | `bool` | Whether to activate firmware after installation |
| `force_update` | `bool` | Force the BMC to accept the firmware even if it's a downgrade |
| `node_descriptor_firmware_targets` | repeated [`NodeDescriptorFirmwareTargetList`](/rms/api-reference/types/rack-manager#nodedescriptorfirmwaretargetlist) | Firmware targets keyed by flexible node identity |

### BatchUpdateFirmwareResponse

BatchUpdateFirmwareResponse reports firmware update results.

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

### CompareFirmwareObjectRequest

CompareFirmwareObjectRequest compares a proposed firmware object with caller-supplied nodes.

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

### CompareFirmwareObjectResponse

CompareFirmwareObjectResponse reports comparison and per-node query results.

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

### ComponentInventoryInfo

ComponentInventoryInfo represents inventory information for a component within a node.

| Field | Type | Description |
| --- | --- | --- |
| `component_id` | `string` | Unique identifier for the component within the node |
| `health` | `string` | Health status |
| `state` | `string` | Operational state (e.g., "Enabled", "Disabled") |
| `model` | `string` | Model name/number of the component |
| `serial_number` | `string` | Serial number of the component |
| `description` | `string` | Human-readable description of the component |
| `hardware_type` | `string` | Type of hardware (e.g., "GPU", "NIC", "Storage") |
| `type` | `int32` | Numeric component type identifier |

### ConfigureScaleUpFabricManagerRequest

ConfigureScaleUpFabricManagerRequest performs complete ScaleUpFabricManager setup on a switch. This operation enables the ScaleUpFabricManager, configures ScaleUpFabricManager access, and sets topology.

| Field | Type | Description |
| --- | --- | --- |
| `node` | [`NodeInfo`](/rms/api-reference/types/rack-manager#nodeinfo) | Target switch identity and direct connection information |
| `topology_type` | `string` | Topology to be set for ScaleUpFabric |
| `domain` | optional `string` | Optional site selector; defaults to --default-switch-domain when unset. |

### ConfigureScaleUpFabricManagerResponse

ConfigureScaleUpFabricManagerResponse reports the ScaleUpFabricManager configuration result.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if configuration completed, RETURN_CODE_FAILURE otherwise |
| `message` | `string` | Human-readable status or error message |
| `topology_used` | `string` | multi-node scaleup topology that was applied |
| `scale_up_fabric_state_enabled` | `bool` | Whether the ScaleUpFabricState State is now enabled |
| `grpc_enabled` | `bool` | Whether gRPC access is now enabled |

### ConfigureSwitchCertificateJobInfo

ConfigureSwitchCertificateJobInfo pairs a switch node ID with its async certificate configuration job ID.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Switch node identifier |
| `job_id` | `string` | Child job ID for this switch |

### ConfigureSwitchCertificateRequest

ConfigureSwitchCertificateRequest installs mTLS certificates on supplied switches.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Switch nodes to update |
| `services` | repeated [`SwitchService`](/rms/api-reference/types/rack-manager#switchservice) | Switch services to protect with the installed mTLS certificates |
| `test_hello` | `bool` | Test Hello Connection over mTLS |
| `domain` | optional `string` | Optional site selector; defaults to --default-switch-domain when unset. |

### ConfigureSwitchCertificateResponse

ConfigureSwitchCertificateResponse reports switch certificate configuration job creation results.

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`NodeBatchResponse`](/rms/api-reference/types/rack-manager#nodebatchresponse) | response.job_id is parent job id |
| `jobs` | repeated [`ConfigureSwitchCertificateJobInfo`](/rms/api-reference/types/rack-manager#configureswitchcertificatejobinfo) | Individual child job ID per switch |

### CreateNodesRequest

CreateNodesRequest registers new nodes in the inventory.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | List of nodes to add (batch operation supported) |

### CreateNodesResponse

CreateNodesResponse reports the results of adding nodes.

| Field | Type | Description |
| --- | --- | --- |
| `response` | [`OperationResponse`](/rms/api-reference/types/rack-manager#operationresponse) | - |
| `stats` | [`NodeOperationStats`](/rms/api-reference/types/rack-manager#nodeoperationstats) | Aggregate add-node counts |

### Credentials

Base credential structure supporting either username/password or session token.

| Field | Type | Description |
| --- | --- | --- |
| `user_pass` | [`UsernamePassword`](/rms/api-reference/types/rack-manager#usernamepassword) | Part of oneof `auth`. |
| `session_token` | `string` | Part of oneof `auth`. |

Set at most one of `user_pass`, `session_token` (oneof `auth`).

### DeleteFirmwareObjectRequest

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

### DeleteFirmwareObjectResponse

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

### DeleteNodeRequest

DeleteNodeRequest deletes a node from the inventory.

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

### DeleteNodeResponse

DeleteNodeResponse confirms the removal result.

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

### Endpoint

Endpoint describes one network endpoint and its credentials.

| Field | Type | Description |
| --- | --- | --- |
| `interface` | [`NetworkInterface`](/rms/api-reference/types/rack-manager#networkinterface) | Network interface used to reach this endpoint |
| `port` | `uint32` | Port number for endpoint communication (max: 65535) |
| `credentials` | [`Credentials`](/rms/api-reference/types/rack-manager#credentials) | - |

### ExecuteColdRebootRequest

ExecuteColdRebootRequest describes a full rack cold reboot over caller-supplied nodes. `nodes` lists every participating device (compute trays, switch trays, and power shelves) as full NodeInfo with direct connection information. All devices must belong to a single rack, and the set must include at least one power shelf, one compute tray, and one switch tray — a request that fails this composition check is rejected before any power action. Switch NodeInfo must carry both bmc_endpoint (for BMC reachability gating) and host_endpoint (for NVOS readiness). `domain` selects the NVL/mTLS material used to build the switch NVUE clients for the NVOS-readiness probe (steps 7-8). The optional timeout fields override the per-stage minimum-wait floor, poll maximum, and poll interval; each unset or 0 field falls back to the server default.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Participating devices: compute + power-shelf + switch trays (full NodeInfo) |
| `domain` | optional `string` | Optional NVL domain selecting switch mTLS material for the NVOS-readiness probe |
| `prestage_shutdown_floor_seconds` | optional `uint32` | Min wait after issuing the compute graceful shutdown before probing (default 0) |
| `prestage_shutdown_poll_max_seconds` | optional `uint32` | Max wait for compute to power down before the shelves are cut (default 300) |
| `discharge_floor_seconds` | optional `uint32` | Min wait after shelf power-off before probing (default 180) |
| `discharge_poll_max_seconds` | optional `uint32` | Max wait for BMCs to become unreachable (default 600) |
| `bmc_up_floor_seconds` | optional `uint32` | Min wait after shelf power-on before probing (default 120) |
| `bmc_up_poll_max_seconds` | optional `uint32` | Max wait for BMCs to become reachable (default 600) |
| `nvos_hello_backoff_seconds` | optional `uint32` | Base delay for the exponential backoff between switch nvue-hello attempts (default 30) |
| `compute_boot_wait_seconds` | optional `uint32` | Fixed wait for the compute OS to boot after power-on (default 300); the BMC cannot report OS readiness |
| `poll_interval_seconds` | optional `uint32` | Poll cadence for all stages (default 15) |

### ExecuteColdRebootResponse

ExecuteColdRebootResponse returns the coordinator job for tracking the reboot.

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

### FirmwareInventoryInfo

FirmwareInventoryInfo represents firmware information for a component.

| Field | Type | Description |
| --- | --- | --- |
| `name` | `string` | Name of the firmware component |
| `version` | `string` | Current firmware version string |
| `updateable` | `bool` | Whether firmware can be updated |
| `target` | `string` | Target URI for firmware updates |
| `health` | `string` | Health status of the firmware component |
| `firmware_type` | `int32` | Type of firmware |

### FirmwareManifestComponentComparison

FirmwareManifestComponentComparison compares one manifest component with live inventory.

| Field | Type | Description |
| --- | --- | --- |
| `component` | `string` | Component name from the proposed manifest |
| `installed_component` | `string` | Matching live inventory component, when found |
| `installed_version` | `string` | - |
| `proposed_version` | `string` | - |
| `status` | [`FirmwareComparisonStatus`](/rms/api-reference/types/rack-manager#firmwarecomparisonstatus) | - |
| `target` | `string` | Matching Redfish or logical firmware target |
| `reason` | `string` | Human-readable explanation for non-matched results |
| `sku_id` | `string` | Optional manifest SKU used to disambiguate fungible components |

### FirmwareObject

FirmwareObject is a managed firmware object catalog entry.

| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` | - |
| `config_json` | `string` | - |
| `available` | `bool` | True when RMS has downloaded all required artifacts and the object is ready to apply. |
| `created` | `google.protobuf.Timestamp` | - |
| `updated` | `google.protobuf.Timestamp` | - |
| `metadata` | [`FirmwareObjectMetadata`](/rms/api-reference/types/rack-manager#firmwareobjectmetadata) | - |
| `hardware_type` | `string` | Hardware class this object applies to. Defaults are scoped by this value. |
| `is_default` | `bool` | - |

### FirmwareObjectArtifact

FirmwareObjectArtifact describes the local artifact RMS resolved for a component.

| Field | Type | Description |
| --- | --- | --- |
| `firmware_type` | `string` | Artifact channel/profile, e.g. "dev" or "prod" |
| `filename` | `string` | Cached artifact filename |
| `target` | `string` | Firmware target RMS passes to the node update API |
| `bundle` | `string` | Source bundle/package label for this artifact |

### FirmwareObjectComponent

FirmwareObjectComponent describes one normalized component clients can request.

| Field | Type | Description |
| --- | --- | --- |
| `name` | `string` | Normalized component name accepted by firmware object apply requests |
| `version` | `string` | - |
| `bundle` | `string` | - |
| `source_component` | `string` | Raw component label from the firmware object |
| `subcomponents` | repeated [`FirmwareObjectSubcomponent`](/rms/api-reference/types/rack-manager#firmwareobjectsubcomponent) | - |
| `artifacts` | repeated [`FirmwareObjectArtifact`](/rms/api-reference/types/rack-manager#firmwareobjectartifact) | - |

### FirmwareObjectComponentFilter

FirmwareObjectComponentFilter wraps component names for one node selector.

| Field | Type | Description |
| --- | --- | --- |
| `components` | repeated `string` | Optional component filter for one node type |

### FirmwareObjectDeviceComponents

FirmwareObjectDeviceComponents groups applyable components by hardware node type.

| Field | Type | Description |
| --- | --- | --- |
| `node_type` | [`NodeType`](/rms/api-reference/types/rack-manager#nodetype) | - |
| `device_type` | `string` | SOT device type label, e.g. "Compute Node", "Switch Tray", "Power Shelf" |
| `components` | repeated [`FirmwareObjectComponent`](/rms/api-reference/types/rack-manager#firmwareobjectcomponent) | - |
| `node_descriptor` | optional [`NodeDescriptor`](/rms/api-reference/types/rack-manager#nodedescriptor) | Flexible node identity for descriptor-aware clients |

### FirmwareObjectHistoryRecord

| Field | Type | Description |
| --- | --- | --- |
| `object_id` | `string` | - |
| `rack_id` | `string` | - |
| `firmware_type` | `string` | - |
| `applied_at` | `google.protobuf.Timestamp` | - |
| `firmware_available` | `bool` | - |
| `hardware_type` | `string` | - |
| `node_ids` | repeated `string` | - |

### FirmwareObjectMetadata

FirmwareObjectMetadata describes the firmware object content RMS can apply.

| Field | Type | Description |
| --- | --- | --- |
| `device_components` | repeated [`FirmwareObjectDeviceComponents`](/rms/api-reference/types/rack-manager#firmwareobjectdevicecomponents) | - |
| `switch_system_images` | repeated [`FirmwareObjectSwitchSystemImage`](/rms/api-reference/types/rack-manager#firmwareobjectswitchsystemimage) | - |

### FirmwareObjectSubcomponent

| Field | Type | Description |
| --- | --- | --- |
| `name` | `string` | - |
| `version` | `string` | - |
| `sku_id` | `string` | - |

### FirmwareObjectSwitchSystemImage

FirmwareObjectSwitchSystemImage describes a switch system-image artifact.

| Field | Type | Description |
| --- | --- | --- |
| `software_type` | `string` | Software channel/profile, e.g. "dev" or "prod" |
| `version` | `string` | - |
| `package_name` | `string` | - |
| `image_filename` | `string` | - |
| `required` | `bool` | - |

### FirmwareTarget

FirmwareTarget pairs a firmware component target with its firmware package file.

| Field | Type | Description |
| --- | --- | --- |
| `target` | `string` | Redfish UpdateService target URI or switch component name (e.g., "bmc", "fpga") |
| `filename` | `string` | Firmware filename (relative to firmware directory or absolute path) |

### FirmwareTargetList

FirmwareTargetList wraps a list of firmware targets for use as a map value.

| Field | Type | Description |
| --- | --- | --- |
| `targets` | repeated [`FirmwareTarget`](/rms/api-reference/types/rack-manager#firmwaretarget) | - |

### GetConfigureSwitchCertificateJobStatusRequest

GetConfigureSwitchCertificateJobStatusRequest queries the status of an asynchronous switch certificate configuration job.

| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | Parent or child job ID returned from ConfigureSwitchCertificate |

### GetConfigureSwitchCertificateJobStatusResponse

GetConfigureSwitchCertificateJobStatusResponse returns the current state of a switch certificate configuration job.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found |
| `job_id` | `string` | Echoed job ID |
| `state` | `string` | queued, running, completed, or failed |
| `message` | `string` | Human-readable progress description |
| `rack_id` | `string` | Rack ID associated with this job |
| `node_id` | `string` | Node ID associated with this job; empty for parent jobs |
| `error_message` | `string` | Error details if job failed |
| `result_json` | `string` | JSON with detailed result data (populated on completion) |
| `created_at` | `google.protobuf.Timestamp` | Time when job was created |
| `updated_at` | `google.protobuf.Timestamp` | Time when job was last updated |

### GetFirmwareJobStatusRequest

GetFirmwareJobStatusRequest queries the status of an asynchronous firmware job.

| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | Job ID returned from UpdateFirmware or BatchUpdateFirmwareByNodeType |

### GetFirmwareJobStatusResponse

GetFirmwareJobStatusResponse returns the current state of a firmware job.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found |
| `job_id` | `string` | Echoed job ID |
| `job_state` | [`FirmwareJobState`](/rms/api-reference/types/rack-manager#firmwarejobstate) | Current state of the firmware job |
| `state_description` | `string` | Human-readable description of current state (e.g., "Installing firmware") |
| `rack_id` | `string` | Rack ID associated with this job |
| `node_id` | `string` | Node ID associated with this job |
| `error_code` | [`FirmwareUpdateError`](/rms/api-reference/types/rack-manager#firmwareupdateerror) | Error code if job failed |
| `error_message` | `string` | Error details if job failed |
| `result_json` | `string` | JSON with detailed result data (populated on completion) |
| `created_at` | `google.protobuf.Timestamp` | Time when job was created |
| `updated_at` | `google.protobuf.Timestamp` | Time when job was last updated |

### GetFirmwareObjectHistoryRequest

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

### GetFirmwareObjectHistoryResponse

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

### GetFirmwareObjectRequest

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

### GetFirmwareObjectResponse

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

### GetJobStatusRequest

| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | ID of the job to query |
| `include_child_job_states` | `bool` | Whether to include results of child jobs. This is disabled by default |

### GetJobStatusResponse

| Field | Type | Description |
| --- | --- | --- |
| `job_states` | repeated [`JobStatus`](/rms/api-reference/types/rack-manager#jobstatus) | States of all jobs queried If a parent job is queried, it will be the first in the result list |

### GetNodeDeviceInfoRequest

GetNodeDeviceInfoRequest retrieves normalized device metadata for a specific node.

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

### GetNodeDeviceInfoResponse

GetNodeDeviceInfoResponse returns normalized device metadata for a specific node.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise |
| `message` | `string` | Human-readable status or error message |
| `device_info` | [`NodeDeviceInfo`](/rms/api-reference/types/rack-manager#nodedeviceinfo) | Normalized device metadata for the node |

### GetNodeFirmwareInventoryRequest

GetNodeFirmwareInventoryRequest retrieves firmware info for a specific node.

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

### GetNodeFirmwareInventoryResponse

GetNodeFirmwareInventoryResponse returns firmware component information.

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

### GetPowerStateRequest

GetPowerStateRequest queries the current power state of a node.

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

### GetPowerStateResponse

GetPowerStateResponse returns the current power state of a node.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if query completed, RETURN_CODE_FAILURE otherwise |
| `node_id` | `string` | Node identifier (echoed from request) |
| `pstate` | `string` | Current power state: "ON", "OFF", or "UNKNOWN" |
| `rack_id` | `string` | Rack identifier (echoed from request) |

### GetRackFirmwareInventoryRequest

GetRackFirmwareInventoryRequest retrieves firmware for all nodes in a rack.

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

### GetRackFirmwareInventoryResponse

GetRackFirmwareInventoryResponse returns firmware info for all nodes.

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

### GetScaleUpFabricStateRequest

GetScaleUpFabricStateRequest retrieves the ScaleUpFabric state for a single switch.

| Field | Type | Description |
| --- | --- | --- |
| `node` | [`NodeInfo`](/rms/api-reference/types/rack-manager#nodeinfo) | Target switch identity and direct connection information |

### GetScaleUpFabricStateResponse

GetScaleUpFabricStateResponse returns the ScaleUpFabric state.

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

### GetScaleUpFabricStatusRequest

GetScaleUpFabricStatusRequest inspects the supplied switches and returns their observed scale-up fabric configuration, including every static config entry reported by the fabric manager, without modifying anything.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | All switches that form the scale-up fabric. |
| `domain` | optional `string` | Optional site selector used for switch server verification (TLS). Defaults to --default-switch-domain when unset. |

### GetScaleUpFabricStatusResponse

GetScaleUpFabricStatusResponse returns the observed scale-up fabric status.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if inspected, RETURN_CODE_FAILURE otherwise |
| `fabric_status` | [`ScaleUpFabricStatus`](/rms/api-reference/types/rack-manager#scaleupfabricstatus) | Observed configuration; unset when status is RETURN_CODE_FAILURE |
| `error_message` | `string` | Error details if inspection failed |

### GetSwitchSystemImageJobStatusRequest

GetSwitchSystemImageJobStatusRequest queries the status of an asynchronous switch system image job.

| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | Parent or child job ID returned from UpdateSwitchSystemImage |

### GetSwitchSystemImageJobStatusResponse

GetSwitchSystemImageJobStatusResponse returns the current state of a switch system image job.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found |
| `job_id` | `string` | Echoed job ID |
| `state` | `string` | queued, running, completed, or failed |
| `message` | `string` | Human-readable progress description |
| `rack_id` | `string` | Rack ID associated with this job |
| `node_id` | `string` | Node ID associated with this job; empty for parent jobs |
| `error_message` | `string` | Error details if job failed |
| `result_json` | `string` | JSON with detailed result data (populated on completion) |
| `created_at` | `google.protobuf.Timestamp` | Time when job was created |
| `updated_at` | `google.protobuf.Timestamp` | Time when job was last updated |

### GetVersionRequest

GetVersionRequest retrieves server version information.

This message has no fields.

### GetVersionResponse

GetVersionResponse reports server version information.

| Field | Type | Description |
| --- | --- | --- |
| `version` | `string` | - |

### InspectScaleUpFabricsRequest

Live inspection uses caller-supplied inventory, without desired settings or job history.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | [`NodeSet`](/rms/api-reference/types/rack-manager#nodeset) | Include the switches to inspect and, optionally, compute trays to identify in the results. At least one switch is required. Node IDs must be nonempty and unique. RMS uses NodeInfo.type when set to a value other than NODE_TYPE_UNSPECIFIED. Otherwise, RMS uses node_descriptor to identify the node's role. Unknown or unsupported node roles are rejected. Each switch needs host_endpoint and credentials. Each compute entry represents one tray and needs bmc_endpoint and credentials to read chassis and tray positions. RMS reads compute BMCs for discovery; it does not configure compute hosts. Without compute entries, RMS cannot match observed computes to caller node IDs. Unresolved nodes are reported as collection errors rather than silently omitted. |
| `domain` | optional `string` | Selects the CA and RMS client credentials for all switches in this request. If omitted, RMS uses --default-switch-domain. TLS server-name verification uses each endpoint's identity or the configured DNS override, not this value. |

### InspectScaleUpFabricsResponse

Live samples collected over an interval, not an atomic rack snapshot.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | SUCCESS means collection completed without read or interpretation errors. An ABNORMAL fabric status alone does not cause FAILURE. |
| `fabrics` | repeated [`ScaleUpFabricInspectionObservation`](/rms/api-reference/types/rack-manager#scaleupfabricinspectionobservation) | One observation per enabled controller, in switch inventory order. The list is empty when no controllers are enabled; that is not an error. Successful observations are retained when another read fails. |
| `discovery_errors` | repeated [`ScaleUpFabricInspectionError`](/rms/api-reference/types/rack-manager#scaleupfabricinspectionerror) | Discovery failures that cannot be associated with a fabric. Fabric-specific errors appear only in that fabric's inspection_errors. |
| `error_message` | `string` | Summary of collection or interpretation failures; empty on SUCCESS. |

### JobStatus

The detailed status of a Job

| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | ID of the job |
| `parent_job_id` | optional `string` | ID of the parent job if applicable |
| `child_job_ids` | repeated `string` | The list of child jobs |
| `execution_state` | [`JobExecutionState`](/rms/api-reference/types/rack-manager#jobexecutionstate) | Current execution status of the job |
| `error_message` | `string` | Human-readable message This message is guaranteed to be set if the job failed. If the job succeeded, the results will be stored in result_json. |
| `error_code` | [`JobError`](/rms/api-reference/types/rack-manager#joberror) | Error code if job failed. |
| `result_json` | `string` | JSON with detailed result data (populated on completion) The schema of the JSON depends on the workflow that initiated the response |
| `state_description` | `string` | Human-readable description of current state (e.g., "Installing firmware") |
| `rack_id` | optional `string` | Rack ID associated with this job Empty if the job is not directly associated with a single rack |
| `node_id` | optional `string` | Node ID associated with this job Empty if the job is not directly associated with a single node |
| `created_at` | `google.protobuf.Timestamp` | Time when job was created |
| `updated_at` | `google.protobuf.Timestamp` | Time when job was last updated |

### ListFirmwareObjectsRequest

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

### ListFirmwareObjectsResponse

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

### ListNodeDeviceInfoByNodeTypeRequest

ListNodeDeviceInfoByNodeTypeRequest retrieves device metadata for all nodes of a type in a rack.

| Field | Type | Description |
| --- | --- | --- |
| `rack_id` | `string` | Target rack identifier |
| `node_type` | [`NodeType`](/rms/api-reference/types/rack-manager#nodetype) | Type of nodes to query; non-UNSPECIFIED values override node_descriptor |
| `node_descriptor` | optional [`NodeDescriptor`](/rms/api-reference/types/rack-manager#nodedescriptor) | Flexible node identity used when node_type is NODE_TYPE_UNSPECIFIED |

### ListNodeDeviceInfoByNodeTypeResponse

ListNodeDeviceInfoByNodeTypeResponse returns device metadata for all matching nodes in a rack.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise |
| `message` | `string` | Human-readable status or error message |
| `node_device_details` | repeated [`NodeDeviceInfo`](/rms/api-reference/types/rack-manager#nodedeviceinfo) | Device metadata details grouped by node |
| `stats` | [`NodeOperationStats`](/rms/api-reference/types/rack-manager#nodeoperationstats) | Aggregate query counts |

### ListNodeInventoryRequest

ListNodeInventoryRequest retrieves the complete system inventory.

This message has no fields.

### ListNodeInventoryResponse

ListNodeInventoryResponse returns all nodes and their components.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | repeated [`NodeInventoryInfo`](/rms/api-reference/types/rack-manager#nodeinventoryinfo) | Complete list of nodes across all racks |

### ListRacksRequest

ListRacksRequest retrieves all rack identifiers.

This message has no fields.

### ListRacksResponse

ListRacksResponse returns all rack identifiers in the system.

| Field | Type | Description |
| --- | --- | --- |
| `rack_ids` | repeated `string` | List of all rack identifiers |

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

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

### ListSwitchSystemImagesRequest

ListSwitchSystemImagesRequest retrieves available OS images on a switch.

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

### ListSwitchSystemImagesResponse

ListSwitchSystemImagesResponse returns available OS images.

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

### NetworkInterface

A network interface with paired IP and MAC address.

| Field | Type | Description |
| --- | --- | --- |
| `ip_address` | `string` | IPv4 or IPv6 textual address |
| `mac_address` | `string` | Text MAC address |
| `host_name` | optional `string` | Host name is required for TLS connection |

### NodeBatchResponse

NodeBatchResponse reports the common result shape for multi-node RPCs.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS only if all targeted nodes completed |
| `message` | `string` | Human-readable summary message |
| `node_results` | repeated [`NodeOperationResult`](/rms/api-reference/types/rack-manager#nodeoperationresult) | Individual results for each node |
| `job_id` | `string` | Parent job ID for async batch operations |
| `stats` | [`NodeOperationStats`](/rms/api-reference/types/rack-manager#nodeoperationstats) | Aggregate node counts |

### NodeDescriptor

NodeDescriptor carries flexible hardware identity attributes for RMS dispatch.

| Field | Type | Description |
| --- | --- | --- |
| `attributes` | map of `string` to `string` | RMS dispatch currently accepts role, vendor, and product_family |

### NodeDescriptorFirmwareObjectComponentFilter

NodeDescriptorFirmwareObjectComponentFilter pairs a flexible node identity with a component filter.

| Field | Type | Description |
| --- | --- | --- |
| `node_descriptor` | [`NodeDescriptor`](/rms/api-reference/types/rack-manager#nodedescriptor) | - |
| `component_filter` | [`FirmwareObjectComponentFilter`](/rms/api-reference/types/rack-manager#firmwareobjectcomponentfilter) | - |

### NodeDescriptorFirmwareTargetList

NodeDescriptorFirmwareTargetList pairs a flexible node identity with firmware targets.

| Field | Type | Description |
| --- | --- | --- |
| `node_descriptor` | [`NodeDescriptor`](/rms/api-reference/types/rack-manager#nodedescriptor) | - |
| `firmware_targets` | [`FirmwareTargetList`](/rms/api-reference/types/rack-manager#firmwaretargetlist) | - |

### NodeDeviceInfo

NodeDeviceInfo represents normalized device metadata for a node.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Unique identifier for the node |
| `chassis_sn` | optional `int64` | Optional chassis serial number when available |
| `slot_number` | optional `uint32` | Optional physical slot number in the rack topology |
| `tray_index` | optional `uint32` | Optional tray index when available |

### NodeFirmwareInventory

NodeFirmwareInventory groups firmware information for a specific node.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Node identifier |
| `firmware_list` | repeated [`FirmwareInventoryInfo`](/rms/api-reference/types/rack-manager#firmwareinventoryinfo) | List of firmware components on the node |

### NodeFirmwareJobInfo

NodeFirmwareJobInfo pairs a node ID with its async firmware job ID.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Node identifier |
| `job_id` | `string` | Firmware job ID returned for this node |

### NodeFirmwareManifestComparison

NodeFirmwareManifestComparison contains the comparison result for one node.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | - |
| `matches_manifest` | `bool` | True only when every selected component is verified and matches |
| `components` | repeated [`FirmwareManifestComponentComparison`](/rms/api-reference/types/rack-manager#firmwaremanifestcomponentcomparison) | - |

### NodeInfo

NodeInfo contains all information needed to describe a node.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Unique identifier for the node within the rack |
| `rack_id` | `string` | Identifier of the rack containing this node |
| `type` | optional [`NodeType`](/rms/api-reference/types/rack-manager#nodetype) | Hardware-specific node type; non-UNSPECIFIED values override node_descriptor |
| `bmc_endpoint` | optional [`Endpoint`](/rms/api-reference/types/rack-manager#endpoint) | BMC connection info and credentials |
| `host_endpoint` | optional [`Endpoint`](/rms/api-reference/types/rack-manager#endpoint) | Host connection info and credentials |
| `node_descriptor` | optional [`NodeDescriptor`](/rms/api-reference/types/rack-manager#nodedescriptor) | Flexible node identity used when type is missing or NODE_TYPE_UNSPECIFIED |
| `additional_host_endpoints` | repeated [`Endpoint`](/rms/api-reference/types/rack-manager#endpoint) | Supplemental host-side endpoints. Each RPC defines whether it consumes this field and, if so, the allowed cardinality and semantics. |

### NodeInventoryInfo

NodeInventoryInfo represents complete inventory information for a node.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Unique identifier for the node |
| `product` | `string` | Product name/model of the node |
| `health` | `string` | Health status |
| `ip_address` | `string` | IP address of the node's BMC |
| `port` | `uint32` | Port number for BMC communication |
| `type` | [`NodeType`](/rms/api-reference/types/rack-manager#nodetype) | Hardware-specific node type |
| `components` | repeated [`ComponentInventoryInfo`](/rms/api-reference/types/rack-manager#componentinventoryinfo) | List of components within the node |
| `mac_address` | `string` | MAC address of the node's BMC interface |
| `rack_id` | `string` | Identifier of the rack containing this node |
| `host_mac_addresses` | repeated `string` | Vector of MAC addresses of the node's Host interfaces |
| `host_ip_addresses` | repeated `string` | Vector of IP addresses of the node's Host interfaces |
| `node_descriptor` | optional [`NodeDescriptor`](/rms/api-reference/types/rack-manager#nodedescriptor) | Flexible node identity returned for descriptor-aware clients |

### NodeOperationResult

NodeOperationResult reports the outcome of an operation on a specific node.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Node that was targeted |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if this node completed, RETURN_CODE_FAILURE otherwise |
| `error_message` | `string` | Human-readable error message for failures |

### NodeOperationStats

NodeOperationStats reports aggregate node counts for batch-like RPCs.

| Field | Type | Description |
| --- | --- | --- |
| `total_nodes` | `uint32` | Total number of nodes targeted |
| `successful_nodes` | `uint32` | Number of nodes successfully processed |
| `failed_nodes` | `uint32` | Number of nodes that failed |

### NodePowerState

NodePowerState pairs a node identifier with its current power state.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Node identifier (echoed from request) |
| `pstate` | `string` | Current power state: "ON", "OFF", or "UNKNOWN" |

### NodeSet

NodeSet represents a collection of nodes, reusable wherever a node list is needed.

| Field | Type | Description |
| --- | --- | --- |
| `nodes` | repeated [`NodeInfo`](/rms/api-reference/types/rack-manager#nodeinfo) | List of nodes in the topology |

### NodeUpdateInfo

NodeUpdateInfo contains fields that can be updated for an existing node. Only specified fields will be updated; unset fields remain unchanged.

| Field | Type | Description |
| --- | --- | --- |
| `bmc_endpoint` | optional [`Endpoint`](/rms/api-reference/types/rack-manager#endpoint) | New BMC connection info and credentials |
| `host_endpoint` | optional [`Endpoint`](/rms/api-reference/types/rack-manager#endpoint) | New host connection info and credentials |

### OperationResponse

OperationResponse reports the common result shape for simple RPCs.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if operation completed, RETURN_CODE_FAILURE otherwise |
| `message` | `string` | Human-readable status or error message |

### PushSwitchFirmwareRequest

PushSwitchFirmware request/response

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

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

### ScaleUpFabricComponentStatus

Independently sampled NMX-C indicators for one observed fabric. ABNORMAL takes precedence over UNKNOWN, then NORMAL. Empty evidence is UNKNOWN. Individual raw device and port states are not included.

| Field | Type | Description |
| --- | --- | --- |
| `controller` | [`ScaleUpFabricReportedStatus`](/rms/api-reference/types/rack-manager#scaleupfabricreportedstatus) | Controller indicator from GetDomainStateInfo, independent of configuration state. |
| `compute` | [`ScaleUpFabricReportedStatus`](/rms/api-reference/types/rack-manager#scaleupfabricreportedstatus) | GPU and compute-node indicators from GetTopologyInfo and GetComputeNodeInfoList; these describe fabric participation, not host operating-system status. |
| `switches` | [`ScaleUpFabricReportedStatus`](/rms/api-reference/types/rack-manager#scaleupfabricreportedstatus) | Device and switch-node indicators from GetTopologyInfo and GetSwitchNodeInfoList. |
| `links` | [`ScaleUpFabricReportedStatus`](/rms/api-reference/types/rack-manager#scaleupfabricreportedstatus) | Operational port indicators from GetTopologyInfo. Administratively down ports and ports outside the scale-up data path do not contribute. |

### ScaleUpFabricInspectionError

Collection or interpretation failure, separate from observed component status.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Affected caller node ID; empty for a fabric-wide or request-wide error. |
| `message` | `string` | Credential-free description identifying the failed operation or ambiguous evidence. |

### ScaleUpFabricInspectionObservation

Observed node associations and component status sampled from one controller. These associations do not confirm that a requested layout was achieved; compare the observed node IDs with the configuration response's selected_fabrics.

| Field | Type | Description |
| --- | --- | --- |
| `switch_node_ids` | repeated `string` | Caller node IDs resolved from live topology and discovered physical identities. Lists are sorted and deduplicated; inspection_errors explain unresolved associations. |
| `compute_node_ids` | repeated `string` | - |
| `primary_switch_node_id` | `string` | Switch whose enabled controller was inspected. |
| `status` | [`ScaleUpFabricReportedStatus`](/rms/api-reference/types/rack-manager#scaleupfabricreportedstatus) | NORMAL requires a configured control plane, NORMAL components, and complete, unambiguous collection. A failed control plane or ABNORMAL component yields ABNORMAL; incomplete evidence otherwise yields UNKNOWN. No communication or bandwidth test is performed. |
| `control_plane_state` | [`ScaleUpFabricControlPlaneState`](/rms/api-reference/types/rack-manager#scaleupfabriccontrolplanestate) | - |
| `component_status` | [`ScaleUpFabricComponentStatus`](/rms/api-reference/types/rack-manager#scaleupfabriccomponentstatus) | Independent sampled component indicators. |
| `inspection_errors` | repeated [`ScaleUpFabricInspectionError`](/rms/api-reference/types/rack-manager#scaleupfabricinspectionerror) | Failed reads and interpretation errors, not successfully observed ABNORMAL states. |

### ScaleUpFabricServiceStatusEntry

ScaleUpFabricServiceStatusEntry stores per-switch status keyed by node_id.

| Field | Type | Description |
| --- | --- | --- |
| `status_json` | `string` | JSON object containing application status |
| `error_message` | `string` | Error details if query failed |

### ScaleUpFabricStaticConfig

ScaleUpFabricStaticConfig is a single fabric manager static configuration entry, identified by the config file it lives in and the key within that file. It is shared by requests and status, so value is the desired value in a rack_manager_v2.ScaleUpFabricConfig and the observed value in a ScaleUpFabricStatus.

| Field | Type | Description |
| --- | --- | --- |
| `config_file_name` | `string` | Static config file that holds the key |
| `key` | `string` | Config key within the file |
| `value` | `string` | Value for the key |

### ScaleUpFabricStatus

ScaleUpFabricStatus reports the observed scale-up fabric configuration as read back from the switches. It is returned directly by GetScaleUpFabricStatus and is also stored, JSON-encoded, in JobStatus.result_json when a no-layout rack_manager_v2.RackManagerV2. ConfigureScaleUpFabricManager job succeeds. Callers can compare desired and observed configurations to detect drift.

| Field | Type | Description |
| --- | --- | --- |
| `topology_type` | `string` | Topology type currently configured for the scale-up fabric. |
| `extra_static_configs` | repeated [`ScaleUpFabricStaticConfig`](/rms/api-reference/types/rack-manager#scaleupfabricstaticconfig) | All observed static configuration entries except the topology entry represented by topology_type above. |
| `switches` | repeated [`ScaleUpFabricSwitchStatus`](/rms/api-reference/types/rack-manager#scaleupfabricswitchstatus) | Per-switch observed state across the fabric: which switch runs the fabric manager (the primary), each switch's enabled/disabled state, and fabric manager status. Lets a caller see membership and whether any switch is out of sync. |

### ScaleUpFabricSwitchStatus

ScaleUpFabricSwitchStatus is the observed state of a single switch in the fabric.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Switch node identifier |
| `enabled` | `bool` | Whether the scale-up fabric cluster is enabled on this switch |
| `fabric_manager_status` | `string` | Raw fabric manager app status reported by the switch; empty when unavailable |
| `error_message` | `string` | Set when this switch could not be inspected |

### SetDefaultFirmwareObjectRequest

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

### SetDefaultFirmwareObjectResponse

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

### SetPowerStateRequest

SetPowerStateRequest controls the power state of a single node.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Target node identifier |
| `operation` | [`PowerOperation`](/rms/api-reference/types/rack-manager#poweroperation) | Power operation to perform |
| `rack_id` | `string` | Rack containing the target node |

### SetPowerStateResponse

SetPowerStateResponse confirms the power operation result.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if power operation completed, RETURN_CODE_FAILURE otherwise |

### SetScaleUpFabricTelemetryInterfaceStateRequest

SetScaleUpFabricTelemetryInterfaceStateRequest enables or disables the FabricTelemetryInterface.

| Field | Type | Description |
| --- | --- | --- |
| `node` | [`NodeInfo`](/rms/api-reference/types/rack-manager#nodeinfo) | Target switch identity and direct connection information |
| `enable` | `bool` | true to enable ScaleUpFabricTelemetryInterface, false to disable |

### SetScaleUpFabricTelemetryInterfaceStateResponse

SetScaleUpFabricTelemetryInterfaceStateResponse reports the FabricTelemetryInterface status.

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

### SwitchSpdmAttestationTargetResult

SwitchSpdmAttestationTargetResult reports evidence collection for one switch tray.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Switch tray node identifier |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | SUCCESS only when every discovered component succeeded |
| `error_message` | optional `string` | Target-level discovery or initialization error; unset when status is SUCCESS |
| `components` | repeated [`SwitchSpdmComponentResult`](/rms/api-reference/types/rack-manager#switchspdmcomponentresult) | Per-component status and evidence |
| `collection_timestamp` | `google.protobuf.Timestamp` | When RMS finished collecting (or failed to collect) this target's evidence |

### SwitchSpdmComponentEvidence

SwitchSpdmComponentEvidence contains the opaque evidence for one SPDM component.

| Field | Type | Description |
| --- | --- | --- |
| `measurements` | `bytes` | Opaque signed-measurement value |
| `certificate_chain` | `bytes` | Opaque certificate-chain value |

### SwitchSpdmComponentResult

SwitchSpdmComponentResult reports collection status for one discovered component.

| Field | Type | Description |
| --- | --- | --- |
| `component_id` | `string` | SPDM component identifier |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | Collection status for this component |
| `error_message` | `string` | Collection error when status is FAILURE |
| `evidence` | [`SwitchSpdmComponentEvidence`](/rms/api-reference/types/rack-manager#switchspdmcomponentevidence) | Present only when collection succeeded |

### SwitchSystemImageUpdateJobInfo

SwitchSystemImageUpdateJobInfo pairs a switch node ID with its async system image job ID.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Switch node identifier |
| `job_id` | `string` | Switch system image job ID |

### UpdateFirmwareRequest

UpdateFirmwareRequest initiates a firmware update on a node. Supports single target (filename + target fields) or multiple targets (firmware_targets list). If firmware_targets is non-empty, it takes precedence over the single filename/target fields.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Target node identifier |
| `filename` | `string` | Single firmware filename (used when firmware_targets is empty) |
| `target` | `string` | Single Redfish target URI (used when firmware_targets is empty) |
| `activate` | `bool` | Whether to immediately activate the firmware after installation |
| `rack_id` | `string` | Rack containing the target node |
| `firmware_targets` | repeated [`FirmwareTarget`](/rms/api-reference/types/rack-manager#firmwaretarget) | Multiple (target, filename) pairs for batch component updates |
| `force_update` | `bool` | Force the BMC to accept the firmware even if it's a downgrade |

### UpdateFirmwareResponse

UpdateFirmwareResponse reports the firmware update result.

| Field | Type | Description |
| --- | --- | --- |
| `status` | [`ReturnCode`](/rms/api-reference/types/rack-manager#returncode) | RETURN_CODE_SUCCESS if update completed, RETURN_CODE_FAILURE otherwise |
| `message` | `string` | Human-readable status or error message |
| `error_code` | [`FirmwareUpdateError`](/rms/api-reference/types/rack-manager#firmwareupdateerror) | Detailed error code for troubleshooting |
| `job_id` | `string` | Job ID for async operations (use with GetFirmwareJobStatus to track progress) |

### UpdateNodeRequest

UpdateNodeRequest modifies an existing node's configuration.

| Field | Type | Description |
| --- | --- | --- |
| `node_id` | `string` | Target node identifier |
| `update_info` | [`NodeUpdateInfo`](/rms/api-reference/types/rack-manager#nodeupdateinfo) | Fields to update (only set fields are changed) |
| `rack_id` | `string` | Rack containing the target node |

### UpdateNodeResponse

UpdateNodeResponse confirms the update result.

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

### UpdateSwitchSystemImageRequest

UpdateSwitchSystemImageRequest initiates switch system image updates on a specified list of switches.

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

### UpdateSwitchSystemImageResponse

UpdateSwitchSystemImageResponse reports switch system image update job creation results.

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

### UpdateSwitchSystemPasswordRequest

UpdateSwitchSystemPasswordRequest starts an OS-level password update for a user on a set of switch nodes.

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

### UpdateSwitchSystemPasswordResponse

UpdateSwitchSystemPasswordResponse reports switch password update job creation results.

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

### UsernamePassword

Username and password pair.

| Field | Type | Description |
| --- | --- | --- |
| `username` | `string` | - |
| `password` | `string` | - |

## Enums

### FirmwareComparisonStatus

FirmwareComparisonStatus describes one installed-to-proposed version comparison.

| Value | Number | Description |
| --- | --- | --- |
| `FIRMWARE_COMPARISON_STATUS_UNSPECIFIED` | 0 | - |
| `FIRMWARE_COMPARISON_STATUS_MATCHED` | 1 | - |
| `FIRMWARE_COMPARISON_STATUS_MISMATCHED` | 2 | - |
| `FIRMWARE_COMPARISON_STATUS_MISSING` | 3 | - |
| `FIRMWARE_COMPARISON_STATUS_UNVERIFIED` | 4 | - |

### FirmwareJobState

FirmwareJobState represents the lifecycle state of an asynchronous firmware job. Deprecated: Use the equivalent and binary compatible JobState definition

| Value | Number | Description |
| --- | --- | --- |
| `FIRMWARE_JOB_STATE_UNSPECIFIED` | 0 | Server left the job state unset or at the proto3 default |
| `FIRMWARE_JOB_STATE_QUEUED` | 1 | Job has been created and is waiting to start |
| `FIRMWARE_JOB_STATE_RUNNING` | 2 | Job is actively executing |
| `FIRMWARE_JOB_STATE_COMPLETED` | 3 | Job finished successfully |
| `FIRMWARE_JOB_STATE_FAILED` | 4 | Job finished with an error |

### FirmwareUpdateError

FirmwareUpdateError provides detailed error codes for firmware update operations.

| Value | Number | Description |
| --- | --- | --- |
| `FIRMWARE_UPDATE_ERROR_UNSPECIFIED` | 0 | Server left the error code unset or at the proto3 default |
| `FIRMWARE_UPDATE_ERROR_SUCCESS` | 1 | Firmware update completed successfully |
| `FIRMWARE_UPDATE_ERROR_FILE_NOT_FOUND` | 2 | Specified firmware file does not exist |
| `FIRMWARE_UPDATE_ERROR_CLIENT_FAILURE` | 3 | HTTP/Redfish client communication failure |
| `FIRMWARE_UPDATE_ERROR_TARGET_NOT_FOUND` | 4 | Target component for update not found on node |
| `FIRMWARE_UPDATE_ERROR_SERVER_ERROR` | 5 | Server returned an error response |
| `FIRMWARE_UPDATE_ERROR_TASK_FAILED` | 6 | Firmware update task reported failure |
| `FIRMWARE_UPDATE_ERROR_NO_TASK_INFO` | 7 | Unable to retrieve task status information |
| `FIRMWARE_UPDATE_ERROR_EXCEPTION` | 8 | Exception occurred during update process |
| `FIRMWARE_UPDATE_ERROR_INVALID_RESPONSE` | 9 | Received invalid or malformed response |
| `FIRMWARE_UPDATE_ERROR_MONITORING_TIMEOUT` | 10 | Timed out waiting for update to complete |
| `FIRMWARE_UPDATE_ERROR_TASK_EXCEPTION` | 11 | Exception in task monitoring |
| `FIRMWARE_UPDATE_ERROR_UNKNOWN` | 12 | Unknown or unclassified error |
| `FIRMWARE_UPDATE_ERROR_UPDATE_IN_PROGRESS` | 13 | The node already has an active firmware update. |

### JobError

JobError provides detailed error codes for asynchronous operations.

| Value | Number | Description |
| --- | --- | --- |
| `JOB_ERROR_UNSPECIFIED` | 0 | Server left the error code unset or at the proto3 default |
| `JOB_ERROR_INTERNAL` | 1 | Operation failed due to a RMS internal issue |
| `JOB_ERROR_OTHER` | 2 | Operation failed due to a non-specified reason |
| `JOB_ERROR_INVALID_ARGUMENT` | 3 | Arguments that have been provided during job start are not valid |
| `JOB_ERROR_CLIENT_ERROR` | 11 | HTTP/Redfish client side communication error |
| `JOB_ERROR_SERVER_ERROR` | 12 | Server returned an error response |
| `JOB_ERROR_TIMEOUT` | 13 | Timed out waiting for an operation to complete |
| `JOB_ERROR_INVALID_RESPONSE` | 14 | Received invalid or malformed response |
| `JOB_ERROR_UNAUTHENTICATED` | 15 | Provided credentials could not authenticate |
| `JOB_ERROR_TARGET_NOT_FOUND` | 21 | Target component for update not found on node |
| `JOB_ERROR_FILE_NOT_FOUND` | 22 | Specified firmware file does not exist |
| `JOB_ERROR_UPDATE_IN_PROGRESS` | 23 | The node already has an active firmware update. |

### JobExecutionState

JobExecutionState represents the lifecycle state of an asynchronous job

| Value | Number | Description |
| --- | --- | --- |
| `JOB_EXECUTION_STATE_UNSPECIFIED` | 0 | Server left the job state unset or at the proto3 default |
| `JOB_EXECUTION_STATE_QUEUED` | 1 | Job has been created and is waiting to start |
| `JOB_EXECUTION_STATE_RUNNING` | 2 | Job is actively executing |
| `JOB_EXECUTION_STATE_COMPLETED` | 3 | Job finished successfully |
| `JOB_EXECUTION_STATE_FAILED` | 4 | Job finished with an error |

### NodeType

NodeType identifies the hardware-specific node implementation in the rack.

| Value | Number | Description |
| --- | --- | --- |
| `NODE_TYPE_UNSPECIFIED` | 0 | Caller left the node type missing or at the proto3 default |
| `COMPUTE_GB200_NVIDIA` | 1 | NVIDIA GB200 compute node |
| `POWERSHELF_GB200_LITEON` | 2 | LiteOn GB200 power shelf |
| `SWITCH_GB200_NVIDIA` | 3 | NVIDIA GB200 network switch |
| `POWERSHELF_GB200_DELTA` | 4 | Delta GB200 power shelf |
| `COMPUTE_GB300_NVIDIA` | 5 | NVIDIA GB300 compute node |
| `SWITCH_GB300_NVIDIA` | 6 | NVIDIA GB300 network switch |
| `POWERSHELF_GB300_LITEON` | 7 | LiteOn GB300 power shelf |
| `POWERSHELF_GB300_DELTA` | 8 | Delta GB300 power shelf |
| `COMPUTE_GB300_LENOVO` | 9 | Lenovo GB300 compute node |
| `COMPUTE_VRNVL72_NVIDIA` | 10 | NVIDIA VR NVL72 compute tray |
| `SWITCH_VRNVL72_NVIDIA` | 11 | NVIDIA VR NVL72 network switch |

### PowerOperation

PowerOperation defines the power control actions for individual nodes.

| Value | Number | Description |
| --- | --- | --- |
| `POWER_OPERATION_UNSPECIFIED` | 0 | Caller left the operation missing or at the proto3 default |
| `POWER_OPERATION_OFF` | 1 | Power off the node using its default off semantics |
| `POWER_OPERATION_ON` | 2 | Power on the node |
| `POWER_OPERATION_RESET` | 3 | Power cycle the node |
| `POWER_OPERATION_FORCE_OFF` | 4 | Redfish ResetType ForceOff |
| `POWER_OPERATION_FORCE_ON` | 5 | Redfish ResetType ForceOn |
| `POWER_OPERATION_GRACEFUL_SHUTDOWN` | 6 | Redfish ResetType GracefulShutdown |
| `POWER_OPERATION_GRACEFUL_RESTART` | 7 | Redfish ResetType GracefulRestart |
| `POWER_OPERATION_FORCE_RESTART` | 8 | Redfish ResetType ForceRestart |

### ReturnCode

ReturnCode indicates the overall success or failure of an RPC operation.

| Value | Number | Description |
| --- | --- | --- |
| `RETURN_CODE_UNSPECIFIED` | 0 | Server left the status unset or at the proto3 default |
| `RETURN_CODE_SUCCESS` | 1 | Operation completed successfully |
| `RETURN_CODE_FAILURE` | 2 | Operation failed (see message field for details) |

### ScaleUpFabricControlPlaneState

Configuration state reported by NMX-C, not compared with caller intent.

| Value | Number | Description |
| --- | --- | --- |
| `SCALE_UP_FABRIC_CONTROL_PLANE_STATE_UNKNOWN` | 0 | No configured or failed state was established. |
| `SCALE_UP_FABRIC_CONTROL_PLANE_STATE_CONFIGURED` | 1 | NMX-C reports CONFIGURED, not a match to requested settings. |
| `SCALE_UP_FABRIC_CONTROL_PLANE_STATE_FAILED` | 2 | NMX-C reports a control-plane timeout or error. |

### ScaleUpFabricReportedStatus

Summary of sampled indicators, not a guarantee of end-to-end communication.

| Value | Number | Description |
| --- | --- | --- |
| `SCALE_UP_FABRIC_REPORTED_STATUS_UNKNOWN` | 0 | Observations are absent or inconclusive. |
| `SCALE_UP_FABRIC_REPORTED_STATUS_NORMAL` | 1 | All applicable sampled indicators are normal. |
| `SCALE_UP_FABRIC_REPORTED_STATUS_ABNORMAL` | 2 | At least one sampled indicator reports an abnormal state. |

### SwitchFirmwareComponentType

SwitchFirmwareComponentType identifies the firmware component type on a switch.

| Value | Number | Description |
| --- | --- | --- |
| `SWITCH_FIRMWARE_COMPONENT_TYPE_UNSPECIFIED` | 0 | Caller left the component type missing or at the proto3 default |
| `SWITCH_FIRMWARE_COMPONENT_TYPE_UNKNOWN` | 1 | Unknown component type |
| `SWITCH_FIRMWARE_COMPONENT_TYPE_BMC` | 2 | Baseboard Management Controller |
| `SWITCH_FIRMWARE_COMPONENT_TYPE_FPGA` | 3 | Field Programmable Gate Array |
| `SWITCH_FIRMWARE_COMPONENT_TYPE_EROT` | 4 | Embedded Root of Trust |
| `SWITCH_FIRMWARE_COMPONENT_TYPE_CPLD` | 5 | Complex Programmable Logic Device |
| `SWITCH_FIRMWARE_COMPONENT_TYPE_BIOS` | 6 | Basic Input/Output System |
| `SWITCH_FIRMWARE_COMPONENT_TYPE_TRANSCEIVER` | 7 | Optical transceiver |

### SwitchService

SwitchService identifies a switch service whose mTLS state should be managed.

| Value | Number | Description |
| --- | --- | --- |
| `SWITCH_SERVICE_UNSPECIFIED` | 0 | Caller left the service missing or at the proto3 default |
| `SWITCH_SERVICE_NVUE_API` | 1 | NVUE REST API service |
| `SWITCH_SERVICE_SCALE_UP_FABRIC_TELEMETRY` | 2 | Scale-up fabric telemetry service |
| `SWITCH_SERVICE_SCALE_UP_FABRIC_MANAGER` | 3 | Scale-up fabric manager service |
| `SWITCH_SERVICE_SCALE_UP_FABRIC_TELEMETRY_INTERFACE` | 4 | Scale-up fabric telemetry interface service |