Skip to navigation
API ReferenceExpected Machine

Replace all Expected Machines

View as Markdown

Replace the complete Expected Machine set for one Site. Entries omitted from the request are deleted, and entries in the request are created with new REST IDs. The expectedMachines array may be empty to clear the Site’s set.

Every entry must use the top-level siteId. BMC MAC addresses and chassis serial numbers must be unique within the replacement set. Referenced SKUs must exist at the Site.

Org must have an Infrastructure Provider entity and the caller must have Provider Admin access, or the caller must be a Tenant Admin with effective TargetedInstanceCreation access to the 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

Path parameters

orgstringRequired
Name of the Org

Request

This endpoint expects an object.
siteIdstringRequiredformat: "uuid"
ID of the Site whose Expected Machines should be replaced
expectedMachineslist of objectsRequired

Full desired Expected Machine set; BMC MAC addresses and chassis serial numbers must be unique

Response

Expected Machines replaced successfully
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)

interfaceslist of objectsOptional
Expected host NIC declarations in their configured order
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. Returns the effective setting: true when no value is configured. An explicitly configured false value is returned as false.

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
409
Conflict Error