POST Vsphere Testconnection

Test connection to the vCenter Server.

Request

URI

POST

https://{api_host}/api/v2/vsphere/testconnection

COPY

Request Body

vsphere.testconnection.post.request of type(s) application/json

Optional

{
    "acceptCert": true,
    "hostname": "example-vc.eng.vmware.com",
    "username": "exampleVCUsername",
    "password": "exampleVCPassword"
}

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Test successful.

Operation doesn't return any data structure

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

440

Operation doesn't return any data structure

495

SSL connection failed. vCenter Server certificate is not trusted. Use "acceptCert":true in request to automatically accept not trusted certificate.

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.

object

errorDetails

Optional

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

502

Host connection problem.

Operation doesn't return any data structure

504

Host unreachable.

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v2/vsphere/testconnection

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Vsphere Operations

GET

GET Vsphere

POST