VCenter API Reference 5.0

VCenter

Represents a VCenter.

Overview

allowDataDHCP	boolean
allowMgmtDHCP	boolean
autoResolveFrequency	integer
connectionStatus	boolean
customizedScriptURL	string
dataDNS1	string
dataDNS2	string
dataGateway	string
dataNetworkPortgroup	string
datapathSyncTimeout	integer
description	string
destinationMirrorPort	enum (ens160 \| ens161 \| ens224 \| ens256 \| no_mirror)
dhcpRelayServer	string
disableNetworkDiscovery	boolean
entityScope	enum (ENTERPRISE \| GLOBAL)	autogenerated
externalID	string	filterable orderable locally unique
flowEvictionThreshold	integer
genericSplitActivation	boolean
hostLevelManagement	boolean
httpPort	integer
httpsPort	integer
ipAddress	string	required filterable
lastUpdatedBy	string	autogenerated
metadataServerIP	string
metadataServerListenPort	integer
metadataServerPort	integer
metadataServiceEnabled	boolean
mgmtDNS1	string
mgmtDNS2	string
mgmtGateway	string
mgmtNetworkPortgroup	string
mirrorNetworkPortgroup	string
mtu	integer
multicastReceiveInterface	string
multicastReceiveInterfaceIP	string
multicastReceiveInterfaceNetmask	string
multicastReceiveRange	string
multicastSendInterface	string
multicastSendInterfaceIP	string
multicastSendInterfaceNetmask	string
multicastSourcePortgroup	string
multiVMSsupport	boolean
name	string	required filterable orderable
networkUplinkInterface	string
networkUplinkInterfaceGateway	string
networkUplinkInterfaceIp	string
networkUplinkInterfaceNetmask	string
nfsLogServer	string
nfsMountPath	string
novaClientVersion	integer
novaIdentityURLVersion	string
novaMetadataServiceAuthUrl	string
novaMetadataServiceEndpoint	string
novaMetadataServicePassword	string
novaMetadataServiceTenant	string
novaMetadataServiceUsername	string
novaMetadataSharedSecret	string
novaOSKeystoneUsername	string
novaProjectDomainName	string
novaProjectName	string
novaRegionName	string
novaUserDomainName	string
ntpServer1	string
ntpServer2	string
oldAgencyName	string	filterable orderable
ovfURL	string
password	string	required
personality	string
portgroupMetadata	boolean
primaryNuageController	string
remoteSyslogServerIP	string
remoteSyslogServerPort	integer
remoteSyslogServerType	enum (NONE \| TCP \| UDP)
secondaryNuageController	string
separateDataNetwork	boolean
siteId	string
staticRoute	string
staticRouteGateway	string
staticRouteNetmask	string
upgradePackagePassword	string
upgradePackageURL	string
upgradePackageUsername	string
upgradeScriptTimeLimit	integer
userName	string	required
vmNetworkPortgroup	string
vRequireNuageMetadata	boolean
vrsConfigID	string
VRSConfigurationTimeLimit	integer
vrsPassword	string
vrsUserName	string

API Resource

/vcenters/id

delete get put

Parents

/vcenters

get post

Children

/vcenters/id/vcenterdatacenters

get post put

/vcenters/id/metadatas

get post

/vcenters/id/globalmetadatas

get post put

/vcenters/id/jobs

post

/vcenters/id/vrsaddressranges

get post

/vcenters/id/vrsredeploymentpolicies

get post

/vcenters/id/autodiscovereddatacenters

get

Members

This object has no members.

Attributes documentation

allowDataDHCP boolean

Discussion

Whether to get the Data IP for the VRS VM from DHCP or statically

Charateristics

Format: free
SDK attribute: allowDataDHCP

allowMgmtDHCP boolean

Discussion

Whether to get the management IP for the VRS VM from DHCP or statically

Charateristics

Format: free
SDK attribute: allowMgmtDHCP

autoResolveFrequency integer

Discussion

Frequency at which VCenter issues are to be resolved

Charateristics

Format: free
SDK attribute: autoResolveFrequency

connectionStatus boolean

Discussion

VCenter connection status.

Charateristics

