Create Vmc Cloud Account

Create an VMC cloud account in the current organization

Request

URI

POST

https://api.mgmt.cloud.vmware.com//iaas/api/cloud-accounts-vmc

COPY

Query Parameters

string

apiVersion

Optional

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

Request Body

CloudAccountVmc specification

CloudAccountVmcSpecification of type(s) application/json

Required

{
    "hostName": "vc1.vmware.com",
    "acceptSelfSignedCertificate": false,
    "apiKey": "string",
    "nsxHostName": "nsxManager.sddc-52-12-8-145.vmwaretest.com",
    "sddcId": "CMBU-PRD-NSXT-M8GA-090319",
    "description": "string",
    "regionIds": [
        "string"
    ],
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "password": "cndhjslacd90ascdbasyoucbdh",
    "createDefaultZones": true,
    "dcId": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
    "name": "string",
    "username": "[email protected]"
}

string

hostName

Required

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

boolean

acceptSelfSignedCertificate

Optional

Accept self signed certificate when connecting to vSphere

string

apiKey

Optional

VMC API access key

string

nsxHostName

Required

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

string

sddcId

Optional

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

string

description

Optional

A human-friendly description.

array of string

regionIds

Required

A set of Region names to enable provisioning on.Refer to /iaas/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.

string

password

Required

Password for the user used to authenticate with the cloud Account

boolean

createDefaultZones

Optional

Create default cloud zones for the enabled regions.

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

string

name

Required

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

string

username

Required

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

Responses

201

successful operation

Returns CloudAccountVmc of type(s) application/json

{
    "owner": "[email protected]",
    "sddc": "string",
    "description": "my-description",
    "orgId": "9e49",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "organizationId": "deprecated",
    "createdAt": "2012-09-27",
    "createDefaultZones": true,
    "name": "my-name",
    "id": "9e49",
    "updatedAt": "2012-09-27",
    "username": "[email protected]"
}

string

owner

Optional

Email of the user that owns the entity.

object

_links

Required

HATEOAS of the entity

string

sddc

Required

SDDC environment.

string

description

Optional

A human-friendly description.

string

orgId

Optional

The id of the organization this entity belongs to.

array of Tag