Sign in
Tray

Retrieve a Tray

Get a Tray by ID.

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

get/v2/org/{org}/nico/tray/{id}

Query parameters

siteIdstring uuid required

ID of the Site

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 5 of the 90 revisions of this API.38

  • 01e93520819d1See the full diff
    • ○

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

      response-required-property-added

  • 77c18e8010961See the full diff
    • ○

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

      response-required-property-added

  • 652b7687aa8133See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

  • 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 leakStatus to the response with the 200 status

      response-optional-property-added

    • ○

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

      response-optional-property-added