Complete-VMFailover

Article
11/23/2015

Complete-VMFailover

Completes a virtual machine’s failover process on the Replica server. Removes all recovery points on a failed over virtual machine.

Syntax

Parameter Set: VMName
Complete-VMFailover [-VMName] <String[]> [-ComputerName <String[]> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Complete-VMFailover [-VM] <VirtualMachine[]> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Complete-VMFailover cmdlet completes a virtual machine’s failover process on the Replica server. The recovery point, on which the virtual machine is failed over, is committed and all other recovery points are removed. Failover cannot be canceled after the recovery points are removed.

Parameters

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which the failover process is to be completed. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.

Aliases	none
Required?	false
Position?	named
Default Value	.
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PassThru

Specifies that an object is to be passed through to the pipeline representing the virtual machine whose failover process is to be completed.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VM<VirtualMachine[]>

Specifies the virtual machine whose failover process is to be completed.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-VMName<String[]>

Specifies the name of the virtual machine whose failover process is to be completed.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	true

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

None by default; Microsoft.Virtualization.Powershell.VirtualMachine if –PassThru is specified.

Examples

Example 1

This command completes the failover process of a virtual machine named VM01, thereby deleting all other recovery points on the server.

PS C:\> Complete-VMFailover VM01

Example 2

This command completes the failover process of all virtual machines on the local host for which the failover process has been started.

PS C:\> Complete-VMFailover *

Complete-VMFailover