Reconfigure Recovery Plan
DescriptionReconfigure settings for this recovery plan.
Request
URLURL
Path Parameters
Path Parameters
The ID of a pairing between this Site Recovery Manager server and remote one.
The ID of a recovery plan defined within current pairing.
Request Body
A spec describing the new recovery plan settings.
{
"description": "string",
"name": "string",
"protected_vc_guid": "string",
"protection_groups": [
"string"
],
"test_network_mappings": [
{
"target_network": "string",
"test_network": "string"
}
],
"vms_to_suspend": [
"string"
]
}
Description of the recovery plan. If null - the description will not be updated.
Name of the recovery plan. If null - the name will not be changed.
GUID of the protected site vCenter Server. Use in order to change recovery plan direction. Plan direction change is possible when there are no protection groups in the plan. If null - will not try to change the direction of the recovery plan.
A list of protection groups to be added to the recovery plan.Protection groups currently in the recovery plan and not in this list will be removed from the recovery plan.If null - no change in the protection groups will be done.
A list of test network mappings to be used for the recovery plan.If existing test network mapping is not part of the list - it will be removed from the recovery plan and site-level mapping will be used.If at site level there is no test network mapping defined, an isolated test network will be created during test operation.If null - no changes in the test network mappings will be done.
A list of VMs to be suspended during recovery. Must contain references for VMs from the recovery site.If a currently suspended VM is not part of this spec when modifying the recovery plan, it will not be suspended anymore.If null - VMs to be suspended will not be changed.
Authentication
Response
Response BodyResponse Body
202 Accepted
A task to monitor the operation progress.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"complete_time": 0,
"description": "string",
"description_id": "string",
"entity": "string",
"entity_name": "string",
"error": {
"details": "string",
"message": "string"
},
"id": "string",
"progress": 0,
"queued_time": 0,
"result": {},
"start_time": 0,
"status": "QUEUED"
}
Errors
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
Unauthorized - the client must authenticate itself to get the requested response
Forbidden - not sufficient access rights to fulfill the request
Not Found - server cannot find the requested in URL resource
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
PowerCLI Client SDK Example
cURL Command
Vendor Extensions
x-dr-permissions:
permissions:
- System.Read
- VcDr.RecoveryProfile.com.vmware.vcDr.Edit
x-dr-remote-site-connectivity-contract:
not-authenticated: DEPENDS_ON_PROVIDED_PARAMS
server-down: DEPENDS_ON_PROVIDED_PARAMS
