ForceRemove-ProtectionGroup
Forcibly removes the VPG.
Syntax
ForceRemove-ProtectionGroup[-ZVMIP] <String> [-ZVMPort] <Int32> [-Username] <String> [-Password] <String> [-VirtualProtectionGroup] <String> [-Wait <int32>] [<Common&RiskParameters>] |
Description
The ForceRemove-ProtectionGroup cmdlet deletes the VPG regardless of its state. The target disks for the VPG managed by the VRA on the recovery site are kept when the VPG is removed
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 to be deleted 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 |
[-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 to delete. The value specified is case-sensitive.
Required? | True |
Position? | 5 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 | ForceRemove-ProtectionGroup returns the task identifier for the command and the site identifier where the VPG is defined. |
Notes
■ Use this cmdlet if the VPG cannot be removed using the
Unprotect-Vpg cmdlet or from within the Zerto User Interface.
■ The command returns a result even when the actual removal of the VPG has not completed.
See Also
Example 1
PS C:\Windows\SysWOW64\WindowsPowerShell\v1.0> ForceRemove-ProtectionGroup -ZVMIP 182.24.123.123 -ZVMPort 9080 -Username administrator -Password password -VirtualProtectionGroup ’Back Office’ |
This command forcibly removes 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 identifier and the site identifier. For example:
Identifier SiteId ---------- ------ aec9135f-5ec6-4b4a-9344-aacb6f29c337 0664463d-0c82-4b3a-96dc-66e0a2e696c5 |