You create a product upgrade request using the vRealize Suite Lifecycle Manager API . Then you use the output from the request to pre-validate and upgrade any vRealize Suite product deployed in your 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. Create a request to 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>",  
    "productType": "<ProductType>", 
    "productVersion": "<Product-Version>", 
  }"
    Table 1. Input Parameters for Upgrade Product Request

    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.

    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.

  2. Examine the response to track the request.

    The output includes:

    • id = Product Upgrade Request ID

    • status = Product Upgrade Request Status

  3. (Optional) Monitor the status of the request with the Product Upgrade 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"

Results

An upgrade request is created and moves to INITIATED status.

What to do next

Use the Product Upgrade Request ID to: