Skip to navigation

RackManager types

View as MarkdownOpen in Claude

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 for how nodes are described.

Messages

AddFirmwareObjectRequest

AddFirmwareObjectRequest adds firmware object config and authorizes RMS artifact download.

FieldTypeDescription
config_jsonstring-
access_tokenoptional stringUsed only for immediate/background artifact download; RMS does not persist this token.
hardware_typestring-
set_defaultboolIf true, mark this object as default for hardware_type after add.

AddFirmwareObjectResponse

FieldTypeDescription
objectFirmwareObject-

ApplyFirmwareObjectRequest

FieldTypeDescription
rack_idstring-
config_jsonstringSOT JSON containing the firmware object ID and artifacts
access_tokenoptional stringUsed only for artifact download; RMS does not persist it
firmware_typestring”dev” or “prod”
hardware_typestring-
nodesNodeSetCaller-supplied nodes
force_updatebool-
component_filtersmap of int32 to FirmwareObjectComponentFilterComponent 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_filtersrepeated NodeDescriptorFirmwareObjectComponentFilterComponent filters keyed by flexible node identity

ApplyFirmwareObjectResponse

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is parent job id
object_idstring-
jobsrepeated NodeFirmwareJobInfo-

ApplyStoredFirmwareObjectRequest

FieldTypeDescription
rack_idstring-
object_idstringEmpty means use default for hardware_type
firmware_typestring”dev” or “prod”
hardware_typestring-
componentsrepeated stringDeprecated: global component filter for all node types
nodesNodeSetCaller-supplied nodes
force_updatebool-
component_filtersmap of int32 to FirmwareObjectComponentFilterComponent 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_filtersrepeated NodeDescriptorFirmwareObjectComponentFilterComponent filters keyed by flexible node identity

ApplyStoredFirmwareObjectResponse

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is parent job id
object_idstring-
jobsrepeated NodeFirmwareJobInfo-

ApplyStoredSwitchSystemImageRequest

FieldTypeDescription
rack_idstring-
object_idstringEmpty means use default for hardware_type
software_typestring”dev” or “prod”
hardware_typestring-
nodesNodeSetCaller-supplied switch nodes
allow_onie_recoveryboolAllow recovery in cases where NVOS is not installed

ApplyStoredSwitchSystemImageResponse

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is parent job id
object_idstring-
image_filenamestring-
jobsrepeated SwitchSystemImageUpdateJobInfo-

ApplySwitchSystemImageRequest

FieldTypeDescription
rack_idstring-
config_jsonstringSOT JSON containing the firmware object ID and switch image
access_tokenoptional stringUsed only for artifact download; RMS does not persist it
software_typestring”dev” or “prod”
hardware_typestring-
nodesNodeSetCaller-supplied switch nodes
allow_onie_recoveryboolAllow recovery in cases where NVOS is not installed

ApplySwitchSystemImageResponse

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is parent job id
object_idstring-
image_filenamestring-
jobsrepeated SwitchSystemImageUpdateJobInfo-

BatchCollectSwitchSpdmAttestationEvidenceRequest

BatchCollectSwitchSpdmAttestationEvidenceRequest challenges one or more switch trays.

FieldTypeDescription
targetsrepeated NodeInfoSwitch trays from which RMS collects evidence
noncebytesCaller-generated nonce bound into every SPDM measurement
domainoptional stringOptional site selector; defaults to —default-switch-domain when unset

BatchCollectSwitchSpdmAttestationEvidenceResponse

BatchCollectSwitchSpdmAttestationEvidenceResponse contains normalized switch evidence.

FieldTypeDescription
statusReturnCodeSUCCESS only when every target and component succeeded
messagestringBatch collection summary
resultsrepeated SwitchSpdmAttestationTargetResultOne entry per requested switch tray

BatchDisableSwitchMtlsRequest

BatchDisableSwitchMtlsRequest disables mTLS for selected services on supplied switches.

FieldTypeDescription
nodesNodeSetTarget switch identities and direct connection information
servicesrepeated SwitchServiceSwitch services that should stop requiring mTLS

BatchDisableSwitchMtlsResponse

BatchDisableSwitchMtlsResponse reports asynchronous mTLS disable job submission status.

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is the parent job ID for GetJobStatus

BatchGetFirmwareInventoryRequest

BatchGetFirmwareInventoryRequest retrieves firmware for unregistered nodes.

FieldTypeDescription
nodesNodeSetCaller-supplied node connection details

BatchGetFirmwareInventoryResponse

BatchGetFirmwareInventoryResponse returns firmware grouped by requested node.

FieldTypeDescription
responseNodeBatchResponse-
nodesrepeated NodeFirmwareInventoryInventory for each successfully queried node

BatchGetNodeDeviceInfoRequest

BatchGetNodeDeviceInfoRequest retrieves device metadata for a specified list of nodes.

FieldTypeDescription
nodesNodeSetNodes to query

BatchGetNodeDeviceInfoResponse

BatchGetNodeDeviceInfoResponse returns device metadata for the requested nodes.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if all requested nodes succeeded, RETURN_CODE_FAILURE otherwise
messagestringBatch summary; includes per-node failure details when any node fails
node_device_detailsrepeated NodeDeviceInfoSuccessful device metadata details
statsNodeOperationStatsAggregate query counts

BatchGetPowerStateRequest

BatchGetPowerStateRequest queries power state for unregistered nodes.

FieldTypeDescription
nodesNodeSetCaller-supplied node connection details

BatchGetPowerStateResponse

BatchGetPowerStateResponse reports per-node power state results.

FieldTypeDescription
responseNodeBatchResponse-
node_power_statesrepeated NodePowerStatePower state for each successfully queried node

BatchGetScaleUpFabricServiceStatusRequest

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

FieldTypeDescription
nodesNodeSetSwitch nodes to query

BatchGetScaleUpFabricServiceStatusResponse

