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 for how nodes are described.
Messages
AddFirmwareObjectRequest
AddFirmwareObjectRequest adds firmware object config and authorizes RMS artifact download.
AddFirmwareObjectResponse
ApplyFirmwareObjectRequest
ApplyFirmwareObjectResponse
ApplyStoredFirmwareObjectRequest
ApplyStoredFirmwareObjectResponse
ApplyStoredSwitchSystemImageRequest
ApplyStoredSwitchSystemImageResponse
ApplySwitchSystemImageRequest
ApplySwitchSystemImageResponse
BatchCollectSwitchSpdmAttestationEvidenceRequest
BatchCollectSwitchSpdmAttestationEvidenceRequest challenges one or more switch trays.
BatchCollectSwitchSpdmAttestationEvidenceResponse
BatchCollectSwitchSpdmAttestationEvidenceResponse contains normalized switch evidence.
BatchDisableSwitchMtlsRequest
BatchDisableSwitchMtlsRequest disables mTLS for selected services on supplied switches.
BatchDisableSwitchMtlsResponse
BatchDisableSwitchMtlsResponse reports asynchronous mTLS disable job submission status.
BatchGetFirmwareInventoryRequest
BatchGetFirmwareInventoryRequest retrieves firmware for unregistered nodes.
BatchGetFirmwareInventoryResponse
BatchGetFirmwareInventoryResponse returns firmware grouped by requested node.
BatchGetNodeDeviceInfoRequest
BatchGetNodeDeviceInfoRequest retrieves device metadata for a specified list of nodes.
BatchGetNodeDeviceInfoResponse
BatchGetNodeDeviceInfoResponse returns device metadata for the requested nodes.
BatchGetPowerStateRequest
BatchGetPowerStateRequest queries power state for unregistered nodes.
BatchGetPowerStateResponse
BatchGetPowerStateResponse reports per-node power state results.
BatchGetScaleUpFabricServiceStatusRequest
BatchGetScaleUpFabricServiceStatusRequest checks cluster health and fabric manager status on caller-supplied switches.
BatchGetScaleUpFabricServiceStatusResponse
BatchGetScaleUpFabricServiceStatusResponse reports per-switch results keyed by node_id.
BatchResetSwitchFactoryDefaultRequest
BatchResetSwitchFactoryDefaultRequest submits NVOS factory-default resets for caller-supplied switches.
BatchResetSwitchFactoryDefaultResponse
BatchResetSwitchFactoryDefaultResponse reports asynchronous reset submission status.
BatchResetSwitchSdnFactoryDefaultRequest
BatchResetSwitchSdnFactoryDefaultRequest submits SDN factory-default resets for caller-supplied switches.
BatchResetSwitchSdnFactoryDefaultResponse
BatchResetSwitchSdnFactoryDefaultResponse reports asynchronous reset submission status.
BatchSetPowerStateRequest
BatchSetPowerStateRequest controls power for unregistered nodes.
BatchSetPowerStateResponse
BatchSetPowerStateResponse reports per-node power operation results.
BatchSetScaleUpFabricStateRequest
BatchSetScaleUpFabricStateRequest performs synchronous ScaleUpFabric state update and config save across caller-supplied switches.
BatchSetScaleUpFabricStateResponse
BatchSetScaleUpFabricStateResponse reports the synchronous per-switch result.
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.
BatchUpdateFirmwareByNodeTypeResponse
BatchUpdateFirmwareByNodeTypeResponse reports the created async jobs.
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.
BatchUpdateFirmwareResponse
BatchUpdateFirmwareResponse reports firmware update results.
CompareFirmwareObjectRequest
CompareFirmwareObjectRequest compares a proposed firmware object with caller-supplied nodes.
CompareFirmwareObjectResponse
CompareFirmwareObjectResponse reports comparison and per-node query results.
ComponentInventoryInfo
ComponentInventoryInfo represents inventory information for a component within a node.
ConfigureScaleUpFabricManagerRequest
ConfigureScaleUpFabricManagerRequest performs complete ScaleUpFabricManager setup on a switch. This operation enables the ScaleUpFabricManager, configures ScaleUpFabricManager access, and sets topology.
ConfigureScaleUpFabricManagerResponse
ConfigureScaleUpFabricManagerResponse reports the ScaleUpFabricManager configuration result.
ConfigureSwitchCertificateJobInfo
ConfigureSwitchCertificateJobInfo pairs a switch node ID with its async certificate configuration job ID.
ConfigureSwitchCertificateRequest
ConfigureSwitchCertificateRequest installs mTLS certificates on supplied switches.
ConfigureSwitchCertificateResponse
ConfigureSwitchCertificateResponse reports switch certificate configuration job creation results.
CreateNodesRequest
CreateNodesRequest registers new nodes in the inventory.
CreateNodesResponse
CreateNodesResponse reports the results of adding nodes.
Credentials
Base credential structure supporting either username/password or session token.
Set at most one of user_pass, session_token (oneof auth).
DeleteFirmwareObjectRequest
DeleteFirmwareObjectResponse
DeleteNodeRequest
DeleteNodeRequest deletes a node from the inventory.
DeleteNodeResponse
DeleteNodeResponse confirms the removal result.
Endpoint
Endpoint describes one network endpoint and its 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.
ExecuteColdRebootResponse
ExecuteColdRebootResponse returns the coordinator job for tracking the reboot.
FirmwareInventoryInfo
FirmwareInventoryInfo represents firmware information for a component.
FirmwareManifestComponentComparison
FirmwareManifestComponentComparison compares one manifest component with live inventory.
FirmwareObject
FirmwareObject is a managed firmware object catalog entry.
FirmwareObjectArtifact
FirmwareObjectArtifact describes the local artifact RMS resolved for a component.
FirmwareObjectComponent
FirmwareObjectComponent describes one normalized component clients can request.
FirmwareObjectComponentFilter
FirmwareObjectComponentFilter wraps component names for one node selector.
FirmwareObjectDeviceComponents
FirmwareObjectDeviceComponents groups applyable components by hardware node type.
FirmwareObjectHistoryRecord
FirmwareObjectMetadata
FirmwareObjectMetadata describes the firmware object content RMS can apply.
FirmwareObjectSubcomponent
FirmwareObjectSwitchSystemImage
FirmwareObjectSwitchSystemImage describes a switch system-image artifact.
FirmwareTarget
FirmwareTarget pairs a firmware component target with its firmware package file.
FirmwareTargetList
FirmwareTargetList wraps a list of firmware targets for use as a map value.
GetConfigureSwitchCertificateJobStatusRequest
GetConfigureSwitchCertificateJobStatusRequest queries the status of an asynchronous switch certificate configuration job.
GetConfigureSwitchCertificateJobStatusResponse
GetConfigureSwitchCertificateJobStatusResponse returns the current state of a switch certificate configuration job.
GetFirmwareJobStatusRequest
GetFirmwareJobStatusRequest queries the status of an asynchronous firmware job.
GetFirmwareJobStatusResponse
GetFirmwareJobStatusResponse returns the current state of a firmware job.
GetFirmwareObjectHistoryRequest
GetFirmwareObjectHistoryResponse
GetFirmwareObjectRequest
GetFirmwareObjectResponse
GetJobStatusRequest
GetJobStatusResponse
GetNodeDeviceInfoRequest
GetNodeDeviceInfoRequest retrieves normalized device metadata for a specific node.
GetNodeDeviceInfoResponse
GetNodeDeviceInfoResponse returns normalized device metadata for a specific node.
GetNodeFirmwareInventoryRequest
GetNodeFirmwareInventoryRequest retrieves firmware info for a specific node.
GetNodeFirmwareInventoryResponse
GetNodeFirmwareInventoryResponse returns firmware component information.
GetPowerStateRequest
GetPowerStateRequest queries the current power state of a node.
GetPowerStateResponse
GetPowerStateResponse returns the current power state of a node.
GetRackFirmwareInventoryRequest
GetRackFirmwareInventoryRequest retrieves firmware for all nodes in a rack.
GetRackFirmwareInventoryResponse
GetRackFirmwareInventoryResponse returns firmware info for all nodes.
GetScaleUpFabricStateRequest
GetScaleUpFabricStateRequest retrieves the ScaleUpFabric state for a single switch.
GetScaleUpFabricStateResponse
GetScaleUpFabricStateResponse returns the ScaleUpFabric state.
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.
GetScaleUpFabricStatusResponse
GetScaleUpFabricStatusResponse returns the observed scale-up fabric status.
GetSwitchSystemImageJobStatusRequest
GetSwitchSystemImageJobStatusRequest queries the status of an asynchronous switch system image job.
GetSwitchSystemImageJobStatusResponse
GetSwitchSystemImageJobStatusResponse returns the current state of a switch system image job.
GetVersionRequest
GetVersionRequest retrieves server version information.
This message has no fields.
GetVersionResponse
GetVersionResponse reports server version information.
InspectScaleUpFabricsRequest
Live inspection uses caller-supplied inventory, without desired settings or job history.
InspectScaleUpFabricsResponse
Live samples collected over an interval, not an atomic rack snapshot.
JobStatus
The detailed status of a Job
ListFirmwareObjectsRequest
ListFirmwareObjectsResponse
ListNodeDeviceInfoByNodeTypeRequest
ListNodeDeviceInfoByNodeTypeRequest retrieves device metadata for all nodes of a type in a rack.
ListNodeDeviceInfoByNodeTypeResponse
ListNodeDeviceInfoByNodeTypeResponse returns device metadata for all matching nodes in a rack.
ListNodeInventoryRequest
ListNodeInventoryRequest retrieves the complete system inventory.
This message has no fields.
ListNodeInventoryResponse
ListNodeInventoryResponse returns all nodes and their components.
ListRacksRequest
ListRacksRequest retrieves all rack identifiers.
This message has no fields.
ListRacksResponse
ListRacksResponse returns all rack identifiers in the system.
ListSwitchFirmwareRequest
ListSwitchFirmwareResponse
ListSwitchSystemImagesRequest
ListSwitchSystemImagesRequest retrieves available OS images on a switch.
ListSwitchSystemImagesResponse
ListSwitchSystemImagesResponse returns available OS images.
NetworkInterface
A network interface with paired IP and MAC address.
NodeBatchResponse
NodeBatchResponse reports the common result shape for multi-node RPCs.
NodeDescriptor
NodeDescriptor carries flexible hardware identity attributes for RMS dispatch.
NodeDescriptorFirmwareObjectComponentFilter
NodeDescriptorFirmwareObjectComponentFilter pairs a flexible node identity with a component filter.
NodeDescriptorFirmwareTargetList
NodeDescriptorFirmwareTargetList pairs a flexible node identity with firmware targets.
NodeDeviceInfo
NodeDeviceInfo represents normalized device metadata for a node.
NodeFirmwareInventory
NodeFirmwareInventory groups firmware information for a specific node.
NodeFirmwareJobInfo
NodeFirmwareJobInfo pairs a node ID with its async firmware job ID.
NodeFirmwareManifestComparison
NodeFirmwareManifestComparison contains the comparison result for one node.
NodeInfo
NodeInfo contains all information needed to describe a node.
NodeInventoryInfo
NodeInventoryInfo represents complete inventory information for a node.
NodeOperationResult
NodeOperationResult reports the outcome of an operation on a specific node.
NodeOperationStats
NodeOperationStats reports aggregate node counts for batch-like RPCs.
NodePowerState
NodePowerState pairs a node identifier with its current power state.
NodeSet
NodeSet represents a collection of nodes, reusable wherever a node list is needed.
NodeUpdateInfo
NodeUpdateInfo contains fields that can be updated for an existing node. Only specified fields will be updated; unset fields remain unchanged.
OperationResponse
OperationResponse reports the common result shape for simple RPCs.
PushSwitchFirmwareRequest
PushSwitchFirmware request/response
PushSwitchFirmwareResponse
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.
ScaleUpFabricInspectionError
Collection or interpretation failure, separate from observed component status.
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.
ScaleUpFabricServiceStatusEntry
ScaleUpFabricServiceStatusEntry stores per-switch status keyed by node_id.
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.
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.
ScaleUpFabricSwitchStatus
ScaleUpFabricSwitchStatus is the observed state of a single switch in the fabric.
SetDefaultFirmwareObjectRequest
SetDefaultFirmwareObjectResponse
SetPowerStateRequest
SetPowerStateRequest controls the power state of a single node.
SetPowerStateResponse
SetPowerStateResponse confirms the power operation result.
SetScaleUpFabricTelemetryInterfaceStateRequest
SetScaleUpFabricTelemetryInterfaceStateRequest enables or disables the FabricTelemetryInterface.
SetScaleUpFabricTelemetryInterfaceStateResponse
SetScaleUpFabricTelemetryInterfaceStateResponse reports the FabricTelemetryInterface status.
SwitchSpdmAttestationTargetResult
SwitchSpdmAttestationTargetResult reports evidence collection for one switch tray.
SwitchSpdmComponentEvidence
SwitchSpdmComponentEvidence contains the opaque evidence for one SPDM component.
SwitchSpdmComponentResult
SwitchSpdmComponentResult reports collection status for one discovered component.
SwitchSystemImageUpdateJobInfo
SwitchSystemImageUpdateJobInfo pairs a switch node ID with its async 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.
UpdateFirmwareResponse
UpdateFirmwareResponse reports the firmware update result.
UpdateNodeRequest
UpdateNodeRequest modifies an existing node’s configuration.
UpdateNodeResponse
UpdateNodeResponse confirms the update result.
UpdateSwitchSystemImageRequest
UpdateSwitchSystemImageRequest initiates switch system image updates on a specified list of switches.
UpdateSwitchSystemImageResponse
UpdateSwitchSystemImageResponse reports switch system image update job creation results.
UpdateSwitchSystemPasswordRequest
UpdateSwitchSystemPasswordRequest starts an OS-level password update for a user on a set of switch nodes.
UpdateSwitchSystemPasswordResponse
UpdateSwitchSystemPasswordResponse reports switch password update job creation results.
UsernamePassword
Username and password pair.
Enums
FirmwareComparisonStatus
FirmwareComparisonStatus describes one installed-to-proposed version comparison.
FirmwareJobState
FirmwareJobState represents the lifecycle state of an asynchronous firmware job. Deprecated: Use the equivalent and binary compatible JobState definition
FirmwareUpdateError
FirmwareUpdateError provides detailed error codes for firmware update operations.
JobError
JobError provides detailed error codes for asynchronous operations.
JobExecutionState
JobExecutionState represents the lifecycle state of an asynchronous job
NodeType
NodeType identifies the hardware-specific node implementation in the rack.
PowerOperation
PowerOperation defines the power control actions for individual nodes.
ReturnCode
ReturnCode indicates the overall success or failure of an RPC operation.
ScaleUpFabricControlPlaneState
Configuration state reported by NMX-C, not compared with caller intent.
ScaleUpFabricReportedStatus
Summary of sampled indicators, not a guarantee of end-to-end communication.
SwitchFirmwareComponentType
SwitchFirmwareComponentType identifies the firmware component type on a switch.
SwitchService
SwitchService identifies a switch service whose mTLS state should be managed.