SDK attribute: connectionStatus

customizedScriptURL string

Discussion

To provide a URL to install a custom app on VRS

Charateristics

Format: free
SDK attribute: customizedScriptURL

dataDNS1 string

Discussion

Data DNS 1

Charateristics

Format: free
SDK attribute: dataDNS1

dataDNS2 string

Discussion

Data DNS 2

Charateristics

Format: free
SDK attribute: dataDNS2

dataGateway string

Discussion

Data Gateway

Charateristics

Format: free
SDK attribute: dataGateway

dataNetworkPortgroup string

Discussion

Data Network Port Group

Charateristics

Format: free
SDK attribute: dataNetworkPortgroup

datapathSyncTimeout integer

Discussion

Datapath Sync Timeout

Charateristics

Format: free
SDK attribute: datapathSyncTimeout

description string

Discussion

Description of the VCenter

Charateristics

Format: free
SDK attribute: description

destinationMirrorPort enum

Discussion

Extra Vnic to mirror access port

Charateristics

Allowed values: ens160, ens161, ens224, ens256, no_mirror
Default value: no_mirror
SDK attribute: destinationMirrorPort

dhcpRelayServer string

Discussion

To provide IP address of the interface from which you will connect to the DHCP relay server

Charateristics

Format: free
SDK attribute: dhcpRelayServer

disableNetworkDiscovery boolean

Discussion

disable Network Discovery (true - dont fetch portgroups from vcenter, false - fetch portgroups from vcenter)

Charateristics

SDK attribute: disableNetworkDiscovery

entityScope enum autogenerated

Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable orderable locally unique

Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

flowEvictionThreshold integer

Discussion

Flow Eviction Threshold

Charateristics

Format: free
SDK attribute: flowEvictionThreshold

genericSplitActivation boolean

Discussion

Whether split-activation is needed from VRO

Charateristics

Format: free
SDK attribute: genericSplitActivation

hostLevelManagement boolean

Discussion

Flag to say if host level management is enabled

Charateristics

SDK attribute: hostLevelManagement

httpPort integer

Discussion

Http proxy port for VCenter

Charateristics

Format: free
SDK attribute: httpPort

httpsPort integer

Discussion

Https proxy port of the VCenter

Charateristics

SDK attribute: httpsPort

ipAddress string required filterable

Discussion

IP Address of the VCenter

Charateristics

Format: free
SDK attribute: ipAddress

lastUpdatedBy string autogenerated

Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

metadataServerIP string

Discussion

Metadata Server IP

Charateristics

Format: free
SDK attribute: metadataServerIP

metadataServerListenPort integer

Discussion

Metadata Server Listen Port

Charateristics

Format: free
SDK attribute: metadataServerListenPort

metadataServerPort integer

Discussion

Metadata Server Port

Charateristics

Format: free
SDK attribute: metadataServerPort

metadataServiceEnabled boolean

Discussion

Metadata Service Enabled

Charateristics

Format: free
SDK attribute: metadataServiceEnabled

mgmtDNS1 string

Discussion

DNS server 1

Charateristics

Format: free
SDK attribute: mgmtDNS1

mgmtDNS2 string

Discussion

DNS server 2

Charateristics

Format: free
SDK attribute: mgmtDNS2

mgmtGateway string

Discussion

Gateway for the IP address

Charateristics

Format: free
SDK attribute: mgmtGateway

mgmtNetworkPortgroup string

Discussion

Management Network Port group

Charateristics

Format: free
SDK attribute: mgmtNetworkPortgroup

mirrorNetworkPortgroup string

Discussion

Mirror Port Group Name

Charateristics

Format: free
SDK attribute: mirrorNetworkPortgroup

mtu integer

Discussion

Maximum Transmission Unit for eth2 interface

Charateristics

Format: free
SDK attribute: mtu

multicastReceiveInterface string

Discussion

Multicast Receive Interface

Charateristics

Format: free
SDK attribute: multicastReceiveInterface

multicastReceiveInterfaceIP string

Discussion

IP address for eth3 interface

Charateristics

Format: free
SDK attribute: multicastReceiveInterfaceIP

multicastReceiveInterfaceNetmask string