BatchGetScaleUpFabricServiceStatusResponse reports per-switch results keyed by node_id.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise
service_statusesmap of string to ScaleUpFabricServiceStatusEntrykey = node_id
statsNodeOperationStatsAggregate query counts

BatchResetSwitchFactoryDefaultRequest

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

FieldTypeDescription
nodesNodeSetTarget switch identities and direct connection information
domainoptional stringOptional domain for the target switch group; defaults to configured switch domain when unset
allow_ssh_fallbackboolAllow SSH fallback when the reset cannot be submitted through NVUE; defaults to false

BatchResetSwitchFactoryDefaultResponse

BatchResetSwitchFactoryDefaultResponse reports asynchronous reset submission status.

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is the parent job ID for GetJobStatus

BatchResetSwitchSdnFactoryDefaultRequest

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

FieldTypeDescription
nodesNodeSetTarget switch identities and direct connection information
domainoptional stringOptional domain for the target switch group; defaults to configured switch domain when unset

BatchResetSwitchSdnFactoryDefaultResponse

BatchResetSwitchSdnFactoryDefaultResponse reports asynchronous reset submission status.

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is the parent job ID for GetJobStatus

BatchSetPowerStateRequest

BatchSetPowerStateRequest controls power for unregistered nodes.

FieldTypeDescription
nodesNodeSetCaller-supplied node connection details
operationPowerOperationPower operation to perform

BatchSetPowerStateResponse

BatchSetPowerStateResponse reports per-node power operation results.

FieldTypeDescription
responseNodeBatchResponse-

BatchSetScaleUpFabricStateRequest

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

FieldTypeDescription
nodesNodeSetSwitch nodes to update
enabledbooltrue = enabled, false/unset = disabled

BatchSetScaleUpFabricStateResponse

BatchSetScaleUpFabricStateResponse reports the synchronous per-switch result.

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

FieldTypeDescription
node_typeNodeTypeType of nodes to update; non-UNSPECIFIED values override node_descriptor
filenamestringSingle firmware filename (used when firmware_targets is empty)
targetstringSingle Redfish target URI (used when firmware_targets is empty)
rack_idstringTarget rack identifier
firmware_targetsrepeated FirmwareTargetMultiple (target, filename) pairs for batch component updates
activateboolWhether to activate firmware after all targets are flashed
force_updateboolForce the BMC to accept the firmware even if it’s a downgrade
node_descriptoroptional NodeDescriptorFlexible node identity used when node_type is NODE_TYPE_UNSPECIFIED

BatchUpdateFirmwareByNodeTypeResponse

BatchUpdateFirmwareByNodeTypeResponse reports the created async jobs.

FieldTypeDescription
responseNodeBatchResponse-
jobsrepeated NodeFirmwareJobInfoIndividual 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.

FieldTypeDescription
nodesNodeSetNodes to update
firmware_targetsmap of int32 to FirmwareTargetListFirmware targets keyed by NodeType enum value
activateboolWhether to activate firmware after installation
force_updateboolForce the BMC to accept the firmware even if it’s a downgrade
node_descriptor_firmware_targetsrepeated NodeDescriptorFirmwareTargetListFirmware targets keyed by flexible node identity

BatchUpdateFirmwareResponse

BatchUpdateFirmwareResponse reports firmware update results.

FieldTypeDescription
responseNodeBatchResponse-
jobsrepeated NodeFirmwareJobInfoIndividual job ID per node

CompareFirmwareObjectRequest

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

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

CompareFirmwareObjectResponse

CompareFirmwareObjectResponse reports comparison and per-node query results.

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

ComponentInventoryInfo

ComponentInventoryInfo represents inventory information for a component within a node.

FieldTypeDescription
component_idstringUnique identifier for the component within the node
healthstringHealth status
statestringOperational state (e.g., “Enabled”, “Disabled”)
modelstringModel name/number of the component
serial_numberstringSerial number of the component
descriptionstringHuman-readable description of the component
hardware_typestringType of hardware (e.g., “GPU”, “NIC”, “Storage”)
typeint32Numeric component type identifier

ConfigureScaleUpFabricManagerRequest

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

FieldTypeDescription
nodeNodeInfoTarget switch identity and direct connection information
topology_typestringTopology to be set for ScaleUpFabric
domainoptional stringOptional site selector; defaults to —default-switch-domain when unset.

ConfigureScaleUpFabricManagerResponse

ConfigureScaleUpFabricManagerResponse reports the ScaleUpFabricManager configuration result.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if configuration completed, RETURN_CODE_FAILURE otherwise
messagestringHuman-readable status or error message
topology_usedstringmulti-node scaleup topology that was applied
scale_up_fabric_state_enabledboolWhether the ScaleUpFabricState State is now enabled
grpc_enabledboolWhether gRPC access is now enabled

ConfigureSwitchCertificateJobInfo

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

FieldTypeDescription
node_idstringSwitch node identifier
job_idstringChild job ID for this switch

ConfigureSwitchCertificateRequest

ConfigureSwitchCertificateRequest installs mTLS certificates on supplied switches.

FieldTypeDescription
nodesNodeSetSwitch nodes to update
servicesrepeated SwitchServiceSwitch services to protect with the installed mTLS certificates
test_helloboolTest Hello Connection over mTLS
domainoptional stringOptional site selector; defaults to —default-switch-domain when unset.

ConfigureSwitchCertificateResponse

ConfigureSwitchCertificateResponse reports switch certificate configuration job creation results.

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is parent job id
jobsrepeated ConfigureSwitchCertificateJobInfoIndividual child job ID per switch

CreateNodesRequest

CreateNodesRequest registers new nodes in the inventory.

FieldTypeDescription
nodesNodeSetList of nodes to add (batch operation supported)

CreateNodesResponse

CreateNodesResponse reports the results of adding nodes.

FieldTypeDescription
responseOperationResponse-
statsNodeOperationStatsAggregate add-node counts

Credentials

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

FieldTypeDescription
user_passUsernamePasswordPart of oneof auth.
session_tokenstringPart of oneof auth.

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

DeleteFirmwareObjectRequest

