CloudAccountVcf

CloudAccountVcf
CloudAccountVcf

State object representing 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.
HATEOAS links:
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccountVcf - Self link to this cloud account

JSON Example
{
    "id": "9.0E49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "ownerType": "ad_group",
    "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "_links": {
        "empty": false
    },
    "name": "my-name",
    "description": "my-description",
    "enabledRegions": [
        {
            "id": "9.0E49",
            "createdAt": "2012-09-27",
            "updatedAt": "2012-09-27",
            "owner": "[email protected]",
            "ownerType": "ad_group",
            "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
            "_links": {
                "empty": false
            },
            "externalRegionId": "us-west",
            "name": "us-west",
            "cloudAccountId": "9.0E49"
        }
    ],
    "sddcManagerId": "2e5bb71d-0c14-4066-a999-2cb6c693654a",
    "vcfDomainName": "Workload Domain - 1",
    "vcfDomainId": "587db412-6037-43e4-8e1e-49ebbaf6cd35",
    "vcenterHostName": "vcenter.mycompany.com",
    "nsxHostName": "nsx.mycompany.com",
    "vcenterUsername": "[email protected]",
    "nsxUsername": "[email protected]",
    "createDefaultZones": true,
    "customProperties": {
        "isExternal": "false"
    },
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ]
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

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

string
description
Optional

A human-friendly description.

array of Region
enabledRegions
Optional

A list of regions that are enabled for provisioning on this cloud account

string
sddcManagerId
Required

SDDC Manager ID

string
vcfDomainName
Required

Name of the VCF worload domain.

string
vcfDomainId
Required

Id of the VCF worload domain.

string
vcenterHostName
Required

vCenter Hostname in a workload domain

string
nsxHostName
Required

NSX Hostname in a workload domain

string
vcenterUsername
Required

Username to authenticate to vCenter Server in workload domain

string
nsxUsername
Required

Username to authenticate to NSX manager in workload domain

boolean
createDefaultZones
Optional

Create default cloud zones for the enabled regions.

object
customProperties
Optional

Additional properties that may be used to extend the base type.

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.