Skip to navigation
API ReferenceRack

Power control a Rack

View as Markdown

Power control a Rack identified by its Rack ID.

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.

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
idstringRequired
ID of the Rack

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)
  • ACPowerCycle: Remove and restore AC power (unsupported on Viking systems)

Exact lowercase forms are also accepted for compatibility.

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 stringsOptional

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

Errors

400
Bad Request Error
403
Forbidden Error
504
Gateway Timeout Error