Vm Replications

Vm Replications

This request returns all the configured VM replications.

Request
URI
GET
https://{api_host}/vm-replications
COPY
Query Parameters
string
owner
Optional

If present, returned replications will be filtered by replication owner. Filtering option available only to admins.

owner example
org2@site2
string
sourceVdcId
Optional

If present, returned replications will be filtered by source vDC id.

sourceVdcId example
38c4079d-131e-499f-aadb-60dfbaf85c08
string
sourceVdcName
Optional

If present, returned replications will be filtered by source vDC name.

sourceVdcName example
org1_vdc1
string
sourceSite
Optional

If present, returned replications will be filtered by source site short name. Local site filtering is not supported.

sourceSite example
site1
sourceSiteType
Optional

If present, returned replications will be filtered by source site type.

sourceSiteType example
vcenter
string
sourceOrg
Optional

If present, returned replications will be filtered by VMware Cloud Director source org.

sourceOrg example
org1
string
sourceVimServerUuid
Optional

If present, admins can filter by source vCenter instance id.

sourceVimServerUuid example
0c4268dc-1786-404a-bea2-52f1709a732f
string
vmId
Optional

If present, returned replications will be filtered by source vm id, e.g. vm-1 for a DR2C replication, 4e7fa4b1-e8d9-45bd-a91d-852c46b7a0da for C2C replication.

vmId example
vm-1
string
vmName
Optional

If present, returned replications will be filtered by Virtual Machine name. The VM name must contain the provided value.

vmName example
VM1
string
storageProfile
Optional

If present, returned replications will be filtered by storage profile.

storageProfile example
7475abd4-7e9f-46de-9edc-64f98e7eac6a
string
destinationOrg
Optional

If present, returned replications will be filtered by destination org.

destinationOrg example
org2
string
destinationVdcId
Optional

If present, returned replications will be filtered by destination vDC id.

destinationVdcId example
f3f9df5d-006b-429b-875b-028f0012759b
string
destinationVdcName
Optional

If present, returned replications will be filtered by destination vDC name.

destinationVdcName example
org2_vdc2
destinationSiteType
Optional

If present, returned replications will be filtered by destination site type.

destinationSiteType example
vcloud
string
vimServerInstanceUuid
Optional

If present, admins can filter by vCenter instance id.

vimServerInstanceUuid example
5b8d24f5-eaa7-4124-ad46-3f84c089360a
string
datastoreMoref
Optional

If present, admins can filter by datastore moid (vimServerInstanceUuid is required in this case).

datastoreMoref example
datastore-1
string
recoveredVmId
Optional

If present, returned replications will be filtered by destination recovered vmId.

recoveredVmId example
05bab7e6-adb9-4aa6-9e38-70f8b9e25613
boolean
isMigration
Optional

If present, returned replications will be filtered by replication type: migration or protection.

isMigration example
true
string
slaProfileId
Optional

The SLA Profile to use instead of the custom rpo/dataConnectionType/retentionPolicy settings.

slaProfileId example
e137ef16-010a-4cc8-9121-53985cb67c5b
string
slaProfileDisplayName
Optional

The displayName of the SLA Profile used by a replication.

slaProfileDisplayName example
Silver
string
ids
Optional

If present, returned replication's IDs will be in the given list. Comma-separated C4 replication ids are expected.

ids example
C4-d50b197f-c0ab-4041-bf38-d59c8fda437c,C4-d75a6707-b9ee-4324-8848-0daf9c0a7bcb
integer
lastUpdatedBefore
Optional

If present, only replications for which management operations that were performed no later than the specified date are returned.

lastUpdatedBefore example
1499929599999
integer
lastUpdatedAfter
Optional

If present, only replications for which management operations that were performed after the specified date are returned.

lastUpdatedAfter example
1499929500000
integer
minRpo
Optional

If present, returned replications will be filtered by RPO values, greater than or equal to the configured value

minRpo example
15
integer
maxRpo
Optional

If present, returned replications will be filtered by RPO values, less than or equal to the configured value

maxRpo example
15
recoveryState
Optional

If present, returned replications will be filtered by their recovery state.

recoveryState example
TEST
string
sort
Optional

An optional list of comma-separated fields, used to sort the result. The default sorting direction is ascending. If one of the fields ends with a hyphen, the direction for this field will be descending. This allows chaining e.g. col,col2-,col3 will result in sorting by col (asc), then by col2 (desc) and finally by col3 (asc). Supported fields: [name, sourceSite, sourceOrg, sourceVdcName, destinationOrg, destinationVdcName, site, owner, lastUpdated]. If this field is omitted, the result is sorted by last update time in descending order.

sort example
vmName,sourceOrg-
dataConnectionState
Optional

If present, returned replications will be filtered by their data connection state.

dataConnectionState example
POWERED_OFF
overallHealth
Optional

If present, returned replications will be filtered by their overall health.

