Stop-VMFailover
Stop-VMFailover
Stops failover of a virtual machine.
Syntax
Parameter Set: VMName
Stop-VMFailover [-VMName] <String[]> [-AsJob] [-ComputerName <String[]> ] [-PassThru] [ <CommonParameters>]
Parameter Set: VMObject
Stop-VMFailover [-VM] <VirtualMachine[]> [-AsJob] [-PassThru] [ <CommonParameters>]
Detailed Description
The Stop-VMFailover cmdlet stops failover of a virtual machine. If the virtual machine is running, this cmdlet turns the virtual machine off and cancels failover. For a test failover, this cmdlet stops the test failover and deletes the test virtual machine. For a planned failover that has been started on a primary virtual machine, this cmdlet cancels that action and restarts replication, which allows you to start the primary virtual machine.
Parameters
-AsJob
Runs the cmdlet as a background job.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String[]>
Specifies one or more hosts on which to cancel the failover of a virtual machine. 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 a VM object is to be passed through to the pipeline representing the virtual machine on which failover is to be stopped.
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 you want to cancel.
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 you want to cancel.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
<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 example stops failover for a virtual machine named VM01.
PS C:\> Stop-VMFailover VM01
Example 2
This example stops all running failovers for all the virtual machines on the local Hyper-V host.
PS C:\> Stop-VMFailover *