Retrieve all Expected Machines

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/expected-machine

GET

/v2/org/:org/nico/expected-machine

curl https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/expected-machine \
     -H "Authorization: Bearer <token>"

[
  {
    "id": "string",
    "siteId": "string",
    "bmcMacAddress": "string",
    "chassisSerialNumber": "string",
    "fallbackDPUSerialNumbers": [
      "string"
    ],
    "skuId": "string",
    "sku": {
      "id": "lenovo.sr650v2.cpu.1",
      "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
      "description": "Lenovo SR650 V2 compute node",
      "schemaVersion": 5,
      "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"
    },
    "machineId": "string",
    "machine": {
      "id": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
      "controllerMachineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
      "controllerMachineType": "x86_64",
      "hwSkuDeviceType": "cpu",
      "vendor": "Lenovo",
      "productName": "ThinkSystem SR670 V2",
      "maintenanceMessage": null,
      "status": "Ready"
    },
    "rackId": "string",
    "bmcIpAddress": "string",
    "name": "string",
    "manufacturer": "string",
    "model": "string",
    "description": "string",
    "slotId": 1,
    "trayIdx": 1,
    "hostId": 1,
    "isDpfEnabled": true,
    "labels": {},
    "hostLifecycleProfile": {
      "disableLockdown": true
    },
    "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 authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

Alternatively, Tenant Admins may retrieve Expected Machines across Sites where TargetedInstanceCreation is effective. The siteId query parameter is optional and, when provided, further restricts results to that Site.

Retrieve all Expected Machines. Org must have an Infrastructure Provider entity. User must have authorization role with `PROVIDER_ADMIN` or `PROVIDER_VIEWER` suffix. Alternatively, Tenant Admins may retrieve Expected Machines across Sites where `TargetedInstanceCreation` is effective. The siteId query parameter is optional and, when provided, further restricts results to that Site.

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

``` 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

siteIdstringOptionalformat: "uuid"

ID of the Site to filter Expected Machines by

includeRelationenumOptional

Related entity to expand

Allowed values:

pageNumberintegerOptional1-21474836

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringOptionalRead-onlyformat: "uuid"

Unique identifier for the Expected Machine

siteIdstringOptionalRead-onlyformat: "uuid"

ID of the site the Expected Machine belongs to

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

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

chassisSerialNumberstringOptional

Serial number of the Expected Machine's chassis

fallbackDPUSerialNumberslist of stringsOptional

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

skuIdstring or nullOptional

Optional ID of the SKU associated with this Expected Machine

skuobjectOptional

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

machineIdstring or nullOptional

Optional ID of the Machine associated with this Expected Machine

machineobjectOptional

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

rackIdstring or nullOptional

Optional rack identifier for this component

bmcIpAddressstring or nullOptional

Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

namestring or nullOptional

Display name for this component

manufacturerstring or nullOptional

Manufacturer of this component

modelstring or nullOptional

Model of this component

descriptionstring or nullOptional

Description of this component

slotIdinteger or nullOptional

Slot ID within the rack

trayIdxinteger or nullOptional

Tray index within the rack

hostIdinteger or nullOptional

Host ID within the tray

isDpfEnabledbooleanOptional

When true, this host is eligible for DPF-based provisioning.

labelsmap from strings to stringsOptional

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

hostLifecycleProfileobjectOptional

Optional per-host lifecycle profile

createddatetimeOptionalRead-only

ISO 8601 datetime when the Expected Machine was created

updateddatetimeOptionalRead-only

ISO 8601 datetime when the Expected Machine was last updated

Errors

400

Bad Request Error

403

Forbidden Error