overallHealth example
YELLOW
string
site
Optional

Optional site to run the operation on. If omitted, defaults to the local site.

site example
site2
integer
limit
Optional

Query limit - maximum number of items this query should retrieve. If omitted or higher than the server's limits, defaults to 100.

limit example
10
integer
offset
Optional

Query offset - how much items to skip, before retrieving the actual items. If omitted, defaults to 0.

offset example
10
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns QueryResult_of_SingleVmReplicationInfo of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "items": [
        {
            "computerName": "computerName",
            "dataConnectionState": "string",
            "destinationState": {
                "currentRpoViolation": 25,
                "isMovingReplica": false,
                "lastError": {
                    "args": [],
                    "code": "Forbidden",
                    "msg": "Permission denied.",
                    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
                },
                "latestInstance": {
                    "isPinned": true,
                    "key": "replica-52f3e775-a8fa-13e3-e9be-39264ed2dfe2",
                    "quiescedType": "string",
                    "sequenceNumber": 11,
                    "timestamp": 1469701818743,
                    "transferBytes": 512000,
                    "transferSeconds": 4
                },
                "spaceRequirement": 0,
                "state": "string",
                "stateAge": 0
            },
            "guestCustomization": {
                "adminAutoLogonCount": 3,
                "adminPassword": "sEcUrEpAsS",
                "adminPasswordAuto": true,
                "adminPasswordEnabled": true,
                "changeSid": true,
                "computerName": "workload-69",
                "customizationScript": "echo 'hello world'",
                "domainName": "workgroup",
                "domainOrgUnit": "computers",
                "domainUserName": "user1",
                "domainUserPassword": "sEcUrEpAsS",
                "enabled": true,
                "joinDomainEnabled": true,
                "resetPasswordRequired": true,
                "resolutionType": "string",
                "useOrgSettings": true
            },
            "id": "C4-11111111-af9d-446a-8599-5b693842c4a3",
            "isMigration": true,
            "isPaused": false,
            "isReversed": false,
            "lastUpdated": 618094800000,
            "metadata": {},
            "overallHealth": "string",
            "owner": "org1@site1",
            "placementPolicy": "ecde053f-1aed-4547-b73a-52b9f7c48298",
            "placementPolicyName": "Gold",
            "settings": {
                "dataConnectionType": "string",
                "description": "new description",
                "excludedDiskKeys": [
                    0
                ],
                "initialSyncTime": 0,
                "quiesced": true,
                "retentionPolicy": {
                    "rules": [
                        {
                            "numberOfInstances": 3,
                            "distance": 60
                        }
                    ]
                },
                "rpo": 15,
                "targetDiskType": "string"
            },
            "sizingPolicy": "ecde053f-1aed-4547-b73a-52b9f7c48298",
            "sizingPolicyName": "SizingPolicy1",
            "slaProfile": {
                "displayName": "Gold",
                "id": "61c528c8-1a8c-4c4e-8886-f1b6eeba98a5"
            },
            "sourceState": {
                "stateAge": 0
            },
            "sourceVmEncrypted": false,
            "startupInfo": {
                "order": 0,
                "startAction": "powerOn",
                "startDelay": 0,
                "stopAction": "powerOff",
                "stopDelay": 0
            },
            "storageProfile": "ecde053f-1aed-4547-b73a-52b9f7c48298",
            "storageProfileName": "*",
            "vimLocation": {
                "datastore": "datastore",
                "datastoreMoref": "datastore-33",
                "datastoreName": "test datastore",
                "dsClusterMoref": "test datastore cluster",
                "dsClusterName": "datastoreCluster-12",
                "vimServer": "vim server",
                "vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
            },
            "vmDescription": "description",
            "vmId": "d1d9739f-9e3b-4c24-9cbb-3a9fdddaf47c",
            "vmName": "my vm 1",
            "destination": {
                "destinationCatalogItemId": "0221b98b-b91c-4524-a491-f744f67bffbe",
                "org": "org2",
                "recoveredVappId": "null",
                "site": "site2",
                "vdcId": "5ee9224f-305d-46f6-865f-b605e70acef8",
                "vdcName": "Virtual DC 2"
            },
            "source": {
                "vappName": "vApp1"
            },
            "vappReplicationId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963"
        }
    ],
    "limit": 100,
    "offset": 0,
    "total": 3
}
items
Optional

A list of items.

integer As int32 As int32
limit
Optional

Maximum number of items that this query could retrieve.

integer As int32 As int32
offset
Optional

How much items were skipped, before retrieving the actual items.

integer As int64 As int64
total
Optional

The total number of items.


400

The returned error codes include (but are not limited to): UnsupportedSortingField

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


401

The returned error codes include (but are not limited to): NotAuthenticated, RemoteAuthenticationFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


404

The returned error codes include (but are not limited to): SiteNotFound

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.