Get Group Vm

Get Group Vm

Details of a protected virtual machine that is part of the protection group.

Request
URI
GET
https://{api_host}/pairings/{pairing_id}/protection-management/groups/{group_id}/vms/{vm_id}
COPY
Path Parameters
string
pairing_id
Required

The ID of a pairing between this Site Recovery Manager server and remote one.

string
group_id
Required

The ID of a protection group defined within current pairing.

string
vm_id
Required

The ID of a protected virtual machine.


Authentication
This operation uses the following authentication methods.
Responses
200

Information about a virtual machine that is part of a protection group.

Returns ProtectionGroupVmInfoDrResponseEntity of type(s) application/json
This response body class contains all of the following: ProtectionGroupVmInfo
{
    "id": "string",
    "name": "string",
    "template": false,
    "inside_vapp": false,
    "protection_info": {
        "recovery_folder": {
            "id": "string",
            "name": "string"
        },
        "recovery_resource_pool": {
            "id": "string",
            "name": "string"
        },
        "recovery_host": {
            "id": "string",
            "name": "string"
        },
        "recovery_networks": [
            {
                "id": "string",
                "name": "string",
                "type": "string"
            }
        ],
        "vmotion_eligible": false
    },
    "protection_status_details": {
        "status": "string",
        "errors": [
            {}
        ]
    },
    "vvol_replication_group_data": [
        {
            "fault_domain_id": "string",
            "device_group_id": "string",
            "name": "string"
        }
    ],
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
_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.