Create Vcenter Integration

Instances are generated for not just the vCenter adapter but also for vSAN and Service Discovery adapters. If configurations for vSAN or Service Discovery are not provided, the corresponding adapters will not be created.

Request

URI

POST

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

COPY

Query Parameters

boolean

force

Optional

Constraints: default: false

Proceed with vCenter integration creation even if connection is not established

boolean

forceManagementOwnership

Optional

Constraints: default: false

Override existing VC management ownership

Request Body

The vCenter integration creation request

VcenterIntegration of type(s) application/json

Required

This request body class requires all of the following: InlineVcenterIntegration0 , InlineVcenterIntegration1

"{\n  \"name\" : \"TestVcenterIntegration\",\n  \"description\" : \"vCenter adapter for test purposes\",\n  \"collectorGroupId\" : \"b3c5e483-23f9-4a7f-b2ff-9c14985218b6\",\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    \"thumbprint\" : \"certificate_thumbprint\",\n    \"certificateDetails\" : \"certificate_details\",\n    \"issuedTo\" : \"issuedTo\",\n    \"issuedBy\" : \"issuedBy\",\n    \"expires\" : \"expirationDate\"\n  } ],\n  \"credentialInstanceId\" : \"fd55abce-4528-4a8e-a196-ebf1ee270f8d\",\n  \"vsanConfig\" : {\n    \"smartDataCollectionEnabled\" : false,\n    \"enabled\" : true\n  },\n  \"sdmpConfig\" : {\n    \"applicationDiscoveryEnabled\" : true,\n    \"enabled\" : true\n  },\n  \"logCollectionEnabled\" : false\n}"

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

201

The result model of the created vCenter integration, with vSAN and Service Discovery configs.

Returns VcenterIntegration of type(s) application/json

This response body class contains all of the following: InlineVcenterIntegration0 , InlineVcenterIntegration1

"{\n  \"name\" : \"TestVcenterIntegration\",\n  \"description\" : \"vCenter adapter for test purposes\",\n  \"collectorGroupId\" : \"25558d9f-498c-425a-ad69-4a3bbe2c9a1f\",\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\" : \"4c602675-321c-4869-a14b-5355ad2d1e5b\",\n  \"vsanConfig\" : {\n    \"smartDataCollectionEnabled\" : false,\n    \"enabled\" : true\n  },\n  \"sdmpConfig\" : {\n    \"applicationDiscoveryEnabled\" : true,\n    \"enabled\" : true\n  },\n  \"logCollectionEnabled\" : false\n}"

400

If create 'vCenter 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 'vCenter 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/vcenters

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Integrations Operations

PUT

Update VCF Integration