Promote Test Image

Cleanup files and objects associated with the image of a group while retaining the contents of the image as a new instance. Only one image of any type can exist for a group at any given moment. The image must be a test bubble image, attempting to promote a failover image will fail. Operation is available only on recovery site (for incoming replications).

Request

URI

POST

https://{api_host}/pairings/{pairing_id}/replications/{replication_id}/actions/promote-test-image

COPY

Path Parameters

string

pairing_id

Required

The ID of the pairing between this vSphere Replication server and the remote one.

string

replication_id

Required

The ID of a replication

Request Body

ID of the test image to promote.

StringDrData of type(s) application/json

Required

{
    "value": "string"
}

string

value

Optional

The string representation of a data.

Authentication

This operation uses the following authentication methods.

SessionHeader

Responses

202

Task to monitor the operation progress.

Returns TaskDrResponseEntity of type(s) application/json

This response body class contains all of the following: InlineTaskDrResponseEntity0 , InlineTaskDrResponseEntity1

"TaskDrResponseEntity Object"

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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/pairings/{pairing_id}/replications/{replication_id}/actions/promote-test-image

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Replication Operations

GET

Get All Replications