Expected Machine

Create Expected Machine

Create an Expected Machine to pre-register Machines expected to be discovered at a Site.

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

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

post/v2/org/{org}/nico/expected-machine

Request body

siteIdstring uuid required

ID of the site the Expected Machine belongs to

bmcMacAddressstring required

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

defaultBmcUsernamestring nullable

Username for accessing the Expected Machine's BMC

defaultBmcPasswordstring nullable

Password for accessing the Expected Machine's BMC

chassisSerialNumberstring required

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). 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 nullable

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

labelsLabels

Example request

{
  "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "bmcMacAddress": "00:1A:2B:3C:4D:5E",
  "bmcIpAddress": "192.168.1.100",
  "defaultBmcUsername": "admin",
  "defaultBmcPassword": "password123",
  "chassisSerialNumber": "CHASSIS-12345",
  "fallbackDPUSerialNumbers": [
    "DPU-001",
    "DPU-002"
  ],
  "skuId": "lenovo.sr650v2.cpu.1",
  "rackId": "rack-01",
  "isDpfEnabled": true,
  "manufacturer": "Lenovo",
  "labels": {
    "environment": "production",
    "rack": "A1"
  }
}

Response

Created

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"
}

Changes

Changed in 8 of the 90 revisions of this API.3616

    • added the new Decommissioning enum value to the machine/status response property for the response status 201

      response-property-enum-value-added

  • 4c29fe59bd4e11See the full diff
    • removed the optional property sku/updated from the response with the 201 status

      response-optional-property-removed

    • the response optional property sku/components/ethernetDevices became read-only for the status 201

      response-optional-property-became-read-only

    • the chassisSerialNumber request property's maxLength was decreased to 32

      request-property-max-length-decreased

    • the defaultBmcPassword request property's maxLength was decreased to 20

      request-property-max-length-decreased

    • the defaultBmcUsername request property's maxLength was decreased to 16

      request-property-max-length-decreased

    • added the optional property sku/components/chassis/architecture to the response with the 201 status

      response-optional-property-added

    • added the optional property sku/components/ethernetDevices/items/isConnected to the response with the 201 status

      response-optional-property-added

    • added the optional property sku/components/infinibandDevices/items/inactiveDevices to the response with the 201 status

      response-optional-property-added

    • added the optional property sku/components/storage/items/maxSizeMiB to the response with the 201 status

      response-optional-property-added

    • added the optional property sku/components/storage/items/minSizeMiB to the response with the 201 status

      response-optional-property-added

    • added the optional property sku/components/storage/items/pciPatterns to the response with the 201 status

      response-optional-property-added

    • added the optional property sku/description to the response with the 201 status

      response-optional-property-added

    • added the optional property sku/schemaVersion to the response with the 201 status

      response-optional-property-added

    • the response optional property sku/components/storage/items/capacityMb became read-only for the status 201

      response-optional-property-became-read-only

    • the response optional property sku/components/storage/items/vendor became read-only for the status 201

      response-optional-property-became-read-only

    • added the new optional request property hostLifecycleProfile

      new-optional-request-property

    • added the optional property hostLifecycleProfile to the response with the 201 status

      response-optional-property-added

    • added the new optional request property isDpfEnabled

      new-optional-request-property

    • added the optional property isDpfEnabled to the response with the 201 status

      response-optional-property-added

    • removed the request property firmwareVersion

      request-property-removed

    • removed the optional property firmwareVersion from the response with the 201 status

      response-optional-property-removed

  • bc7cf73fe60421See the full diff
    • removed the optional property sku/components/tpm/items/count from the response with the 201 status

      response-optional-property-removed

    • removed the optional property sku/components/tpm/items/model from the response with the 201 status

      response-optional-property-removed

    • added the optional property sku/components/tpm/items/version to the response with the 201 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog