VCenter Clusters.
This object has no members.
cluster in scope or not in scope
Format: free
SDK attribute: agencyMoid
Whether to get the Data IP for the VRS VM from DHCP or statically
SDK attribute: allowDataDHCP
Whether to get the management IP for the VRS VM from DHCP or statically.
SDK attribute: allowMgmtDHCP
Whether ARP Reply is enabled/disabled
SDK attribute: ARPReply
The ID of the vcenter to which this host is attached
Format: free
SDK attribute: assocVCenterDataCenterID
ID of the associated VCenter.
Format: free
SDK attribute: assocVCenterID
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
Default value: false
SDK attribute: avrsEnabled
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.
Allowed values: AVRS_25G
Default value: AVRS_25G
SDK attribute: avrsProfile
Configured VRS metrics push interval on VCIN
Default value: 60
Min value: 10
SDK attribute: configuredMetricsPushInterval
The number of vCPUs that will be assigned to the VRS.
Allowed values: DEFAULT_2, LARGE_6, MEDIUM_4, XLARGE_8
Default value: DEFAULT_2
SDK attribute: cpuCount
To provide a URL to install a custom app on VRS
Format: free
SDK attribute: customizedScriptURL
Data DNS 1
Format: free
SDK attribute: dataDNS1
Data DNS 2
Format: free
SDK attribute: dataDNS2
Data Gateway
Format: free
SDK attribute: dataGateway
Data Network Port Group
Format: free
SDK attribute: dataNetworkPortgroup
Datapath Sync Timeout
Format: free
SDK attribute: datapathSyncTimeout
Set to true if the cluster is deleted from Vcenter
SDK attribute: deletedFromVCenterDataCenter
Description of the Cluster
Format: free
SDK attribute: description
Extra Vnic to mirror access port
Allowed values: ens160, ens161, ens224, ens256, no_mirror
Default value: no_mirror
SDK attribute: destinationMirrorPort
To provide IP address of the interface from which you will connect to the DHCP relay server
Format: free
SDK attribute: dhcpRelayServer
Disable GRO on datapath
Default value: false
SDK attribute: disableGROOnDatapath
Disable LRO on datapath
Default value: false
SDK attribute: disableLROOnDatapath
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.
SDK attribute: embeddedMetadata
Enable resource reservation on the VRS. When this is enabled, all memory and 100% of CPU resources allocated to the VRS will be reserved.
Default value: false
SDK attribute: enableVRSResourceReservation
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
Flow Eviction Threshold
Format: free
SDK attribute: flowEvictionThreshold
Whether split-activation is needed from VRO
Format: free
SDK attribute: genericSplitActivation
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
VCenter Managed Object ID of the Cluster.
Format: free
SDK attribute: managedObjectID
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.
Default value: false
SDK attribute: manageVRSAvailability
Memory in Gigabytes
Allowed values: DEFAULT_4, LARGE_8, MEDIUM_6
Default value: DEFAULT_4
SDK attribute: memorySizeInGB
Metadata Server IP
Format: free
SDK attribute: metadataServerIP
Metadata Server Listen Port
Format: free
SDK attribute: metadataServerListenPort
Metadata Server Port
Format: free
SDK attribute: metadataServerPort
Metadata Service Enabled
SDK attribute: metadataServiceEnabled
DNS server 1
Format: free
SDK attribute: mgmtDNS1
DNS server 2
Format: free
SDK attribute: mgmtDNS2
Gateway for the IP address
Format: free
SDK attribute: mgmtGateway
Management Network Port group
Format: free
SDK attribute: mgmtNetworkPortgroup
Mirror Port Group Name
Format: free
SDK attribute: mirrorNetworkPortgroup
Maximum Transmission Unit for eth2 interface
SDK attribute: mtu
Multicast Receive Interface
Format: free
SDK attribute: multicastReceiveInterface
IP address for eth3 interface
Format: free
SDK attribute: multicastReceiveInterfaceIP
Multicast Interface netmask
Format: free
SDK attribute: multicastReceiveInterfaceNetmask
Allowed Range to receive the Multicast traffic from
Format: free
SDK attribute: multicastReceiveRange
Multicast Send Interface
Format: free
SDK attribute: multicastSendInterface
IP address for eth3 interface
Format: free
SDK attribute: multicastSendInterfaceIP
Multicast Interface netmask
Format: free
SDK attribute: multicastSendInterfaceNetmask
Multi Cast Source Port Group Name
Format: free
SDK attribute: multicastSourcePortgroup
Whether Multi VM is to be used or not
SDK attribute: multiVMSsupport
Name of the Cluster
Format: free
SDK attribute: name
Network Uplink Interface to support PAT/NAT with no tunnels on VRS-VM
Format: free
SDK attribute: networkUplinkInterface
Network Uplink Interface Gateway
Format: free
SDK attribute: networkUplinkInterfaceGateway
Ip Address to support PAT/NAT with no tunnels on VRS-VM
Format: free
SDK attribute: networkUplinkInterfaceIp
Network Uplink Interface Netmask
Format: free
SDK attribute: networkUplinkInterfaceNetmask
IP address of NFS server to send the VRS log
Format: free
SDK attribute: nfsLogServer
Location to mount the NFS server
Format: free
SDK attribute: nfsMountPath
Nova client Version
SDK attribute: novaClientVersion
Keystone identity version to use for the Nova metadata configuration on the VRS
Format: free
SDK attribute: novaIdentityURLVersion
Nova metadata service auth url
Format: free
SDK attribute: novaMetadataServiceAuthUrl
Nova metadata service endpoint
Format: free
SDK attribute: novaMetadataServiceEndpoint
Nova metadata service password
Format: free
SDK attribute: novaMetadataServicePassword
Nova metadata service tenant
Format: free
SDK attribute: novaMetadataServiceTenant
Nova metadata service username
Format: free
SDK attribute: novaMetadataServiceUsername
Keystone username used by nova
Format: free
SDK attribute: novaOSKeystoneUsername
Name of the project that the Nova service uses, can be determined from the nova.conf on the OpenStack controller
Format: free
SDK attribute: novaProjectDomainName
Name of the default Nova project (example: services)
Format: free
SDK attribute: novaProjectName
Nova region name
Format: free
SDK attribute: novaRegionName
Name of the user domain used by the Nova service, can be determined from the nova.conf on the OpenStack controller
Format: free
SDK attribute: novaUserDomainName
IP of the NTP server 1
Format: free
SDK attribute: ntpServer1
IP of the NTP server 1
Format: free
SDK attribute: ntpServer2
ovf url
Format: free
SDK attribute: ovfURL
The personality of the VRS Agent, supported values when deploying through the vCenter Integration Node: VRS, VDF.
Allowed values: VDF, VRS
Default value: VRS
SDK attribute: personality
Port Group Meta data
SDK attribute: portgroupMetadata
Primary data uplink underlay ID
Default value: 0
Max value: 65535
SDK attribute: primaryDataUplinkUnderlayID
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.
Default value: 0
Max value: 4094
SDK attribute: primaryDataUplinkVDFControlVLAN
IP address of the primary Controller (VSC)
Format: free
SDK attribute: primaryNuageController
Remote syslog server IP
Format: free
SDK attribute: remoteSyslogServerIP
Remote syslog server port
Default value: 514
SDK attribute: remoteSyslogServerPort
Remote syslog server type (UDP/TCP)
Allowed values: NONE, TCP, UDP
Default value: NONE
SDK attribute: remoteSyslogServerType
Enable revertive controller behaviour. If this is enabled, OVS will make its primary VSC as its master VSC once it is back up.
Default value: false
SDK attribute: revertiveControllerEnabled
A timer in seconds indicating after how long OVS should retry to connect to the primary VSC as its master after a failure.
Default value: 300
Min value: 10
Max value: 7200
SDK attribute: revertiveTimer
Specifies if this cluster is in scope or not in scope.
SDK attribute: scope
Enable DHCP on the secondary data uplink.
Default value: false
SDK attribute: secondaryDataUplinkDHCPEnabled
Enable secondary data uplink
Default value: false
SDK attribute: secondaryDataUplinkEnabled
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.
Format: free
SDK attribute: secondaryDataUplinkInterface
Secondary data uplink MTU
Default value: 1500
SDK attribute: secondaryDataUplinkMTU
Secondary data uplink primary controller IP
Format: free
SDK attribute: secondaryDataUplinkPrimaryController
Secondary data uplink secondary controller IP
Format: free
SDK attribute: secondaryDataUplinkSecondaryController
Secondary data uplink underlay ID
Default value: 1
Max value: 65535
SDK attribute: secondaryDataUplinkUnderlayID
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.
Default value: 0
Max value: 4094
SDK attribute: secondaryDataUplinkVDFControlVLAN
IP address of the secondary Controller (VSC)
Format: free
SDK attribute: secondaryNuageController
Whether Data will use the management network or not
Format: free
SDK attribute: separateDataNetwork
Site ID field for object profiles to support VSD Geo-redundancy
Format: free
SDK attribute: siteId
static route to be configured in the VRS
Format: free
SDK attribute: staticRoute
Gateway for the static route given above
Format: free
SDK attribute: staticRouteGateway
Nova region name
Format: free
SDK attribute: staticRouteNetmask
Upgrade package password used for script based upgrades
Format: free
SDK attribute: upgradePackagePassword
Upgrade package URLused for script based upgrades
Format: free
SDK attribute: upgradePackageURL
Upgrade package username used for script based upgrades
Format: free
SDK attribute: upgradePackageUsername
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
SDK attribute: upgradeScriptTimeLimit
VM Network Port Group Name
Format: free
SDK attribute: vmNetworkPortgroup
Whether split-activation or not (Openstack/CloudStack)
SDK attribute: vRequireNuageMetadata
The maximum wait time limit in minutes to get VRS configured at cluster level
SDK attribute: VRSConfigurationTimeLimit
VRS password to be used by toolbox to communicate with VRS
Format: free
SDK attribute: vrsPassword
VRS user name to be used by toolbox to communicate with VRS
Format: free
SDK attribute: vrsUserName