Sign in
Tray

Power control a Tray

Power control a Tray identified by Tray UUID.

Supported power states: on, off, cycle, forceoff, forcecycle.

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

patch/v2/org/{org}/nico/tray/{id}/power

Request body

siteIdstring uuid required

ID of the Site

state'on' | 'off' | 'cycle' | 'forceoff' | 'forcecycle' required

Power control state to apply:

  • on: Power on the target(s)
  • off: Graceful power off
  • cycle: Graceful power cycle (restart)
  • forceoff: Forced power off (immediate)
  • forcecycle: Forced power cycle (immediate restart)
ruleIdstring uuid

Optional Operation Rule UUID. When set, pins this operation to the named rule and overrides Flow's default rule resolution.

overrideReadinessCheckboolean

When true, proceed even if one or more target components (or hosts on the owning rack for rack-scoped components) are reported as not ready by their persisted status. Intended for operator-supervised maintenance.

Example request

{
  "siteId": "550e8400-e29b-41d4-a716-446655440000",
  "state": "on"
}

Response

OK

taskIdsstring[]

List of task IDs created for the power control operation (one per rack)

Example response

{
  "taskIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

Changes

Changed in 3 of the 90 revisions of this API.3