Retrieve all Trays | NVIDIA Infra Controller

Get all Trays (components) for the specified Site.

Org must have an Infrastructure Provider entity. User must have FORGE_PROVIDER_ADMIN authorization role.

Filter constraints:

rackId and rackName are mutually exclusive
rackId/rackName cannot be combined with id/componentId (rack-level vs component-level targeting)
componentId requires type to be specified

Get all Trays (components) for the specified Site. Org must have an Infrastructure Provider entity. User must have `FORGE_PROVIDER_ADMIN` authorization role. **Filter constraints:** - `rackId` and `rackName` are mutually exclusive - `rackId`/`rackName` cannot be combined with `id`/`componentId` (rack-level vs component-level targeting) - `componentId` requires `type` to be specified

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site to retrieve Trays from

rackIdstringOptionalformat: "uuid"

Filter by Rack ID

rackNamestringOptional

Filter by Rack name

typeenumOptional

Filter by tray type

Allowed values:

componentIdstringOptional

Filter by component ID. Can be specified multiple times to filter on more than one component ID. Requires 'type' parameter.

idstringOptionalformat: "uuid"

Filter by tray UUID. Can be specified multiple times to filter on more than one tray ID.

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringformat: "uuid"

Unique identifier of the Tray

componentIdstring

ID of the component

typeenum

Type of the tray

Allowed values:

namestring

Name of the tray

manufacturerstring

Manufacturer of the tray

modelstring

Model of the tray

serialNumberstring

Serial number of the tray

descriptionstring

Description of the tray

firmwareVersionstring

Firmware version of the tray

powerStatestring

Current power state of the tray

positionobject

Position of a tray within a rack

bmcslist of objects

BMC (Baseboard Management Controller) entries for the tray

rackIdstringformat: "uuid"

ID of the rack this tray belongs to

Errors

403

Forbidden Error

1	[
2	{
3	"id": "660e8400-e29b-41d4-a716-446655440001",
4	"componentId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
5	"type": "compute",
6	"name": "compute-tray-1",
7	"manufacturer": "NVIDIA",
8	"model": "GB200",
9	"serialNumber": "TSN001",
10	"description": "Compute tray in slot 1",
11	"firmwareVersion": "2.1.0",
12	"powerState": "on",
13	"position": {
14	"slotId": 1,
15	"trayIdx": 0,
16	"hostId": 1
17	},
18	"rackId": "550e8400-e29b-41d4-a716-446655440000"
19	}
20	]

1	curl -G https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/tray \
2	-H "Authorization: Bearer <token>" \
3	-d siteId=siteId