Skip to navigation

RMS gRPC API reference

View as MarkdownOpen in Claude

The Rack Management Service (RMS) exposes its functionality as a gRPC API. Use this reference to find every RPC, see its request and response shapes, and learn whether it returns its result directly or returns a job ID that you poll.

Services

The RMS API consists of two gRPC services, both defined in the librms protobuf files in crates/librms/proto. RMS serves both on the same port (default 8801).

ServiceProtobuf packageProto fileScope
RackManagerrack_managerrack_manager.protoPower, inventory, firmware, switches, jobs
RackManagerV2rack_manager_v2rack_manager_v2.protoScale-up fabric, system validation

RackManagerV2 reuses message types from the rack_manager package, such as NodeSet. Both services share one job tracker, so you can poll a job from either service with the RackManager job status RPCs.

How this reference is organized

PageWhat you find there
Getting startedConnect to RMS, call your first RPC, and follow three common flows
ConventionsNode identity, registered and caller-supplied targets, and error handling
Async jobsThe job model, execution modes, and which RPC polls which job
RPC catalogEvery RPC with its execution mode, polling RPC, and target
RPC pages by categoryRequest, response, and behavior for each RPC (refer to the following list)
Protobuf referenceInteractive reference rendered from the protobuf definitions

The RPC pages group RPCs by task:

Message and enum definitions are in rack_manager types and rack_manager_v2 types.

How the reference stays accurate

The protobuf files are the source of truth for request shapes, response shapes, and RPC descriptions. The RPC pages are generated from them, so field names and descriptions match the API that RMS serves. The execution mode, polling RPC, and target of each RPC come from a reviewed metadata file that a CI check compares with the protobuf files.

For the behavior behind each RPC, such as retries, ordering, and per-node limits, refer to the Operations guides.

Compatibility

The RackManager gRPC API is a guaranteed public interface of RMS. Within a major version, existing clients continue to work and new functionality is added in a backward-compatible way. For the full policy, refer to Release and QA process.