New-PveNodesQemuStatusStop

Stop virtual machine. The qemu process will exit immediately. This is akin to pulling the power plug of a running computer and may damage the VM data.

API: POST /nodes/{node}/qemu/{vmid}/status/stop, Proxmox VE API viewer

Aliases: Stop-PveQemu

Syntax

New-PveNodesQemuStatusStop
    [-PveTicket <PveTicket>]
    [-Keepactive <bool>]
    [-Migratedfrom <string>]
    -Node <string>
    [-OverruleShutdown <bool>]
    [-Skiplock <bool>]
    [-Timeout <int>]
    -Vmid <int>
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Keepactive	bool	No	Do not deactivate storage volumes.
-Migratedfrom	string	No	The cluster node name.
-Node	string	Yes	The cluster node name.
-OverruleShutdown	bool	No	Try to abort active ‘qmshutdown’ tasks before stopping.
-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

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.