VCenterServer

VCenterServer
VCenterServer

An object representing a vCenter server.

JSON Example
{
    "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",
    "vcNoneNetworkMoref": "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
vcNoneNetworkMoref
Optional

Moref for 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

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

string
clusterHealthStatus
Optional

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

  • GRAY
  • RED
  • YELLOW
  • GREEN

Possible values are : GRAY, RED, YELLOW, GREEN,
string
vcVersion
Optional

The version of the VIM server.

string
buildNumber
Optional

The build number of the VIM server.

string
uuid
Optional

The instance UUID property of the vCenter server.

nsxVManager
Optional

nsxVManager

string
proxyConfigurationUrn
Optional

proxyConfigurationUrn

Availability
Added in 34.0