Stop-PveGuest

Stop VM/CT immediately; with -Shutdown, shut it down cleanly through the guest operating system (ACPI or guest agent for a VM).

Explained with examples in this guide.

Aliases: Stop-PveVm

Syntax

Stop-PveGuest
    [-PveTicket <PveTicket>]
    -VmIdOrName <string>
    -Shutdown
    [-Timeout <int>]
    [-ForceStop]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Pipeline	Description
-PveTicket	PveTicket	No	By value, by property name	Ticket data connection.
-VmIdOrName	string	Yes	By value, by property name	VM/CT, the selection of Get-PveGuest (id, name, range, @node-, @pool-, @tag-…).
-Shutdown	switch	Yes	No	Shut down cleanly through the guest operating system instead of stopping immediately.
-Timeout	int	No	No	With -Shutdown: seconds the guest has to shut down.
-ForceStop	switch	No	No	With -Shutdown: stop the guest if it has not shut down within Timeout.

Output

PveResponse. Return response, one per VM/CT.

Example

Stop-PveGuest -VmIdOrName web01 -Shutdown -Timeout 60 -ForceStop