Test Domain

Test Domain

NOTE: This operation will only work for configured domains.

Request
URI
POST
https://{api_host}/suite-api/api/integrations/vcf/{integrationId}/domains/{domainId}/testConnection
COPY
Path Parameters
string
integrationId
Required

The identifier of the VCF integration in UUID format.

string
domainId
Required

The identifier of the VCF's domain in UUID format.

Request Body

The VCF domain test request

VCFDomain of type(s) application/json
Required 
"{\n  \"vcfDomainVcenter\" : {\n    \"id\" : \"d3218530-c92d-4dbd-83d3-f76e72981e45\",\n    \"collectorId\" : \"1a0165b7-c063-42c2-8422-0e8e5d85028f\",\n    \"collectorGroupId\" : \"bf6673bb-bf57-4ceb-9aec-61ee4178159f\",\n    \"resourceIdentifiers\" : [ ],\n    \"certificates\" : [ ],\n    \"credentialInstanceId\" : \"cf5ce3a8-db2e-4477-a83f-ab6dfa4dd857\",\n    \"vsanConfig\" : {\n      \"smartDataCollectionEnabled\" : false,\n      \"enabled\" : true\n    },\n    \"sdmpConfig\" : {\n      \"applicationDiscoveryEnabled\" : true,\n      \"enabled\" : true\n    },\n    \"logCollectionEnabled\" : false,\n    \"serviceCredentialsUsed\" : false\n  },\n  \"nsxtIntegration\" : {\n    \"enabled\" : false,\n    \"credentialId\" : \"ab14fdad-60b9-46f4-a7dc-fd72e27c5836\",\n    \"serviceCredentialsUsed\" : false\n  }\n}"
object
vcfDomainVcenter
Optional

A model that serves as the structure of the payload data for VCF domain's vCenter integration

object
nsxtIntegration
Optional

A model that represents NSXT integration details of VCF domain.

Authentication
This operation uses the following authentication methods.
Responses
200

Provided update model passed the test

Returns VCFDomain of type(s) application/json 
"{\n  \"vcfDomainVcenter\" : {\n    \"id\" : \"597f031e-bb3a-4dd1-ab83-82c7538979aa\",\n    \"name\" : \"TestVcenterIntegration\",\n    \"description\" : \"vCenter adapter for test purposes\",\n    \"collectorGroupId\" : \"e119fe86-3acd-43e9-887c-9e310451e476\",\n    \"resourceIdentifiers\" : [ {\n      \"name\" : \"AUTODISCOVERY\",\n      \"value\" : \"true\"\n    }, {\n      \"name\" : \"PROCESSCHANGEEVENTS\",\n      \"value\" : \"true\"\n    }, {\n      \"name\" : \"VCURL\",\n      \"value\" : \"VC_IP_Adress\"\n    } ],\n    \"certificates\" : [ ],\n    \"credentialInstanceId\" : \"7b78239b-7d4f-46f4-9504-dc9afdc939a1\",\n    \"vsanConfig\" : {\n      \"smartDataCollectionEnabled\" : false,\n      \"enabled\" : true\n    },\n    \"sdmpConfig\" : {\n      \"applicationDiscoveryEnabled\" : true,\n      \"enabled\" : true\n    },\n    \"logCollectionEnabled\" : false,\n    \"serviceCredentialsUsed\" : false\n  },\n  \"nsxtIntegration\" : {\n    \"url\" : \"nsxt_url\",\n    \"certificates\" : [ ],\n    \"enabled\" : true,\n    \"id\" : \"fbf66843-153b-4265-b52d-33dff60207e4\",\n    \"credentialId\" : \"8a5f1b4b-d2a7-4c96-a71a-74909a728c36\",\n    \"serviceCredentialsUsed\" : false\n  },\n  \"domainName\" : \"DomainName\",\n  \"domainId\" : \"5a6601ad-cdcc-422d-8730-94c3b41e384e\",\n  \"vcUrl\" : \"vc_url\",\n  \"domainState\" : \"CONFIGURED\"\n}"
object
vcfDomainVcenter
Optional

A model that serves as the structure of the payload data for VCF domain's vCenter integration

object
nsxtIntegration
Optional

A model that represents NSXT integration details of VCF domain.


400

If update 'VCF domain' 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    \"integrationType\" : \"NSXT\",\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}"

404

If no VCF domain was found by provided domain id, or no VCF was found by provided VCF id

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/{integrationId}/domains/{domainId}/testConnection
On This Page
Integrations Operations
PUT
Update VCF Integration
POST
Create VCF Integration
PUT
Unregister VCF
PUT
Register VCF
GET
Get Domain Details By Id
PUT
Update Domain Details
DELETE
Delete Vcf Domain
PUT
Update Vcenter Integration
POST
Create Vcenter Integration
PUT
Unregister VC
PUT
Register VC
POST
Test Domain
POST
Test VCF Integration
POST
Test Vcenter Integration
GET
Get VCF Integration By Id
DELETE
Delete Vcf Integration
GET
Get Domain Summary
GET
Get Vcenter Integration By Id
DELETE
Delete Vcenter Integration