POST Vrops

POST Vrops

Configure VMware Aria Operations integration.

Request
URI
POST
https://{api_host}/api/v2/vrops
COPY
Query Parameters
boolean
showDetails
Optional
Constraints: default: false

Show more details for VMware Aria Operations integration configuration and Launch In Context registration.

Request Body
vrops.post.request of type(s) application/json
Optional 
{
    "acceptCert": true,
    "hostname": "example-vrops-host-or-ip.eng.vmware.com",
    "username": "exampleVRopsUsername",
    "password": "exampleVRopsPassword",
    "enableAlertsIntegration": true,
    "enableLaunchInContext": false,
    "enableMetricCalculation": true,
    "target": "example-log-insight-vip-ip-address"
}
Authentication
This operation uses the following authentication methods.
Responses
201

VMware Aria Operations integration successfully configured.

Returns vrops.post.response of type(s) application/json 
{
    "hostname": "vROps-hostname",
    "username": "vROps-Username",
    "passwordSet": true,
    "enableAlertsIntegration": false,
    "enableLaunchInContext": true,
    "enableMetricCalculation": true,
    "target": "vip.or.master.ip",
    "details": {
        "info": "info",
        "warning": "Connection test failed: Invalid username or password."
    }
}

400

The request failed because the request body either did not contain valid JSON, or did not match the required JSON format.

Returns error of type(s) application/json 
{
    "errorMessage": "Invalid request body.",
    "errorCode": "JSON_FORMAT_ERROR",
    "errorDetails": {
        "reason": "..."
    }
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


401
Operation doesn't return any data structure

409

VMware Aria Operations integration is already configured.

Operation doesn't return any data structure

440
Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json 
{
    "errorMessage": "The operation failed due to an internal error."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v2/vrops
On This Page
Vrops Operations
GET
GET Vrops
PUT
PUT Vrops
POST
POST Vrops
DELETE
DELETE Vrops
PATCH
PATCH Vrops
POST
POST Vrops Testconnection