Create Vcf Cloud Account Async

Create Vcf Cloud Account Async

Create a cloud account in the current organization

Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/cloud-accounts-vcf
COPY
Query Parameters
string
apiVersion
Required

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

string
validateOnly
Optional

If provided, it only validates the credentials in the Cloud Account Specification, and cloud account will not be created.


Request Body

Cloud account VCF specification

CloudAccountVcfSpecification of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "workloadDomainId": "string",
    "workloadDomainName": "Management",
    "vcenterHostName": "vc.mycompany.com",
    "vcenterUsername": "[email protected]",
    "vcenterPassword": "cndhjslacd90ascdbasyoucbdh",
    "nsxHostName": "nsxt.mycompany.com",
    "nsxUsername": "[email protected]",
    "nsxPassword": "cndhjslacd90ascdbasyoucbdh",
    "regions": [
        {
            "name": "us-east-1",
            "externalRegionId": "us-east-1"
        }
    ]
}
{
    "name": "string",
    "description": "string",
    "sddcManagerId": "string",
    "workloadDomainId": "string",
    "workloadDomainName": "Management",
    "vcenterHostName": "vc.mycompany.com",
    "vcenterUsername": "[email protected]",
    "vcenterPassword": "cndhjslacd90ascdbasyoucbdh",
    "createDefaultZones": true,
    "nsxHostName": "nsxt.mycompany.com",
    "nsxUsername": "[email protected]",
    "nsxPassword": "cndhjslacd90ascdbasyoucbdh",
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ],
    "vcenterCertificate": "string",
    "nsxCertificate": "string",
    "acceptSelfSignedCertificate": false,
    "dcId": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
    "regions": [
        {
            "name": "us-east-1",
            "externalRegionId": "us-east-1"
        }
    ],
    "certificateInfo": {
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDHjCCAoegAwIBAgIBATANBgkqhkiG9w0BAQsFADCBpjEUMBIGA1UEChMLVk13\nYXJlIEluYAAc1pw18GT3iAqQRPx0PrjzJhgjIJMla\n/1Kg4byY4FPSacNiRgY/FG2bPCqZk1yRfzmkFYCW/vU+Dg==\n-----END CERTIFICATE-----\n-"
    }
}
string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

string
sddcManagerId
Optional

SDDC manager integration id

string
workloadDomainId
Required

Id of the workload domain to add as VCF cloud account.

string
workloadDomainName
Required

Name of the workload domain to add as VCF cloud account.

string
vcenterHostName
Required

Host name for the vSphere from the specified workload domain.

string
vcenterUsername
Required

vCenter user name for the specified workload domain.The specified user requires CloudAdmin credentials. The user does not require CloudGlobalAdmin credentials.

string
vcenterPassword
Required

Password for the user used to authenticate with the vCenter in VCF cloud account

boolean
createDefaultZones
Optional

Create default cloud zones for the enabled regions.

string
nsxHostName
Required

Host name for the NSX endpoint from the specified workload domain.

string
nsxUsername
Required

User name for the NSX manager in the specified workload domain.

string
nsxPassword
Required

Password for the user used to authenticate with the NSX manager in VCF cloud account

array of object
tags
Optional

A set of tag keys and optional values to set on the Cloud Account.Cloud account capability tags may enable different features.

string
vcenterCertificate
Optional

vCenter Certificate

string
nsxCertificate
Optional

NSX Certificate

boolean
acceptSelfSignedCertificate
Optional

Accept self signed certificate when connecting to vSphere and NSX Manager

string
dcId
Optional

Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in VMware Aria Automation (on-prem) release.

array of object
regions
Required

A set of regions to enable provisioning on.Refer to /iaas/api/cloud-accounts/region-enumeration.

object
certificateInfo
Optional

Specification for certificate for a cloud account.

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns RequestTracker of type(s) application/json
"RequestTracker Object"
integer As int32 As int32
progress
Required

Progress of the request as percentage.

string
message
Optional

Status message of the request.

string
status
Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,
array of string
resources
Optional

Collection of resources.

string
name
Optional

Name of the operation.

string
id
Required

ID of this request.

string
selfLink
Required

Self link of this request.

string
deploymentId
Optional

ID of the deployment, this request is connected to.


400

Invalid Request - bad data

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","nsxHostName:"string","nsxPassword:"string","nsxUsername:"string","regions":["object"],"vcenterHostName:"string","vcenterPassword:"string","vcenterUsername:"string","workloadDomainId:"string","workloadDomainName:"string"}' https://{api_host}/iaas/api/cloud-accounts-vcf
                
Cloud Account Operations
POST
Enumerate Private Images
POST
Run Endpoint Health Check
POST
Enumerate Regions Async
POST
Enumerate Private Images V Sphere
POST
Enumerate V Sphere Regions Async
GET
Get V Sphere Cloud Accounts
POST
Create V Sphere Cloud Account Async
POST
Enumerate Private Images VMC
POST
Enumerate Vmc Regions Async
GET
Get Vmc Cloud Accounts
POST
Create Vmc Cloud Account Async
POST
Enumerate Private Images VCF
POST
Enumerate Vcf Regions Async
GET
Get Vcf Cloud Accounts
POST
Create Vcf Cloud Account Async
GET
Get Nsx T Cloud Accounts
POST
Create Nsx T Cloud Account Async
POST
Enumerate Private Images Gcp
POST
Enumerate Gcp Regions Async
GET
Get Gcp Cloud Accounts
POST
Create Gcp Cloud Account Async
POST
Enumerate Private Images Azure
POST
Enumerate Azure Regions Async
GET
Get Azure Cloud Accounts
POST
Create Azure Cloud Account Async
POST
Enumerate Private Images AWS
POST
Enumerate Aws Regions Async
GET
Get Aws Cloud Accounts
POST
Create Aws Cloud Account Async
GET
Get Cloud Accounts
POST
Create Cloud Account Async
GET
Get Cloud Account
DELETE
Delete Cloud Account
PATCH
Update Cloud Account Async
GET
Get V Sphere Cloud Account
DELETE
Delete V Sphere Cloud Account
PATCH
Update V Sphere Cloud Account Async
GET
Get Vmc Cloud Account
DELETE
Delete Vmc Cloud Account
PATCH
Update VMC Cloud Account Async
GET
Get Vcf Cloud Account
DELETE
Delete Vcf Cloud Account
PATCH
Update Vcf Cloud Account Async
GET
Get Nsx T Cloud Account
DELETE
Delete Cloud Account Nsx T
PATCH
Update Nsx T Cloud Account Async
GET
Get Gcp Cloud Account
DELETE
Delete Gcp Cloud Account
PATCH
Update Gcp Cloud Account Async
GET
Get Azure Cloud Account
DELETE
Delete Azure Cloud Account
PATCH
Update Azure Cloud Account Async
GET
Get Aws Cloud Account
DELETE
Delete Aws Cloud Account
PATCH
Update AWS Cloud Account Async
GET
Get Region Enumeration Result