Test VCF Integration

Test VCF Integration

In case if certificate is needed, will return untrusted certificate for acceptance in response

Request
URI
POST
https://{api_host}/suite-api/api/integrations/vcf/testConnection
COPY
Request Body

The VCF integration test request

VCFIntegration of type(s) application/json
Required
This request body class requires all of the following: InlineVCFIntegration0 , InlineVCFIntegration1
"{\n  \"name\" : \"TestVCFIntegration\",\n  \"description\" : \"VCF adapter for test purposes\",\n  \"collectorGroupId\" : \"80c3562f-9f10-45f9-8ebb-50b7d3018711\",\n  \"resourceIdentifiers\" : [ {\n    \"name\" : \"SDDCManager_Hostname\",\n    \"value\" : \"SDDC_manager_hostname\"\n  }, {\n    \"name\" : \"vcf_config_limits_file_name\",\n    \"value\" : \"file_name\"\n  }, {\n    \"name\" : \"DomainMonitoringOnCreation\",\n    \"value\" : \"false\"\n  } ],\n  \"certificates\" : [ ],\n  \"credentialInstanceId\" : \"7b0fb858-02f3-42b3-a1fa-db661003399e\",\n  \"serviceCredentialsUsed\" : false\n}"
Authentication
This operation uses the following authentication methods.
Responses
200

Provided VCF integration, successfully passed the test

Returns VCFIntegration of type(s) application/json
This response body class contains all of the following: InlineVCFIntegration0 , InlineVCFIntegration1
"{\n  \"name\" : \"TestVCFIntegration\",\n  \"description\" : \"VCF adapter for test purposes\",\n  \"collectorGroupId\" : \"aec4d2e4-fcb9-4bc9-b25d-167f97ff675b\",\n  \"resourceIdentifiers\" : [ {\n    \"name\" : \"SDDCManager_Hostname\",\n    \"value\" : \"SDDC_manager_hostname\"\n  }, {\n    \"name\" : \"vcf_config_limits_file_name\",\n    \"value\" : \"file_name\"\n  }, {\n    \"name\" : \"DomainMonitoringOnCreation\",\n    \"value\" : \"false\"\n  } ],\n  \"certificates\" : [ ],\n  \"credentialInstanceId\" : \"26adf5ce-d2d3-402c-9506-7ee54078a36f\",\n  \"serviceCredentialsUsed\" : false\n}"

400

If test 'VCF integration' failed. Typically the service will return extra information as to why the test failed. In case if connection testing failed due to certificates, untrusted certificates will be returned for acceptance.

Returns OneOfErrorMessage of type(s) application/json
"{\n  \"type\" : \"CertificatesError\",\n  \"certificates\" : [ {\n    \"integrationType\" : \"VCENTER\",\n    \"certificates\" : [ {\n      \"thumbprint\" : \"certificate_thumbprint\",\n      \"certificateDetails\" : \"certificate_details\",\n      \"issuedTo\" : \"issuedTo\",\n      \"issuedBy\" : \"issuedBy\",\n      \"expires\" : \"expirationDate\"\n    } ]\n  } ],\n  \"httpStatusCode\" : 400,\n  \"apiErrorCode\" : 400,\n  \"message\" : \"No valid certificates were found, while testing connection. Returning provided untrusted certificates for acceptance.\"\n}"

422

If test 'vCenter integration' failed. Typically the service will return extra information as to why the test failed.

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}/suite-api/api/integrations/vcf/testConnection