New-PveNodesQemuMigrate

Migrate virtual machine. Creates a new migration task.

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

Aliases: Move-PveQemu

Syntax

New-PveNodesQemuMigrate
    [-PveTicket <PveTicket>]
    [-Bwlimit <int>]
    [-Force <bool>]
    [-MigrationNetwork <string>]
    [-MigrationType <string>]
    -Node <string>
    [-Online <bool>]
    -Target <string>
    [-Targetstorage <string>]
    -Vmid <int>
    [-WithConntrackState <bool>]
    [-WithLocalDisks <bool>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Bwlimit	int	No	Override I/O bandwidth limit (in KiB/s).
-Force	bool	No	Allow to migrate VMs which use local devices. Only root may use this option.
-MigrationNetwork	string	No	CIDR of the (sub) network that is used for migration.
-MigrationType	string	No	Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Values: secure, insecure.
-Node	string	Yes	The cluster node name.
-Online	bool	No	Use online/live migration if VM is running. Ignored if VM is stopped.
-Target	string	Yes	Target node.
-Targetstorage	string	No	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.
-Vmid	int	Yes	The (unique) ID of the VM.
-WithConntrackState	bool	No	Whether to migrate conntrack entries for running VMs.
-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

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.