New-PveClusterBulkActionGuestSuspend
Bulk suspend all guests on the cluster.
API: POST /cluster/bulk-action/guest/suspend, Proxmox VE API viewer
Syntax
Section titled “Syntax”New-PveClusterBulkActionGuestSuspend [-PveTicket <PveTicket>] [-MaxWorkers <int>] [-Maxworkers2 <int>] [-Statestorage <string>] [-ToDisk <bool>] [-Vms <array>] [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-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. |
-Statestorage |
string |
No | The storage for the VM state. |
-ToDisk |
bool |
No | If set, suspends the guests to disk. Will be resumed on next start. |
-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.
