Suspend-VMReplication

Suspends replication of a virtual machine.

Syntax

Suspend-VMReplication
       [-VMName] <String[]>
       [-CimSession <CimSession[]>]
       [-ComputerName <String[]>]
       [-Confirm]
       [-Credential <PSCredential[]>]
       [-Passthru]
       [-ReplicationRelationshipType <VMReplicationRelationshipType>]
       [-WhatIf]
       [<CommonParameters>]
Suspend-VMReplication
       [-VM] <VirtualMachine[]>
       [-Confirm]
       [-Passthru]
       [-WhatIf]
       [<CommonParameters>]
Suspend-VMReplication
       [-VMReplication] <VMReplication[]>
       [-Confirm]
       [-Passthru]
       [-WhatIf]
       [<CommonParameters>]

Description

The Suspend-VMReplication cmdlet suspends, or pauses, replication of a virtual machine. To resume replication, use the Resume-VMReplication cmdlet to resume replication. When replication is resumed, all changes made since replication was suspended will be replicated.

Examples

Example 1

PS C:\> Suspend-VMReplication VM01

Suspends replication of virtual machine VM01.

Example 2

PS C:\> Suspend-VMReplication *

Suspends replication of all virtual machines on the local Hyper-V host.

Required Parameters

-VM

Specifies the virtual machine whose replication is to be suspended.

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 replication is to be suspended.

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

Specifies the virtual machine replication to be suspended.

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 replication of a virtual machine is to be suspended. 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 a VMReplication object is to be passed through to the pipeline representing the replication to be suspended.

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 suspends replication 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; VMReplication if PassThru is specified.