Assess Readiness for a vRealize Operations Manager Upgrade

If you plan to upgrade vRealize Operations Manager to version 6.7 or later, first check the output content of your existing vRealize Operations Manager deployment.

vRealize Operations Manager 6.7 or later enables different metrics than in earlier versions. Before upgrading, you use the Pre-Upgrade Assessment Tool to scan your vRealize Operations Manager output content for discontinued or disabled metrics.

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. Request an assessment check for a vRealize Operations Manager deployment in your vRealize Suite environment.
   If you are running vRealize Suite Lifecycle Manager 1.3, see Assess Readiness for a vRealize Operations Manager 6.7 Upgrade in the vRealize Suite Lifecycle Manager 1.3 Programming Guide.

   curl -X POST "https://LCM-HostName/lcm/api/v1/action/assessment/product" \
     -H "accept: application/json" \
     -H "x-xenon-auth-token: $token" \
     -H "content-type: application/json" \
     -d "{ 
       "environmentId": "<Environment-ID>",
       "productId": "<product-ID>"  
       "requestId": "<request-ID>"
       "properties": {
          "upgradeVersion": "<target-upgrade-version>"
      }
     }" 

   Table 1. Input Parameters for Assessment Request

   Parameter	Description
   environmentId	Environment ID is in the response to the request for a list of all environments managed by vRealize Suite. See List All Products in an Environment
   productId	Product ID as found in Environment. See the List All Products in an Environment.
   requestId	ID received from the response of the call POST /action/upgrade/product. See Create Product Upgrade Request.
   upgradeVersion	The vRealize Operations Manager version to which you are upgrading.

2. Examine the response.
   The output includes:

   • id: Assessment Check Request ID
   • status: Status of the request
3. Monitor the status of the request with the Assessment Check Request ID.

   curl -X GET "https://LCM-HostName/lcm/api/v1/request/status/{Assessment-Check-Request-ID}" \
     -H "accept: application/json" \
     -H "x-xenon-auth-token: $token" \
     -H "content-type: application/json" 

4. Once the assessment check reaches COMPLETED status, request the assessment report.

   curl -X GET "https://LCM-HostName/lcm/api/request/{requestId}" \
     -H "accept: application/json" \
     -H "x-xenon-auth-token: $token" \
     -H "content-type: application/json" 

   Where the requestId is from the response of the call POST /action/upgrade/product. See Create Product Upgrade Request.
5. Examine the response to obtain the value for resultText under the resultData property. The value for resultText is the absolute path to the generated report in the vRealize Suite Lifecycle Manager appliance.
   The following snippet is from an example response.

   {
     "requestId":"d7ca8663e452e275572731276c3a3",
     "requestState":"COMPLETED",
     "requestSource":"d7ca8663e452e27556991da97e3ba",
     "requestData":"{...}",
     "requestDataType": "com.vmware.vrealize.lcm.nxui.document.GuiRequest",
     "executionPath":"{...}",
     "requestStatus":"{...}",
     "requestType":"APUAT_CHECK",
     "resultData":"[
     {
       "vmid":"c4de1537-c9bf-4632-bea6-14c262c9f119",
       "createdOn":1533213518038,
       "lastUpdatedOn":1533213518038,
       "version":0,
       "sourceOfTheRequest":"c13ca5c1-ad39-4997-a129-d5e4e5dcd9d1",
       "resultKey":"apuatReport",
       "resultType":"java.lang.String",
       "resultText":""/data/APUAT/APUAT_BY_LCM_d7ca8663e452e27556991da97e3ba/report/index.html"",
       "eventId":"8febbdf6-3080-4dcb-a456-8f4495d0d18e",
       "machineInstanceId":"0d27e506-8d73-4a68-9964-9e0080f2c6ab"
     }]",
     "documentVersion":17
     "documentKind":"com:vmware:vrealize:lcm:common:documents:nxrequest:GenericRequest",
     "documentSelfLink":"/lcm/api/request/d7ca8663e452e275572731276c3a3",
     "documentUpdateTimeMicros":1533213521931004,
     "documentUpdateAction":"PATCH",
     "documentExpirationTimeMicros":0,
     "documentAuthPrincipalLink":"/core/authz/system-user"
   }
     
   

What to do next

Use the value for resultText to view the assessment report from the appliance console. To obtain the same report from a web browser, replace /data/ with https://LCM-hostname:4443/ in the URL. To access the web link, you must provide UI administrator credentials.

The assessment report identifies the vRealize Operations Manager output content such as dashboards, alerts, and reports that will be affected by the upgrade. For more information about the upgrade assessment tool and how to act on information provided as output, see the VMware Knowledge Base article: https://kb.vmware.com/s/article/53545.