Create Product Upgrade Request V2 Using POST

Create Product Upgrade Request V2 Using POST

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

Request
URI
POST
https://{api_host}//localhost:8080/lcm/lcops/api/v2/environments/{environmentId}/products/{productId}/upgrade
COPY
Path Parameters
string
environmentId
Required

environmentId

string
productId
Required

productId

Request Body

upgradeProductRequestDTO

UpgradeProductRequestDTO of type(s) application/json
Required 
{
    "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

array of MigrateVidmConnectorRequestDTO
migrations
Optional

migrations

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
This operation uses the following authentication methods.
Responses
200

OK

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

Request ID


201

Created

Operation doesn't return any data structure

400

Bad Request

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


404

Not Found

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


On This Page
Deployments Controller Operations
POST
Apply Product Patch V2 Using POST
POST
Check Product Health V2 Using POST
POST
Create Product Snapshot Request V2 Using POST
PUT
Create Product Update Certificate Request V2 Using PUT
POST
Create Product Upgrade Request V2 Using POST
DELETE
Delete Product Data Source Request V2 Using DELETE
DELETE
Delete Product Logs Using DELETE
DELETE
Delete Product V2 Using DELETE
GET
Download Product Logs V2 Using GET
GET
Export Product V2 Using GET
POST
Generate Product Logs V2 Using POST
GET
Get All Product Snapshots V2 Using GET
GET
Get Compatablity Matrix V2 Using GET
GET
Get Deployed Product Vms V2 Using GET
GET
Get Product Certificate V2 Using GET
GET
Get Product Details V2 Using GET
GET
Get Product Patch Details V2 Using GET
GET
Get Product Snapshot By Snapshot Name V2 Using GET
POST
Power On Product V2 Using POST
POST
Revert Product Snapshot Request V2 Using POST
POST
Shut Down Product V2 Using POST
POST
Trigger Inventory Sync For Product V2 Using POST
PUT
Update Node Password Request V2 Using PUT
PUT
Update Product Admin Password Request V2 Using PUT
PUT
Update Product Data Source Password Request V2 Using PUT
POST
Validate Patch Product V2 Using POST
POST
Validate Product Data Source Password Request V2 Using POST
POST
Validate Product Update Certificate Request V2 Using POST
POST
Validate Vertical Scale Up Request V2 Using POST
POST
Vertical Scale Up Request V2 Using POST