Machine

Machine power control

Changed on

Execute power control actions for a specific Machine. When an Instance is attached to the Machine, acknowledgeAttachedInstance must be true.

Org must have an Infrastructure Provider entity and own the Site that the Machine belongs to. User must have authorization role with PROVIDER_ADMIN suffix.

patch/v2/org/{org}/nico/machine/{machineId}/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/machine/{machineId}/power
  • Auth
    HTTP bearer

Request body

action'On' | 'GracefulShutdown' | 'ForceOff' | 'GracefulRestart' | 'ForceRestart' | 'ACPowercycle' required

Redfish power control action to apply to the Machine. ACPowercycle is not supported on Viking systems.

acknowledgeAttachedInstanceboolean

Acknowledges that an Instance is currently attached to the Machine and this action may disrupt Tenant workload on the Instance.

Example request

{
  "action": "ForceRestart",
  "acknowledgeAttachedInstance": true
}

Response

Machine power control request was accepted. The message is empty unless Core returns a power-manager warning.

messagestring required

Human-readable outcome of the request

Example response

{
  "message": "Deletion request was accepted"
}

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