Add Replicator
This request registers a new Replicator Appliance instance.
Operation ID for correlating logs across multiple services
The new replicator request.
{
"owner": "*",
"site": "site1",
"description": "Some description",
"details": {
"apiUrl": "https://replicator1:8043",
"apiThumbprint": "SHA-256:0D:80:21:91:C7:DC:94:BC:9D:E8:A7:04:0F:6B:F1:09:5C:AA:97:C8:4A:72:E5:CF:5E:8F:84:A7:B9:CC:8C:85",
"rootPassword": "rootappliancepasswordformyreplicator",
"ssoUser": "Administrator@VSPHERE.LOCAL",
"ssoPassword": "passwordforssouser"
},
"replicatorId": "3c7b13d7-661d-4ca7-a630-e6866bddfc8a"
}Description for the Replicator.
This field indicates the owner of the Replicator instance. vSphere DR and Migration sites use multi-tenant Replicator instances. To denote a multi-tenant Replicator instance, for the owner pass '*'. Cloud Director sites use dedicated Replicator instances. For dedicated Replicator instances, for the owner pass the name of the Cloud Director organization, followed by '@' then followed by the name of the cloud site in VMware Cloud Director Availability, for example, 'myCloudDirectorOrg@myvcdasite'.
The UUID of the Replicator instance.
Site in which the replicator lives.
OK
{
"id": "9664de13-6150-4315-9f59-2d85eb4c302f",
"owner": "tenant1",
"site": "on-prem-dc1",
"description": "on-prem replicator 1",
"apiUrl": "https://replicator1:8043",
"certThumbprint": "SHA-256:0D:80:21:91:C7:DC:94:BC:9D:E8:A7:04:0F:6B:F1:09:5C:AA:97:C8:4A:72:E5:CF:5E:8F:84:A7:B9:CC:8C:85",
"pairingCookie": "lBvDMttZLLnWVZwC+85ufqiNt4M=",
"state": {
"incomingCommError": {
"code": "Forbidden",
"msg": "Permission denied.",
"args": [],
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
},
"outgoingCommError": {
"code": "Forbidden",
"msg": "Permission denied.",
"args": [],
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"isInMaintenanceMode": false,
"apiVersion": "4.5",
"dataAddress": "lwd://localhost:44045",
"buildVersion": "4.5.0.5801221-9aeebc925e"
}The URL of the REST API of the Replicator Service. Guaranteed to be populated only for completely registered Replicator Service instances. WARNING: This URL changes once L4 tunneling is in place!
The API version used to communicate to this Replicator Service.
The complete build number identifier of the Replicator Service.
The Replicator Service certificate that is used for trusting both incoming and outgoing connections. Guaranteed to be populated only for completely registered Replicator Service instances.
The data address that is used to communicate to this Replicator Service instance.
User-supplied description of this Replicator Service instance.
Unique identifier of this Replicator Service instance (instance UUID). Note: Before the Replicator Service is completely registered, this UUID might be null.
Whether this Replicator Service instance is temporarily out of service due to being placed in maintenance mode.
Owner of this Replicator Service instance.
A cookie that the Replicator Service instance can use to register or re-register with this Manager Service. Note: Registration cookies can only be used once.
Site identifier. Not interpreted by the Manager Service. Can be used for filtering or for automatic selection of a Replicator Service instance.
The returned error codes include (but are not limited to): NotAuthenticated
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}Positional arguments.
Specific error code.
Detailed error message.
Exception stacktrace.
The returned error codes include (but are not limited to): GeneralServerFailure
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}Positional arguments.
Specific error code.
Detailed error message.
Exception stacktrace.