[{"label":"Latest (1.0.0)","version":"latest"}]
vsphere-replication-api

Reconfigure Replication

Description

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

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/replications/{replication_id}/actions/reconfigure
Copy

Path Parameters

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

Request Body

ReconfigureReplicationSpec of mimetype application/json Optional

Spec that is used to reconfigure replication.

{}
boolean
auto_replicate_new_disks Required

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


disks Required

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


boolean
lwd_encryption_enabled Required

Specify whether LWD encryption is enabled for this replication.


boolean
mpit_enabled Required

Point-in-time recovery enabled


boolean
network_compression_enabled Required

Use network compression for replication traffic.


integer as int64
rpo Required

Target RPO in minutes.


integer as int32
mpit_days Optional

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


integer as int32
mpit_instances Optional

Point-in-time recovery instances per day.


boolean
quiesce_enabled Optional

A flag that defines whether the quiescing method is enabled.


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
vm_data_sets_replication_enabled Optional

Flag defining if VM’s DataSets replication is enabled.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns TaskDrResponseEntity of type application/json

Reconfigure replication task

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	}
}
_meta Optional

Response meta data. Contains data about the response payload data.

Errors

Errors

ResponseError
400

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


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"target_replication_server_id":"HmsRemoteHbrServer:HBRSRV-1924009b-0562-433d-8db9-082141ac04cd:067878e6-2ff0-41eb-928c-5e91492a7b29"}' https://{api_host}/pairings/{pairing_id}/replications/{replication_id}/actions/reconfigure
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
    permissions:
        - System.View
        - System.Read
        - Host.Hbr.HbrManagement
x-dr-remote-site-connectivity-contract:
    not-authenticated: ERROR
    server-down: ERROR


Feedback

Was this page helpful?