Unraid icon

Unraid

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

Actions36

VM → Pause

AI-generated

Summary

Pauses a running virtual machine on an Unraid server by sending a GraphQL vm.pause mutation for the given VM ID. Requires at least the Control level.

Inputs

  • VM ID (required) — Prefixed VM ID of the VM to pause (e.g. vm:abc123). 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 the Unraid credential's limit, never exceed it. Pause needs Control or higher, so Read blocks it with an error before any request is sent.

Output shape

One item per input item with a fixed confirmation object: { id: , operation: "pause", success: true }.

The server's mutation response is discarded, so the output does not report the VM's actual state. Success means the API call did not error. If the API returns GraphQL errors with no data, the node throws. With Continue On Fail enabled, the item instead contains { error: message }.

Examples

Example 1: Pause a VM before a backup window starts.

Resource: VM, Operation: Pause, VM ID: vm:abc123; credential Maximum Control Level set to Control or Full.

Example 2: Pause every VM returned by Get Many.

Run VM > Get Many, then VM > Pause with VM ID set to the expression {{ $json.id }}.

Links

Discussion