Skip to navigation
API ReferenceExpected Machine

Retrieve all Expected Machines

View as Markdown

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

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

X-PaginationstringOptional
Pagination result in JSON format

Response

OK
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
Stored SKU ID for this Expected Machine, or null when no association is stored. The ID can belong to another Site, including when inventory synchronization imports an entry configured directly in Core.
skuobjectOptional

SKU information included when includeRelation=Sku is specified and the associated SKU belongs to this Expected Machine’s Site. For an association to another Site’s SKU, REST omits sku and returns the stored skuId.

machineIdstring or nullOptional
Stored Machine ID for this Expected Machine, or null when no association is stored. The ID can belong to another Site.
machineobjectOptional

Machine information included when includeRelation=Machine is specified and the associated Machine is found at this Expected Machine’s Site. For an association to another Site’s Machine, REST omits machine and returns the stored machineId.

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
serverNamestring or nullOptional
Optional server name advertised to connected switches in LLDP responses and used for cable validation.
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