[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Upgrade Uag Deployment

Description

Upgrades the specified UAG deployment to use the latest image for UAG VMs

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
id Required

UAG Deployment ID


Query Parameters

Query Parameters

string
org_id Optional

Filter by orgId: non-super users can only query for their own orgIds


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns UAGDeploymentTOV2 of type */*
{
	"createdAt": "string",
	"description": "string",
	"errorDetails": [
		{
			"cause": "ErrorDetail Object",
			"code": "string",
			"detail": "string",
			"domain": "string",
			"message": "string",
			"parameters": {
				"key": "string"
			}
		}
	],
	"fqdn": "www.example.com",
	"gateways": [
		{
			"desktopPrivateIp": "string",
			"dmzPrivateIp": "string",
			"errorDetails": [
				{
					"cause": "ErrorDetail Object",
					"code": "string",
					"detail": "string",
					"domain": "string",
					"message": "string",
					"parameters": {
						"key": "string"
					}
				}
			],
			"id": "string",
			"managementPrivateIp": "string",
			"markedForDeletion": false,
			"status": "DELETED",
			"version": "string",
			"vmName": "string"
		}
	],
	"hdc": {
		"edgeHubUrl": "string",
		"id": "string",
		"modelVersion": 0,
		"name": "string",
		"url": "string",
		"vmHub": {
			"name": "string",
			"url": "string"
		},
		"vmHubName": "string",
		"vmHubURL": "string"
	},
	"id": "string",
	"infrastructure": {
		"key": {
			"data": {},
			"id": "string",
			"infrastructureLinks": {},
			"kind": "string"
		}
	},
	"loadBalancer": {
		"fqdn": "string",
		"ipAddress": "string",
		"publicIpEnabled": false
	},
	"location": "US",
	"name": "My Instance Name",
	"numberOfGateways": 2,
	"orgId": "0123456789",
	"passwordCredentialId": "string",
	"privateLoadBalancer": {
		"fqdn": "string",
		"ipAddress": "string",
		"publicIpEnabled": false
	},
	"providerInstanceId": "0123456789",
	"providerLabel": "AZURE",
	"proxyConfiguration": {
		"certificateData": "string",
		"certificateName": "string",
		"deleting": false,
		"enabled": false,
		"proxyHost": "string",
		"proxyIncludedHosts": [
			"string"
		],
		"proxyName": "string",
		"proxyPort": 0,
		"proxyType": "HTTP"
	},
	"reportedProperties": {
		"location": "string",
		"orgId": "string",
		"reportedGatewayDetails": [
			{
				"certUpdateErrorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"certUpdateStatus": "DELETED",
				"fqdnUpdateErrorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"fqdnUpdateStatus": "DELETED",
				"gatewayHealthErrorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"gatewayHealthStatus": "ERROR",
				"gatewayId": "string",
				"proxyUpdateErrorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"proxyUpdateStatus": "DELETED"
			}
		],
		"uagDeploymentId": "string",
		"updatedAt": "string",
		"version": 0
	},
	"resourceTags": {
		"key": "string"
	},
	"sslCertificateCredentialId": "string",
	"sslCertificateTO": {
		"credentialId": "string",
		"expiryDate": "string",
		"sslCertificateType": "PEM"
	},
	"status": "PENDING",
	"type": "EXTERNAL | INTERNAL_AND_EXTERNAL",
	"updatedAt": "string",
	"version": 0
}
string as date-time
createdAt Optional

Record creation timestamp


string
description Optional

array of ErrorDetail
errorDetails Optional

List of Error Details


string
fqdn Optional

Admin-defined FQDN of the UAG cluster


array of UAGVmDetails
gateways Optional

List of UAG VMs and their details which are deployed


HDC
hdc Optional

string
id Optional

infrastructure Optional

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


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.


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)


proxyConfiguration Optional

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 Optional

string
status Optional

The configured status of the UAG Cluster deployment

Possible values are: DELETEDDELETE_PENDINGDELETINGDELETION_FAILEDDEPLOYINGFAILEDPENDINGREADYUPDATE_FAILEDUPDATE_PENDINGUPDATINGUPGRADE_FAILEDUPGRADE_PENDINGUPGRADING


string
type Optional

UAG deployment type

Possible values are: EXTERNALINTERNAL_AND_EXTERNAL


string as date-time
updatedAt Optional

Record updated timestamp


integer as int64
version Optional

Record version (internal)

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


500

Unexpected internal server error

Code Samples

Code Samples

cURL Command

curl -X POST https://cloud.vmwarehorizon.com/admin/v2/uag-deployments/{id}/upgrade


Feedback

Was this page helpful?