Stop-VMReplication

Cancels an ongoing virtual machine resynchronization.

Syntax

Stop-VMReplication
    [-VMName] <String[]>
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Confirm]
    [-Credential <PSCredential[]>]
    [-Passthru]
    [-ReplicationRelationshipType <VMReplicationRelationshipType>]
    [-WhatIf]
    [<CommonParameters>]
Stop-VMReplication
    [-VM] <VirtualMachine[]>
    [-CimSession <CimSession[]>]
    [-Confirm]
    [-Credential <PSCredential[]>]
    [-Passthru]
    [-ReplicationRelationshipType <VMReplicationRelationshipType>]
    [-WhatIf]
    [<CommonParameters>]
Stop-VMReplication
    [-VMReplication] <VMReplication[]>
    [-CimSession <CimSession[]>]
    [-Confirm]
    [-Credential <PSCredential[]>]
    [-Passthru]
    [-WhatIf]
    [<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 server that runs Hyper-V.

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

-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
Accept pipeline input:False
Accept wildcard characters:False
-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:None
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
-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
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.