Update Domain Details

NOTE: This operation will only work for configured domains.

Request

URI

PUT

https://{api_host}/suite-api/api/integrations/vcf/{integrationId}/domains/{domainId}

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.

Query Parameters

boolean

force

Optional

Constraints: default: false

Update the domain even if connection test fails.

Request Body

The VCF domain update request

VCFDomain of type(s) application/json

Required

"{\n  \"vcfDomainVcenter\" : {\n    \"id\" : \"7168916d-c220-4fae-a7fb-21d885eaac2c\",\n    \"collectorId\" : \"d45385ec-91e3-4241-a0a1-776d5057281b\",\n    \"collectorGroupId\" : \"ea35904d-6c55-4bb2-a15f-9758af2157ce\",\n    \"resourceIdentifiers\" : [ ],\n    \"certificates\" : [ ],\n    \"credentialInstanceId\" : \"a43faf46-8526-4bbb-8a3e-23cdbad5e0db\",\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\" : \"0db5e17d-3156-4d75-8549-f06ba6ddea10\",\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.

Token-based-authorization

Responses

200

The updated model of VCF domain

Returns VCFDomain of type(s) application/json

"{\n  \"vcfDomainVcenter\" : {\n    \"id\" : \"09f8afd1-9a80-4486-ad36-fab7065e2b99\",\n    \"name\" : \"TestVcenterIntegration\",\n    \"description\" : \"vCenter adapter for test purposes\",\n    \"collectorGroupId\" : \"9d78cd83-0a63-4aed-a61f-b809533e213c\",\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\" : \"cb2042f9-ee8b-411c-b4c6-8b665261683f\",\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\" : \"fd92498f-75a5-45d7-80d3-add67f188fad\",\n    \"credentialId\" : \"4b54c676-ea1a-4c43-ad68-d72ef0c29fc5\",\n    \"serviceCredentialsUsed\" : false\n  },\n  \"domainName\" : \"DomainName\",\n  \"domainId\" : \"2ef8814b-632a-4595-a3d6-373f32606be7\",\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 PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/suite-api/api/integrations/vcf/{integrationId}/domains/{domainId}

On This Page

Description

Request

Path Parameters

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Integrations Operations

PUT