New-PveClusterBulkActionGuestMigrate
Bulk migrate all guests on the cluster.
API: POST /cluster/bulk-action/guest/migrate, Proxmox VE API viewer
Syntax
Section titled “Syntax”New-PveClusterBulkActionGuestMigrate [-PveTicket <PveTicket>] [-MaxWorkers <int>] [-Maxworkers2 <int>] [-Online <bool>] -Target <string> [-Vms <array>] [-WithLocalDisks <bool>] [<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. |
-Online |
bool |
No | Enable live migration for VMs and restart migration for CTs. |
-Target |
string |
Yes | Target node. |
-Vms |
array |
No | Only consider guests from this list of VMIDs. |
-WithLocalDisks |
bool |
No | Enable live storage migration for local disk. |
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.
