Remove-VMReplication
Removes the replication relationship of a virtual machine.
Syntax
Remove-VMReplication
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-VMName] <String[]>
[-ReplicationRelationshipType <VMReplicationRelationshipType>]
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Remove-VMReplication
[-VM] <VirtualMachine[]>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Remove-VMReplication
[-VMReplication] <VMReplication[]>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
The Remove-VMReplication cmdlet 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.
Examples
Example 1
PS C:\> Remove-VMReplication VM01This example removes the replication relationship of virtual machine VM01.
Example 2
PS C:\> Remove-VMReplication *This example removes the replication relationships from all replica-enabled virtual machines on the local Hyper-V host.
Parameters
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
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.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
| Type: | PSCredential[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReplicationRelationshipType
Specifies the replication relationship type of the virtual machine. Specify whether the replication relationship is a simple primary to replica or is an extended replication chain. The cmdlet removes the replication relationship of the virtual machines that have the replication type that you specify.
| Type: | VMReplicationRelationshipType |
| Aliases: | Relationship |
| Accepted values: | Simple, Extended |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VM
Specifies the virtual machine for which the replication relationship is to be removed.
| Type: | VirtualMachine[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMName
Specifies the name of the virtual machine for which the replication relationship is to be removed.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMReplication
Specifies a virtual machine replication object associated with the virtual machine whose replication relationship is to be removed.
| Type: | VMReplication[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
None
Default
VMReplication
If -PassThru is specified.