Skip to navigation
API ReferenceExpected Power Shelf

Update Expected Power Shelf

View as Markdown

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.

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
expectedPowerShelfIdstringRequired
ID of the Expected Power Shelf

Request

Expected Power Shelf update request.

Provide defaultBmcUsername, defaultBmcPassword, or both to update BMC credentials. Each supplied value must be non-empty. Omitted credential fields and JSON null preserve the stored values. Credential removal is not supported.

idstring or nullOptionalformat: "uuid"

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.

defaultBmcUsernamestring or nullOptional1-16 characters

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 or nullOptional1-20 characters

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 or nullOptional1-32 characters
Serial number of the Expected Power Shelf
bmcIpAddressstring or nullOptional

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 or nullOptional
Optional rack identifier for this component
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
slotIdinteger or nullOptional
Slot ID within the rack
trayIdxinteger or nullOptional
Tray index within the rack
hostIdinteger or nullOptional
Host ID within the tray
labelsmap from strings to stringsOptional

User-defined key-value pairs for organizing and categorizing Expected Power Shelves

bmcMacAddressstring or nullOptionalformat: "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$"Deprecated

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.

Response

OK
idstringOptionalRead-onlyformat: "uuid"
Unique identifier for the Expected Power Shelf
siteIdstringOptionalRead-onlyformat: "uuid"
ID of the site the Expected Power Shelf belongs to
bmcMacAddressstringOptionalformat: "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$"

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

shelfSerialNumberstringOptional
Serial number of the Expected Power Shelf
bmcIpAddressstring or nullOptional

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

rackIdstring or nullOptional
Optional rack identifier for this component
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
slotIdinteger or nullOptional
Slot ID within the rack
trayIdxinteger or nullOptional
Tray index within the rack
hostIdinteger or nullOptional
Host ID within the tray
labelsmap from strings to stringsOptional

User-defined key-value pairs for organizing and categorizing Expected Power Shelves

createddatetimeOptionalRead-only
ISO 8601 datetime when the Expected Power Shelf was created
updateddatetimeOptionalRead-only
ISO 8601 datetime when the Expected Power Shelf was last updated

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error