Upgrade Product

Upgrade Product

Upgrade a product with VCP LCM to the specified target version. The environment ID and product ID define the product to upgrade.

Request
URI
PUT
https://{api_host}/https://{{host}}:{{port}}/api/v5/lcm/environment/{environmentId}/product/{productId}/upgrade
COPY
Path Parameters
string
environmentId
Required

ID of the environment

string
productId
Required

ID of the product within the environment

Query Parameters
string
action
Optional

The action to perform - VALIDATE, UPGRADE

Possible values are : UPGRADE, VALIDATE,
boolean
ignoreValidation
Optional

Ignore validation result and proceed with the task even if validation fails.

boolean
disableRollback
Optional

Disable rollback in case of failure.

boolean
enableStartup
Optional

Enable startup of services.

boolean
disableBackup
Optional

Disable backup step.

Request Body
ProductUpgradeSpec of type(s) application/json
Required

Show optional properties

{
    "upgradeDetails": {
        "targetVersion": "string"
    }
}
{
    "upgradeDetails": {
        "targetVersion": "string",
        "additionalProperties": {
            "additionalProperties": {}
        },
        "productModifyNodesSpecV2": {
            "nodeSpecs": [
                {
                    "properties": {
                        "properties": {}
                    },
                    "nodeId": 0,
                    "isPrimary": false,
                    "cpuNum": 0,
                    "ramMemory": 0,
                    "hostName": "string",
                    "vmName": "string",
                    "deploymentOption": "string",
                    "datastoreName": "string",
                    "clusterName": "string",
                    "resourcePool": "string",
                    "datacenterName": "string",
                    "rootPassword": "string",
                    "gateway": "string",
                    "deployment": {
                        "vcenterName": "string",
                        "datacenterName": "string",
                        "clusterName": "string",
                        "resourcePool": "string",
                        "vmFolder": "string",
                        "datastoreNames": [
                            "string"
                        ]
                    },
                    "nics": [
                        {
                            "ipAddress": "string",
                            "networkName": "string",
                            "staticRoutes": [
                                "string"
                            ],
                            "dcVcenterNetworksSpec": {
                                "portGroupName": "string",
                                "gateway": "string",
                                "subnetMask": "string",
                                "domainName": "string",
                                "searchPath": [
                                    "string"
                                ],
                                "useDhcp": false,
                                "dns": [
                                    "string"
                                ],
                                "ntp": [
                                    "string"
                                ]
                            }
                        }
                    ],
                    "status": "string"
                }
            ]
        }
    }
}
UpgradeDetailsSpec
upgradeDetails
Required

The product upgrade details, defining target version and other optional parameters.

Responses
200

Task ID for the task updating the product.

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


400

Invalid product spec

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


401

Unauthorized access

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


On This Page
Product Operations
POST
Add Integration
POST
Add Product Node
PUT
Configure Certificate
DELETE
Delete Product
DELETE
Delete Product Node
POST
Discover Product
GET
Get All Product Nodes
GET
Get Certificate 1
GET
Get Product Node Spec By Id
PUT
Redeploy Product Node
DELETE
Remove Integration
PATCH
Update All Product Nodes
PUT
Update Integration
PATCH
Update Product Node
PUT
Upgrade Product