Sign in
Expected Rack Group

Replace all Expected Rack Groups

Deprecated compatibility route. Use PUT /v2/org/{org}/nico/expected-rack-group/all instead. This route preserves the same Site scoping, authorization, validation, response, and mutation semantics during migration.

Replace the full set of Expected Rack Groups for a Site with the provided list. All existing rows for the Site are deleted and the supplied replacement set is created atomically, so response UUIDs may differ from earlier rows even when rackGroupId is unchanged.

Every entry in expectedRackGroups must reference the same siteId as the top-level siteId. The rackGroupId values must be unique within the request. The expectedRackGroups array may be empty to clear all Expected Rack Groups for 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 replace Expected Rack Groups if they have an account with the Site's Infrastructure Provider.

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

Request body

siteIdstring uuid required

ID of the Site whose Expected Rack Groups should be replaced

Example request

{
  "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "expectedRackGroups": [
    {
      "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "rackGroupId": "nvl5-gp1-jhb01",
      "topology": "gb200_nvl72r1_c2g4",
      "racks": [
        {
          "rackId": "rack-01",
          "members": []
        },
        {
          "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.datacenter": "phx-dc01",
        "location.position": "A1"
      }
    },
    {
      "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "rackGroupId": "nvl5-gp2-jhb01",
      "topology": "gb200_nvl72r1_c2g4",
      "racks": [
        {
          "rackId": "rack-03",
          "members": []
        },
        {
          "rackId": "rack-04",
          "members": []
        }
      ],
      "name": "NVL rack group 2",
      "description": "Production NVL rack group in row A",
      "labels": {
        "chassis.manufacturer": "NVIDIA",
        "chassis.serial-number": "NVRK0001002",
        "chassis.model": "GB200-NVL72",
        "location.datacenter": "phx-dc01",
        "location.position": "A2"
      }
    }
  ]
}

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 3 of the 162 revisions of this API.5

  • 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

  • 009b95f8f8a32See the full diff
    • ○

      api operation id replace-all-expected-rack-group removed and replaced with replace-all-expected-rack-group-legacy

      api-operation-id-removed

    • ○

      endpoint deprecated

      endpoint-deprecated

  • cf1b2b20dc451See the full diff
    • ○

      endpoint added

      endpoint-added