Sign in
Expected Rack Group

Retrieve all Expected Rack Groups

Retrieve all Expected Rack Groups.

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

Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Rack Groups if they have an account with the Site's Infrastructure Provider (siteId query parameter is required for Tenants).

get/v2/org/{org}/nico/expected-rack-group

Query parameters

siteIdstring uuid

ID of the Site to filter Expected Rack Groups by

includeRelation'Site'

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'RACK_GROUP_ID_ASC' | 'RACK_GROUP_ID_DESC' | 'ID_ASC' | 'ID_DESC' | 'SITE_ID_ASC' | 'SITE_ID_DESC' | 'NAME_ASC' | 'NAME_DESC' | 'TOPOLOGY_ASC' | 'TOPOLOGY_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query. Defaults to CREATED_ASC, with ID ascending as the tie-breaker.

Response

OK

idstring uuid

Unique identifier (UUID) for the Expected Rack Group

rackGroupIdstring

Operator-supplied identifier for the rack group (opaque string; UUID syntax is not required). Unique within a Site.

siteIdstring uuid

ID of the Site the Expected Rack Group belongs to

topologystring

External group-level NVLink topology identifier.

namestring

Human-readable name of the Expected Rack Group

descriptionstring

Human-readable description of the Expected Rack Group

labelsLabels

Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.

createdstring date-time

ISO 8601 datetime when the Expected Rack Group was created

updatedstring date-time

ISO 8601 datetime when the Expected Rack Group was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "rackGroupId": "nvl5-gp1-jhb01",
    "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "topology": "gb200_nvl72r1_c2g4",
    "racks": [
      {
        "rackId": "rack-01",
        "members": [
          {
            "type": "NVSwitch",
            "manufacturer": "NVIDIA",
            "id": "switch-01"
          }
        ]
      },
      {
        "rackId": "rack-02",
        "members": []
      }
    ],
    "name": "NVL rack group 1",
    "description": "Production NVL rack group in row A",
    "labels": {
      "chassis.manufacturer": "NVIDIA",
      "chassis.serial-number": "NVRK0001001",
      "chassis.model": "GB200-NVL72",
      "location.region": "us-west-2",
      "location.datacenter": "phx-dc01",
      "location.room": "room-1",
      "location.position": "A1"
    },
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Changes

Changed in 2 of the 162 revisions of this API.3

  • 78f3b35615a52See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • cf1b2b20dc451See the full diff
    • ○

      endpoint added

      endpoint-added