Domain

Power control NVLink Domains

Changed on

Power control one or more NVLink Domains identified by their case-sensitive IDs.

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/domain/nvlink/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/domain/nvlink/power
  • Auth
    HTTP bearer

Request body

siteIdstring uuid required

ID of the Site

domainIdsstring[] required

Nonblank, case-sensitive IDs of the NVLink Domains to power control. Exact duplicate IDs are rejected.

state'On' | 'Off' | 'Cycle' | 'ForceOff' | 'ForceCycle' | 'ACPowerCycle' | 'on' | 'off' | 'cycle' | 'forceoff' | 'forcecycle' | 'acpowercycle' required

Target power state. Exact lowercase forms are also accepted for compatibility.

ruleIdstring uuid

Optional Operation Rule UUID. When set, pins every task spawned by 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",
  "domainIds": [
    "650e8400-e29b-41d4-a716-446655440001",
    "750e8400-e29b-41d4-a716-446655440002"
  ],
  "state": "Cycle"
}

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

    • 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

  • 51b54c5d58d1Revision changes
    • breaking

      the / request property's minLength was increased from 0 to 1

    • breaking

      added the pattern \S to the request property /

    • info

      the / request property format was generalized from uuid to no format