FieldTypeDescription
idstring-

DeleteFirmwareObjectResponse

FieldTypeDescription
responseOperationResponse-

DeleteNodeRequest

DeleteNodeRequest deletes a node from the inventory.

FieldTypeDescription
node_idstringTarget node identifier to remove
rack_idstringRack containing the target node

DeleteNodeResponse

DeleteNodeResponse confirms the removal result.

FieldTypeDescription
responseOperationResponse-

Endpoint

Endpoint describes one network endpoint and its credentials.

FieldTypeDescription
interfaceNetworkInterfaceNetwork interface used to reach this endpoint
portuint32Port number for endpoint communication (max: 65535)
credentialsCredentials-

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.

FieldTypeDescription
nodesNodeSetParticipating devices: compute + power-shelf + switch trays (full NodeInfo)
domainoptional stringOptional NVL domain selecting switch mTLS material for the NVOS-readiness probe
prestage_shutdown_floor_secondsoptional uint32Min wait after issuing the compute graceful shutdown before probing (default 0)
prestage_shutdown_poll_max_secondsoptional uint32Max wait for compute to power down before the shelves are cut (default 300)
discharge_floor_secondsoptional uint32Min wait after shelf power-off before probing (default 180)
discharge_poll_max_secondsoptional uint32Max wait for BMCs to become unreachable (default 600)
bmc_up_floor_secondsoptional uint32Min wait after shelf power-on before probing (default 120)
bmc_up_poll_max_secondsoptional uint32Max wait for BMCs to become reachable (default 600)
nvos_hello_backoff_secondsoptional uint32Base delay for the exponential backoff between switch nvue-hello attempts (default 30)
compute_boot_wait_secondsoptional uint32Fixed wait for the compute OS to boot after power-on (default 300); the BMC cannot report OS readiness
poll_interval_secondsoptional uint32Poll cadence for all stages (default 15)

ExecuteColdRebootResponse

ExecuteColdRebootResponse returns the coordinator job for tracking the reboot.

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is the coordinator job ID for GetJobStatus

FirmwareInventoryInfo

FirmwareInventoryInfo represents firmware information for a component.

FieldTypeDescription
namestringName of the firmware component
versionstringCurrent firmware version string
updateableboolWhether firmware can be updated
targetstringTarget URI for firmware updates
healthstringHealth status of the firmware component
firmware_typeint32Type of firmware

FirmwareManifestComponentComparison

FirmwareManifestComponentComparison compares one manifest component with live inventory.

FieldTypeDescription
componentstringComponent name from the proposed manifest
installed_componentstringMatching live inventory component, when found
installed_versionstring-
proposed_versionstring-
statusFirmwareComparisonStatus-
targetstringMatching Redfish or logical firmware target
reasonstringHuman-readable explanation for non-matched results
sku_idstringOptional manifest SKU used to disambiguate fungible components

FirmwareObject

FirmwareObject is a managed firmware object catalog entry.

FieldTypeDescription
idstring-
config_jsonstring-
availableboolTrue when RMS has downloaded all required artifacts and the object is ready to apply.
createdgoogle.protobuf.Timestamp-
updatedgoogle.protobuf.Timestamp-
metadataFirmwareObjectMetadata-
hardware_typestringHardware class this object applies to. Defaults are scoped by this value.
is_defaultbool-

FirmwareObjectArtifact

FirmwareObjectArtifact describes the local artifact RMS resolved for a component.

FieldTypeDescription
firmware_typestringArtifact channel/profile, e.g. “dev” or “prod”
filenamestringCached artifact filename
targetstringFirmware target RMS passes to the node update API
bundlestringSource bundle/package label for this artifact

FirmwareObjectComponent

FirmwareObjectComponent describes one normalized component clients can request.

FieldTypeDescription
namestringNormalized component name accepted by firmware object apply requests
versionstring-
bundlestring-
source_componentstringRaw component label from the firmware object
subcomponentsrepeated FirmwareObjectSubcomponent-
artifactsrepeated FirmwareObjectArtifact-

FirmwareObjectComponentFilter

FirmwareObjectComponentFilter wraps component names for one node selector.

FieldTypeDescription
componentsrepeated stringOptional component filter for one node type

FirmwareObjectDeviceComponents

FirmwareObjectDeviceComponents groups applyable components by hardware node type.

FieldTypeDescription
node_typeNodeType-
device_typestringSOT device type label, e.g. “Compute Node”, “Switch Tray”, “Power Shelf”
componentsrepeated FirmwareObjectComponent-
node_descriptoroptional NodeDescriptorFlexible node identity for descriptor-aware clients

FirmwareObjectHistoryRecord

FieldTypeDescription
object_idstring-
rack_idstring-
firmware_typestring-
applied_atgoogle.protobuf.Timestamp-
firmware_availablebool-
hardware_typestring-
node_idsrepeated string-

FirmwareObjectMetadata

FirmwareObjectMetadata describes the firmware object content RMS can apply.

FieldTypeDescription
device_componentsrepeated FirmwareObjectDeviceComponents-
switch_system_imagesrepeated FirmwareObjectSwitchSystemImage-

FirmwareObjectSubcomponent

FieldTypeDescription
namestring-
versionstring-
sku_idstring-

FirmwareObjectSwitchSystemImage

FirmwareObjectSwitchSystemImage describes a switch system-image artifact.

FieldTypeDescription
software_typestringSoftware channel/profile, e.g. “dev” or “prod”
versionstring-
package_namestring-
image_filenamestring-
requiredbool-

FirmwareTarget

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

FieldTypeDescription
targetstringRedfish UpdateService target URI or switch component name (e.g., “bmc”, “fpga”)
filenamestringFirmware filename (relative to firmware directory or absolute path)

FirmwareTargetList

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

FieldTypeDescription
targetsrepeated FirmwareTarget-

GetConfigureSwitchCertificateJobStatusRequest

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

FieldTypeDescription
job_idstringParent or child job ID returned from ConfigureSwitchCertificate

