Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
Expected Power Shelf

Update Expected Power Shelf

Update an existing Expected Power Shelf by ID.

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

Infrastructure Provider must own the Expected Power Shelf.

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

patch/v2/org/{org}/nico/expected-power-shelf/{expectedPowerShelfId}

Request body

idstring uuid nullable

ID of the Expected Power Shelf to update (ignored for single update, used for identification in batch operations).

bmcMacAddressstring nullable

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

defaultBmcUsernamestring nullable

Username for accessing the Expected Power Shelf's BMC

defaultBmcPasswordstring nullable

Password for accessing the Expected Power Shelf's BMC

shelfSerialNumberstring nullable

Serial number of the Expected Power Shelf

bmcIpAddressstring nullable

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

rackIdstring nullable

Optional rack identifier for this component

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

labelsLabels

Example request

{
  "defaultBmcUsername": "newadmin",
  "defaultBmcPassword": "newpassword123",
  "shelfSerialNumber": "SHELF-54321",
  "bmcIpAddress": "192.168.1.200",
  "rackId": "rack-02",
  "manufacturer": "Delta",
  "labels": {
    "environment": "staging",
    "rack": "B2"
  }
}

Response

OK

idstring uuid

Unique identifier for the Expected Power Shelf

siteIdstring uuid

ID of the site the Expected Power Shelf belongs to

bmcMacAddressstring

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

shelfSerialNumberstring

Serial number of the Expected Power Shelf

bmcIpAddressstring nullable

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

rackIdstring nullable

Optional rack identifier for this component

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

labelsLabels
createdstring date-time

ISO 8601 datetime when the Expected Power Shelf was created

updatedstring date-time

ISO 8601 datetime when the Expected Power Shelf was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "bmcMacAddress": "00:1A:2B:3C:4D:5E",
  "shelfSerialNumber": "SHELF-12345",
  "bmcIpAddress": "192.168.1.100",
  "rackId": "rack-01",
  "manufacturer": "Delta",
  "labels": {
    "environment": "production",
    "rack": "A1"
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}