Get Effective Guest Customization Vm Replication

Get Effective Guest Customization Vm Replication

This request returns the effective guest customization settings for failover and test failover of the specified VM replication.

Request
URI
GET
https://{api_host}//vm-replications/{replicationId}/guest-customization
COPY
Path Parameters
string
replicationId
Required

Cloud VM-level replication identifier

replicationId example
C4-ec991bd5-af9d-446a-8599-5b693842c4a3
Query Parameters
string
site
Optional

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

site example
site1
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 VmReplicationGuestCustomizationSettings of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8
{
    "failoverSettings": {
        "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,
        "useOrgSettings": true
    },
    "failoverTestSettings": {
        "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,
        "useOrgSettings": true
    }
}
failoverSettings
Optional

failoverSettings

failoverTestSettings
Optional

failoverTestSettings


401

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

Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+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.5+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.