ReplicationSettings

ReplicationSettings
ReplicationSettings

Settings used for configuring a replication.

JSON Example
{
    "vcId": "7a3f3a25-1b33-4573-b36b-8dc89a0f8f59",
    "vmId": "vm-1",
    "description": "My description.",
    "externalKey": null,
    "excludedDiskKeys": [
        2000
    ],
    "rpo": 4,
    "dataConnectionType": "ENCRYPTED_COMPRESSED",
    "quiesced": true,
    "sourceLocation": {
        "site": "site1",
        "replicatorId": "a336f29d-2e84-45f7-9b5a-286c078c7691"
    },
    "destinationLocation": {
        "site": "site2",
        "replicatorId": "841fe316-a2cb-4203-8f30-4ce5ab186de7"
    },
    "replicationPlacement": {
        "datastoreId": "datastore-1",
        "datastoreFolder": "folder",
        "vcId": "72707e54-b9cd-4ced-8359-499d7f89381a",
        "disks": [
            {
                "diskKey": 2000,
                "datastoreId": "datastore-1",
                "diskPath": "disk/path",
                "isSeed": false,
                "storageProfileId": "841fe316-a2cb-4203-8f30-4ce5ab186de7",
                "contentId": "040dcc1e-6532-455a-9f27-02840eed4c0a"
            }
        ],
        "validateSeedUuids": true,
        "storageProfileId": "841fe316-a2cb-4203-8f30-4ce5ab186de7"
    },
    "retentionPolicy": {
        "rules": [
            {
                "numberOfInstances": 3,
                "distance": 60
            }
        ]
    },
    "autopinInstances": true,
    "targetDiskType": "THIN",
    "archiveSettings": null,
    "startPaused": false,
    "initialSyncTime": 0,
    "isMigration": false,
    "isReversed": false
}
boolean
autopinInstances
Optional

Must be set to 'false'.

dataConnectionType
Optional

dataConnectionType

string
description
Optional

User-supplied description of this protection.

destinationLocation
Optional

destinationLocation

array of integer
excludedDiskKeys
Optional

Optional virtual disks' device keys to exclude from replication.

integer As int64 As int64
initialSyncTime
Optional

Replication initial synchronization time. The time is specified as the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC. When set in the past, as 0, or as a negative, then the synchronization starts immediately. When this field is set the 'startPaused' field must be set to 'true'.

boolean
isMigration
Optional

Whether this replication represents a migration.

boolean
isReversed
Optional

Whether this replication is reversed. Note: Each reverse operation inverts this flag. Therefore, only the odd reversed replication shows 'true'.

boolean
quiesced
Optional

Whether to use guest quiescing. By default, set to 'true', meaning quiescing is active.

replicationPlacement
Optional

replicationPlacement

retentionPolicy
Optional

retentionPolicy

integer As int32 As int32
rpo
Optional

Recovery Point Objective.

sourceLocation
Optional

sourceLocation

boolean
startPaused
Optional

Sets the replication in paused state upon creation. When 'true' the 'initialSyncTime' must be set.

targetDiskType
Optional

targetDiskType

string
vcId
Optional

vCenter Server instance UUID on the source side.

string
vmId
Optional

Virtual Machine ManagedObject ID in the source vCenter Server.