To create a VMware Aria Operations endpoint, you make a POST request with a request body that includes VMware Aria Operations specific parameters.

As a content developer, you use the API to create a VMware Aria Operations content endpoint.

Prerequisites

  • Verify that the appliance name and fully qualified domain name of the VMware Aria Suite Lifecycle instance are available.
  • Verify that the URL variable is assigned.
    url='https://LCM-Hostname'
  • Verify that the SSH user account is configured.
  • Verify that all VMware Aria Operations instances have the same management packs installed and required adapter instances configured.

Procedure

  1. Create an endpoint to capture VMware Aria Operations content. For the server, use the FQDN, IP address, or host name of the VMware Aria Operations instance that you are adding to VMware Aria Suite Lifecycle.
    curl -X POST \
      '$url/lcm/cms/api/v1/endpoints' \
      -H 'Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=' \
      -H 'Content-Type: application/json' \
      -d '{
        "userName": "admin",
        "sshUserName": "root",
        "tagNames": [
            "tag-1"
        ],
        "endpointType": "CONTENT_ENDPOINT",
        "category": "Operations",
        "name": "vrops",
        "server": "{<endpoint_IP_FQDN>}",
        "password": "<example_password>",
        "sshPassword": "<example_sshPassword>",
        "supportCapture": true,
        "supportTest": true,
        "supportRelease": true,
        "sourceControlEnvironment": false
    }' | jq "."
  2. Examine the response.
    {
      "requestId":"fcb8040a-e44a-48b1-8cb4-ff7f793becf6",
      "status":"IN_PROGRESS",
      "message":"Endpoint Successfully Created",
      "referenceId":"1e8be9df-893f-4545-b99a-432f90a88e10"
    }
  3. Assign the reference ID of the endpoint to a variable name.
    vROpsEndpoint = '<referenceID>'
  4. Get information about the VMware Aria Operations endpoint.
    curl -X GET \
      '$url/lcm/cms/api/v1/endpoints/{$vROpsEndpoint}' \
      -H 'Accept: application/json' \
      -H 'Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=' \
      -H 'Content-Type: application/json' | jq "."
     
  5. Examine the response for information about the VMware Aria Operations endpoint.
    Response:
    {
        "id": "1e8be9df-893f-4545-b99a-432f90a88e10",
        "createdOn": 1573449661631,
        "lastUpdatedOn": 1573449661712,
        "errorMessage": "Endpoint test connection failed",
        "tagNames": [
            "tag-1"
        ],
        "supportCapture": true,
        "supportTest": true,
        "supportRelease": true,
        "supportTemplates": false,
        "supportOnlySourceControlledContent": false,
        "storeTemplates": false,
        "requestedBy": "admin@local",
        "name": "vrops",
        "enabled": false,
        "category": "Operations",
        "systemEndpoint": false,
        "server": "vROpsserver.my.company.com",
        "userName": "[email protected]",
        "password": "example_user_password",
        "sshUserName": "ssh_user",
        "sshPassword": "example_ssh_password",
        "reviewRequired": false,
        "endpointType": "CONTENT_ENDPOINT",
        "userIdentity": "admin@local"
    }
     

What to do next

Use your endpoint to manage the following types of VMware Aria Operations content:
  • Operations-Dashboard
  • Operations-Report
  • Operations-ResourceKindMetricConfig
  • Operations-SuperMetric
  • Operations-Symptom
  • Operations-TextWidgetContent
  • Operations-TopoWidgetConfig
  • Operations-View