Suspend-VMReplication
Suspend-VMReplication
Suspends replication of a virtual machine.
Syntax
Parameter Set: VMName
Suspend-VMReplication [-VMName] <String[]> [-ComputerName <String[]> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMObject
Suspend-VMReplication [-VM] <VirtualMachine[]> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMReplication
Suspend-VMReplication [-VMReplication] <VMReplication[]> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-ComputerName<String[]>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies the virtual machine whose replication is to be suspended.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-VMName<String[]>
Specifies the name of the virtual machine whose replication is to be suspended.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
-VMReplication<VMReplication[]>
Specifies the virtual machine replication to be suspended.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None by default; VMReplication if –PassThru is specified.
Examples
Example 1
Suspends replication of virtual machine VM01.
PS C:\> Suspend-VMReplication VM01
Example 2
Suspends replication of all virtual machines on the local Hyper-V host.
PS C:\> Suspend-VMReplication *