Unraid icon

Unraid

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

Actions36

VM → Stop

AI-generated

Summary

Gracefully stops a virtual machine on an Unraid server by sending the VM stop GraphQL mutation for the given VM ID.

Inputs

  • VM ID (required) — Prefixed VM ID (e.g. vm:abc123) of the VM to stop. Use the VM Get Many operation to find IDs.
  • Maximum Control Level — Optional cap on what this node may do (Use Credential Default, Read, Control, Full). It can only narrow the credential's limit, never raise it. Stop is a 'control' operation, so the effective level must be Control or Full. If it is Read, the node errors before contacting the server.

Output shape

One item per input item, with json {id: , operation: 'stop', success: true}.

The mutation's own response is not returned, only this confirmation object. The mutation returns when the stop request is sent, so the VM may not have finished shutting down. Errors from the Unraid API, or a control-level denial, throw an error. If Continue On Fail is enabled, they are returned as {error: message}.

Examples

Example 1: Shut down a VM at the end of a nightly maintenance workflow.

Resource: VM, Operation: Stop, VM ID: vm:abc123. The credential's Maximum Control Level is Control or Full.

Example 2: Let an AI Agent stop VMs but not force-stop or delete them.

Use the node as an agent tool with Maximum Control Level set to Control and VM ID supplied by the agent or an expression.

Links

Discussion