Unprotect-Vpg
Deletes the VPG after unprotecting all the virtual machines being protected by the VPG.
Syntax
Unprotect-Vpg [-ZVMIP] <String> [-ZVMPort] <Int32> [-Username] <String> [-Password] <String> [-VirtualProtectionGroup] <String> [-DeleteTargetDisks] [-Wait <int32>] [<Common&RiskParameters>] |
Description
The Unprotect-Vpg cmdlet unprotects all the virtual machines being protected by the VPG by removing the VPG definition. The cmdlet cannot be executed when the VPG is being created or during the initial synchronization nor during a test failover, an actual failover, or a move operation, on the 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 |
[-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 |
-DeleteTargetDisks
Whether the target disks for the VPG managed by the VRA on the recovery site are kept or not. The default, when this parameter is not specified, is that these disks are saved when the VPG is removed.
Required? | False |
Position? | Named |
Default Value | False |
Accept Wildcard Characters? | False |
-Wait <Int32>
The number of seconds to wait before timing out.
Required? | True |
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 | Unprotect-Vpg returns the task identifier for the command and the site identifier where the VPG was defined. |
Note: 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> Unprotect-Vpg 182.24.123.123 9080 administrator password -VirtualProtectionGroup ’Back Office’ |
This command removes the Back Office VPG definition and keeps the disks used by the paired site VRA to recover the virtual machines that were protected by the 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 ---------- ------ dcea5d1e-4449-42de-b7c7-7f6ac5c8cb99 6d7b297c-a2d6-417c-b38c-d2679f0e17f8 |