Sign in
Tray

Retrieve all Trays

Get all Trays (components) for the specified Site.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

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
  • slotId restricts to trays at that rack slot, requires rackId or rackName, and composes with the rest of the query via AND
get/v2/org/{org}/nico/tray

Query parameters

siteIdstring uuid required

ID of the Site to retrieve Trays from

rackIdstring uuid

Filter by Rack ID

rackNamestring

Filter by Rack name

type'Compute' | 'NVSwitch' | 'PowerShelf'

Filter by tray type

componentIdstring

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

idstring uuid

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

slotIdinteger

Restrict to trays at this rack slot (matches position.slotId). Requires rackId or rackName. Composes with the rest of the filter via AND.

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'MANUFACTURER_ASC' | 'MANUFACTURER_DESC' | 'MODEL_ASC' | 'MODEL_DESC' | 'TYPE_ASC' | 'TYPE_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique identifier of the Tray

componentIdstring

ID of the component

type'Compute' | 'NVSwitch' | 'PowerShelf'

Type of the tray

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

operationStatus'Unknown' | 'Initializing' | 'Ready' | 'InUse' | 'Error' | 'Deleting'

Flow-derived operability phase of the tray

leakStatus'Unknown' | 'NoLeak' | 'Leaking'

Whether the tray is considered leaking coolant

rackIdstring uuid

ID of the rack this tray belongs to

nvLinkDomainIdstring uuid nullable required

ID of the NVLink Domain containing this Tray's Rack. Null when the Rack is not assigned to an NVLink Domain.

Example response

[
  {
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "componentId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
    "type": "Compute",
    "name": "compute-tray-1",
    "manufacturer": "NVIDIA",
    "model": "GB200",
    "serialNumber": "TSN001",
    "description": "Compute tray in slot 1",
    "firmwareVersion": "2.1.0",
    "powerState": "on",
    "position": {
      "slotId": 1,
      "trayIdx": 0,
      "hostId": 1
    },
    "bmcs": [
      {
        "type": "BmcTypeHost",
        "macAddress": "00:11:22:33:44:55",
        "ipAddress": "192.168.1.100"
      }
    ],
    "rackId": "550e8400-e29b-41d4-a716-446655440000",
    "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
    "taskStats": {
      "pendingTaskCount": 3,
      "activeTaskCount": 1
    }
  }
]

Changes

Changed in 9 of the 90 revisions of this API.3513

  • 01e93520819d1See the full diff
    • ○

      added the required property items/taskStats to the response with the 200 status

      response-required-property-added

  • 77c18e8010961See the full diff
    • ○

      added the required property items/nvLinkDomainId to the response with the 200 status

      response-required-property-added

  • 652b7687aa81336See the full diff
    • ▲

      removed the enum value compute from the query request parameter type

      request-parameter-enum-value-removed

    • ▲

      removed the enum value powershelf from the query request parameter type

      request-parameter-enum-value-removed

    • ▲

      removed the enum value switch from the query request parameter type

      request-parameter-enum-value-removed

    • ●

      added the new Compute enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new NVSwitch enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PowerShelf enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value Compute to the query request parameter type

      request-parameter-enum-value-added

    • ○

      added the new enum value NVSwitch to the query request parameter type

      request-parameter-enum-value-added

    • ○

      added the new enum value PowerShelf to the query request parameter type

      request-parameter-enum-value-added

    • ○

      removed the compute enum value from the items/type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the powershelf enum value from the items/type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the switch enum value from the items/type response property for the response status 200

      response-property-enum-value-removed

  • c459c6587dee1See the full diff
    • ●

      for the query request parameter pageNumber, the max was set to 21474836.00

      request-parameter-max-set

  • 441cfc1afc1c1See the full diff
    • ○

      added the non-success response with the status 504

      response-non-success-status-added

  • 268117a964212See the full diff
    • ○

      added the optional property items/leakStatus to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/operationStatus to the response with the 200 status

      response-optional-property-added

  • b078e63260c11See the full diff
    • ○

      added the new optional query request parameter slotId

      new-optional-request-parameter

  • ffa0635230581See the full diff
    • ●

      deleted the query request parameter slotId

      request-parameter-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f20872e0979a1See the full diff
    • ○

      added the new optional query request parameter slotId

      new-optional-request-parameter