New-PveClusterBulkActionGuestShutdown
Bulk shutdown all guests on the cluster.
API: POST /cluster/bulk-action/guest/shutdown, Proxmox VE API viewer
Syntax
Section titled “Syntax”New-PveClusterBulkActionGuestShutdown [-PveTicket <PveTicket>] [-ForceStop <bool>] [-MaxWorkers <int>] [-Maxworkers2 <int>] [-Timeout <int>] [-Vms <array>] [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-ForceStop |
bool |
No | Makes sure the Guest stops after the timeout. |
-MaxWorkers |
int |
No | Defines the maximum number of tasks running concurrently. |
-Maxworkers2 |
int |
No | Defines the maximum number of tasks running concurrently. Deprecated, use ‘max-workers’ instead. |
-Timeout |
int |
No | Default shutdown timeout in seconds if none is configured for the guest. |
-Vms |
array |
No | Only consider guests from this list of VMIDs. |
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.
