CloudAccountVmcSpecification

CloudAccountVmcSpecification

Specification for a VMC 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",
    "apiKey": "string",
    "sddcId": "CMBU-PRD-NSXT-M8GA-090319",
    "username": "[email protected]",
    "password": "cndhjslacd90ascdbasyoucbdh",
    "hostName": "vc1.vmware.com",
    "nsxHostName": "nsxManager.sddc-52-12-8-145.vmwaretest.com",
    "dcId": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
    "regions": [
        {
            "name": "Datacenter:datacenter-3",
            "externalRegionId": "Datacenter:datacenter-3"
        }
    ],
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ],
    "createDefaultZones": true,
    "acceptSelfSignedCertificate": false,
    "certificateInfo": {
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDHjCCAoegAwIBAgIBATANBgkqhkiG9w0BAQsFADCBpjEUMBIGA1UEChMLVk13\nYXJlIEluYAAc1pw18GT3iAqQRPx0PrjzJhgjIJMla\n/1Kg4byY4FPSacNiRgY/FG2bPCqZk1yRfzmkFYCW/vU+Dg==\n-----END CERTIFICATE-----\n-"
    },
    "environment": "aap"
}

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

apiKey

Required

VMC API access key.

string

sddcId

Required

Identifier of the on-premise SDDC to be used by this cloud account. Note that NSX-V SDDCs are not supported.

string

username

Required

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

string

password

Required

Password for the user used to authenticate with the cloud Account.

string

hostName

Required

Enter the IP address or FQDN of the vCenter Server in the specified SDDC. The cloud proxy belongs on this vCenter.

string

nsxHostName

Required

The IP address of the NSX Manager server in the specified SDDC / FQDN.

string

dcId

Required

Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors.

array of RegionSpecification

regions

Required

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

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.

boolean

createDefaultZones

Optional

Create default cloud zones for the enabled regions.

boolean

acceptSelfSignedCertificate

Optional

Accept self signed certificate when connecting to vSphere

CertificateInfoSpecification

certificateInfo

Optional

Specification for certificate for a cloud account.

string

environment

Optional

The environment where the agent has been deployed. When the agent has been deployed using the "Add Ons" in VMC UI or Api use "aap".

Parameter To

Create Vmc Cloud Account Async