GetConfigureSwitchCertificateJobStatusResponse

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

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found
job_idstringEchoed job ID
statestringqueued, running, completed, or failed
messagestringHuman-readable progress description
rack_idstringRack ID associated with this job
node_idstringNode ID associated with this job; empty for parent jobs
error_messagestringError details if job failed
result_jsonstringJSON with detailed result data (populated on completion)
created_atgoogle.protobuf.TimestampTime when job was created
updated_atgoogle.protobuf.TimestampTime when job was last updated

GetFirmwareJobStatusRequest

GetFirmwareJobStatusRequest queries the status of an asynchronous firmware job.

FieldTypeDescription
job_idstringJob ID returned from UpdateFirmware or BatchUpdateFirmwareByNodeType

GetFirmwareJobStatusResponse

GetFirmwareJobStatusResponse returns the current state of a firmware job.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found
job_idstringEchoed job ID
job_stateFirmwareJobStateCurrent state of the firmware job
state_descriptionstringHuman-readable description of current state (e.g., “Installing firmware”)
rack_idstringRack ID associated with this job
node_idstringNode ID associated with this job
error_codeFirmwareUpdateErrorError code if job failed
error_messagestringError details if job failed
result_jsonstringJSON with detailed result data (populated on completion)
created_atgoogle.protobuf.TimestampTime when job was created
updated_atgoogle.protobuf.TimestampTime when job was last updated

GetFirmwareObjectHistoryRequest

FieldTypeDescription
object_idstringEmpty means no object filter
rack_idsrepeated stringEmpty means all racks

GetFirmwareObjectHistoryResponse

FieldTypeDescription
recordsrepeated FirmwareObjectHistoryRecord-

GetFirmwareObjectRequest

FieldTypeDescription
idstring-

GetFirmwareObjectResponse

FieldTypeDescription
objectFirmwareObject-

GetJobStatusRequest

FieldTypeDescription
job_idstringID of the job to query
include_child_job_statesboolWhether to include results of child jobs. This is disabled by default

GetJobStatusResponse

FieldTypeDescription
job_statesrepeated JobStatusStates 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.

FieldTypeDescription
rack_idstringRack containing the target node
node_idstringTarget node identifier

GetNodeDeviceInfoResponse

GetNodeDeviceInfoResponse returns normalized device metadata for a specific node.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise
messagestringHuman-readable status or error message
device_infoNodeDeviceInfoNormalized device metadata for the node

GetNodeFirmwareInventoryRequest

GetNodeFirmwareInventoryRequest retrieves firmware info for a specific node.

FieldTypeDescription
node_idstringTarget node identifier
rack_idstringRack containing the target node

GetNodeFirmwareInventoryResponse

GetNodeFirmwareInventoryResponse returns firmware component information.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise
firmware_listrepeated FirmwareInventoryInfoList of firmware components on the node

GetPowerStateRequest

GetPowerStateRequest queries the current power state of a node.

FieldTypeDescription
node_idstringTarget node identifier
rack_idstringRack containing the target node

GetPowerStateResponse

GetPowerStateResponse returns the current power state of a node.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if query completed, RETURN_CODE_FAILURE otherwise
node_idstringNode identifier (echoed from request)
pstatestringCurrent power state: “ON”, “OFF”, or “UNKNOWN”
rack_idstringRack identifier (echoed from request)

GetRackFirmwareInventoryRequest

GetRackFirmwareInventoryRequest retrieves firmware for all nodes in a rack.

FieldTypeDescription
rack_idstringTarget rack identifier

GetRackFirmwareInventoryResponse

GetRackFirmwareInventoryResponse returns firmware info for all nodes.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise
nodesrepeated NodeFirmwareInventoryFirmware inventory grouped by node

GetScaleUpFabricStateRequest

GetScaleUpFabricStateRequest retrieves the ScaleUpFabric state for a single switch.

FieldTypeDescription
nodeNodeInfoTarget switch identity and direct connection information

GetScaleUpFabricStateResponse

GetScaleUpFabricStateResponse returns the ScaleUpFabric state.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise
state_jsonstringJSON object containing ScaleUpFabric state information
error_messagestringError 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.

FieldTypeDescription
nodesNodeSetAll switches that form the scale-up fabric.
domainoptional stringOptional site selector used for switch server verification (TLS). Defaults to —default-switch-domain when unset.

GetScaleUpFabricStatusResponse

GetScaleUpFabricStatusResponse returns the observed scale-up fabric status.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if inspected, RETURN_CODE_FAILURE otherwise
fabric_statusScaleUpFabricStatusObserved configuration; unset when status is RETURN_CODE_FAILURE
error_messagestringError details if inspection failed

GetSwitchSystemImageJobStatusRequest

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

FieldTypeDescription
job_idstringParent or child job ID returned from UpdateSwitchSystemImage

GetSwitchSystemImageJobStatusResponse

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

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if job found, RETURN_CODE_FAILURE if job_id not found
job_idstringEchoed job ID
statestringqueued, running, completed, or failed
messagestringHuman-readable progress description
rack_idstringRack ID associated with this job
node_idstringNode ID associated with this job; empty for parent jobs
error_messagestringError details if job failed
result_jsonstringJSON with detailed result data (populated on completion)
created_atgoogle.protobuf.TimestampTime when job was created
updated_atgoogle.protobuf.TimestampTime when job was last updated

GetVersionRequest

GetVersionRequest retrieves server version information.

This message has no fields.

GetVersionResponse

GetVersionResponse reports server version information.

FieldTypeDescription
versionstring-

InspectScaleUpFabricsRequest

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

FieldTypeDescription
nodesNodeSetInclude 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.
domainoptional stringSelects 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.

FieldTypeDescription
statusReturnCodeSUCCESS means collection completed without read or interpretation errors. An ABNORMAL fabric status alone does not cause FAILURE.
fabricsrepeated ScaleUpFabricInspectionObservationOne 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_errorsrepeated ScaleUpFabricInspectionErrorDiscovery failures that cannot be associated with a fabric. Fabric-specific errors appear only in that fabric’s inspection_errors.
error_messagestringSummary of collection or interpretation failures; empty on SUCCESS.

