New-PveNodesLxcStatusShutdown

Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.

API: POST /nodes/{node}/lxc/{vmid}/status/shutdown, Proxmox VE API viewer

Aliases: Shutdown-PveLxc

Syntax

New-PveNodesLxcStatusShutdown
    [-PveTicket <PveTicket>]
    [-Forcestop <bool>]
    -Node <string>
    [-Timeout <int>]
    -Vmid <int>
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Forcestop	bool	No	Make sure the Container stops.
-Node	string	Yes	The cluster node name.
-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.