Stop-VMInitialReplication
Stops an ongoing initial replication.
Syntax
Stop-VMInitialReplication
[-ComputerName <String[]>]
[-VMName] <String[]>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Stop-VMInitialReplication
[-VMReplication] <VMReplication[]>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Stop-VMInitialReplication
[-PassThru]
[-VM] <VirtualMachine[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Stop-VMInitialReplication cmdlet stops an ongoing initial replication that uses either a virtual machine restored from backup or the network. It does not stop an initial replication that uses external media. For an initial replication that uses external media, you can use this cmdlet to stop the export, which returns the virtual machine to a pending state. After an export is finished, the initial replication cannot be stopped.
Examples
Example 1
PS C:\> Stop-VMInitialReplication VM01
This example stops initial replication of a virtual machine named VM01.
Example 2
PS C:\>Stop-VMInitialReplication *
This example stops initial replication of all virtual machines whose initial replication is in progress on the local Replica server.
Parameters
-ComputerName
Specifies one or more Hyper-V hosts on which an ongoing initial replication 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: | . |
Required: | False |
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 |
Required: | 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 whose initial replication is to be stopped.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VM
Specifies the virtual machine whose initial replication is to be stopped.
Type: | VirtualMachine[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VMName
Specifies the name of the virtual machine whose initial replication is to be stopped.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VMReplication
Specifies the virtual machine replication to be stopped.
Type: | VMReplication[] |
Position: | 0 |
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 |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
None by default; Microsoft.HyperV.PowerShell.VirtualMachine if -PassThru is specified.