JobStatus

The detailed status of a Job

FieldTypeDescription
job_idstringID of the job
parent_job_idoptional stringID of the parent job if applicable
child_job_idsrepeated stringThe list of child jobs
execution_stateJobExecutionStateCurrent execution status of the job
error_messagestringHuman-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_codeJobErrorError code if job failed.
result_jsonstringJSON with detailed result data (populated on completion) The schema of the JSON depends on the workflow that initiated the response
state_descriptionstringHuman-readable description of current state (e.g., “Installing firmware”)
rack_idoptional stringRack ID associated with this job Empty if the job is not directly associated with a single rack
node_idoptional stringNode ID associated with this job Empty if the job is not directly associated with a single node
created_atgoogle.protobuf.TimestampTime when job was created
updated_atgoogle.protobuf.TimestampTime when job was last updated

ListFirmwareObjectsRequest

FieldTypeDescription
only_availablebool-
hardware_typestring-

ListFirmwareObjectsResponse

FieldTypeDescription
objectsrepeated FirmwareObject-

ListNodeDeviceInfoByNodeTypeRequest

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

FieldTypeDescription
rack_idstringTarget rack identifier
node_typeNodeTypeType of nodes to query; non-UNSPECIFIED values override node_descriptor
node_descriptoroptional NodeDescriptorFlexible node identity used when node_type is NODE_TYPE_UNSPECIFIED

ListNodeDeviceInfoByNodeTypeResponse

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

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise
messagestringHuman-readable status or error message
node_device_detailsrepeated NodeDeviceInfoDevice metadata details grouped by node
statsNodeOperationStatsAggregate query counts

ListNodeInventoryRequest

ListNodeInventoryRequest retrieves the complete system inventory.

This message has no fields.

ListNodeInventoryResponse

ListNodeInventoryResponse returns all nodes and their components.

FieldTypeDescription
nodesrepeated NodeInventoryInfoComplete 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.

FieldTypeDescription
rack_idsrepeated stringList of all rack identifiers

ListSwitchFirmwareRequest

FieldTypeDescription
rack_idstringRack ID for inventory lookup
node_idstringNode ID for inventory lookup
component_typeSwitchFirmwareComponentTypeRequired: Firmware component type enum

ListSwitchFirmwareResponse

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise
result_jsonstringJSON object containing firmware inventory result
error_messagestringError details if retrieval failed

ListSwitchSystemImagesRequest

ListSwitchSystemImagesRequest retrieves available OS images on a switch.

FieldTypeDescription
rack_idstringRack containing the target switch
node_idstringTarget switch node identifier

ListSwitchSystemImagesResponse

ListSwitchSystemImagesResponse returns available OS images.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if retrieved, RETURN_CODE_FAILURE otherwise
images_jsonstringJSON array containing image information
error_messagestringError details if query failed

NetworkInterface

A network interface with paired IP and MAC address.

FieldTypeDescription
ip_addressstringIPv4 or IPv6 textual address
mac_addressstringText MAC address
host_nameoptional stringHost name is required for TLS connection

NodeBatchResponse

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

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS only if all targeted nodes completed
messagestringHuman-readable summary message
node_resultsrepeated NodeOperationResultIndividual results for each node
job_idstringParent job ID for async batch operations
statsNodeOperationStatsAggregate node counts

NodeDescriptor

NodeDescriptor carries flexible hardware identity attributes for RMS dispatch.

FieldTypeDescription
attributesmap of string to stringRMS dispatch currently accepts role, vendor, and product_family

NodeDescriptorFirmwareObjectComponentFilter

NodeDescriptorFirmwareObjectComponentFilter pairs a flexible node identity with a component filter.

FieldTypeDescription
node_descriptorNodeDescriptor-
component_filterFirmwareObjectComponentFilter-

NodeDescriptorFirmwareTargetList

NodeDescriptorFirmwareTargetList pairs a flexible node identity with firmware targets.

FieldTypeDescription
node_descriptorNodeDescriptor-
firmware_targetsFirmwareTargetList-

NodeDeviceInfo

NodeDeviceInfo represents normalized device metadata for a node.

FieldTypeDescription
node_idstringUnique identifier for the node
chassis_snoptional int64Optional chassis serial number when available
slot_numberoptional uint32Optional physical slot number in the rack topology
tray_indexoptional uint32Optional tray index when available

NodeFirmwareInventory

NodeFirmwareInventory groups firmware information for a specific node.

FieldTypeDescription
node_idstringNode identifier
firmware_listrepeated FirmwareInventoryInfoList of firmware components on the node

NodeFirmwareJobInfo

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

FieldTypeDescription
node_idstringNode identifier
job_idstringFirmware job ID returned for this node

NodeFirmwareManifestComparison

NodeFirmwareManifestComparison contains the comparison result for one node.

FieldTypeDescription
node_idstring-
matches_manifestboolTrue only when every selected component is verified and matches
componentsrepeated FirmwareManifestComponentComparison-

NodeInfo

NodeInfo contains all information needed to describe a node.

FieldTypeDescription
node_idstringUnique identifier for the node within the rack
rack_idstringIdentifier of the rack containing this node
typeoptional NodeTypeHardware-specific node type; non-UNSPECIFIED values override node_descriptor
bmc_endpointoptional EndpointBMC connection info and credentials
host_endpointoptional EndpointHost connection info and credentials
node_descriptoroptional NodeDescriptorFlexible node identity used when type is missing or NODE_TYPE_UNSPECIFIED
additional_host_endpointsrepeated EndpointSupplemental 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.

