New-PveNodesQemuStatusShutdown
Shutdown virtual machine. This is similar to pressing the power button on a physical machine. This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.
API: POST /nodes/{node}/qemu/{vmid}/status/shutdown, Proxmox VE API viewer
Aliases: Shutdown-PveQemu
Syntax
Section titled “Syntax”New-PveNodesQemuStatusShutdown [-PveTicket <PveTicket>] [-Forcestop <bool>] [-Keepactive <bool>] -Node <string> [-Skiplock <bool>] [-Timeout <int>] -Vmid <int> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Forcestop |
bool |
No | Make sure the VM stops. |
-Keepactive |
bool |
No | Do not deactivate storage volumes. |
-Node |
string |
Yes | The cluster node name. |
-Skiplock |
bool |
No | Ignore locks - only root is allowed to use this option. |
-Timeout |
int |
No | Wait maximal timeout seconds. |
-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.
