Retrieve Expected Machine

GET

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

GET

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

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

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

Retrieve a specific Expected Machine by ID.

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

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

Retrieve a specific Expected Machine by ID. Org must have an Infrastructure Provider entity. User must have authorization role with `PROVIDER_ADMIN` or `PROVIDER_VIEWER` suffix. Alternatively, Tenant Admins with `TargetedInstanceCreation` capability can also retrieve Expected Machines if they have an account with the Site's Infrastructure Provider.

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

expectedMachineIdstringRequired

ID of the Expected Machine

Query parameters

includeRelationenumOptional

Related entity to expand

Allowed values:

Response

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

labelsmap from strings to strings

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

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