Remove-VMReplication
Removes the replication relationship of a virtual machine.
Syntax
Remove-VMReplication
[-ReplicationRelationshipType <VMReplicationRelationshipType>]
[-ComputerName <String[]>]
[-VMName] <String[]>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-VMReplication
[-ReplicationRelationshipType <VMReplicationRelationshipType>]
[-PassThru]
[-VM] <VirtualMachine[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-VMReplication
[-VMReplication] <VMReplication[]>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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.
Examples
Example 1
PS C:\> Remove-VMReplication VM01
This 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
-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: | . |
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 |
-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 by default; VMReplication if -PassThru is specified.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for