FieldTypeDescription
node_idstringUnique identifier for the node
productstringProduct name/model of the node
healthstringHealth status
ip_addressstringIP address of the node’s BMC
portuint32Port number for BMC communication
typeNodeTypeHardware-specific node type
componentsrepeated ComponentInventoryInfoList of components within the node
mac_addressstringMAC address of the node’s BMC interface
rack_idstringIdentifier of the rack containing this node
host_mac_addressesrepeated stringVector of MAC addresses of the node’s Host interfaces
host_ip_addressesrepeated stringVector of IP addresses of the node’s Host interfaces
node_descriptoroptional NodeDescriptorFlexible node identity returned for descriptor-aware clients

NodeOperationResult

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

FieldTypeDescription
node_idstringNode that was targeted
statusReturnCodeRETURN_CODE_SUCCESS if this node completed, RETURN_CODE_FAILURE otherwise
error_messagestringHuman-readable error message for failures

NodeOperationStats

NodeOperationStats reports aggregate node counts for batch-like RPCs.

FieldTypeDescription
total_nodesuint32Total number of nodes targeted
successful_nodesuint32Number of nodes successfully processed
failed_nodesuint32Number of nodes that failed

NodePowerState

NodePowerState pairs a node identifier with its current power state.

FieldTypeDescription
node_idstringNode identifier (echoed from request)
pstatestringCurrent power state: “ON”, “OFF”, or “UNKNOWN”

NodeSet

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

FieldTypeDescription
nodesrepeated NodeInfoList 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.

FieldTypeDescription
bmc_endpointoptional EndpointNew BMC connection info and credentials
host_endpointoptional EndpointNew host connection info and credentials

OperationResponse

OperationResponse reports the common result shape for simple RPCs.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if operation completed, RETURN_CODE_FAILURE otherwise
messagestringHuman-readable status or error message

PushSwitchFirmwareRequest

PushSwitchFirmware request/response

FieldTypeDescription
rack_idstringRequired: Rack ID for inventory lookup
node_idstringRequired: Node ID for inventory lookup
component_typeSwitchFirmwareComponentTypeRequired: Firmware component type enum
filenamestringRequired: Desired filename on the switch (used as-is, no suffix modification)
local_file_pathstringRequired: Local file path on rackmanager host (file must be at least 1KB)

PushSwitchFirmwareResponse

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if pushed, RETURN_CODE_FAILURE otherwise
result_jsonstringJSON object containing push result
error_messagestringError 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.

FieldTypeDescription
controllerScaleUpFabricReportedStatusController indicator from GetDomainStateInfo, independent of configuration state.
computeScaleUpFabricReportedStatusGPU and compute-node indicators from GetTopologyInfo and GetComputeNodeInfoList; these describe fabric participation, not host operating-system status.
switchesScaleUpFabricReportedStatusDevice and switch-node indicators from GetTopologyInfo and GetSwitchNodeInfoList.
linksScaleUpFabricReportedStatusOperational 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.

FieldTypeDescription
node_idstringAffected caller node ID; empty for a fabric-wide or request-wide error.
messagestringCredential-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.

FieldTypeDescription
switch_node_idsrepeated stringCaller node IDs resolved from live topology and discovered physical identities. Lists are sorted and deduplicated; inspection_errors explain unresolved associations.
compute_node_idsrepeated string-
primary_switch_node_idstringSwitch whose enabled controller was inspected.
statusScaleUpFabricReportedStatusNORMAL 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_stateScaleUpFabricControlPlaneState-
component_statusScaleUpFabricComponentStatusIndependent sampled component indicators.
inspection_errorsrepeated ScaleUpFabricInspectionErrorFailed reads and interpretation errors, not successfully observed ABNORMAL states.

ScaleUpFabricServiceStatusEntry

ScaleUpFabricServiceStatusEntry stores per-switch status keyed by node_id.

FieldTypeDescription
status_jsonstringJSON object containing application status
error_messagestringError 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.

FieldTypeDescription
config_file_namestringStatic config file that holds the key
keystringConfig key within the file
valuestringValue 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.

FieldTypeDescription
topology_typestringTopology type currently configured for the scale-up fabric.
extra_static_configsrepeated ScaleUpFabricStaticConfigAll observed static configuration entries except the topology entry represented by topology_type above.
switchesrepeated ScaleUpFabricSwitchStatusPer-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.

FieldTypeDescription
node_idstringSwitch node identifier
enabledboolWhether the scale-up fabric cluster is enabled on this switch
fabric_manager_statusstringRaw fabric manager app status reported by the switch; empty when unavailable
error_messagestringSet when this switch could not be inspected

SetDefaultFirmwareObjectRequest

FieldTypeDescription
object_idstringDefault scope is determined by the hardware_type stored on this object.

SetDefaultFirmwareObjectResponse

FieldTypeDescription
objectFirmwareObject-

SetPowerStateRequest

SetPowerStateRequest controls the power state of a single node.

FieldTypeDescription
node_idstringTarget node identifier
operationPowerOperationPower operation to perform
rack_idstringRack containing the target node

SetPowerStateResponse

SetPowerStateResponse confirms the power operation result.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if power operation completed, RETURN_CODE_FAILURE otherwise

SetScaleUpFabricTelemetryInterfaceStateRequest

SetScaleUpFabricTelemetryInterfaceStateRequest enables or disables the FabricTelemetryInterface.

FieldTypeDescription
nodeNodeInfoTarget switch identity and direct connection information
enablebooltrue to enable ScaleUpFabricTelemetryInterface, false to disable

SetScaleUpFabricTelemetryInterfaceStateResponse

SetScaleUpFabricTelemetryInterfaceStateResponse reports the FabricTelemetryInterface status.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if configured, RETURN_CODE_FAILURE otherwise
result_jsonstringJSON object containing configuration result
error_messagestringError details if configuration failed

SwitchSpdmAttestationTargetResult

SwitchSpdmAttestationTargetResult reports evidence collection for one switch tray.

FieldTypeDescription
node_idstringSwitch tray node identifier
statusReturnCodeSUCCESS only when every discovered component succeeded
error_messageoptional stringTarget-level discovery or initialization error; unset when status is SUCCESS
componentsrepeated SwitchSpdmComponentResultPer-component status and evidence
collection_timestampgoogle.protobuf.TimestampWhen RMS finished collecting (or failed to collect) this target’s evidence

