[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
Get Plan Virtual Machine
DescriptionGet the protected virtual machine included in a recovery plan in a given pairing.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}
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.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
RecoveryPlanVmInfoDrResponseEntity
of type application/json
Details about a protected virtual machine.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"id": "string",
"inside_vapp": false,
"managing_recovery_plan": "string",
"name": "string",
"protection_group": "string",
"protection_group_name": "string",
"recovery_settings": {
"allow_migration": false,
"dependent_vms": [
{
"id": "string",
"inside_vapp": false,
"name": "string",
"priority_group": "P1",
"protection_group_name": "string",
"status": "OK",
"template": false
}
],
"post_power_on_steps": "string",
"pre_power_on_steps": "string",
"priority": "P1",
"startup_action": "POWER_ON"
},
"status": "READY_TO_RECOVER",
"template": false
}
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
Invoke-SrmGetPlanVirtualMachine -pairingId "MypairingId" -planId "MyplanId" -vmId "MyvmId"
cURL Command
curl https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions:
- System.View
- System.Read
x-dr-remote-site-connectivity-contract:
not-authenticated: DEPENDS_ON_PROVIDED_PARAMS
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
post
Create Recovery Plan Folder
Introduced
post
Create Recovery Steps Callout
Introduced
delete
delete
Delete Recovery Plan Folder
Introduced
delete
Delete Recovery Step
Introduced
post
Dismiss Recovery Steps Recovery Plan Prompt
Introduced
post
Edit Recovery Steps Callout
Introduced
get
Get Recovery Plan Folder
Introduced
get
Get Recovery Plan Folder Children
Introduced
get
Get Recovery Plan Folders
Introduced
get
Get Recovery Step
Introduced
get
Get Recovery Steps
Introduced
get
Get Recovery Steps Callout Details
Introduced
get
Get Recovery Steps User Prompt
Introduced
get
Get Recovery Steps User Prompts
Introduced
post
Move Recovery Plan Folder
Introduced
post
Rename Recovery Plan Folder
Introduced
post
post
post
