Expected Rack

Create Expected Rack

Changed on

Create an Expected Rack to pre-register a rack expected to be discovered at a Site. The rackId is an operator-supplied string identifier (not a UUID) that uniquely identifies the rack 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 Racks 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

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/expected-rack
  • Auth
    HTTP bearer

Request body

siteIdstring uuid required

ID of the Site the Expected Rack belongs to

rackIdstring required

Operator-supplied identifier for the rack (string, not UUID). Must be non-empty and unique within the Site.

rackProfileIdstring

Ignored compatibility field. Core derives the profile from the matching ExpectedRackGroup; omit this field.

namestring nullable

Human-readable name of the Expected Rack

descriptionstring nullable

Human-readable description of the Expected Rack

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",
  "rackId": "rack-01",
  "name": "Rack 01",
  "description": "Production rack 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

rackIdstring

Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

siteIdstring uuid

ID of the Site the Expected Rack belongs to

rackProfileIdstring

Identifier of the Rack Profile this rack conforms to

rackGroupIdstring nullable

External rack group ID selected and persisted at creation together with rackProfileId. Null for legacy rows without a recorded group; metadata updates preserve it.

namestring

Human-readable name of the Expected Rack

descriptionstring

Human-readable description of the Expected Rack

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 was created

updatedstring date-time

ISO 8601 datetime when the Expected Rack was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "rackId": "rack-01",
  "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "rackProfileId": "rp-standard-42u",
  "name": "Rack 01",
  "description": "Production rack 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

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 4a2b5e050a2eRevision changes
    • info

      added the non-success response with the status