Inventory and Device Info
Register nodes, list racks and nodes, and read tray and chassis location data.
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.
Request: ListNodeInventoryRequest
This message has no fields.
Response: ListNodeInventoryResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command:
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.
Request: CreateNodesRequest
Response: CreateNodesResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command:
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”.
Request: UpdateNodeRequest
Response: UpdateNodeResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
DeleteNode
rack_manager.RackManager/DeleteNode
DeleteNode removes a node from the inventory. The node must exist in the specified rack.
Request: DeleteNodeRequest
Response: DeleteNodeResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
ListRacks
rack_manager.RackManager/ListRacks
ListRacks returns a list of all rack IDs in the system.
Request: ListRacksRequest
This message has no fields.
Response: ListRacksResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command:
GetNodeDeviceInfo
rack_manager.RackManager/GetNodeDeviceInfo
GetNodeDeviceInfo retrieves normalized device metadata for a specific node.
Request: GetNodeDeviceInfoRequest
Response: GetNodeDeviceInfoResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command:
ListNodeDeviceInfoByNodeType
rack_manager.RackManager/ListNodeDeviceInfoByNodeType
ListNodeDeviceInfoByNodeType retrieves normalized device metadata for all nodes of a specific type in a rack.
Request: ListNodeDeviceInfoByNodeTypeRequest
Response: ListNodeDeviceInfoByNodeTypeResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command:
BatchGetNodeDeviceInfo
rack_manager.RackManager/BatchGetNodeDeviceInfo
BatchGetNodeDeviceInfo retrieves normalized device metadata for a caller-supplied list of nodes. Each node is identified by its NodeInfo.
Request: BatchGetNodeDeviceInfoRequest
Response: BatchGetNodeDeviceInfoResponse
Errors: Refer to Conventions for how RMS reports failures.
Example request
Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.
The rack_manager_client test client offers an equivalent command: