Get Plan Virtual Machines

Get Plan Virtual Machines

Get virtual machines that are part of a recovery plan in a given pairing.

Request
URI
GET
https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms
COPY
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.

Query Parameters
string
filter_property
Optional

The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1

string of array
filter
Optional

The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2

string
sort_by
Optional

Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.

sort_by example
name
string
order_by
Optional

Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.

string
limit
Optional

Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.

limit example
10
string
offset
Optional

The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10

offset example
10

Authentication
This operation uses the following authentication methods.
Responses
200

Virtual machines related to a recovery plan.

Returns RecoveryPlanVmInfoDrResponseList of type(s) application/json
{
    "list": [
        {
            "id": "string",
            "name": "string",
            "template": false,
            "inside_vapp": false,
            "recovery_settings": {
                "priority": "string",
                "startup_action": "string",
                "dependent_vms": [
                    {
                        "id": "string",
                        "name": "string",
                        "template": false,
                        "inside_vapp": false,
                        "status": "string",
                        "priority_group": "string",
                        "protection_group_name": "string"
                    }
                ],
                "pre_power_on_steps": "string",
                "post_power_on_steps": "string",
                "allow_migration": false
            },
            "status": "string",
            "managing_recovery_plan": "string",
            "protection_group_name": "string",
            "protection_group": "string"
        }
    ],
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ],
        "total": 0,
        "offset": 0,
        "limit": 0,
        "links": {
            "next": {
                "href": "string"
            },
            "self": {
                "href": "string"
            },
            "previous": {
                "href": "string"
            }
        }
    }
}
list
Optional

list

_meta
Optional

_meta


400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Recovery Operations
POST
Cancel Recovery Plan
POST
Create Plan
POST
Create Recovery Plan Folder
POST
Create Recovery Steps Callout
DELETE
Delete Recovery Plan
DELETE
Delete Recovery Plan Folder
DELETE
Delete Recovery Step
POST
Dismiss Recovery Steps Recovery Plan Prompt
POST
Edit Recovery Steps Callout
GET
Get All Plan History Records
GET
Get All Recovery Plans
GET
Get Plan History Record
GET
Get Plan History Records
GET
Get Plan Related Protection Groups
GET
Get Plan Related Test Networks
GET
Get Plan Virtual Machine
GET
Get Plan Virtual Machine Dependent Vms
GET
Get Plan Virtual Machine Ip Customization
GET
Get Plan Virtual Machine Recovery Priority
GET
Get Plan Virtual Machine Recovery Settings
GET
Get Plan Virtual Machines
GET
Get Plan Virtual Machine Summarized Recovery Settings
GET
Get Recovery Plan
GET
Get Recovery Plan Folder
GET
Get Recovery Plan Folder Children
GET
Get Recovery Plan Folders
GET
Get Recovery Plan Issues
GET
Get Recovery Step
GET
Get Recovery Steps
GET
Get Recovery Steps Callout Details
GET
Get Recovery Steps User Prompt
GET
Get Recovery Steps User Prompts
POST
Move Recovery Plan Folder
POST
Plan Virtual Machine Check Dependent Vms
POST
Reconfigure Recovery Plan
POST
Rename Recovery Plan Folder
POST
Run Cleanup Test Recovery
POST
Run Recovery
POST
Run Reprotect
POST
Run Test Recovery
POST
Update Plan Virtual Machine Dependent Vms
POST
Update Plan Virtual Machine Ip Customization
PUT
Update Plan Virtual Machine Recovery Priority
POST
Update Plan Virtual Machine Recovery Settings