Replace Guest Customization Vm Replication

Replace Guest Customization Vm Replication

This request updates/replaces the VM guest customization settings for failover and test failover of the specified VM replication.

Request
URI
PUT
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

Request Body
VmReplicationGuestCustomizationSettings of type(s) application/json
Required 
{
    "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,
        "resolutionType": "string",
        "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,
        "resolutionType": "string",
        "useOrgSettings": true
    }
}
VmGuestCustomizationSettings
failoverSettings
Optional

failoverSettings

VmGuestCustomizationSettings
failoverTestSettings
Optional

failoverTestSettings

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VmReplicationGuestCustomizationSettings of type(s) application/vnd.vmware.h4-v4.7+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,
        "resolutionType": "string",
        "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,
        "resolutionType": "string",
        "useOrgSettings": true
    }
}
VmGuestCustomizationSettings
failoverSettings
Optional

failoverSettings

VmGuestCustomizationSettings
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.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.


On This Page
Vm Replications Operations
POST
Apply Storage Profile Vm Replication
PATCH
Chown Vm Replication
DELETE
Cleanup Failover Test Vm Replication
GET
Disk Samples Vm Replication
POST
Failover Test Vm Replication
POST
Failover Vm Replication
GET
Get Effective Guest Customization Vm Replication
GET
Get Network Settings Vm Replication
GET
Get Virtual Hardware
GET
Get Vm Replication
GET
Instance Vm Replication
GET
Instances Vm Replication
POST
Migrate Vm Replication
POST
Pause Vm Replication
PATCH
Reconfigure Disks Vm Replication
PATCH
Reconfigure Vm Replication
PUT
Replace Guest Customization Vm Replication
PUT
Replace Network Settings Vm Replication
POST
Resume Vm Replication
POST
Reverse Vm Replication
POST
Start Vm Replication
DELETE
Stop Vm Replication
POST
Sync Vm Replication
GET
Traffic Samples Vm Replication
GET
Vm Replications