Update Virtual Center

Update the representation of a registered vCenter server. This operation is asynchronous and returns a task that you can monitor to track the progress of the request. Starting with API version 36.0, a null nsxVManager will attempt to remove the NSX-V Manager from the vCenter, and a non-null nsxVManager will attempt to add the NSX-V Manager to the vCenter if there is none registered or update the NSX-V Manager if there is one already registered to the vCenter. If you don't want to update the NSX-V Manager, provide the same NSX-V Manager settings as the existing one. For API versions before 36.0, no changes or updates to the nsxVManager will be made, regardless of whether an nsxVManger is provided or if it's different than the existing one.

Request

URI

PUT

https://{api_host}/cloudapi/1.0.0/virtualCenters/{vcUrn}

COPY

Path Parameters

string

vcUrn

Required

vcUrn

Request Body

VCenterServer of type(s) application/json

Optional

{
    "vcId": "urn:vcloud:vimserver:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "vCenter Sample Name",
    "description": "vCenter Sample Description",
    "username": "string",
    "password": "string",
    "url": "https://sampleVc.vmware.com",
    "isEnabled": false,
    "vsphereWebClientServerUrl": "string",
    "hasProxy": false,
    "rootFolder": "string",
    "vcNoneNetwork": "string",
    "tenantVisibleName": "string",
    "isConnected": false,
    "mode": "string",
    "listenerState": "string",
    "clusterHealthStatus": "string",
    "vcVersion": "6.7.0",
    "buildNumber": "12345",
    "uuid": "string",
    "nsxVManager": {
        "username": "string",
        "password": "string",
        "url": "https://sampleVsm.vmware.com",
        "softwareVersion": "string"
    },
    "proxyConfigurationUrn": "string"
}

string

vcId

Optional

URN of the associated vCenter server.

string

name

Required

The name of the vCenter server.

string

description

Optional

Optional description.

string

username

Required

User name to connect to the server.

string

password

Optional

Cleartext password to connect to the server.

string As uri As uri

url

Required

URL of the server.

boolean

isEnabled

Optional

True if the vCenter server is enabled for use with vCloud Director.

string As uri As uri

vsphereWebClientServerUrl

Optional

The URL of vCenter web client server.

boolean

hasProxy

Optional

When present, indicates that a proxy exists within vCloud Director that proxies this vCenter server for access by authorized end-users. Setting this field to true when registering a vCenter server will result in a proxy being created for the vCenter server, and another for the corresponding SSO endpoint (if different from the vCenter server's endpoint). This field is immutable after the vCenter Server is registered, and will be updated by the system when/if the proxy is removed.

string

rootFolder

Optional

vCenter root folder in which the vCloud Director system folder will be created. This parameter only takes the folder name and not directory structure.

string

vcNoneNetwork

Optional

Network in Vcenter to be used as 'NONE' network by vCD.

string

tenantVisibleName

Optional

Public label of this vCenter server visible to all tenants.

boolean

isConnected

Optional

True if the vCenter server is connected.

string

mode

Optional

The vcenter mode. One of

NONE - undetermined
IAAS - provider scoped
SDDC - tenant scoped
MIXED

IAAS indicates this vCenter server is scoped to the provider. SDDC indicates that this vCenter server is scoped to tenants, while MIXED indicates mixed mode, where both uses are allowed in this vCenter server.

Possible values are : NONE, IAAS, SDDC, MIXED,

string

listenerState

Optional

The vcenter listener state. One of