Reconfigure Replication

Reconfigure Replication

Change the settings of a replication, including reconfiguring a replication on new virtual hard disks and enabling the default seed disk to use a replica disk in the VM folder.

Request
URI
POST
https://{api_host}/pairings/{pairing_id}/replications/{replication_id}/actions/reconfigure
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

Spec that is used to reconfigure replication.

ReconfigureReplicationSpec of type(s) application/json
Optional
{
    "quiesce_enabled": false,
    "rpo": 0,
    "network_compression_enabled": false,
    "mpit_enabled": false,
    "mpit_instances": 0,
    "mpit_days": 0,
    "auto_replicate_new_disks": false,
    "target_replication_server_id": "HmsRemoteHbrServer:HBRSRV-1924009b-0562-433d-8db9-082141ac04cd:067878e6-2ff0-41eb-928c-5e91492a7b29",
    "lwd_encryption_enabled": false,
    "vm_data_sets_replication_enabled": false,
    "disks": [
        {
            "vm_disk": {
                "vm_id": "VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0",
                "device_key": 0,
                "is_vm_home": false,
                "encrypted": false,
                "capacity": 0,
                "source_disk_format": "string",
                "source_path": {
                    "datastore_id": "Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd",
                    "datastore_name": "local-datastore",
                    "path": "/path/to/folder",
                    "filename": "vmDisk1.vmdk"
                },
                "source_storage_policy_name": "string",
                "source_storage_policy_id": "dsbrowser.defaultStoragePolicy",
                "label": "string",
                "controller_key": 0,
                "controller_label": "string",
                "supported_for_replication": false
            },
            "enabled_for_replication": false,
            "use_seeds": false,
            "destination_storage_policy_id": "dsbrowser.defaultStoragePolicy",
            "destination_path": "my_vm_seeds_folder/my_vm_disk_1.vmdk",
            "destination_datastore_id": "Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd",
            "destination_disk_format": "string"
        }
    ]
}
boolean
quiesce_enabled
Optional

A flag that defines whether the quiescing method is enabled.

integer As int64 As int64
rpo
Required

Target RPO in minutes.

boolean
network_compression_enabled
Required

Use network compression for replication traffic.

boolean
mpit_enabled
Required

Point-in-time recovery enabled

integer As int32 As int32
mpit_instances
Optional

Point-in-time recovery instances per day.

integer As int32 As int32
mpit_days
Optional

Point-in-time recovery days to retain instances for.

boolean
auto_replicate_new_disks
Required

Enable automatic replication of new disks that are added to a VM that is replicated.

string
target_replication_server_id
Optional

The ID of the vSphere Replication server this group resides on. In case of null, the server will be automatically determined.

boolean
lwd_encryption_enabled
Required

Specify whether LWD encryption is enabled for this replication.

boolean
vm_data_sets_replication_enabled
Optional

Flag defining if VM's DataSets replication is enabled.

disks
Required

A VM disk with a destination path, a disk format, a storage policy, and the replication status.

Authentication
This operation uses the following authentication methods.
Responses
202

Reconfigure replication task

Returns TaskDrResponseEntity of type(s) application/json
This response body class contains all of the following: Task
{
    "id": "string",
    "description": "string",
    "description_id": "string",
    "entity": "string",
    "entity_name": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "progress": 0,
    "queued_time": "string",
    "start_time": "string",
    "complete_time": "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

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


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

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


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

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id