Before upgrading a product in your vRealize Suite environment, you can pre-validate the product upgrade request to identify issues that can possibly cause an upgrade failure.

Pre-validation is an optional step that ensures a smooth product upgrade using vRealize Suite Lifecycle Manager. To pre-validate as part of the upgrade process, you can set the preValidate toggle in the PATCH /action/upgrade/product request. See Patch Product Upgrade Request Then Upgrade.

Pre-validation is particularly useful when upgrading from an older version of a product or in a production environment where a clean upgrade is critical. However, a best practice is to pre-validate every product upgrade request.

Prerequisites

Satisfy the following conditions before performing any tasks for this use case.

  • Use POST /lcm/api/v1/login to log in to vRealize Suite Lifecycle Manager.

  • Verify that you have a valid authentication token that matches your login credentials. See Request an Authentication Token.

Procedure

  1. Pre-validate your product upgrade request.
    curl -X POST "https://LCM-HostName/lcm/api/v1/action/prevalidate/upgrade/product" \
      -H "accept: application/json" \
      -H "x-xenon-auth-token: $token" \
      -H "content-type: application/json" \
      -d "{ 
        "environmentId": "<Environment-ID>",  
        "productType": "<ProductType>", 
        "repositoryType": "URL", 
        "repositoryUrl": "<Product-Upgrade-File-URL>", 
        "productVersion": "<Product-Version>", 
        "requestId": "<request-ID>",
        "preValidate": "<Prevalidate-True-or-False>",
        "requestState": "SUBMITTED",
      }" 
    Table 1. Input Parameters for Product Upgrade Request Pre-Validation

    Parameter

    Description

    environmentId

    Environment ID is in the response to the request for a list of all environments managed by vRealize Suite Lifecycle Manager. See List All Products in an Environment

    productType

    Supported vRealize Suite product name in vRealize Suite Lifecycle Manager. For example: vra, vrbc, vrops, vrli, or vrni.

    repositoryType

    Repository Type can be URL or lcmrepository

    repositoryUrl

    The URL points to the upgrade binary file. For example: https://<LCM-IP>:4443/productlinks/vrli/4.6.0/upgrade/<UpgradeFileName>

    productVersion

    vRealize Suite product version post upgrade. For example, if upgrading from version x.x.x to version y.y.y, the value is y.y.y.

    requestId

    ID received from the response of the call POST /action/upgrade/product. See Create Product Upgrade Request.

    preValidate

    Option to toggle the pre-validation before actual upgrade flow: true or false.

    requestState

    Request state to patch the existing state. Default is SUBMITTED.

  2. Examine the response to track the request.

    The output includes:

    • id = Product Update Request ID provided as input

    • status = Request status

  3. (Optional) Monitor the status of the request with the Product Update Request ID.
    curl -X GET "https://LCM-HostName/lcm/api/v1/request/status/<Product-Update-Request-ID>" -H "accept: application/json" -H "x-xenon-auth-token: $token"