Abort-Backup
Aborts a specified offsite backup.
Syntax
Abort-Backup [-ZVMIP] <String> [-ZVMPort] <Int32> [-Username] <String> [-Password] <String>
[-VirtualProtectionGroup] <String> [-Wait <int32>] [<Common&RiskParameters>] |
Description
The Abort-Backup cmdlet aborts a running offsite backup job for a specified VPG. 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 being backed up which needs to be aborted. The value specified is case-sensitive.
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 | Abort-Backup returns the task identifier for the command and the site identifier where the VPG is defined. |
See Also
Example 1
PS C:\Windows\SysWOW64\WindowsPowerShell\v1.0> Abort-Backup 182.24.123.123 9080 -Username usr
-Password pswd -VirtualProtectionGroup ’Back Office’ |
The Back Office VPG backup currently running is aborted. 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 ---------- ------ 5e81d46e-c49e-4b2c-b65a-d742a4939192 d2da8a37-68f0-4464-a70c-abb19683fd01 |