VCenterHypervisor API Reference 4.0

VCenterHypervisor

Host or Hypervisors.

Overview

allowDataDHCP	boolean
allowMgmtDHCP	boolean
availableNetworks	list
customizedScriptURL	string
dataDNS1	string
dataDNS2	string
dataGateway	string
dataIPAddress	string
dataNetmask	string
dataNetworkPortgroup	string	required
datapathSyncTimeout	integer
deploymentCount	integer
description	string	required
destinationMirrorPort	enum (ens160 \| ens161 \| ens224 \| ens256 \| no_mirror)
dhcpRelayServer	string
entityScope	enum (ENTERPRISE \| GLOBAL)	autogenerated filterable orderable
externalID	string	filterable orderable locally unique
flowEvictionThreshold	integer
genericSplitActivation	boolean
hypervisorIP	string	required filterable
hypervisorPassword	string	required
hypervisorUser	string	required
lastUpdatedBy	string	autogenerated
lastVRSDeployedDate	time
managedObjectID	string	filterable orderable
metadataServerIP	string
metadataServerListenPort	integer
metadataServerPort	integer
metadataServiceEnabled	boolean
mgmtDNS1	string
mgmtDNS2	string
mgmtGateway	string
mgmtIPAddress	string
mgmtNetmask	string
mgmtNetworkPortgroup	string	required
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
novaMetadataServiceAuthUrl	string
novaMetadataServiceEndpoint	string
novaMetadataServicePassword	string
novaMetadataServiceTenant	string
novaMetadataServiceUsername	string
novaMetadataSharedSecret	string
novaRegionName	string
ntpServer1	string
ntpServer2	string
ovfURL	string	filterable orderable
personality	string
portgroupMetadata	boolean
primaryNuageController	string
removedFromVCenterInventory	boolean	filterable orderable
scope	boolean
secondaryNuageController	string
separateDataNetwork	boolean
siteId	string
staticRoute	string
staticRouteGateway	string
staticRouteNetmask	string
successfullyAppliedVersion	string
toolboxDeploymentMode	boolean
toolboxGroup	string
toolboxIP	string
toolboxPassword	string
toolboxUserName	string
upgradePackagePassword	string	filterable orderable
upgradePackageURL	string	filterable orderable
upgradePackageUsername	string	filterable orderable
upgradeScriptTimeLimit	integer	filterable orderable
upgradeStatus	string	filterable orderable
upgradeTimedout	boolean	filterable orderable
vCenterIP	string
vCenterPassword	string
vCenterUser	string
vmNetworkPortgroup	string	required
vRequireNuageMetadata	boolean
VRSConfigurationTimeLimit	integer
vrsId	string
VRSMetricsID	string	filterable
vrsPassword	string
VRSState	enum (DEPLOYED \| DEPLOYING \| NOT_DEPLOYED \| TIMEDOUT \| UPGRADING)
vrsUserName	string

API Resource

/vcenterhypervisors/id

delete get put

Parents

/vcenterdatacenters/id/vcenterhypervisors

get post put

/vcenterhypervisors

get

/vcenterclusters/id/vcenterhypervisors

get post put

Children

/vcenterhypervisors/id/metadatas

get post

/vcenterhypervisors/id/globalmetadatas

get post put

/vcenterhypervisors/id/jobs

post

/vcenterhypervisors/id/vrsaddressranges

get post

/vcenterhypervisors/id/vrsmetrics

get

/vcenterhypervisors/id/vrsredeploymentpolicies

get post

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

availableNetworks list

Discussion

List of the available network list for the hypervisor.

Charateristics

SDK attribute: availableNetworks

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

dataIPAddress string

Discussion

Data IP Address

Charateristics

Format: free
SDK attribute: dataIPAddress

dataNetmask string

Discussion

Data NetMask

Charateristics

Format: free
SDK attribute: dataNetmask

dataNetworkPortgroup string required

Discussion

Data Network Port Group

Charateristics

Format: free
SDK attribute: dataNetworkPortgroup

datapathSyncTimeout integer

Discussion

Datapath Sync Timeout

Charateristics

Format: free
SDK attribute: datapathSyncTimeout

deploymentCount integer

Discussion

The number of times the vrs was deployed on this hypervisor

Charateristics

SDK attribute: deploymentCount

description string required

Discussion

Description of the Hypervisor

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

entityScope enum autogenerated filterable orderable

Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
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

hypervisorIP string required filterable

Discussion

IP Address of the Hypervisor

Charateristics

Format: free
SDK attribute: hypervisorIP

