Update V Sphere Cloud Account Async

Update vSphere cloud account

Request

URI

PATCH

https://vra-interop-222-139.lvn.broadcom.net/iaas/api/cloud-accounts-vsphere/{id}

COPY

Path Parameters

string

Required

Cloud account id

Query Parameters

string

apiVersion

Required

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

Request Body

vSphere cloud account details to be updated

UpdateCloudAccountVsphereSpecification of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "hostName": "vc.mycompany.com",
    "regions": [
        {
            "name": "Datacenter:datacenter-3",
            "externalRegionId": "Datacenter:datacenter-3"
        }
    ]
}

{
    "name": "string",
    "description": "string",
    "hostName": "vc.mycompany.com",
    "acceptSelfSignedCertificate": false,
    "associatedCloudAccountIds": [
        "42f3e0d199d134755684cd935435a"
    ],
    "associatedMobilityCloudAccountIds": {
        "42f3e0d199d134755684cd935435a": "BIDIRECTIONAL"
    },
    "dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
    "username": "[email protected]",
    "password": "cndhjslacd90ascdbasyoucbdh",
    "regions": [
        {
            "name": "Datacenter:datacenter-3",
            "externalRegionId": "Datacenter:datacenter-3"
        }
    ],
    "createDefaultZones": true,
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ],
    "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

hostName

Required

Host name for the vSphere endpoint

boolean

acceptSelfSignedCertificate

Optional

Accept self signed certificate when connecting to vSphere

array of string

associatedCloudAccountIds

Optional

NSX Manager account to associate with this vSphere cloud account. vSphere cloud account can be associated to a single NSX Manager cloud account

object

associatedMobilityCloudAccountIds

Optional

Cloud account IDs and directionalities create associations to other vSphere cloud accounts that can be used for workload mobility. ID refers to an associated cloud account, and directionality can be unidirectional or bidirectional.

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.

string

username

Optional

Username to authenticate with the cloud account.

string

password

Optional

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

array of object

regions

Required

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

boolean

createDefaultZones

Optional

Create default cloud zones for the enabled regions.

array of object

tags

Optional

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

object

certificateInfo

Optional

Specification for certificate for a cloud account.

string

environment

Optional

The environment where data collectors are deployed. When the data collectors are deployed on an aap-based cloud gateway appliance, use "aap".

Authentication

This operation uses the following authentication methods.

Authorization

Responses

202

Accepted

Returns RequestTracker of type(s) application/json

"RequestTracker Object"

integer As int32 As int32

progress

Required

Progress of the request as percentage.

string

message

Optional

Status message of the request.

string

status

Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,

array of string

resources

Optional

Collection of resources.

string

name

Optional

Name of the operation.

string

Required

ID of this request.

string

selfLink

Required

Self link of this request.

string

deploymentId

Optional

ID of the deployment, this request is connected to.

403

Forbidden

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

404

Not Found

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

Code Samples

COPY

                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"hostName:"string","name:"string","regions":["object"]}'

On This Page

Description

Request

Path Parameters

Query Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Cloud Account Operations

POST