Register VCF
If force parameter is passed as true, in case if vcf is already registered, registration will be overwritten.
NOTE: The registration of some of the VCs under the VCF may fail because of different issues, e.g. connection issue. In such cases response will be returned with http 200 status code, however the failed resources id's will be reported in the response body. Please check the status field of the response after executing this API, in order to make sure that the operation has fully succeeded.
Request
URI
PUT
https://{api_host}/suite-api/api/integrations/vcf/{integrationId}/register
COPY
Path Parameters
string
integrationId
Required
The identifier of the VCF integration in UUID format.
Query Parameters
boolean
force
Optional
Constraints:
default: false
Force override existing vcf management ownership
Responses
200
Successfully registered vcf
Returns
VcfRegistrationResult
of type(s)
application/json
"{\n \"failedVcenterIds\" : [ \"d3cbb0a2-3443-4a5d-ae23-2ca28b9c41da\", \"4490af75-62ae-412a-97aa-23d0709cc086\", \"6f4c5470-91e0-40b7-9c91-d78ee83ed667\" ],\n \"status\" : \"PARTIALLY_SUCCEEDED\"\n}"
array of
string
failedVcenterIds
Optional
Set of VCF VC ids for which registration update failed.
string
status
Optional
Indicates VCF registration result status
Possible values are :
SUCCEEDED,
PARTIALLY_SUCCEEDED,
FAILED,
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' https://{api_host}/suite-api/api/integrations/vcf/{integrationId}/register
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