hypervisorPassword string required

Discussion

Hypervisor username

Charateristics

Format: free
SDK attribute: hypervisorPassword

hypervisorUser string required

Discussion

Hypervisor username

Charateristics

Format: free
SDK attribute: hypervisorUser

lastUpdatedBy string autogenerated

Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastVRSDeployedDate time

Discussion

Determines the time the vrs vm was last deployed.

Charateristics

SDK attribute: lastVRSDeployedDate

managedObjectID string filterable orderable

Discussion

managed Object ID of hypervisor

Charateristics

Format: free
SDK attribute: managedObjectID

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

mgmtIPAddress string

Discussion

The Mangement IP address for VRS VM if needed to be given statically

Charateristics

Format: free
SDK attribute: mgmtIPAddress

mgmtNetmask string

Discussion

Netmask of the IP address above

Charateristics

Format: free
SDK attribute: mgmtNetmask

mgmtNetworkPortgroup string required

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 Hypervisor

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

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

novaRegionName string

Discussion

Nova region name

Charateristics

Format: free
SDK attribute: novaRegionName

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 filterable orderable

Discussion

ovf url

Charateristics

Format: free
SDK attribute: ovfURL

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

removedFromVCenterInventory boolean filterable orderable

Discussion

Set to true if the hypervisor is removed from Vcenter inventory datacenter or cluster

Charateristics

SDK attribute: removedFromVCenterInventory

scope boolean

Discussion

Cluster in scope or not in scope.

Charateristics

SDK attribute: scope

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

successfullyAppliedVersion string

Discussion

Successfully applied version of the VRS VM (Provided by VRS VM)

Charateristics

SDK attribute: successfullyAppliedVersion

toolboxDeploymentMode boolean

Discussion

Flag to specify if VRS is deployed using tool box.

Charateristics

Format: free
SDK attribute: toolboxDeploymentMode

toolboxGroup string

Discussion

Deployment Toolbox Group.

Charateristics

Format: free
SDK attribute: toolboxGroup

toolboxIP string

Discussion

Deployment Toolbox IP.

Charateristics

Format: free
SDK attribute: toolboxIP

toolboxPassword string

Discussion

Deployment Toolbox password.

Charateristics

Format: free
SDK attribute: toolboxPassword

toolboxUserName string

Discussion

Deployment Toolbox username.

Charateristics

Format: free
SDK attribute: toolboxUserName

upgradePackagePassword string filterable orderable

Discussion

upgradePackagePassword

Charateristics

Format: free
SDK attribute: upgradePackagePassword

upgradePackageURL string filterable orderable

Discussion

upgradePackageURL

Charateristics

Format: free
SDK attribute: upgradePackageURL

upgradePackageUsername string filterable orderable

Discussion

upgradePackageUsername

Charateristics

Format: free
SDK attribute: upgradePackageUsername

upgradeScriptTimeLimit integer filterable orderable

Discussion

upgradeScriptTimeLimit

Charateristics

SDK attribute: upgradeScriptTimeLimit

upgradeStatus string filterable orderable

Discussion

Script based upgrade Status

Charateristics

Format: free
SDK attribute: upgradeStatus

upgradeTimedout boolean filterable orderable

Discussion

upgrade Timedout

Charateristics

SDK attribute: upgradeTimedout

vCenterIP string

Discussion

IP Address of the VCenter.

Charateristics

Format: free
SDK attribute: vCenterIP

vCenterPassword string

Discussion

Password for VCenter.

Charateristics

Format: free
SDK attribute: vCenterPassword

vCenterUser string

Discussion

Username for VCenter.

Charateristics

Format: free
SDK attribute: vCenterUser

vmNetworkPortgroup string required

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

vrsId string

Discussion

VCenter Name or Id used by toolbox to identify the VRS virtual machine

Charateristics

Format: free
SDK attribute: vrsId

VRSMetricsID string filterable

Discussion

ID of the VRS metrics object.

Charateristics

Format: free
SDK attribute: VRSMetricsID

vrsPassword string

Discussion

VRS password to be used by toolbox to communicate with VRS

Charateristics

Format: free
SDK attribute: vrsPassword

VRSState enum

Discussion

Current state of the VRS VM on the hypervisor

Charateristics

Allowed values: DEPLOYED, DEPLOYING, NOT_DEPLOYED, TIMEDOUT, UPGRADING
Default value: NOT_DEPLOYED
SDK attribute: VRSState

vrsUserName string

Discussion

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

Charateristics

Format: free
SDK attribute: vrsUserName