Retrieve Pre-Validation Report for Environment Creation

After completing a pre-validation request, you retrieve the pre-validation report to check for errors.

A pre-validation report provides:

• Input data validation alerts such as missing input or incorrect input formats.

• Infrastructure validation alerts such as vCenter Server input checks, a reused VM name, already used IP addresses, and other checks related to the vCenter Server.

• Product validation alerts.

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.

• Verify that you have the Environment Pre-validate Request ID from Pre-validate Environment Request.

Procedure

1. Retrieve the pre-validation report.

   curl -X GET "https://LCM-HostName/lcm/api/v1/view/prevalidation/report?requestId=<Request-ID>" \
     -H "accept: application/json" \
     -H "x-xenon-auth-token: $token"
   

   Request-ID is the Environment Pre-validate Request ID.

2. Examine the response.

   If there are issues in the Data validation, Infrastructure validation, or product validation, "status": "FAILED" appears in the pre-validation report. The following snippet is from an example response.

   {
     "rootValidations": [
       {
         "checkName": "Data validation",
         "status": "PASSED",
         "childElements": [{
             "checkName": "Input schema",
             "status": "PASSED",
             "childElements": [{
                 "checkName": "Input schema validation",
                 "checkType": "ERROR",
                 "status": "PASSED",
                 "resultDescription": "Success. all the schema validations passed"
              }]
           }]		
       },
       {
         "checkName": "GENERIC",
         "status": "PASSED",
         "childElements": [{
             "checkName": "Environment validation",
             "status": "PASSED",
             "childElements": [
   	         {
                 "checkName": "Datacenter name check",
                 "checkType": "ERROR",
                 "status": "PASSED",
                 "resultDescription": "Provided datacenter name exists."
             }, 
             {
                 "checkName": "vCenter data collection check",
                 "checkType": "ERROR",
                 "status": "PASSED",
                 "resultDescription": "vCenter data collection is completed"
             }, 
   	         {
                 "checkName": "vCenter name check",
                 "checkType": "ERROR",
                 "status": "PASSED",
                 "resultDescription": "vCenter given exists."
             }]
         }]
       }]
   }, 
   {
     "checkName": "Infrastructure Validations",
     "status": "FAILED",
     "elementType": "GROUP",
     "childElements": [
       {
         "checkName": "Vcenter Validations",
         "status": "PASSED",
         "elementType": "GROUP",
         "childElements": [{
             "checkName": "VC-HOSTNAME",
             "status": "PASSED",
             "elementType": "RESOURCE",
             "childElements": [{
                 "checkName": "Check credentials for the given vCenter.",
                 "checkType": "ERROR",
                 "status": "PASSED",
                 "resultDescription": "Check if correct credentials have been provided for the given vCenter.",
                 "elementType": "CHECK"
              }]
          }]
       },
       {
         "checkName": "DNS Server Validations",
         "status": "PASSED",
         "elementType": "GROUP",
         "childElements": [
         {
             "checkName": "DNS server reachability check.",
              "checkType": "ERROR",
              "status": "PASSED",
              "resultDescription": "DNS Server '10.141.66.213' is reachable.",
              "elementType": "CHECK"
          },    
          {
             "checkName": "DNS server reachability check.",
              "checkType": "ERROR",
              "status": "PASSED",
              "resultDescription": "DNS Server '10.118.183.252' is reachable.",
              "elementType": "CHECK"
          }]
       },
       {
         "checkName": "Network Gateway Validations",
         "status": "PASSED",
         "elementType": "GROUP",
         "childElements": [{
             "checkName": "Network Gateway reachability check.",
             "checkType": "ERROR",
             "status": "PASSED",
             "resultDescription": "Network Gateway '10.196.55.253' is reachable.",
             "elementType": "CHECK"
         }]
       }
     ]
     "overallStatus": false,
     "requestState": "FAILED",
     "lastUpdateTimeMillis": 1530791811679,
     "startTimeMillis": 0
   }

What to do next

If the report indicates errors in the environment request, correct the JSON input spec with the correct parameter values and run the pre-validation request again. See Pre-validate Environment Request.

If there are no issues with the validation checks, you can proceed to create the environment when all statuses appear as "status": "PASSED". See Create an Environment.