API ReferenceExpected Machine

Batch Update Expected Machines

View as Markdown
Update multiple Expected Machines in a single request. All machines must belong to the same site. All items in a batch update must provide the same set of fields, except that `bmcIpAddress` may be omitted or set to `null` to preserve that machine's current BMC IP address. Org must have an Infrastructure Provider entity. User must have authorization role with `PROVIDER_ADMIN` suffix. Infrastructure Provider must own the Expected Machines. Alternatively, Tenant Admins with `TargetedInstanceCreation` capability can also update Expected Machines if they have an account with the Site's Infrastructure Provider. Maximum batch size: 100 Expected Machines per request.

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

Array of Expected Machine update requests
idstring or nullOptionalformat: "uuid"

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.

defaultBmcUsernamestring or nullOptional<=20 characters
Username for accessing the Expected Machine's BMC
defaultBmcPasswordstring or nullOptional<=50 characters
Password for accessing the Expected Machine's BMC
chassisSerialNumberstring or nullOptional1-100 characters
Serial number of the Expected Machine's chassis
fallbackDPUSerialNumberslist of strings or nullOptional

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

skuIdstring or nullOptional
Optional ID of the SKU to associate with this Expected Machine
rackIdstring or nullOptional
Optional rack identifier for this component
bmcIpAddressstring or nullOptional

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 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
isDpfEnabledboolean or nullOptional

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

bmcMacAddressstring or nullOptionalformat: "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$"Deprecated

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.

Response

OK
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
bmcIpAddressstring or null

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

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
slotIdinteger or null
Slot ID within the rack
trayIdxinteger or null
Tray index within the rack
hostIdinteger or null
Host ID within the tray
isDpfEnabledboolean

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

labelsmap from strings to strings

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

hostLifecycleProfileobject

Optional per-host lifecycle profile

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
404
Not Found Error