API ReferenceTray

Power control a Tray

View as Markdown

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.

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
idstringRequiredformat: "uuid"
ID of the Tray

Request

This endpoint expects an object.
siteIdstringRequiredformat: "uuid"
ID of the Site
stateenumRequired

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)
ruleIdstringOptionalformat: "uuid"
Optional Operation Rule UUID. When set, pins this operation to the named rule and overrides Flow's default rule resolution.
overrideReadinessCheckbooleanOptionalDefaults to false

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.

Response

OK
taskIdslist of strings

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

Errors

400
Bad Request Error
403
Forbidden Error