Create VCF Integration

vCenter,vSAN and NSXT adapter instances will be generated, upon VCF integration creation, but service discovery is still needed to be enabled manually

Request

URI

POST

https://{api_host}/suite-api/api/integrations/vcf

COPY

Query Parameters

boolean

forceManagementOwnership

Optional

Constraints: default: false

Override existing VCF management ownership

boolean

force

Optional

Constraints: default: false

Create VCF even if connection test fails

Request Body

The VCF integration creation 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\" : \"acf980d6-a995-475e-8d55-04383d0bf46a\",\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    \"thumbprint\" : \"certificate_thumbprint\",\n    \"certificateDetails\" : \"certificate_details\",\n    \"issuedTo\" : \"issuedTo\",\n    \"issuedBy\" : \"issuedBy\",\n    \"expires\" : \"expirationDate\"\n  } ],\n  \"credentialInstanceId\" : \"e134a8af-25a0-4dc0-bce8-b73ca5cd0107\",\n  \"serviceCredentialsUsed\" : false\n}"

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

201

The result model of the created VCF integration.

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\" : \"0cd0b708-08dc-47c4-bcb0-ecb39fef5c32\",\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\" : \"030cdf65-28cd-418f-8aa0-29e33ab97b21\",\n  \"serviceCredentialsUsed\" : false\n}"

400

If create 'VCF integration' failed. Typically the service will return extra information as to why the creation 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 create 'VCF integration' failed. Typically the service will return extra information as to why the creation 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

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Integrations Operations

PUT

Update VCF Integration