Retrieve all Expected Machines | NVIDIA Infra Controller

curl https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/expected-machine \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    "chassisSerialNumber": "CHASSIS-12345",
    "fallbackDPUSerialNumbers": [
      "DPU-001",
      "DPU-002"
    ],
    "skuId": "lenovo.sr650v2.cpu.1",
    "sku": {
      "id": "lenovo.sr650v2.cpu.1",
      "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
      "deviceType": "gpu",
      "associatedMachineIds": [
        "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g"
      ],
      "components": {
        "cpus": [
          {
            "vendor": "Intel",
            "model": "Xeon Platinum 8480+",
            "threadCount": 112,
            "count": 2
          }
        ],
        "gpus": [
          {
            "vendor": "NVIDIA",
            "model": "H100 SXM5",
            "totalMemory": "80GB HBM3",
            "count": 8
          }
        ],
        "memory": [
          {
            "capacityMb": 65536,
            "memoryType": "DDR5",
            "count": 16
          }
        ],
        "storage": [
          {
            "vendor": "Samsung",
            "model": "PM9A3",
            "capacityMb": 7680000,
            "count": 4
          }
        ],
        "chassis": {
          "vendor": "Supermicro",
          "model": "SYS-420GP-TNR"
        }
      },
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    },
    "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
    "machine": {
      "id": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
      "controllerMachineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
      "controllerMachineType": "x86_64",
      "hwSkuDeviceType": "cpu",
      "vendor": "Lenovo",
      "productName": "ThinkSystem SR670 V2",
      "maintenanceMessage": null,
      "status": "Ready"
    },
    "rackId": "rack-01",
    "name": "Prod Server 01",
    "manufacturer": "Lenovo",
    "model": "ThinkSystem SR670 V2",
    "description": "Primary production server in rack A1",
    "firmwareVersion": "1.2.3",
    "slotId": 12,
    "trayIdx": 2,
    "hostId": 5,
    "labels": {
      "environment": "production",
      "rack": "A1"
    },
    "created": "2024-01-15T09:30:00Z",
    "updated": "2024-01-15T09:30:00Z"
  }
]

Retrieve all Expected Machines.

Org must have an Infrastructure Provider entity. User must have FORGE_PROVIDER_ADMIN or FORGE_PROVIDER_VIEWER role.

Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Machines if they have an account with the Site’s Infrastructure Provider (siteId query parameter is required for Tenants).

Retrieve all Expected Machines. Org must have an Infrastructure Provider entity. User must have `FORGE_PROVIDER_ADMIN` or `FORGE_PROVIDER_VIEWER` role. Alternatively, Tenant Admins with `TargetedInstanceCreation` capability can also retrieve Expected Machines if they have an account with the Site's Infrastructure Provider (siteId query parameter is required for Tenants).

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current

``` 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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

Query parameters

siteIdstringOptionalformat: "uuid"

ID of the Site to filter Expected Machines by

includeRelationenumOptional

Related entity to expand

Allowed values:

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringRead-onlyformat: "uuid"

Unique identifier for the Expected Machine

siteIdstringRead-onlyformat: "uuid"

ID of the site the Expected Machine belongs to

bmcMacAddressstringformat: "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$"

MAC address of the Expected Machine’s BMC (Baseboard Management Controller)

chassisSerialNumberstring

Serial number of the Expected Machine's chassis

fallbackDPUSerialNumberslist of strings

Serial numbers of the Expected Machine’s fallback DPUs (Data Processing Units)

skuIdstring or null

Optional ID of the SKU associated with this Expected Machine

skuobject

SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

machineIdstring or null

Optional ID of the Machine associated with this Expected Machine

machineobject

Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

rackIdstring or null

Optional rack identifier for this component

namestring or null

Display name for this component

manufacturerstring or null

Manufacturer of this component

modelstring or null

Model of this component

descriptionstring or null

Description of this component

firmwareVersionstring or null

Firmware version of this component

slotIdinteger or null

Slot ID within the rack

trayIdxinteger or null

Tray index within the rack

hostIdinteger or null

Host ID within the tray

labelsmap from strings to strings

User-defined key-value pairs for organizing and categorizing Expected Machines

createddatetimeRead-only

ISO 8601 datetime when the Expected Machine was created

updateddatetimeRead-only

ISO 8601 datetime when the Expected Machine was last updated

Errors

400

Bad Request Error

403

Forbidden Error