Expected Power Shelf

Update Expected Power Shelf

Changed on

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

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/expected-power-shelf/{expectedPowerShelfId}
  • Auth
    HTTP bearer

Request body

idstring uuid nullable

ID of the Expected Power Shelf to update.

For single updates, omit id or set it to null to use the ID from the URL path. A non-null body id must match the URL ID and use lowercase, hyphenated UUID format. Otherwise, REST returns HTTP 400.

bmcMacAddressstring nullable

Immutable MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller). Omit this field when updating. A formatting-equivalent value is accepted for compatibility and preserves the originally stored spelling, but changing the physical MAC address is rejected with HTTP 400.

defaultBmcUsernamestring nullable

Username for accessing the Expected Power Shelf's BMC. Omission or null preserves the value. A non-empty value can be supplied without defaultBmcPassword.

defaultBmcPasswordstring nullable

Password for accessing the Expected Power Shelf's BMC. Omission or null preserves the value. A non-empty value can be supplied without defaultBmcUsername.

shelfSerialNumberstring nullable

Serial number of the Expected Power Shelf

bmcIpAddressstring nullable

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. It must not be unspecified, multicast, or IPv4 limited broadcast.

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

Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.

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

Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.

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

Changes

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      added the non-success response with the status