V Rslcm APIs | MARKDOWN TESTING API

V Rslcm APIs

APIs for managing vRealize Suite Lifecycle Manager

Table of Contents

VMware Aria Suite Lifecycle Deployment
VMware Aria Suite Lifecycle Rollback

1. VMware Aria Suite Lifecycle Deployment

To deploy and manage the VMware Aria Suite products after the initial greenfield deploy of VMware Cloud Foundation, you must first deploy VMware Aria Suite Lifecycle. To guarantee the success of the VMware Aria Suite Lifecycle deployment operation, you should pre-validate the deployment input.

1.1. Prerequisites

The following data is required:
- Application Virtual Networks are configured
- Unique VMware Aria Suite Lifecycle hostname and corresponding IP address from the X-Region Application Virtual Network
- VMware Aria Suite Lifecycle API and root passwords
- Free IP address from the X-Region Application Virtual Network for the Standalone Tier 1 router
Additional prerequisites:
- The VMware Aria Suite Lifecycle bundle needs to be downloaded and applied on the SDDC Manager
- Application Virtual Network should have connectivity to the management VLAN

Note : VMware Aria Suite Lifecycle deployment is not available if VMware Aria Suite Lifecycle is successfully deployed as only one instance of it is allowed in the system. In this case, calling the API will produce an error and the user will be provided with information about the allowed HTTP methods for the given endpoint. This information can be found in the "allow" field from the response headers.

1.2. Steps

Assemble the VMware Aria Suite Lifecycle deployment input specification.

Tip : Refer to VrslcmDeploymentSpec.

Trigger the VMware Aria Suite Lifecycle deployment input specification validations. For help using the VMware Aria Suite Lifecycle validation API refer to: Get the status of the validations for VMware Aria Suite Lifecycle deployment API

Warning : The triggered validations return a response containing a validation report ID. With that ID, poll the VMware Aria Suite Lifecycle validations API. While the validations are running, the "executionStatus" is "IN_PROGRESS" . You should poll the API until the "executionStatus" is "COMPLETED".

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vrslcms/validations/77c17ee9-7fa6-455f-ace6-602e43c76887' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vrslcms/validations/77c17ee9-7fa6-455f-ace6-602e43c76887 HTTP/1.1
Content-Type: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 170

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "description" : "Validating vRealize Suite Lifecycle Manager input parameters",
  "executionStatus" : "IN_PROGRESS"
}

Once the validations are completed, you can get the overall result of the validations and a detailed list with all checks that have been done and the corresponding status of each check.
- In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".
- In case of only warnings in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED_WITH_WARNINGS".
- In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

Tip : The validation checks have two severity levels - warning and error . If a failed validation check is marked as an error, the issue must be resolved before proceeding with the deployment. If the issue is marked as a warning, you are advised to look at it and do the best to fix it. You could ignore it and proceed on your own risk without fixing it, but this might affect the deployment and make it fail at a later stage. NOTE: Make changes to the input specification and re-validate using a new API invocation

Once there are no errors and warnings in the validation response, you can proceed with the VMware Aria Suite Lifecycle deployment. Although the warnings are not forced to be resolved, you should give the best to resolve the uncovered issues by the validations.
Trigger the VMware Aria Suite Lifecycle deployment. This will start a long-running task whose details can be obtained form the HTTP response.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vrslcms' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept-Language: fr' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "fqdn" : "vrslcm.vrack.vsphere.local",
  "sshPassword" : "XXXXXXX",
  "apiPassword" : "XXXXXXX"
}'

HTTP Request

POST /v1/vrslcms HTTP/1.1
Content-Type: application/json
Accept-Language: fr
Content-Length: 101
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "fqdn" : "vrslcm.vrack.vsphere.local",
  "sshPassword" : "XXXXXXX",
  "apiPassword" : "XXXXXXX"
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Type: application/json
Content-Length: 131

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "isCancellable" : false,
  "isRetryable" : false
}

Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly. Refer to: Get a Task.
- If the "status" is "IN_PROGRESS", the task is still in progress.
- If the "status" is "SUCCESSFUL", the task is completed successfully.
- If the "status" is "FAILED", the task can be re-executed.

Tip : Refer to: Retry a Task.

If the workflow fails after trying to restart the task, perform the VMware Aria Suite Lifecycle rollback

Tip : Refer to: VMware Aria Suite Lifecycle Rollback.

2. VMware Aria Suite Lifecycle Rollback

When VMware Aria Suite Lifecycle deployment fails, you can perform rollback to get the environment in a clean state and start a fresh VMware Aria Suite Lifecycle deployment.

2.1. Prerequisites

Failed VMware Aria Suite Lifecycle deployment operation.

Note : VMware Aria Suite Lifecycle rollback is not available if VMware Aria Suite Lifecycle is successfully deployed. In this case, calling the API will produce an error and the user will be provided with information about the allowed HTTP methods for the given endpoint. This information can be found in the "allow" field from the response headers.

2.2. Steps

Trigger the VMware Aria Suite Lifecycle rollback.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vrslcm' -i -X DELETE \
    -H 'Accept-Language: fr' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

DELETE /v1/vrslcm HTTP/1.1
Accept-Language: fr
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Type: application/json
Content-Length: 131

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "isCancellable" : false,
  "isRetryable" : false
}