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

Show optional properties

{
    "rpo": 0,
    "network_compression_enabled": false,
    "mpit_enabled": false,
    "auto_replicate_new_disks": false,
    "disks": [
        {
            "vm_disk": {
                "vm_id": "VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0"
            },
            "enabled_for_replication": false,
            "destination_datastore_id": "Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd",
            "destination_disk_format": "string"
        }
    ]
}
{
    "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,
    "enhanced_replication": 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
Constraints: minimum: 1 maximum: 1440

The target RPO in minutes.

boolean
network_compression_enabled
Required

Use network compression for replication traffic.

boolean
mpit_enabled
Required

The point-in-time recovery enabled. Up to 24 instances are supported if both ''mpit_days'' and ''mpit_instances'' are specified.

integer As int32 As int32
mpit_instances
Optional

The point-in-time recovery instances per day. If ''mpit_days'' is 0, then latest ''mpit_instances'' will be kept."It is recommended to have a vSAN ESA datastore as a target for values over 24.

integer As int32 As int32
mpit_days
Optional

The point-in-time recovery days to retain instances for. If 0 - latest ''mpit_instances'' will be kept. (VMware Live Recovery subscription required)

boolean
auto_replicate_new_disks
Required

Indicate whether automatic replication of new disks is enabled for a VM being 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. Deprecated - from VMware Live Recovery 9.0.3 legacy replications are not supported and this property is ignored.

boolean
lwd_encryption_enabled
Optional
Constraints: default: true

Indicate whether LWD encryption is enabled for this replication. Deprecated - from VMware Live Recovery 9.0.3 LWD encryption is always enabled and this value is ignored.

boolean
vm_data_sets_replication_enabled
Optional

Indicate whether VM's DataSets replication is enabled.

boolean
enhanced_replication
Optional
Constraints: default: true

Indicate whether the replication is an enhanced replication. Enhanced vSphere Replication includes automated load balancing and scaling to achieve higher performance, and when enabled with VMware Live Recovery provides a 1 minute RPO. Legacy vSphere Replication routes traffic to the replication appliance at the target site. Depending on replication traffic, you might need to manually deploy additional vSphere Replication servers. If set to true - target_replication_server_id is ignored.Deprecated - from VMware Live Recovery 9.0.3 legacy replications are not supported and enhanced_replication is always true.

array of object
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: 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 '{"auto_replicate_new_disks:"boolean","disks":["object"],"mpit_enabled:"boolean","network_compression_enabled:"boolean","rpo:"integer"}' https://{api_host}/pairings/{pairing_id}/replications/{replication_id}/actions/reconfigure