Discussion

Multicast Interface netmask

Charateristics

Format: free
SDK attribute: multicastReceiveInterfaceNetmask

multicastReceiveRange string

Discussion

Allowed Range to receive the Multicast traffic from

Charateristics

Format: free
SDK attribute: multicastReceiveRange

multicastSendInterface string

Discussion

Multicast Send Interface

Charateristics

Format: free
SDK attribute: multicastSendInterface

multicastSendInterfaceIP string

Discussion

IP address for eth3 interface

Charateristics

Format: free
SDK attribute: multicastSendInterfaceIP

multicastSendInterfaceNetmask string

Discussion

Multicast Interface netmask

Charateristics

Format: free
SDK attribute: multicastSendInterfaceNetmask

multicastSourcePortgroup string

Discussion

Multi Cast Source Port Group Name

Charateristics

Format: free
SDK attribute: multicastSourcePortgroup

multiVMSsupport boolean

Discussion

Whether Multi VM is to be used or not

Charateristics

Format: free
SDK attribute: multiVMSsupport

name string required filterable orderable

Discussion

Name of the VCenter

Charateristics

Format: free
SDK attribute: name

networkUplinkInterface string

Discussion

Network Upling Interface to support PAT/NAT with no tunnels on VRS-VM

Charateristics

Format: free
SDK attribute: networkUplinkInterface

networkUplinkInterfaceGateway string

Discussion

Network Uplink Interface Gateway

Charateristics

Format: free
SDK attribute: networkUplinkInterfaceGateway

networkUplinkInterfaceIp string

Discussion

Ip Address to support PAT/NAT with no tunnels on VRS-VM

Charateristics

Format: free
SDK attribute: networkUplinkInterfaceIp

networkUplinkInterfaceNetmask string

Discussion

Network Uplink Interface Netmask

Charateristics

Format: free
SDK attribute: networkUplinkInterfaceNetmask

nfsLogServer string

Discussion

IP address of NFS server to send the VRS log

Charateristics

Format: free
SDK attribute: nfsLogServer

nfsMountPath string

Discussion

Location to mount the NFS server

Charateristics

Format: free
SDK attribute: nfsMountPath

novaClientVersion integer

Discussion

Nova client Version

Charateristics

Format: free
SDK attribute: novaClientVersion

novaIdentityURLVersion string

Discussion

Keystone identity version to use for the Nova metadata configuration on the VRS

Charateristics

Format: free
SDK attribute: novaIdentityURLVersion

novaMetadataServiceAuthUrl string

Discussion

Nova metadata service auth url

Charateristics

Format: free
SDK attribute: novaMetadataServiceAuthUrl

novaMetadataServiceEndpoint string

Discussion

Nova metadata service endpoint

Charateristics

Format: free
SDK attribute: novaMetadataServiceEndpoint

novaMetadataServicePassword string

Discussion

Nova metadata service password

Charateristics

Format: free
SDK attribute: novaMetadataServicePassword

novaMetadataServiceTenant string

Discussion

Nova metadata service tenant

Charateristics

Format: free
SDK attribute: novaMetadataServiceTenant

novaMetadataServiceUsername string

Discussion

Nova metadata service username

Charateristics

Format: free
SDK attribute: novaMetadataServiceUsername

novaMetadataSharedSecret string

Discussion

Nova metadata shared secret

Charateristics

Format: free
SDK attribute: novaMetadataSharedSecret

novaOSKeystoneUsername string

Discussion

Keystone username used by nova

Charateristics

Format: free
SDK attribute: novaOSKeystoneUsername

novaProjectDomainName string

Discussion

Name of the project that the Nova service uses, can be determined from the nova.conf on the OpenStack controller

Charateristics

Format: free
SDK attribute: novaProjectDomainName

novaProjectName string

Discussion

Name of the default Nova project (example: services)

Charateristics

Format: free
SDK attribute: novaProjectName

novaRegionName string

Discussion

Nova region name

Charateristics

Format: free
SDK attribute: novaRegionName

novaUserDomainName string

Discussion

Name of the user domain used by the Nova service, can be determined from the nova.conf on the OpenStack controller

Charateristics

