[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
VMware Cloud Foundation API Reference Guide

vROPs

APIs for managing vRealize Operations

1. vRealize Operations Manager

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

Tip : Refer to Deploy vRealize Suite Lifecycle Manager API, Get all existing vRealize Operations instances API

1.1. Steps

  • Deploy vRealize Suite Lifecycle Manager.

Tip : Refer to Deploy vRealize Suite Lifecycle Manager API

  • Refer to vRealize Suite Lifecycle Manager Public API documentation for creating global environment.

Tip : Refer to vRSLCM create environment API guide

  • Refer to vRealize Suite Lifecycle Manager Public API documentation for creating vRealize Operations Manager environment.

Tip : Refer to vRSLCM create environment API guide

2. Connect vRealize Operations to workload domain

You can connect vRealize Operations product deployment in Cloud Foundation to your workload domains.

2.1. Prerequisites

  • Before you can connect the management domain or workload domains to vRealize Operations, it must be deployed and in “ACTIVE” state.

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

2.2. Steps

  • Assemble the vRealize Operations domain specification.

Tip : Refer to DomainIntegration

  • Trigger the vRealize Operations domain connection.

Tip : For help using the vRealize Log Insight domain connection API refer to: Connect/disconnect workload domains with vRealize Operations API

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vrops/domains' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "domainId" : "25f2a2b0-5e11-407e-9142-1fd254ae305f",
  "status" : "ENABLED"
}'

HTTP Request

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

{
  "domainId" : "25f2a2b0-5e11-407e-9142-1fd254ae305f",
  "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",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

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 vRealize Operations refer to: Gets vRealize Operations integration status for workload domains API

Last updated 2022-01-24 06:18:36 PST

Operations



[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
Feedback

Was this page helpful?