Remove-VMReplication
Remove-VMReplication
Removes the replication relationship of a virtual machine.
Syntax
Parameter Set: VMName
Remove-VMReplication [-VMName] <String[]> [-ComputerName <String[]> ] [-PassThru] [ <CommonParameters>]
Parameter Set: VMObject
Remove-VMReplication [-VM] <VirtualMachine[]> [-PassThru] [ <CommonParameters>]
Parameter Set: VMReplication
Remove-VMReplication [-VMReplication] <VMReplication[]> [-PassThru] [ <CommonParameters>]
Detailed Description
The Remove-VMReplication removes the replication relationship of a virtual machine. Replication must be removed independently from both the primary and Replica virtual machines. Removing replication on a Replica virtual machine does not delete the Replica virtual machine.
Parameters
-ComputerName<String[]>
Specifies one or more Hyper-V hosts on which the replication relationship of a virtual machine is to be removed. 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 VMReplication object is to be passed through to the pipeline representing the virtual machine for which the replication relationship will be removed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies the virtual machine for which the replication relationship is to be removed.
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 for which the replication relationship is to be removed.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
-VMReplication<VMReplication[]>
Specifies a virtual machine replication object associated with the virtual machine whose replication relationship is to be removed.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
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; VMReplication if –PassThru is specified.
Examples
Example 1
This example removes the replication relationship of virtual machine VM01.
PS C:\> Remove-VMReplication VM01
Example 2
This example removes the replication relationships from all replica-enabled virtual machines on the local Hyper-V host.
PS C:\> Remove-VMReplication *