VCenterDataCenter

VCenter DataCenters.

Overview

allowDataDHCP boolean
allowMgmtDHCP boolean
ARPReply boolean
associatedVCenterID string
avrsEnabled boolean
avrsProfile enum (AVRS_25G)
configuredMetricsPushInterval integer
cpuCount enum (DEFAULT_2 | LARGE_6 | MEDIUM_4 | XLARGE_8)
customizedScriptURL string
dataDNS1 string
dataDNS2 string
dataGateway string
dataNetworkPortgroup string
datapathSyncTimeout integer
deletedFromVCenter boolean
description string
destinationMirrorPort enum (ens160 | ens161 | ens224 | ens256 | no_mirror)
dhcpRelayServer string
disableGROOnDatapath boolean
disableLROOnDatapath boolean
embeddedMetadata list read only   autogenerated  
enableVRSResourceReservation boolean
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
flowEvictionThreshold integer
genericSplitActivation boolean
lastUpdatedBy string autogenerated  
managedObjectID string filterable   orderable  
manageVRSAvailability boolean
memorySizeInGB enum (DEFAULT_4 | LARGE_8 | MEDIUM_6)
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
ovfURL string
personality enum (VDF | VRS)
portgroupMetadata boolean
primaryDataUplinkUnderlayID integer
primaryDataUplinkVDFControlVLAN integer
primaryNuageController string
remoteSyslogServerIP string
remoteSyslogServerPort integer
remoteSyslogServerType enum (NONE | TCP | UDP)
revertiveControllerEnabled boolean required  
revertiveTimer integer required  
secondaryDataUplinkDHCPEnabled boolean
secondaryDataUplinkEnabled boolean required  
secondaryDataUplinkInterface string
secondaryDataUplinkMTU integer
secondaryDataUplinkPrimaryController string
secondaryDataUplinkSecondaryController string
secondaryDataUplinkUnderlayID integer
secondaryDataUplinkVDFControlVLAN integer
secondaryNuageController string
separateDataNetwork boolean
siteId string
staticRoute string
staticRouteGateway string
staticRouteNetmask string
upgradePackagePassword string
upgradePackageURL string
upgradePackageUsername string
upgradeScriptTimeLimit integer
vmNetworkPortgroup string
vRequireNuageMetadata boolean
VRSConfigurationTimeLimit integer
vrsPassword string
vrsUserName string

API Resource

/vcenterdatacenters/id
delete get put

Parents

/vcenters/id/vcenterdatacenters
get post put

Children

/vcenterdatacenters/id/vcenterclusters
get post put
/vcenterdatacenters/id/vcenterhypervisors
get post put
/vcenterdatacenters/id/permissions
delete get post put
/vcenterdatacenters/id/metadatas
get post
/vcenterdatacenters/id/globalmetadatas
get post put
/vcenterdatacenters/id/vrsaddressranges
get post
/vcenterdatacenters/id/vrsredeploymentpolicies
get post
/vcenterdatacenters/id/autodiscoveredclusters
get
/vcenterdatacenters/id/autodiscoveredhypervisors
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

SDK attribute: allowDataDHCP

allowMgmtDHCP boolean
Discussion

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

Charateristics

SDK attribute: allowMgmtDHCP

ARPReply boolean
Discussion

Whether ARP Reply is enabled/disabled

Charateristics

SDK attribute: ARPReply

associatedVCenterID string
Discussion

The ID of the vcenter to which this host is attached

Charateristics

Format: free
SDK attribute: associatedVCenterID

avrsEnabled boolean
Discussion

When enabled, the AVRS functionality will be enabled on the VRS during bootstrapping. This feature requires special AVRS licenses and specific configuration which is described in the product documentation.

Charateristics

Default value: false
SDK attribute: avrsEnabled

avrsProfile enum
Discussion

The AVRS configuration profile that needs to be set up. This profile will configure the AVRS services so that it can support a certain type of performance.

Charateristics

Allowed values: AVRS_25G
Default value: AVRS_25G
SDK attribute: avrsProfile

configuredMetricsPushInterval integer
Discussion

Configured VRS metrics push interval on VCIN

Charateristics

Default value: 60
Min value: 10
SDK attribute: configuredMetricsPushInterval

cpuCount enum
Discussion

The number of vCPUs that will be assigned to the VRS.

Charateristics

Allowed values: DEFAULT_2, LARGE_6, MEDIUM_4, XLARGE_8
Default value: DEFAULT_2
SDK attribute: cpuCount

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

deletedFromVCenter boolean
Discussion

Set to true if the datacenter is deleted from Vcenter

Charateristics

SDK attribute: deletedFromVCenter

description string
Discussion

Description of the Datacenter

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

disableGROOnDatapath boolean
Discussion

Disable GRO on datapath

Charateristics