SwitchSpdmComponentEvidence

SwitchSpdmComponentEvidence contains the opaque evidence for one SPDM component.

FieldTypeDescription
measurementsbytesOpaque signed-measurement value
certificate_chainbytesOpaque certificate-chain value

SwitchSpdmComponentResult

SwitchSpdmComponentResult reports collection status for one discovered component.

FieldTypeDescription
component_idstringSPDM component identifier
statusReturnCodeCollection status for this component
error_messagestringCollection error when status is FAILURE
evidenceSwitchSpdmComponentEvidencePresent only when collection succeeded

SwitchSystemImageUpdateJobInfo

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

FieldTypeDescription
node_idstringSwitch node identifier
job_idstringSwitch 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.

FieldTypeDescription
node_idstringTarget node identifier
filenamestringSingle firmware filename (used when firmware_targets is empty)
targetstringSingle Redfish target URI (used when firmware_targets is empty)
activateboolWhether to immediately activate the firmware after installation
rack_idstringRack containing the target node
firmware_targetsrepeated FirmwareTargetMultiple (target, filename) pairs for batch component updates
force_updateboolForce the BMC to accept the firmware even if it’s a downgrade

UpdateFirmwareResponse

UpdateFirmwareResponse reports the firmware update result.

FieldTypeDescription
statusReturnCodeRETURN_CODE_SUCCESS if update completed, RETURN_CODE_FAILURE otherwise
messagestringHuman-readable status or error message
error_codeFirmwareUpdateErrorDetailed error code for troubleshooting
job_idstringJob ID for async operations (use with GetFirmwareJobStatus to track progress)

UpdateNodeRequest

UpdateNodeRequest modifies an existing node’s configuration.

FieldTypeDescription
node_idstringTarget node identifier
update_infoNodeUpdateInfoFields to update (only set fields are changed)
rack_idstringRack containing the target node

UpdateNodeResponse

UpdateNodeResponse confirms the update result.

FieldTypeDescription
responseOperationResponse-

UpdateSwitchSystemImageRequest

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

FieldTypeDescription
nodesNodeSetSwitch nodes to update
image_filenamestringBinary filename as it should exist on the switch
local_file_pathstringLocal file path on the RMS host
allow_onie_recoveryboolAllow recovery in cases where NVOS is not installed

UpdateSwitchSystemImageResponse

UpdateSwitchSystemImageResponse reports switch system image update job creation results.

FieldTypeDescription
responseNodeBatchResponse-
jobsrepeated SwitchSystemImageUpdateJobInfoIndividual job ID per switch

UpdateSwitchSystemPasswordRequest

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

FieldTypeDescription
nodesNodeSetSwitch nodes to update
usernamestringTarget OS username whose password will be changed (mandatory)
passwordstringNew password to set for the user (mandatory)

UpdateSwitchSystemPasswordResponse

UpdateSwitchSystemPasswordResponse reports switch password update job creation results.

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is the parent job ID for GetJobStatus

UsernamePassword

Username and password pair.

FieldTypeDescription
usernamestring-
passwordstring-

Enums

FirmwareComparisonStatus

FirmwareComparisonStatus describes one installed-to-proposed version comparison.

ValueNumberDescription
FIRMWARE_COMPARISON_STATUS_UNSPECIFIED0-
FIRMWARE_COMPARISON_STATUS_MATCHED1-
FIRMWARE_COMPARISON_STATUS_MISMATCHED2-
FIRMWARE_COMPARISON_STATUS_MISSING3-
FIRMWARE_COMPARISON_STATUS_UNVERIFIED4-

FirmwareJobState

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

ValueNumberDescription
FIRMWARE_JOB_STATE_UNSPECIFIED0Server left the job state unset or at the proto3 default
FIRMWARE_JOB_STATE_QUEUED1Job has been created and is waiting to start
FIRMWARE_JOB_STATE_RUNNING2Job is actively executing
FIRMWARE_JOB_STATE_COMPLETED3Job finished successfully
FIRMWARE_JOB_STATE_FAILED4Job finished with an error

FirmwareUpdateError

FirmwareUpdateError provides detailed error codes for firmware update operations.

ValueNumberDescription
FIRMWARE_UPDATE_ERROR_UNSPECIFIED0Server left the error code unset or at the proto3 default
FIRMWARE_UPDATE_ERROR_SUCCESS1Firmware update completed successfully
FIRMWARE_UPDATE_ERROR_FILE_NOT_FOUND2Specified firmware file does not exist
FIRMWARE_UPDATE_ERROR_CLIENT_FAILURE3HTTP/Redfish client communication failure
FIRMWARE_UPDATE_ERROR_TARGET_NOT_FOUND4Target component for update not found on node
FIRMWARE_UPDATE_ERROR_SERVER_ERROR5Server returned an error response
FIRMWARE_UPDATE_ERROR_TASK_FAILED6Firmware update task reported failure
FIRMWARE_UPDATE_ERROR_NO_TASK_INFO7Unable to retrieve task status information
FIRMWARE_UPDATE_ERROR_EXCEPTION8Exception occurred during update process
FIRMWARE_UPDATE_ERROR_INVALID_RESPONSE9Received invalid or malformed response
FIRMWARE_UPDATE_ERROR_MONITORING_TIMEOUT10Timed out waiting for update to complete
FIRMWARE_UPDATE_ERROR_TASK_EXCEPTION11Exception in task monitoring
FIRMWARE_UPDATE_ERROR_UNKNOWN12Unknown or unclassified error
FIRMWARE_UPDATE_ERROR_UPDATE_IN_PROGRESS13The node already has an active firmware update.

JobError

JobError provides detailed error codes for asynchronous operations.

