Suspend-VMReplication
Suspends replication of a virtual machine.
Syntax
Suspend-VMReplication
[-VMName] <String[]>
[-ComputerName <String[]>]
[-PassThru]
[-Confirm]
[-WhatIf]
Suspend-VMReplication
[-VM] <VirtualMachine[]>
[-PassThru]
[-Confirm]
[-WhatIf]
Suspend-VMReplication
[-VMReplication] <VMReplication[]>
[-PassThru]
[-Confirm]
[-WhatIf]
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.
Parameters
-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: | . |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
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 replication to be suspended.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VM
Specifies the virtual machine whose replication is to be suspended.
Type: | VirtualMachine[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VMName
Specifies the name of the virtual machine whose replication is to be suspended.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-VMReplication
Specifies the virtual machine replication to be suspended.
Type: | VMReplication[] |
Position: | 1 |
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 |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
None
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