Default value: false
SDK attribute: disableGROOnDatapath

disableLROOnDatapath boolean
Discussion

Disable LRO on datapath

Charateristics

Default value: false
SDK attribute: disableLROOnDatapath

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

enableVRSResourceReservation boolean
Discussion

Enable resource reservation on the VRS. When this is enabled, all memory and 100% of CPU resources allocated to the VRS will be reserved.

Charateristics

Default value: false
SDK attribute: enableVRSResourceReservation

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

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

managedObjectID string filterable   orderable  
Discussion

VCenter Managed Object ID of the Datacenter.

Charateristics

Format: free
SDK attribute: managedObjectID

manageVRSAvailability boolean
Discussion

When this is set to true, the vCenter Integration Node will be responsible for marking a VRS Agent as available in the EAM framework. Until a VRS Agent has been marked as available, vCenter will not migrate VMs to the host running the VRS Agent and will not allow VMs to be powered on that host.

Charateristics

Default value: false
SDK attribute: manageVRSAvailability

memorySizeInGB enum
Discussion

Memory in Gigabytes

Charateristics

Allowed values: DEFAULT_4, LARGE_8, MEDIUM_6
Default value: DEFAULT_4
SDK attribute: memorySizeInGB

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

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

Max value: 9000
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

SDK attribute: multiVMSsupport

name string required   filterable   orderable  
Discussion

Name of the Datacenter

Charateristics

Format: free
SDK attribute: name

networkUplinkInterface string
Discussion

Network Uplink 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

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

ovfURL string
Discussion

ovf url

Charateristics

Format: free
SDK attribute: ovfURL

personality enum
Discussion

The personality of the VRS Agent, supported values when deploying through the vCenter Integration Node: VRS, VDF.

Charateristics

Allowed values: VDF, VRS
Default value: VRS
SDK attribute: personality

portgroupMetadata boolean
Discussion

Port Group Meta data

Charateristics

SDK attribute: portgroupMetadata

primaryDataUplinkUnderlayID integer
Discussion

Primary data uplink underlay ID

Charateristics

Default value: 0
Max value: 65535
SDK attribute: primaryDataUplinkUnderlayID

primaryDataUplinkVDFControlVLAN integer
Discussion

The VLAN for the control communication with VSC on the primary datapath interface, when VDF is enabled. This VLAN can not be used as a subnet VLAN in the VSD configuration.

Charateristics

Default value: 0
Max value: 4094
SDK attribute: primaryDataUplinkVDFControlVLAN

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

revertiveControllerEnabled boolean required  
Discussion

Enable revertive controller behaviour. If this is enabled, OVS will make its primary VSC as its master VSC once it is back up.

Charateristics

Default value: false
SDK attribute: revertiveControllerEnabled

revertiveTimer integer required  
Discussion

A timer in seconds indicating after how long OVS should retry to connect to the primary VSC as its master after a failure.

Charateristics

Default value: 300
Min value: 10
Max value: 7200
SDK attribute: revertiveTimer

secondaryDataUplinkDHCPEnabled boolean
Discussion

Enable DHCP on the secondary data uplink.

Charateristics

Default value: false
SDK attribute: secondaryDataUplinkDHCPEnabled

secondaryDataUplinkEnabled boolean required  
Discussion

Enable secondary data uplink

Charateristics

Default value: false
SDK attribute: secondaryDataUplinkEnabled

secondaryDataUplinkInterface string
Discussion

Interface to use for the secondary data uplink. This interface can be a normal interface or a VLAN on an existing interface. Please read the VMware integration guide for more details.

Charateristics

Format: free
SDK attribute: secondaryDataUplinkInterface

secondaryDataUplinkMTU integer
Discussion

Secondary data uplink MTU

Charateristics

Default value: 1500
SDK attribute: secondaryDataUplinkMTU

secondaryDataUplinkPrimaryController string
Discussion

Secondary data uplink primary controller IP

Charateristics

Format: free
SDK attribute: secondaryDataUplinkPrimaryController

secondaryDataUplinkSecondaryController string
Discussion

Secondary data uplink secondary controller IP

Charateristics

Format: free
SDK attribute: secondaryDataUplinkSecondaryController

secondaryDataUplinkUnderlayID integer
Discussion

Secondary data uplink underlay ID

Charateristics

Default value: 1
Max value: 65535
SDK attribute: secondaryDataUplinkUnderlayID

secondaryDataUplinkVDFControlVLAN integer
Discussion

The VLAN for the control communication with VSC on the secondary datapath interface, when VDF is enabled. This VLAN can not be used as a subnet VLAN in the VSD configuration.

Charateristics

Default value: 0
Max value: 4094
SDK attribute: secondaryDataUplinkVDFControlVLAN

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

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

SDK attribute: vRequireNuageMetadata

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