Start-VMInitialReplication
Start-VMInitialReplication
Starts replication of a virtual machine.
Syntax
Parameter Set: VMName
Start-VMInitialReplication [-VMName] <String[]> [-AsJob] [-ComputerName <String[]> ] [-DestinationPath <String> ] [-InitialReplicationStartTime <DateTime> ] [-PassThru] [-UseBackup] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMObject
Start-VMInitialReplication [-VM] <VirtualMachine[]> [-AsJob] [-DestinationPath <String> ] [-InitialReplicationStartTime <DateTime> ] [-PassThru] [-UseBackup] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMReplication
Start-VMInitialReplication [-VMReplication] <VMReplication[]> [-AsJob] [-DestinationPath <String> ] [-InitialReplicationStartTime <DateTime> ] [-PassThru] [-UseBackup] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-VMInitialReplication cmdlet starts replication of a virtual machine using the method you select. You also can schedule replication to start up to 7 days later.
Parameters
-AsJob
Runs the cmdlet as a background job.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String[]>
Specifies one or more Hyper-V hosts on which replication of a virtual machine is to be started. 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 |
-DestinationPath<String>
Specifies the path to use when copying the files for initial replication; assumes use of external media as the method for initial replication. External media is typically a removable drive that is shipped to the location of the Replica server. When the external media arrives at the Replica site, use the Import-InitialVMReplication on the Replica virtual machine to copy the files.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InitialReplicationStartTime<DateTime>
Specifies the time to start the initial replication, when scheduling initial replication to occur later. You can specify a time up to 7 days later. When this parameter is not specified, initial replication occurs immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PassThru
Specifies that a VM object is to be passed through to the pipeline representing the virtual machine on which replication is to be started.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies the virtual machine on which replication is to be started.
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 on which replication is to be started.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
-VMReplication<VMReplication[]>
Specifies an object that represents the replication to be started.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-UseBackup
Indicates that you want to use a copy of this virtual machine on the Replica server as the basis for the initial replication. Specify this option only if it was specified when replication was enabled on the primary virtual machine.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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; Microsoft.Virtualization.Powershell.VirtualMachine if –PassThru is specified.
Examples
Example 1
This example starts initial replication of virtual machine VM01 over the network.
PS C:\> Start-VMInitialReplication VM01
Example 2
This example starts initial replication over the network for all the virtual machines on the local Hyper-V host for which initial replication is pending.
PS C:\> Start-VMInitialReplication *
Example 3
This example exports the initial replication of all virtual machines on the local Hyper-V host for which initial replication is pending, to the location R:\IRLoc. This example assumes that the location is an external drive, which would be shipped to the Replica site so that the initial replication can be completed.
PS C:\> Start-VMInitialReplication * -DestinationPath R:\IRLoc
Example 4
This example uses several consecutive commands to start initial replication from backup. First, it enables a restored copy of virtual machine VM01 on the Replica server as a Replica virtual machine. Then, it enables replication for VM01 from the primary server. Finally, it starts the initial replication to use the restored copy of VM01 on Replica server as the basis of the initial replication.
PS C:\> Enable-VMReplication VM01 -AsReplica –computername MyReplica.contoso.com
PS C:\> Enable-VMReplication VMO1 -ReplicaServerName ReplicaServer01 -ReplicaServerPort 80 -AuthenticationType Kerberos –computername MyPrimary.contoso.comPS
PS C:\> Start-VMInitialReplication VM01 –usebackup –computername MyPrimary.contoso.com