Domain

Retrieve all NVLink Domains

Changed on

Retrieve NVLink Domains for a Flow-enabled Site. Requires an Infrastructure Provider and the PROVIDER_ADMIN role. Set includeComponents=true to include components.

get/v2/org/{org}/nico/domain/nvlink

Request

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

Query parameters

includeComponentsboolean

Include component details in the response.

siteIdstring uuid required

ID of the Site

namestring[]

Filter by Domain name. Repeated values are ORed.

pageNumberinteger

One-indexed page number.

Page number

pageSizeinteger

Number of results per page

orderBy'NAME_ASC' | 'NAME_DESC'

Order by name; immutable Rack UUID ascending breaks ties.

Response

OK

idstring required

Case-sensitive Domain external ID, equal to its rack group ID.

rackGroupIdstring required

Rack group ID, identical to id.

nmxcClusterIdstring uuid nullable required

NMX-C cluster UUID observed on the group's switches. Null when no valid observation is available. Conflicting observations are logged and preserve the last valid cluster without interrupting inventory sync.

namestring required

Domain display name. Empty for newly inventory-created Domains; inventory sync preserves existing names.

topologystring nullable required

Common member-rack profile ID without the qualified vendor and optional _NO_POWERSHELF suffix. Null when unavailable, unrecognized, or inconsistent across member racks.

operationStatusstring required

Operability phase aggregated across member racks, not the Core lifecycle state.

Example response

[
  {
    "id": "group-01",
    "rackGroupId": "group-01",
    "nmxcClusterId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
    "name": "",
    "topology": "GB200_NVL72R1_C2G4",
    "operationStatus": "Ready",
    "components": []
  }
]

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

    • info

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

  • 0b2823e8f92bRevision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status