Tray

Power control a Tray

Changed on

Power control a Tray identified by its component ID or component MAC address.

Supported power states: On, Off, Cycle, ForceOff, ForceCycle, ACPowerCycle. Exact lowercase forms remain accepted for compatibility. ACPowerCycle removes and restores AC power and is unsupported on Viking systems.

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

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

Request body

siteIdstring uuid required

ID of the Site

state'On' | 'Off' | 'Cycle' | 'ForceOff' | 'ForceCycle' | 'ACPowerCycle' | 'on' | 'off' | 'cycle' | 'forceoff' | 'forcecycle' | 'acpowercycle' 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)
  • ACPowerCycle: Remove and restore AC power (unsupported on Viking systems)

Exact lowercase forms are also accepted for compatibility.

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

  • 293dc126ab73Revision 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

  • 78f3b35615a5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status