[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager

Create Product Upgrade Request V2

Description

This API is used to trigger request to upgrade a product.

Request

Request

URL

URL


post
https://localhost:8080/lcm/lcops/api/v2/environments/{environmentId}/products/{productId}/upgrade
Copy

Path Parameters

Path Parameters

string
environmentId Required

environmentId


string
productId Required

productId


Request Body

Request Body

UpgradeProductRequestDTO of type(s) application/json Required

upgradeProductRequestDTO

{
	"environmentId": "string",
	"licenseRef": "string",
	"migrations": [
		{
			"configFileEncryptionKey": "string",
			"connectorHostname": "string",
			"connectorSshRootPassword": "string",
			"connectorSshUserPassword": "string",
			"preValidate": false,
			"windowsDomainPassword": "string",
			"windowsDomainUser": "string",
			"windowsHostname": "string",
			"windowsVCHostName": "string",
			"windowsVCPassword": "string",
			"windowsVCUser": "string",
			"windowsVMName": "string"
		}
	],
	"preValidate": false,
	"productId": "string",
	"productVersion": "8.0.0",
	"repositoryType": "lcmRepository",
	"repositoryUrl": "/data/nfsPath/vrops-8.1.0.pak",
	"retainProductSnapshot": false,
	"snapshotIaasAfterVaUpgrade": false,
	"takeProductSnapshot": false,
	"tenantId": "string"
}
string
environmentId Optional

Environment ID


string
licenseRef Optional

License Reference


migrations Optional

boolean
preValidate Optional

Prevalidate


string
productId Optional

Product ID


string
productVersion Optional

Product Version


string
repositoryType Optional

Repository Type


string
repositoryUrl Optional

Repository URL


boolean
retainProductSnapshot Optional

Retain Product Snapshot After Upgrade


boolean
snapshotIaasAfterVaUpgrade Optional

Snapshot Iaas After VA Upgrade


boolean
takeProductSnapshot Optional

Take Product Snapshot Before Upgrade


string
tenantId Optional

TenantId only required for vSSC upgrade

Authentication

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

201 Created returns GenericRequestResponse of type(s) application/json
{
	"requestId": "a0d8d8cd-ac87-4b5c-ba8b-7a0173c56b55"
}
string
requestId Optional

Request ID

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"environmentId":"string","licenseRef":"string","migrations":[{"configFileEncryptionKey":"string","connectorHostname":"string","connectorSshRootPassword":"string","connectorSshUserPassword":"string","preValidate":false,"windowsDomainPassword":"string","windowsDomainUser":"string","windowsHostname":"string","windowsVCHostName":"string","windowsVCPassword":"string","windowsVCUser":"string","windowsVMName":"string"}],"preValidate":false,"productId":"string","productVersion":"8.0.0","repositoryType":"lcmRepository","repositoryUrl":"/data/nfsPath/vrops-8.1.0.pak","retainProductSnapshot":false,"snapshotIaasAfterVaUpgrade":false,"takeProductSnapshot":false,"tenantId":"string"}' https://localhost:8080/lcm/lcops/api/v2/environments/{environmentId}/products/{productId}/upgrade


Feedback

Was this page helpful?