Sign in
Expected Rack Group

Create Expected Rack Group

Create an Expected Rack Group to declare racks and devices at a Site. The rackGroupId is an opaque operator-supplied string identifier (UUID syntax is not required) that uniquely identifies the group within the Site.

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

Alternatively, Tenant Admins with TargetedInstanceCreation capability can also create Expected Rack Groups if they have an account with the Site's Infrastructure Provider.

Chassis identity and physical location information are conveyed via well-known label keys in labels:

  • chassis.manufacturer, chassis.serial-number, chassis.model
  • location.region, location.datacenter, location.room, location.position
post/v2/org/{org}/nico/expected-rack-group

Request body

siteIdstring uuid required

ID of the Site the Expected Rack Group belongs to

rackGroupIdstring required

Operator-supplied identifier for the rack group (opaque string; UUID syntax is not required). Must be non-empty and unique within the Site.

topologystring required

External group-level NVLink topology identifier, non-blank and at most 128 characters.

namestring nullable

ASCII human-readable name, at most 256 characters. An empty string is allowed.

descriptionstring nullable

Human-readable description, at most 1024 UTF-8 bytes. An empty string is allowed.

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.

Example request

{
  "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "rackGroupId": "nvl5-gp1-jhb01",
  "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"
  }
}

Response

Created

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