VPGs: DELETE
Delete a specified VPG, keeping the target disks to use for preseeding if the virtual machines are reprotected.
URL
Delete VPG | https://zvm_ip:port/v1/vpgs/{VpgIdentifier} |
Where:
zvm_ip | The IP address of the Zerto Virtual Manager where the API is run. |
port | The port to access the Zerto Virtual Manager. The default port is 9669. |
VpgIdentifier | The identifier of the VPG to be deleted. |
Request Body Using Json Format
The following is an example of a request body in Json format for https://zvm_ip:port/v1/vpgs/{VpgIdentifier}.
{ "Force": Boolean, "KeepRecoveryVolumes": Boolean } |
XML Request Format
For the XML response format, see “VPGs API DELETE Method Request and Response Formats”, on page 242.
Request Values
Request values for https://zvm_ip:port/v1/vpgs/{VpgIdentifier}.
Parameter | Description | Mandatory | default |
Force | True: Force deletion of the VPG. False: Do not force deletion of the VPG. | No | False |
KeepRecoveryVolumes | True: Keep the recovery volumes. If the virtual machines in the deleted VPG are reprotected, these volumes can be used as preseeded volumes to speed up the initial synchronization of the new VPG. False: Do not keep the recovery volumes. | No | |
Response In Json Format
The following is an example response Json body for https://zvm_ip:port/v1/vpgs/{VpgIdentifier}.
Response Values
The response value is the task identifier which can be used with the
Tasks API to monitor the delete action.
XML Response Format
For the XML response format, see “VPGs API DELETE Method Request and Response Formats”, on page 242.
PowerShell Scripts
For complete PowerShell Scripts, see “Script Examples”, on page 21.