Retrieve all NVLink Domains

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/domain/nvlink

GET

/v2/org/:org/nico/domain/nvlink

curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/domain/nvlink \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d siteId=siteId

[
  {
    "id": "group-42",
    "rackGroupId": "group-42",
    "nmxcClusterId": "a3f1c9d2-7b4e-4f8a-9c3d-2e5b7f9a1c6d",
    "name": "NVLink Domain Alpha",
    "topology": "GB300_NVL96R2_C4G8",
    "operationStatus": "Ready",
    "components": [
      {
        "health": {
          "source": "aggregate-host-health",
          "observedAt": "2024-06-10T12:00:00Z",
          "successes": [
            {
              "id": "FanSpeed",
              "target": "System Board Fan1A"
            },
            {
              "id": "PowerSupply",
              "target": "PS1 Status"
            }
          ],
          "alerts": [
            {
              "id": "FailedValidationTest",
              "target": "DcgmFullShort",
              "inAlertSince": "2024-06-09T08:30:00Z",
              "message": "Failed validation test",
              "tenantMessage": null,
              "classifications": [
                "PreventAllocations"
              ]
            }
          ]
        },
        "id": "comp-1001",
        "rackId": "rack-21",
        "type": "NVSwitch",
        "name": "NVSwitch-21A",
        "serialNumber": "SN1234567890",
        "manufacturer": "NVIDIA",
        "model": "NVSwitch-X2",
        "description": "{\"ports\": 36, \"speed\": \"200Gbps\"}",
        "firmwareVersion": "v1.4.3",
        "slotId": 3,
        "trayIdx": 1,
        "hostId": 101,
        "bmcs": [
          {
            "type": "BmcTypeHost",
            "macAddress": "00:1A:2B:3C:4D:5E",
            "ipAddress": "192.168.10.21"
          }
        ],
        "powerState": "On",
        "operationStatus": "Ready",
        "leakStatus": "NoLeak",
        "leakHandlingStatus": "None"
      }
    ]
  }
]

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

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"

# Example org name: "acme-inc
export ORG_NAME=<org-name>

# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

Path parameters

orgstringRequired

Name of the Org

Query parameters

includeComponentsbooleanOptionalDefaults to false

Include component details in the response.

siteIdstringRequiredformat: "uuid"

ID of the Site

namelist of stringsOptional

Filter by Domain name. Repeated values are ORed.

pageNumberintegerOptional1-21474836

Page number

pageSizeintegerOptional1-100Defaults to 20

Number of results per page

orderByenumOptionalDefaults to NAME_ASC

Order by name; immutable Rack UUID ascending breaks ties.

Allowed values:

Response headers

Response

idstring

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

rackGroupIdstring

Rack group ID, identical to id.

nmxcClusterIdstring or nullformat: "uuid"

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

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

topologystring or null

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

operationStatusstring

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

componentslist of objects or null

Components belonging to this Domain. Null when includeComponents is false; an empty array when requested but none are known.

Errors

400

Bad Request Error

403

Forbidden Error

412

Precondition Failed Error

504

Gateway Timeout Error