ValueNumberDescription
JOB_ERROR_UNSPECIFIED0Server left the error code unset or at the proto3 default
JOB_ERROR_INTERNAL1Operation failed due to a RMS internal issue
JOB_ERROR_OTHER2Operation failed due to a non-specified reason
JOB_ERROR_INVALID_ARGUMENT3Arguments that have been provided during job start are not valid
JOB_ERROR_CLIENT_ERROR11HTTP/Redfish client side communication error
JOB_ERROR_SERVER_ERROR12Server returned an error response
JOB_ERROR_TIMEOUT13Timed out waiting for an operation to complete
JOB_ERROR_INVALID_RESPONSE14Received invalid or malformed response
JOB_ERROR_UNAUTHENTICATED15Provided credentials could not authenticate
JOB_ERROR_TARGET_NOT_FOUND21Target component for update not found on node
JOB_ERROR_FILE_NOT_FOUND22Specified firmware file does not exist
JOB_ERROR_UPDATE_IN_PROGRESS23The node already has an active firmware update.

JobExecutionState

JobExecutionState represents the lifecycle state of an asynchronous job

ValueNumberDescription
JOB_EXECUTION_STATE_UNSPECIFIED0Server left the job state unset or at the proto3 default
JOB_EXECUTION_STATE_QUEUED1Job has been created and is waiting to start
JOB_EXECUTION_STATE_RUNNING2Job is actively executing
JOB_EXECUTION_STATE_COMPLETED3Job finished successfully
JOB_EXECUTION_STATE_FAILED4Job finished with an error

NodeType

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

ValueNumberDescription
NODE_TYPE_UNSPECIFIED0Caller left the node type missing or at the proto3 default
COMPUTE_GB200_NVIDIA1NVIDIA GB200 compute node
POWERSHELF_GB200_LITEON2LiteOn GB200 power shelf
SWITCH_GB200_NVIDIA3NVIDIA GB200 network switch
POWERSHELF_GB200_DELTA4Delta GB200 power shelf
COMPUTE_GB300_NVIDIA5NVIDIA GB300 compute node
SWITCH_GB300_NVIDIA6NVIDIA GB300 network switch
POWERSHELF_GB300_LITEON7LiteOn GB300 power shelf
POWERSHELF_GB300_DELTA8Delta GB300 power shelf
COMPUTE_GB300_LENOVO9Lenovo GB300 compute node
COMPUTE_VRNVL72_NVIDIA10NVIDIA VR NVL72 compute tray
SWITCH_VRNVL72_NVIDIA11NVIDIA VR NVL72 network switch

PowerOperation

PowerOperation defines the power control actions for individual nodes.

ValueNumberDescription
POWER_OPERATION_UNSPECIFIED0Caller left the operation missing or at the proto3 default
POWER_OPERATION_OFF1Power off the node using its default off semantics
POWER_OPERATION_ON2Power on the node
POWER_OPERATION_RESET3Power cycle the node
POWER_OPERATION_FORCE_OFF4Redfish ResetType ForceOff
POWER_OPERATION_FORCE_ON5Redfish ResetType ForceOn
POWER_OPERATION_GRACEFUL_SHUTDOWN6Redfish ResetType GracefulShutdown
POWER_OPERATION_GRACEFUL_RESTART7Redfish ResetType GracefulRestart
POWER_OPERATION_FORCE_RESTART8Redfish ResetType ForceRestart

ReturnCode

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

ValueNumberDescription
RETURN_CODE_UNSPECIFIED0Server left the status unset or at the proto3 default
RETURN_CODE_SUCCESS1Operation completed successfully
RETURN_CODE_FAILURE2Operation failed (see message field for details)

ScaleUpFabricControlPlaneState

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

ValueNumberDescription
SCALE_UP_FABRIC_CONTROL_PLANE_STATE_UNKNOWN0No configured or failed state was established.
SCALE_UP_FABRIC_CONTROL_PLANE_STATE_CONFIGURED1NMX-C reports CONFIGURED, not a match to requested settings.
SCALE_UP_FABRIC_CONTROL_PLANE_STATE_FAILED2NMX-C reports a control-plane timeout or error.

ScaleUpFabricReportedStatus

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

ValueNumberDescription
SCALE_UP_FABRIC_REPORTED_STATUS_UNKNOWN0Observations are absent or inconclusive.
SCALE_UP_FABRIC_REPORTED_STATUS_NORMAL1All applicable sampled indicators are normal.
SCALE_UP_FABRIC_REPORTED_STATUS_ABNORMAL2At least one sampled indicator reports an abnormal state.

SwitchFirmwareComponentType

SwitchFirmwareComponentType identifies the firmware component type on a switch.

ValueNumberDescription
SWITCH_FIRMWARE_COMPONENT_TYPE_UNSPECIFIED0Caller left the component type missing or at the proto3 default
SWITCH_FIRMWARE_COMPONENT_TYPE_UNKNOWN1Unknown component type
SWITCH_FIRMWARE_COMPONENT_TYPE_BMC2Baseboard Management Controller
SWITCH_FIRMWARE_COMPONENT_TYPE_FPGA3Field Programmable Gate Array
SWITCH_FIRMWARE_COMPONENT_TYPE_EROT4Embedded Root of Trust
SWITCH_FIRMWARE_COMPONENT_TYPE_CPLD5Complex Programmable Logic Device
SWITCH_FIRMWARE_COMPONENT_TYPE_BIOS6Basic Input/Output System
SWITCH_FIRMWARE_COMPONENT_TYPE_TRANSCEIVER7Optical transceiver

SwitchService

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

ValueNumberDescription
SWITCH_SERVICE_UNSPECIFIED0Caller left the service missing or at the proto3 default
SWITCH_SERVICE_NVUE_API1NVUE REST API service
SWITCH_SERVICE_SCALE_UP_FABRIC_TELEMETRY2Scale-up fabric telemetry service
SWITCH_SERVICE_SCALE_UP_FABRIC_MANAGER3Scale-up fabric manager service
SWITCH_SERVICE_SCALE_UP_FABRIC_TELEMETRY_INTERFACE4Scale-up fabric telemetry interface service