Set-Checkpoint
Sets a checkpoint in the journal for the specified VPG.
Syntax
Set-Checkpoint [-ZVMIP] <String> [-ZVMPort] <Int32> [-Username] <String> [-Password] <String>
[-VirtualProtectionGroup] <String> [-Tag] <String> [-Wait <int32>] [<Common&RiskParameters>] |
Description
The Set-Checkpoint cmdlet sets a checkpoint for the specified VPG.
Parameters
[-ZVMIP] <String>
The IP address of the machine where the Zerto Virtual Manager is installed that is used to process the cmdlet. The VPG can be defined on this Zerto Virtual Manager site or a paired site.
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 |
[-VirtualProtectionGroup] <String>
The name of the VPG to which to add a checkpoint. The value specified is case-sensitive.
Required? | True |
Position? | 5 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[-Tag] <String>
The name used to identify the checkpoint in the list of checkpoints.
Required? | True |
Position? | 6 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 | Set-Checkpoint returns the task identifier for the command and the site identifier where the VPG was defined to which the checkpoint was added. |
See Also
Example 1
PS C:\Windows\SysWOW64\WindowsPowerShell\v1.0> Set-Checkpoint 182.24.123.123 9080 administrator password -VirtualProtectionGroup ’Back Office’ -Tag ’24 hour power outage’ |
This command sets a checkpoint for the Back Office VPG. The Zerto Virtual Manager 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 ---------- ------ b4eba428-9b53-4e96-9e39-ba363bfb2e41 d2da8a37-68f0-4464-a70c-abb19683fd01 |