[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Patch Uag Deployment

Description

Patches an existing UAG deployment record with new values.

Request

URL

patch

https://cloud.vmwarehorizon.com/admin/v2/uag-deployments/{id}

Copy

Path Parameters

string

id Required

UAG Deployment ID

Query Parameters

boolean

ignore_warnings Optional

If true, errors classified as warnings will be ignored

string

org_id Optional

Organization ID: non-super users can only access their own organization

Request Body

UAGDeploymentPatchTOV2 of mimetype application/json Required

uagDeploymentPatchToV2

{
    "fqdn": "uag.example.com",
    "numberOfGateways": 2
}

string

fqdn Optional

Admin-defined FQDN of the UAG cluster

map of InfrastructureResource

infrastructure Optional

Other infrastructure resources for the UAG deployment. The keys in this map and the interpretation of the values depend on the provider type.

integer as int32

numberOfGateways Optional

Number of Gateways needed in the UAG deployment cluster

UAGProxyConfigTO

proxyConfiguration Optional

SslCertificateTO

sslCertificate Optional

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response Body

202 Accepted

Returns UAGDeploymentTOV2 of type */*

Accepted the request to patch existing UAG deployment record

{
    "edgeDeploymentId": "1234",
    "fqdn": "www.example.com",
    "location": "US",
    "name": "My Instance Name",
    "numberOfGateways": 2,
    "orgId": "0123456789",
    "providerInstanceId": "0123456789",
    "providerLabel": "AZURE",
    "status": "PENDING",
    "type": "EXTERNAL | INTERNAL | INTERNAL_AND_EXTERNAL"
}

string as date-time

createdAt Optional

Record creation timestamp

string

description Optional

string

edgeDeploymentId Optional

Edge Deployment id

array of ErrorDetail

errorDetails Optional

List of Error Details

string

fqdn Optional

Admin-defined FQDN of the UAG cluster

array of UAGVmDetailsTO

gateways Optional

List of UAG VMs and their details which are deployed

HDC

hdc Optional

string

id Optional

map of InfrastructureResource

infrastructure Optional

Other infrastructure resources for the deployment. The keys in this map and the interpretation of the values depend on the provider type.

UAGLoadBalancer

loadBalancer Optional

string

location Optional

location

string

name Optional

User defined name for this instance

integer as int32

numberOfGateways Optional

Number of Gateways needed in the UAG deployment cluster

string

orgId Optional

Org ID that owns this record

string

passwordCredentialId Optional

CredentialId where the Gateway password is stored.

UAGLoadBalancer

privateLoadBalancer Optional

string

providerInstanceId Optional

Provider instance to where this UAG deployment is deployed

string

providerLabel Optional

Provider label (provider of which this is an instance)

UAGProxyConfig

proxyConfiguration Optional

UAGDeploymentReported

reportedProperties Optional

map of string

resourceTags Optional

Resource tags that are added to UAG deployment

string

sslCertificateCredentialId Optional

CredentialId where the SSL certificate is stored.

SSLCertificateTO

sslCertificateTO Optional

string

status Optional

The configured status of the UAG Cluster deployment

Possible values are: DELETED , DELETE_PENDING , DELETING , DELETION_FAILED , DEPLOYING , FAILED , PARTIALLY_READY , PENDING , READY , UPDATE_FAILED , UPDATE_PENDING , UPDATING , UPGRADE_FAILED , UPGRADE_PENDING , UPGRADING

string

type Optional

UAG deployment type

string as date-time

updatedAt Optional

Record updated timestamp

integer as int64

version Optional

Record version (internal)

204 No Content

No Content

Operation doesn't return any data structure.

Errors

ErrorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

403

Forbidden

ErrorResponse

404

Not Found

ErrorResponse

409

Conflict - concurrent updates

ErrorResponse

500

Unexpected internal server error

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"fqdn":"uag.example.com","numberOfGateways":2}' https://cloud.vmwarehorizon.com/admin/v2/uag-deployments/{id}

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-codegen-request-body-name: uagDeploymentPatchToV2

[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Admin Operations

post

Create

delete

Delete Uag Deployment

post

Generate Otp For Uag Deployment

get

Get All Uag Deployments

get

Get Uag Deployment By ID

patch

Patch Uag Deployment

Patch Uag Deployment

Request

URL

Path Parameters

Query Parameters

Request Body

Authentication

Bearer

Response

Response Body

202 Accepted

204 No Content

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Admin Operations

Was this page helpful?