Stop-VMReplication

Cancels an ongoing virtual machine resynchronization.

Syntax

Stop-VMReplication
    [-ReplicationRelationshipType <VMReplicationRelationshipType>]
    [-ComputerName <String[]>]
    [-VMName] <String[]>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-VMReplication
    [-ReplicationRelationshipType <VMReplicationRelationshipType>]
    [-PassThru]
    [-VM] <VirtualMachine[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-VMReplication
    [-VMReplication] <VMReplication[]>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-VMReplication cmdlet cancels an ongoing virtual machine resynchronization.

Examples

Example 1

PS C:\>Stop-VMReplication *

Stops all ongoing replications of virtual machines on the local Hyper-V server.

Required Parameters

-VM

Specifies the virtual machine whose resychronization is to be stopped.

Type:VirtualMachine[]
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VMName

Specifies the name of the virtual machine whose resynchronization is to be stopped.

Type:String[]
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VMReplication

Specifies the resynchronization to be stopped.

Type:VMReplication[]
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-ComputerName

Specifies one or more Hyper-V hosts on which the ongoing virtual machine resynchronization is to be stopped. 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:.
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
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 on which the ongoing virtual machine resynchronization is to be stopped.

Type:SwitchParameter
Position:Named
Default value:None
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 cancels the ongoing resynchronization of the virtual machines that have the replication type that you specify.

Type:VMReplicationRelationshipType
Aliases:Relationship
Parameter Sets:Simple, Extended
Position:Named
Default value:None
Accept pipeline input:False
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
Accept pipeline input:False
Accept wildcard characters:False

Outputs

None by default; Microsoft.HyperV.PowerShell.VirtualMachine if -PassThru is specified.