You can trigger a product upgrade in your vRealize Suite environment.

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. Upgrade a product in your environment. 
    curl -X POST "https://LCM-HostName/lcm/api/v1/action/upgrade/product" \
  -H "accept: application/json" \
  -H "x-xenon-auth-token: $token" \
  -H "content-type: application/json" \
  -d "{ 
    "environmentId": "<Environment-ID>", 
    "productLink": "<Product-ID>", 
    "productType": "<ProductType>", 
    "productVersion": "<Product-Version>", 
    "repositoryType": "URL", 
    "repositoryUrl": "<Product-Upgrade-File-URL>", 
    "takeSnapshot": "false"
  }"
    Table 1. Input Parameters for Upgrade Product

    Parameter

    Description

    environmentId

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

    productLink

    Product Link is the ID of a product listed in the response to the request for information about all products installed in an environment. See List All Products in an Environment.

    productType

    Supported vRealize Suite product name in vRLCM. For example: vra, vrbc, or vrops/vrli

    productVersion

    Current vRealize Suite product version in vRLCM

    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>

    takeSnapshot

    True or False

  2. Examine the response to track the upgrade.

    The output of the request includes:

    • id = Product Upgrade Request ID

    • status = Product Upgrade Status

  3. (Optional) Monitor the status of the upgrade with the Product Upgrade Request ID from Upgrade vRealize Suite Products. 
    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"