New-PveNodesQemuRemoteMigrate

Migrate virtual machine to a remote cluster. Creates a new migration task. EXPERIMENTAL feature!

API: POST /nodes/{node}/qemu/{vmid}/remote_migrate, Proxmox VE API viewer

Syntax

New-PveNodesQemuRemoteMigrate
    [-PveTicket <PveTicket>]
    [-Bwlimit <int>]
    [-Delete <bool>]
    -Node <string>
    [-Online <bool>]
    -TargetBridge <string>
    -TargetEndpoint <string>
    -TargetStorage <string>
    [-TargetVmid <int>]
    -Vmid <int>
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Bwlimit	int	No	Override I/O bandwidth limit (in KiB/s).
-Delete	bool	No	Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state.
-Node	string	Yes	The cluster node name.
-Online	bool	No	Use online/live migration if VM is running. Ignored if VM is stopped.
-TargetBridge	string	Yes	Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value ‘1’ will map each source bridge to itself.
-TargetEndpoint	string	Yes	Remote target endpoint.
-TargetStorage	string	Yes	Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value ‘1’ will map each source storage to itself.
-TargetVmid	int	No	The (unique) ID of the VM.
-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.