Format: free
SDK attribute: novaUserDomainName

ntpServer1 string

Discussion

IP of the NTP server 1

Charateristics

Format: free
SDK attribute: ntpServer1

ntpServer2 string

Discussion

IP of the NTP server 1

Charateristics

Format: free
SDK attribute: ntpServer2

oldAgencyName string filterable orderable

Discussion

Old Agency Name

Charateristics

Format: free
SDK attribute: oldAgencyName

ovfURL string

Discussion

The url for the ovf

Charateristics

Format: free
SDK attribute: ovfURL

password string required

Discussion

Password for the VCenter user

Charateristics

Format: free
SDK attribute: password

personality string

Discussion

VRS/VRS-G

Charateristics

Format: free
SDK attribute: personality

portgroupMetadata boolean

Discussion

Port Group Meta data

Charateristics

Format: free
SDK attribute: portgroupMetadata

primaryNuageController string

Discussion

IP address of the primary Controller (VSC)

Charateristics

Format: free
SDK attribute: primaryNuageController

remoteSyslogServerIP string

Discussion

Remote syslog server IP

Charateristics

Format: free
SDK attribute: remoteSyslogServerIP

remoteSyslogServerPort integer

Discussion

Remote syslog server port

Charateristics

Default value: 514
SDK attribute: remoteSyslogServerPort

remoteSyslogServerType enum

Discussion

Remote syslog server type (UDP/TCP)

Charateristics

Allowed values: NONE, TCP, UDP
Default value: NONE
SDK attribute: remoteSyslogServerType

secondaryNuageController string

Discussion

IP address of the secondary Controller (VSC)

Charateristics

Format: free
SDK attribute: secondaryNuageController

separateDataNetwork boolean

Discussion

Whether Data will use the management network or not

Charateristics

Format: free
SDK attribute: separateDataNetwork

siteId string

Discussion

Site ID field for object profiles to support VSD Geo-redundancy

Charateristics

Format: free
SDK attribute: siteId

staticRoute string

Discussion

static route to be configured in the VRS

Charateristics

Format: free
SDK attribute: staticRoute

staticRouteGateway string

Discussion

Gateway for the static route given above

Charateristics

Format: free
SDK attribute: staticRouteGateway

staticRouteNetmask string

Discussion

Nova region name

Charateristics

Format: free
SDK attribute: staticRouteNetmask

upgradePackagePassword string

Discussion

Upgrade package password used for script based upgrades

Charateristics

Format: free
SDK attribute: upgradePackagePassword

upgradePackageURL string

Discussion

Upgrade package URLused for script based upgrades

Charateristics

Format: free
SDK attribute: upgradePackageURL

upgradePackageUsername string

Discussion

Upgrade package username used for script based upgrades

Charateristics

Format: free
SDK attribute: upgradePackageUsername

upgradeScriptTimeLimit integer

Discussion

Time limit for the patch based upgrade functionality. If the upgrade process of a VRS has not returned a success or failure status within this time limit, the status will be changed to TIMEOUT. Specified in seconds

Charateristics

SDK attribute: upgradeScriptTimeLimit

userName string required

Discussion

User name of the VCenter

Charateristics

Format: free
SDK attribute: userName

vmNetworkPortgroup string

Discussion

VM Network Port Group Name

Charateristics

Format: free
SDK attribute: vmNetworkPortgroup

vRequireNuageMetadata boolean

Discussion

Whether split-activation or not (Openstack/CloudStack)

Charateristics

Format: free
SDK attribute: vRequireNuageMetadata

vrsConfigID string

Discussion

The ID of the template that this Port was created from

Charateristics

Format: free
SDK attribute: vrsConfigID

VRSConfigurationTimeLimit integer

Discussion

The maximum wait time limit in minutes to get VRS configured at cluster level

Charateristics

SDK attribute: VRSConfigurationTimeLimit

vrsPassword string

Discussion

VRS password to be used by toolbox to communicate with VRS

Charateristics

Format: free
SDK attribute: vrsPassword

vrsUserName string

Discussion

VRS user name to be used by toolbox to communicate with VRS

Charateristics

Format: free
SDK attribute: vrsUserName