New-PveNodesQemuStatusSuspend
Suspend virtual machine.
API: POST /nodes/{node}/qemu/{vmid}/status/suspend, Proxmox VE API viewer
Aliases: Suspend-PveQemu
Syntax
Section titled “Syntax”New-PveNodesQemuStatusSuspend [-PveTicket <PveTicket>] -Node <string> [-Skiplock <bool>] [-Statestorage <string>] [-Todisk <bool>] -Vmid <int> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Node |
string |
Yes | The cluster node name. |
-Skiplock |
bool |
No | Ignore locks - only root is allowed to use this option. |
-Statestorage |
string |
No | The storage for the VM state. |
-Todisk |
bool |
No | If set, suspends the VM to disk. Will be resumed on next VM start. |
-Vmid |
int |
Yes | The (unique) ID of the VM. |
Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.
Output
Section titled “Output”A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.
