CloudAccountVcfSpecification

CloudAccountVcfSpecification
CloudAccountVcfSpecification

Specification for a VCF cloud account.

A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.

JSON Example
{
    "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 Tag
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.

regions
Required

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

certificateInfo
Optional

Specification for certificate for a cloud account.