Run Replication Mappings Tests

Run tests for all replication mappings for a vSphere Replication Management Server in a given pairing.

Request

URI

POST

https://{api_host}/pairings/{pairing_id}/vrs/{vr_id}/replication-mappings/actions/run-tests

COPY

Path Parameters

string

pairing_id

Required

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

string

vr_id

Required

The ID of the VRMS

Request Body

Spec describing which replication mappings tests to run (or all if not specified) and their run configuration settings.

RunReplicationMappingsTestsSpec of type(s) application/json

Required

{
    "replication_mappings_specs": [
        {
            "source_object_id": "ClusterComputeResource:domain-c9:ee04fc10-131c-4d39-901f-a3de65dd8c6e",
            "target_object_id": "ClusterComputeResource:domain-c9:ee04fc10-131c-4d39-901f-a3de65dd8c6e"
        }
    ],
    "run_throughput_test": false
}

array of object

replication_mappings_specs

Optional

Specs describing which replication mappings to test. If not specified tests will be run for all existing replication mappings.

boolean

run_throughput_test

Optional

Whether the throughput test should be run. Running throughput test might disturb your network and might increase your CPU usage.

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}/vrs/{vr_id}/replication-mappings/actions/run-tests

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Replication Mappings Operations

GET

Get Replication Mappings