Sign in
Expected Power Shelf

Retrieve all Expected Power Shelves

Retrieve all Expected Power Shelves.

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 Power Shelves if they have an account with the Site's Infrastructure Provider (siteId query parameter is required for Tenants).

get/v2/org/{org}/nico/expected-power-shelf

Query parameters

siteIdstring uuid

ID of the Site to filter Expected Power Shelves by

includeRelation'Site'

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'BMC_MAC_ADDRESS_ASC' | 'BMC_MAC_ADDRESS_DESC' | 'SHELF_SERIAL_NUMBER_ASC' | 'SHELF_SERIAL_NUMBER_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

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

Changes

Changed in 2 of the 94 revisions of this API.2

  • c459c6587dee1See the full diff
    • ●

      for the query request parameter pageNumber, the max was set to 21474836.00

      request-parameter-max-set

  • dd48984807881See the full diff
    • ●

      removed the optional property items/firmwareVersion from the response with the 200 status

      response-optional-property-removed