Start-FailoverTest
Starts a failover test.
Syntax
Start-FailoverTest [-ZVMIP] <String> [-ZVMPort] <Int32> [-Username] <String> [-Password] <String> [-VirtualProtectionGroup] <String> [[-ZertoOrganization] <String>]
[[-CheckpointDateTime] <DateTime>] [[-CheckpointID] <UInt64>] [[-IsContinueOnPreScriptFailure] [<Boolean>]] -Wait <int32>] [<Common&RiskParameters>] |
Description
The Start-FailoverTest cmdlet starts a failover test for a specified VPG using a specific checkpoint. If the VPG belongs to a ZORG, then you can specify the ZORG as well. When the Zerto Virtual Manager is paired with multiple sites the VPGs can be from any of these paired sites, as long as they were either protected or recovered to the site of the Zerto Virtual Manager where the cmdlet is run.
Parameters
[-ZVMIP] <String>
The IP address of the machine where the Zerto Virtual Manager is installed that is used to process the cmdlet.
Required? | True |
Position? | 1 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[-ZVMPort] <Int32>
The HTTP port used for inbound communication with the Zerto Virtual Manager for APIs and cmdlets, specified during the installation. The default port recommended during installation is 9080.
Required? | True |
Position? | 2 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[-Username] <String>
A username defined in the users.txt file in the Zerto Virtual Replication installation folder, for the Zerto Virtual Manager where the cmdlet is run.
Required? | True |
Position? | 3 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[-Password] <String>
The password for the specified username, in the users.txt file in the Zerto Virtual Replication installation folder, for the Zerto Virtual Manager where the cmdlet is run, encrypted using SHA-1.
Required? | True |
Position? | 4 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[-VirtualProtectionGroup] <String>
The name of the VPG for which to start a failover test. The value specified is case-sensitive.
Required? | True |
Position? | 6 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[[-ZertoOrganization] <String>]
The Zerto organization, ZORG, used by a cloud service provider to identify a customer. When a Zerto Organization is specified, the VPG in the VirtualProtectionGroup parameter belongs to this ZORG.
Required? | False |
Position? | 7 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[[-CheckpointDateTime] <DateTime>]
The checkpoint date and time which is used to create the failover test machines to. The format is DD/MM/YYYY hh:mm:ss AM/PM. If there is no exact match for the specified time, a value within one second of the specified time is used, otherwise an error is returned. This value is part of the object returned by the Get-Checkpoints cmdlet.
Required? | False |
Position? | 8 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[[-CheckpointID] <UInt64>]
The checkpoint ID which is used to create the failover test machines to. This value is part of the object returned by the Get-Checkpoints cmdlet.
Required? | False |
Position? | 9 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[[-IsContinueOnPreScriptFailure] [<Boolean>]]
When set to true, continues the failover test if a script runs at the start of the operation and times out or fails. When set to false, aborts the operation if the script fails or times out. The default is false.
Required? | False |
Position? | 10 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[-Wait <Int32>]
The number of seconds to wait before timing out.
Required? | False |
Position? | Named |
Default Value | None |
Accept Wildcard Characters? | False |
<Common&RiskParameters>
This cmdlet supports the parameters described in
Optional PowerShell Parameters.
Inputs and Outputs
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.
Inputs | None. |
Outputs | Start-FailoverTest returns the task identifier for the command and the site identifier where the VPG is defined. |
Note: When using prompts the latest checkpoint is used. When using the command line, if neither checkpointDateTime nor CheckpointID is specified, the latest checkpoint is used.
See Also
Example 1
PS C:\Windows\SysWOW64\WindowsPowerShell\v1.0> Start-FailoverTest 182.24.123.123 9080 -Username usr -Password pswd -VirtualProtectionGroup ’Back Office’ -CheckpointDateTime ’07/12/2013 4:52:29 PM’ |
The Back Office VPG is tested at the recovery site using a checkpoint within one second of 07/12/2013 4:52:29 PM. The Zerto Virtual Manager site used to process the cmdlet runs on IP 182.24.123.123 and port 9080.
The cmdlet returns the command task identifier and site identifier. For example:
Identifier SiteId ---------- ------ ab1b3c1b-fc94-4a1f-a42d-eb57b40526e0 d2da8a37-68f0-4464-a70c-abb19683fd01 |