[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Update Virtual Center

Description

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

Request

URL

URL


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

Path Parameters

Path Parameters

string
vcUrn Required

Request Body

Request Body

VCenterServer of type(s) application/json Required
{
    "name": "vCenter Sample Name",
    "url": "https://sampleVc.vmware.com"
}
string
name Required

The name of the vCenter server.


string
username Required

User name to connect to the server.


string as uri
url Required

URL of the server.


string
buildNumber Optional

The build number of the VIM server.


boolean
isConnected Optional

True if the vCenter server is connected.


boolean
isEnabled Optional

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


string
listenerState Optional

The vcenter listener state. One of

  • INITIAL
  • INVALID_SETTINGS
  • UNSUPPORTED
  • DISCONNECTED
  • CONNECTING
  • CONNECTED_SYNCING
  • CONNECTED
  • STOP_REQ
  • STOP_AND_PURGE_REQ
  • STOP_ACK


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: NONEIAASSDDCMIXED


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.


nsxVManager Optional

the NSX-V attached to this Virtual Center server, when present.


string
password Optional

Cleartext password to connect to the server.


string
proxyConfigurationUrn Optional

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
tenantVisibleName Optional

Public label of this vCenter server visible to all tenants.


string
description Optional

Optional description.


string
clusterHealthStatus Optional

The overall health status of clusters in this vCenter server. One of

  • GRAY
  • RED
  • YELLOW
  • GREEN

Possible values are: GRAYREDYELLOWGREEN


string
uuid Optional

The instance UUID property of the vCenter server.


string
vcId Optional

URN of the associated vCenter server.


string
vcNoneNetwork Optional

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


string
vcVersion Optional

The version of the VIM server.


string as uri
vsphereWebClientServerUrl Optional

The URL of vCenter web client server.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

The request have been accepted and the task to monitor the request is in the Location header.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"buildNumber":"12345","description":"vCenter Sample Description","name":"vCenter Sample Name","url":"https://sampleVc.vmware.com","vcId":"urn:vcloud:vimserver:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","vcVersion":"6.7.0"}' https://{api_host}/cloudapi/1.0.0/virtualCenters/{vcUrn}


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?