Skip to navigation

Inventory and Device Info

View as MarkdownOpen in Claude

Register nodes, list racks and nodes, and read tray and chassis location data.

RPCExecutionSummary
ListNodeInventorySynchronousListNodeInventory retrieves the complete inventory of all nodes across all racks.
CreateNodesSynchronousCreateNodes registers one or more new nodes in the inventory.
UpdateNodeSynchronousUpdateNode modifies the configuration of an existing node.
DeleteNodeSynchronousDeleteNode removes a node from the inventory.
ListRacksSynchronousListRacks returns a list of all rack IDs in the system.
GetNodeDeviceInfoSynchronousGetNodeDeviceInfo retrieves normalized device metadata for a specific node.
ListNodeDeviceInfoByNodeTypeSynchronousListNodeDeviceInfoByNodeType retrieves normalized device metadata for all nodes of a specific type in a rack.
BatchGetNodeDeviceInfoSynchronousBatchGetNodeDeviceInfo retrieves normalized device metadata for a caller-supplied list of nodes.

For definitions of execution modes and job polling, refer to Async jobs.

ListNodeInventory

rack_manager.RackManager/ListNodeInventory

ListNodeInventory retrieves the complete inventory of all nodes across all racks.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceListNodeInventory

Request: ListNodeInventoryRequest

This message has no fields.

Response: ListNodeInventoryResponse

FieldTypeDescription
nodesrepeated NodeInventoryInfoComplete list of nodes across all racks

Errors: Refer to Conventions for how RMS reports failures.

Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{}' \
"$RMS_ADDR" rack_manager.RackManager/ListNodeInventory

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> list_node_inventory

CreateNodes

rack_manager.RackManager/CreateNodes

CreateNodes registers one or more new nodes in the inventory. Supports batch addition of multiple nodes in a single request.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceCreateNodes

Request: CreateNodesRequest

FieldTypeDescription
nodesNodeSetList of nodes to add (batch operation supported)

Response: CreateNodesResponse

FieldTypeDescription
responseOperationResponse-
statsNodeOperationStatsAggregate add-node counts

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"nodes": {
"nodes": [
{
"node_id": "<node_id>",
"rack_id": "<rack_id>",
"type": "COMPUTE_GB200_NVIDIA",
"bmc_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"host_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"additional_host_endpoints": [
{
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
}
]
}
]
}
}' \
"$RMS_ADDR" rack_manager.RackManager/CreateNodes

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> add_nodes <devices.csv>

UpdateNode

rack_manager.RackManager/UpdateNode

UpdateNode modifies the configuration of an existing node. Only specified fields in the update_info will be changed.

Not implemented. The server always returns RETURN_CODE_FAILURE with the message “UpdateNode not yet implemented”.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceUpdateNode

Request: UpdateNodeRequest

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

Response: UpdateNodeResponse

FieldTypeDescription
responseOperationResponse-

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"node_id": "<node_id>",
"update_info": {
"bmc_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"host_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
}
},
"rack_id": "<rack_id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/UpdateNode

DeleteNode

rack_manager.RackManager/DeleteNode

DeleteNode removes a node from the inventory. The node must exist in the specified rack.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceDeleteNode

Request: DeleteNodeRequest

FieldTypeDescription
node_idstringTarget node identifier to remove
rack_idstringRack containing the target node

Response: DeleteNodeResponse

FieldTypeDescription
responseOperationResponse-

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"node_id": "<node_id>",
"rack_id": "<rack_id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/DeleteNode

ListRacks

rack_manager.RackManager/ListRacks

ListRacks returns a list of all rack IDs in the system.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceListRacks

Request: ListRacksRequest

This message has no fields.

Response: ListRacksResponse

FieldTypeDescription
rack_idsrepeated stringList of all rack identifiers

Errors: Refer to Conventions for how RMS reports failures.

Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{}' \
"$RMS_ADDR" rack_manager.RackManager/ListRacks

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> list_racks

GetNodeDeviceInfo

rack_manager.RackManager/GetNodeDeviceInfo

GetNodeDeviceInfo retrieves normalized device metadata for a specific node.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceGetNodeDeviceInfo

Request: GetNodeDeviceInfoRequest

FieldTypeDescription
rack_idstringRack containing the target node
node_idstringTarget node identifier

Response: GetNodeDeviceInfoResponse

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

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"rack_id": "<rack_id>",
"node_id": "<node_id>"
}' \
"$RMS_ADDR" rack_manager.RackManager/GetNodeDeviceInfo

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> switch device_info <rack_id> <node_id>

ListNodeDeviceInfoByNodeType

rack_manager.RackManager/ListNodeDeviceInfoByNodeType

ListNodeDeviceInfoByNodeType retrieves normalized device metadata for all nodes of a specific type in a rack.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetRegistered inventory. Reads or changes nodes and racks stored in RMS inventory.
Behavior detailsOperations guide
Protobuf referenceListNodeDeviceInfoByNodeType

Request: ListNodeDeviceInfoByNodeTypeRequest

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

Response: ListNodeDeviceInfoByNodeTypeResponse

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

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"rack_id": "<rack_id>",
"node_type": "COMPUTE_GB200_NVIDIA",
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
}
}' \
"$RMS_ADDR" rack_manager.RackManager/ListNodeDeviceInfoByNodeType

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> switch device_info_by_type <rack_id> <node_type>

BatchGetNodeDeviceInfo

rack_manager.RackManager/BatchGetNodeDeviceInfo

BatchGetNodeDeviceInfo retrieves normalized device metadata for a caller-supplied list of nodes. Each node is identified by its NodeInfo.

PropertyValue
ExecutionSynchronous. The response carries the full result.
TargetCaller-supplied nodes. The request carries each node’s endpoints and credentials, and RMS does not store them.
Behavior detailsOperations guide
Protobuf referenceBatchGetNodeDeviceInfo

Request: BatchGetNodeDeviceInfoRequest

FieldTypeDescription
nodesNodeSetNodes to query

Response: BatchGetNodeDeviceInfoResponse

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

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"nodes": {
"nodes": [
{
"node_id": "<node_id>",
"rack_id": "<rack_id>",
"type": "COMPUTE_GB200_NVIDIA",
"bmc_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"host_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"additional_host_endpoints": [
{
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
}
]
}
]
}
}' \
"$RMS_ADDR" rack_manager.RackManager/BatchGetNodeDeviceInfo

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> switch device_info_batch <nodes.csv>