Sign in
Rack

Retrieve a Rack

Get a Rack by ID.

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

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

Query parameters

siteIdstring uuid required

ID of the Site

includeComponentsboolean

Include rack components in response

Response

OK

idstring uuid

Unique identifier of the Rack

namestring

Name of the Rack

manufacturerstring

Manufacturer of the Rack

modelstring

Model of the Rack

serialNumberstring

Serial number of the Rack

descriptionstring

Description of the Rack

nvLinkDomainIdsstring[] required

IDs of the NVLink Domains containing this Rack. Empty when the Rack is not assigned to an NVLink Domain.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Rack-01",
  "manufacturer": "Dell",
  "model": "PowerEdge R750",
  "serialNumber": "SN-RACK-001",
  "description": "Primary compute rack",
  "nvLinkDomainIds": [
    "59202b81-65fb-45ec-b3b8-91ab0ad3f34a"
  ],
  "taskStats": {
    "pendingTaskCount": 0,
    "activeTaskCount": 0
  },
  "location": {
    "region": "us-east-1",
    "datacenter": "DC-01",
    "room": "Room-A",
    "position": "A1"
  },
  "components": [
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "componentId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
      "type": "Compute",
      "name": "Server-01",
      "serialNumber": "SN-SRV-001",
      "manufacturer": "Dell",
      "firmwareVersion": "2.1.0",
      "slotId": 1,
      "trayIdx": 0,
      "hostId": 0,
      "bmcs": [
        {
          "type": "BmcTypeHost",
          "macAddress": "AA:BB:CC:DD:EE:01",
          "ipAddress": "10.0.0.101"
        }
      ],
      "powerState": "on"
    }
  ]
}

Changes

Changed in 4 of the 90 revisions of this API.5

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

      response-required-property-added

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

      response-optional-property-added

    • ○

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

      response-optional-property-added