V Rops APIs

APIs for managing vRealize Operations

Table of Contents

• VMware Aria Operations

• Connect VMware Aria Operations to workload domain

1. VMware Aria Operations

In order to have VMware Aria Operations 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.

Tip : Refer to Deploy VMware Aria Suite Lifecycle, Get all existing VMware Aria Operations 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 environment.

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

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

• Refer to Connect VMware Aria Operations to workload domain for connecting VMware Aria Operations to workload domains.

2. Connect VMware Aria Operations to workload domain

This method has been deprecated from the VCF 5.2 release. Instead workload domains should be connected to VMware Aria Operations from the Operations product itself.

2.1. Prerequisites

• Before you can connect the management domain or workload domains to VMware Aria Operations, it must be deployed and in "ACTIVE" state.

Tip : For more information refer to Get all existing VMware Aria Operations instances API

2.2. Steps

• Assemble the VMware Aria Operations domain specification.

Tip : Refer to DomainIntegration.

• Trigger the VMware Aria Operations domain connection.

Tip : For help using the VMware Aria Operations for Logs domain connection API refer to: Connect/disconnect workload domains with VMware Aria Operations API

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vrops/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/vrops/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.

Note : To see the domain connection status of VMware Aria Operations refer to: Gets VMware Aria Operations integration status for workload domains API

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