V Rli APIs

APIs for managing vRealize Log Insight

Table of Contents

• VMware Aria Operations for Logs

• Connect VMware Aria Operations for Logs to workload domains

1. VMware Aria Operations for Logs

In order to have VMware Aria Operations for Logs you need to first deploy VMware Aria Suite Lifecycle and then Workspace ONE Access. After VMware Aria Suite Lifecycle is deployed please refer to its public API documentation to deploy Workspace ONE Access and VMware Aria Operations for Logs.

Tip : Refer to Deploy VMware Aria Suite Lifecycle, Get all existing VMware Aria Operations for Logs instances API

1.1. Steps

• Deploy VMware Aria Suite Lifecycle.

Tip : Refer to Deploy VMware Aria Suite Lifecycle

• Refer to VMware Aria Suite Lifecycle Public API documentation for creating global environment.

Tip : Refer to VMware Aria Suite Lifecycle create environment API guide

• Refer to VMware Aria Suite Lifecycle Public API documentation for creating VMware Aria Operations for Logs environment.

Tip : Refer to VMware Aria Suite Lifecycle create environment API guide

• VMware Aria Operations for Logs is being automatically connected to the management domain after deployment.

• Refer to Connect VMware Aria Operations for Logs to workload domains for connection VMware Aria Operations for Logs to workload domains.

2. Connect VMware Aria Operations for Logs to workload domains

You can connect VMware Aria Operations for Logs product deployment in Cloud Foundation to your workload domains.

2.1. Prerequisites

• Verify that the VMware Aria Operations for Logs cluster is online and operational.

Tip : Refer to Get all existing VMware Aria Operations for Logs instances API

2.2. Steps

• Assemble the VMware Aria Operations for Logs domain specification.

Tip : Refer to Vrli.

• Trigger the VMware Aria Operations for Logs domain connection.

Tip : For help using the VMware Aria Operations for Logs domain connection API refer to: Connects VMware Aria Operations for Logs with domain API

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vrli/domains' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept-Language: fr' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "domainId" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "ENABLED"
}'

HTTP Request

PUT /v1/vrli/domains HTTP/1.1
Content-Type: application/json
Accept-Language: fr
Content-Length: 81
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "domainId" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "ENABLED"
}

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
}

Note : This operation is a long-running task which details can be obtained form the HTTP response.

• Track the task status using the "id" from the previous response.

Tip : 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 : For task re-execution refer to: Retry a Task.

Last updated 2024-02-29 05:35:20 -0800