RMS gRPC API reference
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).
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
The RPC pages group RPCs by task:
- Power control
- Inventory and device info
- Firmware inventory
- Firmware object catalog
- Firmware updates
- Switch management
- Scale-up fabric
- Switch TLS and certificates
- System validation
- Utility and jobs
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.