[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
Update Plan Virtual Machine Dependent VMS
DescriptionUpdate the dependent VMs of a protected virtual machine.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}/recovery-settings/dependent-vms/actions/update
Path Parameters
Path Parameters
string
pairing_id
Required
The ID of a pairing between this Site Recovery Manager server and remote one
string
plan_id
Required
The ID of a recovery plan defined within current pairing
string
vm_id
Required
The ID of a virtual machine
Request Body
Request Body
{
"dependent_vms": [
"string"
]
}
array of
string
dependent_vms
Optional
A list of dependent VM IDs.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted
Returns
TaskDrResponseEntity
of type application/json
A task to monitor the operation progress.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"complete_time": "string",
"description": "string",
"description_id": "string",
"entity": "string",
"entity_name": "string",
"error": {
"details": "string",
"message": "string"
},
"id": "string",
"progress": 0,
"queued_time": "string",
"result": {},
"start_time": "string",
"status": "QUEUED"
}
Errors
ResponseError
400
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
401
Unauthorized - the client must authenticate itself to get the requested response
ResponseError
403
Forbidden - not sufficient access rights to fulfill the request
404
Not Found - server cannot find the requested in URL resource
ResponseError
500
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
PowerCLI Client SDK Example
$DependentVmSpec = Initialize-SrmDependentVmSpec -DependentVms "MyDependentVms"
Invoke-SrmUpdatePlanVirtualMachineDependentVms -pairingId "MypairingId" -planId "MyplanId" -vmId "MyvmId" -dependentVmSpec $dependentVmSpec
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"dependent_vms":["string"]}' https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}/recovery-settings/dependent-vms/actions/update
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions:
- System.View
- System.Read
- VcDr.RecoveryProfile.com.vmware.vcDr.Edit
x-dr-remote-site-connectivity-contract:
not-authenticated: OK
server-down: DEPENDS_ON_PROVIDED_PARAMS
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
On This Page
Recovery Operations
post
post
delete
post
post
post
