Get Vm Protection Settings

Get details about the current protection settings of a virtual machine.

Request

URI

GET

https://{api_host}/pairings/{pairing_id}/protection-management/groups/{group_id}/vms/{vm_id}/protection-settings

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.

SessionHeader

Responses

200

Detailed VM protection settings

Returns VmProtectionSettingsDrResponseEntity of type(s) application/json

This response body class contains all of the following: InlineVmProtectionSettingsDrResponseEntity0 , InlineVmProtectionSettingsDrResponseEntity1

{
    "placeholder_needs_repair": false,
    "location": {
        "name": "string",
        "protected_site": "string",
        "production_vm_path": {
            "datastore": "string",
            "datastore_name": "local",
            "path": "vms/finance-vm",
            "filename": "finance-vm.vmdk",
            "friendly_path": "string"
        },
        "recovery_site": "string",
        "placeholder_vm_path": {
            "datastore": "string",
            "datastore_name": "local",
            "path": "vms/finance-vm",
            "filename": "finance-vm.vmdk",
            "friendly_path": "string"
        },
        "placeholder_vm": "string"
    },
    "devices": [
        {
            "key": 0,
            "type": "string",
            "backing": "string",
            "label": "string",
            "production_path": {
                "datastore": "string",
                "datastore_name": "local",
                "path": "vms/finance-vm",
                "filename": "finance-vm.vmdk",
                "friendly_path": "string"
            },
            "production_datastores": [
                "string"
            ],
            "recovery_path": {
                "datastore": "string",
                "datastore_name": "local",
                "path": "vms/finance-vm",
                "filename": "finance-vm.vmdk",
                "friendly_path": "string"
            },
            "replicated": false,
            "detached": false
        }
    ],
    "networks": [
        {
            "editable": false,
            "source": "string",
            "source_name": "string",
            "target": "string",
            "target_name": "string",
            "is_inventory_mapped_target": false,
            "source_has_inventory_mapping": false,
            "index": 0,
            "key": 0,
            "source_network_nsx_backed": false,
            "target_network_nsx_backed": false
        }
    ],
    "folder": {
        "editable": false,
        "source": "string",
        "source_name": "string",
        "target": "string",
        "target_name": "string",
        "is_inventory_mapped_target": false,
        "source_has_inventory_mapping": false
    },
    "resource_pool": {
        "editable": false,
        "source": "string",
        "source_name": "string",
        "target": "string",
        "target_name": "string",
        "is_inventory_mapped_target": false,
        "source_has_inventory_mapping": false
    },
    "host": {
        "editable": false,
        "source": "string",
        "source_name": "string",
        "target": "string",
        "target_name": "string",
        "is_inventory_mapped_target": false,
        "source_has_inventory_mapping": false
    },
    "change_version": "string",
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}

400

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

Returns ResponseError of type(s) application/json

"ResponseError Object"

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

"ResponseError Object"

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

"ResponseError Object"

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.

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/pairings/{pairing_id}/protection-management/groups/{group_id}/vms/{vm_id}/protection-settings

Deprecated

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Protection Operations

GET

Get All Groups