Create V Sphere Cloud Account | vRealize Automation Cloud Infrastructure as a Service (IaaS) API

Create V Sphere Cloud Account

Create a vSphere cloud account within the current organization

Request

URI

POST

https://{api_host}/iaas/api/cloud-accounts-vsphere

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

CloudAccountVsphereSpecification of type(s) application/json

Optional

{
    "name": "string",
    "description": "string",
    "hostName": "vc.mycompany.com",
    "acceptSelfSignedCertificate": false,
    "associatedCloudAccountIds": [
        "string"
    ],
    "dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
    "username": "administrator@mycompany.com",
    "password": "cndhjslacd90ascdbasyoucbdh",
    "regionIds": [
        "string"
    ],
    "createDefaultZones": true,
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

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

hostName

Required

Host name for the vSphere endpoint

boolean

acceptSelfSignedCertificate

Optional

Accept self signed certificate when connecting to vSphere

array of string

associatedCloudAccountIds

Optional

Cloud accounts to associate with this cloud account

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

username

Required

Username to authenticate with the cloud account

string

password

Required

Password for the user used to authenticate with the cloud Account

array of string

regionIds

Required

A set of datacenter managed object reference identifiers (MoRef) to enable provisioning on. Refer to /iaas/cloud-accounts-vsphere/region-enumeration.

boolean

createDefaultZones

Optional

Create default cloud zones for the enabled regions.

array of Tag

tags

Optional

A set of tag keys and optional values to set on the Cloud Account

Responses

201

successful operation

Returns CloudAccountVsphere of type(s) application/json

{
    "id": "9e49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "csp@vmware.com",
    "organizationId": "deprecated",
    "orgId": "9e49",
    "name": "my-name",
    "description": "my-description",
    "hostName": "vc1.vmware.com",
    "dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
    "username": "administrator@mycompany.com",
    "enabledRegionIds": [
        "string"
    ],
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

string

Required

The id of this resource instance

string

createdAt

Optional

Date when the entity was created. The date is in ISO 6801 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 that owns the entity.

string

organizationId

Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

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.

string

hostName

Required

Host name for the vSphere cloud account

string

dcid

Optional

Identifier of a data collector vm deployed in the on premise infrastructure.

string

username

Required

Username to authenticate with the cloud account

array of string

enabledRegionIds

Optional

A set of region names that are enabled for this cloud account.

object

customProperties

Optional

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

array of Tag