Unraid icon

Unraid

Interact with the Unraid API — manage Docker containers, VMs, array health, disks, notifications, and system metrics

Actions36

VM → Force Stop

AI-generated

Summary

Force-stops (hard powers off) a virtual machine on an Unraid server via the Unraid GraphQL API. Classified destructive, so it requires the Full control level.

Inputs

  • VM ID (required) — Prefixed VM ID (e.g. vm:abc123) of the VM to force-stop. Use the VM Get Many operation to find IDs.
  • Maximum Control Level — Caps what this node may do: Use Credential Default (default), Read, Control, or Full. It can only narrow below the Unraid credential's limit, never exceed it. Force Stop needs an effective level of Full, otherwise the operation errors before contacting the server.

Output shape

One item per input item: { id: , operation: "forceStop", success: true }.

The mutation's own return value isn't used, so the output only confirms the API call didn't error and does not report the VM's resulting state. A GraphQL error with no data throws a NodeApiError. A control-level failure throws a NodeOperationError. With Continue On Fail enabled, an item that fails returns { error: message } instead.

Examples

Example 1: Kill a hung VM that ignores graceful shutdown

Resource: VM, Operation: Force Stop, VM ID: vm:abc123; the Unraid credential's Maximum Control Level set to Full.

Example 2: Force-stop a VM chosen from an upstream VM Get Many node

VM ID set to the expression {{ $json.id }}; Maximum Control Level on the node left as Use Credential Default.

Links

Discussion