Replace Guest Customization Settings

This request updates/replaces the guest customization settings for all VMs in the specified vApp replication

Request

URI

PUT

https://{api_host}//vapp-replications/{replicationId}/guest-customization

COPY

Path Parameters

string

replicationId

Required

Cloud vApp-level replication identifier

replicationId example

C4VAPP-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

VappReplicationGuestCustomizationSettings of type(s) application/json

Required

object

vmGuestCustomizationSettings

Optional

Guest customization settings for each VM organized as map by VM ID

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns VappReplicationGuestCustomizationSettings of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8

Operation doesn't return any data structure

object

vmGuestCustomizationSettings

Optional

Guest customization settings for each VM organized as map by VM ID

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.