Update Vcenter Integration

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

Request

URI

PUT

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

COPY

Query Parameters

boolean

force

Optional

Constraints: default: false

Proceed with vCenter integration update even if connection is not established

Request Body

The vCenter integration update request

VcenterIntegration of type(s) application/json

Required

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

"{\n  \"id\" : \"76d41588-b084-4cfc-a921-5e2de18ae8c8\",\n  \"name\" : \"TestVcenterIntegration\",\n  \"description\" : \"vCenter adapter for test purposes\",\n  \"collectorGroupId\" : \"df4ac4da-0b77-40fe-ba1c-21a540f0839e\",\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\" : \"fb2bb205-a204-4cd0-b0ca-4a7b35866ee2\",\n  \"vsanConfig\" : {\n    \"smartDataCollectionEnabled\" : false,\n    \"enabled\" : true,\n    \"id\" : \"1beb79ee-223b-4016-9705-486567641e27\"\n  },\n  \"sdmpConfig\" : {\n    \"applicationDiscoveryEnabled\" : true,\n    \"enabled\" : true,\n    \"id\" : \"7306c4e9-39ad-4c75-9e3f-2ca34bde510b\"\n  },\n  \"logCollectionEnabled\" : false\n}"

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The model of the updated 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  \"id\" : \"b1e5ff5d-776d-4f01-bd16-fcf4c777b2ce\",\n  \"name\" : \"TestVcenterIntegration\",\n  \"description\" : \"vCenter adapter for test purposes\",\n  \"collectorGroupId\" : \"ef98f6d2-94a1-4d3e-85d3-76f39c863af8\",\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\" : \"5a7b957f-aca9-48ae-acd6-7e3eedc4e09b\",\n  \"vsanConfig\" : {\n    \"smartDataCollectionEnabled\" : false,\n    \"enabled\" : true,\n    \"id\" : \"a378d5b8-cea0-46af-bad7-6b7ad0552e22\"\n  },\n  \"sdmpConfig\" : {\n    \"applicationDiscoveryEnabled\" : true,\n    \"enabled\" : true,\n    \"id\" : \"f1090b57-7c5c-4bbe-ade5-a08b843ee30c\"\n  },\n  \"logCollectionEnabled\" : false\n}"

400

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

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X PUT -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

200 Response Body

Errors

Integrations Operations

PUT

Update VCF Integration