Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
Expected Machine

Update Expected Machine

Update an existing Expected Machine by ID.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Infrastructure Provider must own the Expected Machine.

Alternatively, Tenant Admins with TargetedInstanceCreation capability can also update Expected Machines if they have an account with the Site's Infrastructure Provider.

patch/v2/org/{org}/nico/expected-machine/{expectedMachineId}

Request body

idstring uuid nullable

ID of the Expected Machine to update.

Optional for individual Expected Machine update (ignored if provided, ID from URL path is used).

Required for batch update operations.

bmcMacAddressstring nullable

The Expected Machine's BMC MAC address is immutable after creation. Omit this field, or provide another case/separator spelling of the current MAC as a compatibility no-op.

defaultBmcUsernamestring nullable

Username for accessing the Expected Machine's BMC

defaultBmcPasswordstring nullable

Password for accessing the Expected Machine's BMC

chassisSerialNumberstring nullable

Serial number of the Expected Machine's chassis

fallbackDPUSerialNumbersstring[] nullable

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

skuIdstring nullable

Optional ID of the SKU to associate with this Expected Machine

rackIdstring nullable

Optional rack identifier for this component

bmcIpAddressstring nullable

Optional BMC IP address (IPv4 or IPv6). A non-empty address sets the value and pre-allocates a reserved IP for the BMC. An empty string clears the value. Omission or null preserves the current value.

namestring nullable

Display name for this component

manufacturerstring nullable

Manufacturer of this component

modelstring nullable

Model of this component

descriptionstring nullable

Description of this component

slotIdinteger nullable

Slot ID within the rack

trayIdxinteger nullable

Tray index within the rack

hostIdinteger nullable

Host ID within the tray

isDpfEnabledboolean nullable

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

labelsLabels

Example request

{
  "defaultBmcUsername": "newadmin",
  "defaultBmcPassword": "newpassword123",
  "chassisSerialNumber": "CHASSIS-54321",
  "skuId": "sku-xyz789",
  "rackId": "rack-02",
  "isDpfEnabled": false,
  "manufacturer": "Lenovo",
  "labels": {
    "environment": "staging",
    "rack": "B2"
  }
}

Response

OK

idstring uuid

Unique identifier for the Expected Machine

siteIdstring uuid

ID of the site the Expected Machine belongs to

bmcMacAddressstring

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

chassisSerialNumberstring

Serial number of the Expected Machine's chassis

fallbackDPUSerialNumbersstring[]

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

skuIdstring nullable

Optional ID of the SKU associated with this Expected Machine

machineIdstring nullable

Optional ID of the Machine associated with this Expected Machine

rackIdstring nullable

Optional rack identifier for this component

bmcIpAddressstring nullable

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

namestring nullable

Display name for this component

manufacturerstring nullable

Manufacturer of this component

modelstring nullable

Model of this component

descriptionstring nullable

Description of this component

slotIdinteger nullable

Slot ID within the rack

trayIdxinteger nullable

Tray index within the rack

hostIdinteger nullable

Host ID within the tray

isDpfEnabledboolean

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

labelsLabels
createdstring date-time

ISO 8601 datetime when the Expected Machine was created

updatedstring date-time

ISO 8601 datetime when the Expected Machine was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "bmcMacAddress": "00:1A:2B:3C:4D:5E",
  "bmcIpAddress": "192.168.1.100",
  "chassisSerialNumber": "CHASSIS-12345",
  "fallbackDPUSerialNumbers": [
    "DPU-001",
    "DPU-002"
  ],
  "skuId": "lenovo.sr650v2.cpu.1",
  "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
  "rackId": "rack-01",
  "isDpfEnabled": true,
  "manufacturer": "Lenovo",
  "labels": {
    "environment": "production",
    "rack": "A1"
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}