Search

Class VcDatacenter

Extends com.vmware.vmo.plugin.vi4.model.VimManagedEntity
The VcDatacenter managed object provides the interface to the common container object for hosts, virtual machines, networks, and datastores. These entities must be under a distinct datacenter in the inventory, and datacenters may not be nested under other datacenters.

Every VcDatacenter has the following set of dedicated folders. These folders are empty until you create entities for the Datacenter.

For a visual representation of the organization of objects in a vCenter hierarchy, see the description of the VcServiceInstance object.

Attributes

Name Type Description
alarmActionsEnabled boolean Whether alarm actions are enabled for this entity. True if enabled; false otherwise.
availableField VcCustomFieldDef[] List of custom field definitions that are valid for the object's type. The fields are sorted by <a href="VcCustomFieldDef.html#name">VcCustomFieldDef</a>.
configIssue VcEvent[] Current configuration issues that have been detected for this entity. Typically, these issues have already been logged as events. The entity stores these events as long as they are still current. The <a href="VcManagedEntity.html#configStatus">VcManagedEntity</a> property provides an overall status based on these events.
configStatus VcManagedEntityStatus The configStatus indicates whether or not the system has detected a configuration issue involving this entity. For example, it might have detected a duplicate IP address or MAC address, or a host in a cluster might be out of compliance. The meanings of the configStatus values are: <ul> <li>red: A problem has been detected involving the entity. <li>yellow: A problem is about to occur or a transient condition has occurred (For example, reconfigure fail-over policy). <li>green: No configuration issues have been detected. <li>gray: The configuration status of the entity is not being monitored. </ul> A green status indicates only that a problem has not been detected; it is not a guarantee that the entity is problem-free. <p> The <a href="VcManagedEntity.html#configIssue">VcManagedEntity</a> property contains a list of the problems that have been detected. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
configuration VcDatacenterConfigInfo Configuration of the datacenter.
customValue VcCustomFieldValue[] Custom field values.
datastore VcDatastore[] A collection of references to the datastore objects available in this datacenter.
datastoreFolder VcFolder A reference to the folder hierarchy that contains the datastores for this datacenter. <p> This folder is guaranteed to exist.
declaredAlarmState VcAlarmState[] A set of alarm states for alarms that apply to this managed entity. The set includes alarms defined on this entity and alarms inherited from the parent entity, or from any ancestors in the inventory hierarchy. <p> Alarms are inherited if they can be triggered by this entity or its descendants. This set does not include alarms that are defined on descendants of this entity.
disabledMethod String[] List of operations that are disabled, given the current runtime state of the entity. For example, a power-on operation always fails if a virtual machine is already powered on. This list can be used by clients to enable or disable operations in a graphical user interface. <p> Note: This list is determined by the current runtime state of an entity, not by its permissions. <p> This list may include the following operations for a HostSystem: <ul> <li><a href="VcHostSystem.html#enterMaintenanceMode">VcHostSystem</a> <li><a href="VcHostSystem.html#exitMaintenanceMode">VcHostSystem</a> <li><a href="VcHostSystem.html#reboot">VcHostSystem</a> <li><a href="VcHostSystem.html#shutdown">VcHostSystem</a> <li><a href="VcHostSystem.html#reconnect">VcHostSystem</a> <li><a href="VcHostSystem.html#disconnect">VcHostSystem</a> </ul> <p> This list may include the following operations for a VirtualMachine: <ul> <li><a href="VcVirtualMachine.html#answer">VcVirtualMachine</a> <li><a href="VcManagedEntity.html#rename">VcManagedEntity</a> <li><a href="VcVirtualMachine.html#clone">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#powerOff">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#powerOn">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#suspend">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#reset">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#reconfigure">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#relocate">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#migrate">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#customize">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#shutdownGuest">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#standbyGuest">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#rebootGuest">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#createSnapshot">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#removeAllSnapshots">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#revertToCurrentSnapshot">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#markAsTemplate">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#markAsVirtualMachine">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#resetGuestInformation">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#mountToolsInstaller">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#unmountToolsInstaller">VcVirtualMachine</a> <li><a href="VcManagedEntity.html#destroy">VcManagedEntity</a> <li><a href="VcVirtualMachine.html#upgradeVirtualHardware">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#exportVm">VcVirtualMachine</a> </ul> <p> This list may include the following operations for a ResourcePool: <ul> <li><a href="VcResourcePool.html#importVApp">VcResourcePool</a> <li><a href="VcResourcePool.html#createVm">VcResourcePool</a> <li><a href="VcResourcePool.html#updateConfig">VcResourcePool</a> <li><a href="VcFolder.html#createVm">VcFolder</a> <li><a href="VcManagedEntity.html#destroy">VcManagedEntity</a> <li><a href="VcManagedEntity.html#rename">VcManagedEntity</a> </ul> This list may include the following operations for a VirtualApp: <ul> <li><a href="VcManagedEntity.html#destroy">VcManagedEntity</a> <li><a href="VcVirtualApp.html#clone">VcVirtualApp</a> <li><a href="VcVirtualApp.html#unregister">VcVirtualApp</a> <li><a href="VcVirtualApp.html#exportVApp">VcVirtualApp</a> <li><a href="VcVirtualApp.html#powerOn">VcVirtualApp</a> <li><a href="VcVirtualApp.html#powerOff">VcVirtualApp</a> <li><a href="VcVirtualApp.html#updateVAppConfig">VcVirtualApp</a> </ul> <p> In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
effectiveRole Number[] Access rights the current session has to this entity.
hostFolder VcFolder A reference to the folder hierarchy that contains the compute resources, including hosts and clusters, for this datacenter. <p> This folder is guaranteed to exist.
id String returns the id of this ManagedObject
name String Name of this entity, unique relative to its parent. <p> Any / (slash), \ (backslash), character used in this name element will be escaped. Similarly, any % (percent) character used in this name element will be escaped, unless it is used to start an escape sequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or %5c, and a percent is escaped as %25.
network VcNetwork[] A collection of references to the network objects available in this datacenter.
networkFolder VcFolder A reference to the folder hierarchy that contains the network entities for this datacenter. The folder can include <a href="VcNetwork.html">VcNetwork</a>, <a href="VcDistributedVirtualSwitch.html">VcDistributedVirtualSwitch</a>, and <a href="VcDistributedVirtualPortgroup.html">VcDistributedVirtualPortgroup</a> objects. <p> This folder is guaranteed to exist.
overallStatus VcManagedEntityStatus General health of this managed entity. The overall status of the managed entity is computed as the worst status among its alarms and the configuration issues detected on the entity. The status is reported as one of the following values: <ul> <li>red: The entity has alarms or configuration issues with a red status. <li>yellow: The entity does not have alarms or configuration issues with a red status, and has at least one with a yellow status. <li>green: The entity does not have alarms or configuration issues with a red or yellow status, and has at least one with a green status. <li>gray: All of the entity's alarms have a gray status and the configuration status of the entity is not being monitored. </ul> In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
parent VcManagedEntity Parent of this entity. <p> This value is null for the root object and for <a href="VcVirtualMachine.html">VcVirtualMachine</a> objects that are part of a <a href="VcVirtualApp.html">VcVirtualApp</a>.
permission VcPermission[] List of permissions defined for this entity.
recentTask VcTask[] The set of recent tasks operating on this managed entity. This is a subset of <a href="VcTaskManager.html#recentTask">VcTaskManager</a> belong to this entity. A task in this list could be in one of the four states: pending, running, success or error. <p> This property can be used to deduce intermediate power states for a virtual machine entity. For example, if the current powerState is "poweredOn" and there is a running task performing the "suspend" operation, then the virtual machine's intermediate state might be described as "suspending." <p> Most tasks (such as power operations) obtain exclusive access to the virtual machine, so it is unusual for this list to contain more than one running task. One exception, however, is the task of cloning a virtual machine. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
reference VcManagedObjectReference returns the ManagedObjectReference of this ManagedObject
sdkConnection VcSdkConnection returns the parent SdkConnection
tag VcTag[] The set of tags associated with this managed entity. Experimental. Subject to change.
triggeredAlarmState VcAlarmState[] A set of alarm states for alarms triggered by this entity or by its descendants. <p> Triggered alarms are propagated up the inventory hierarchy so that a user can readily tell when a descendant has triggered an alarm. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
value VcCustomFieldValue[] List of custom field values. Each value uses a key to associate an instance of a <a href="VcCustomFieldStringValue.html">VcCustomFieldStringValue</a> with a custom field definition.
vimHost VcSdkConnection returns the parent SdkConnection (deprecated)
vimType String returns the type of this ManagedObject
vmFolder VcFolder A reference to the folder hierarchy that contains <a href="VcVirtualMachine.html">VcVirtualMachine</a> virtual machine templates (identified by the <a href="VcVirtualMachineConfigInfo.html#template">VcVirtualMachineConfigInfo</a> property, and <a href="VcVirtualApp.html">VcVirtualApp</a> objects for this datacenter. <p> Note that a VirtualApp that is a child of a <a href="VcResourcePool.html">VcResourcePool</a> may also be visible in this folder. VirtualApp objects can be nested, but only the parent VirtualApp can be visible in the folder. <p> This folder is guaranteed to exist.

Methods

Name Returns
VcDatacenter(com.vmware.vmo.plugin.vi4.model.IVimObjectFactory , VcManagedObjectReference , String ) constructor
createTrigger(Number timeout, String filter, String condition, String filterToSync) Trigger
destroy_Task() VcTask
powerOnMultiVM_Task(VcVirtualMachine[] vm, VcOptionValue[] option) VcTask
queryConnectionInfo(String hostname, Number port, String username, String password, String sslThumbprint) VcHostConnectInfo
queryConnectionInfoViaSpec(VcHostConnectSpec ) VcHostConnectInfo
queryDatacenterConfigOptionDescriptor() VcVirtualMachineConfigOptionDescriptor[]
reconfigureDatacenter_Task(VcDatacenterConfigSpec spec, boolean modify) VcTask
reload() void
rename_Task(String newName) VcTask
setCustomValue(String key, String value) void

Returned by

Method Returns
VcFolder.createDatacenter(String name) VcDatacenter
VcPlugin.getAllDatacenters(String[] additionalPropertyFilters, String query) VcDatacenter[]
VcSdkConnection.getAllDatacenters(String[] additionalPropertyFilters, String query) VcDatacenter[]
VcStoragePod.createDatacenter(String name) VcDatacenter

Referenced in

Method Returns
VcDatastoreNamespaceManager.deleteDirectory(VcDatacenter datacenter, String datastorePath) void
VcFileManager.changeOwner(String name, VcDatacenter datacenter, String owner) void
VcFileManager.copyDatastoreFile_Task(String sourceName, VcDatacenter sourceDatacenter, String destinationName, VcDatacenter destinationDatacenter, boolean force) VcTask
VcFileManager.copyDatastoreFile_Task(String sourceName, VcDatacenter sourceDatacenter, String destinationName, VcDatacenter destinationDatacenter, boolean force) VcTask
VcFileManager.deleteDatastoreFile_Task(String name, VcDatacenter datacenter) VcTask
VcFileManager.makeDirectory(String name, VcDatacenter datacenter, boolean createParentDirectories) void
VcFileManager.moveDatastoreFile_Task(String sourceName, VcDatacenter sourceDatacenter, String destinationName, VcDatacenter destinationDatacenter, boolean force) VcTask
VcFileManager.moveDatastoreFile_Task(String sourceName, VcDatacenter sourceDatacenter, String destinationName, VcDatacenter destinationDatacenter, boolean force) VcTask
VcFileManager.uploadFileToDatastore(VcDatacenter datacenter, VcDatastore datastore, String srcFilePath, String destFilePath) boolean
VcIpPoolManager.allocateIpv4Address(VcDatacenter dc, Number poolId, String allocationId) String
VcIpPoolManager.allocateIpv6Address(VcDatacenter dc, Number poolId, String allocationId) String
VcIpPoolManager.createIpPool(VcDatacenter dc, VcIpPool pool) Number
VcIpPoolManager.destroyIpPool(VcDatacenter dc, Number id, boolean force) void
VcIpPoolManager.queryIPAllocations(VcDatacenter dc, Number poolId, String extensionKey) VcIpPoolManagerIpAllocation[]
VcIpPoolManager.queryIpPools(VcDatacenter dc) VcIpPool[]
VcIpPoolManager.releaseIpAllocation(VcDatacenter dc, Number poolId, String allocationId) void
VcIpPoolManager.updateIpPool(VcDatacenter dc, VcIpPool pool) void
VcSearchIndex.findAllByDnsName(VcDatacenter datacenter, String dnsName, boolean vmSearch) VcManagedEntity[]
VcSearchIndex.findAllByIp(VcDatacenter datacenter, String ip, boolean vmSearch) VcManagedEntity[]
VcSearchIndex.findAllByUuid(VcDatacenter datacenter, String uuid, boolean vmSearch, boolean instanceUuid) VcManagedEntity[]
VcSearchIndex.findByDatastorePath(VcDatacenter datacenter, String path) VcVirtualMachine
VcSearchIndex.findByDnsName(VcDatacenter datacenter, String dnsName, boolean vmSearch) VcManagedEntity
VcSearchIndex.findByIp(VcDatacenter datacenter, String ip, boolean vmSearch) VcManagedEntity
VcSearchIndex.findByUuid(VcDatacenter datacenter, String uuid, boolean vmSearch, boolean instanceUuid) VcManagedEntity
VcVirtualDiskManager.copyVirtualDisk_Task(String sourceName, VcDatacenter sourceDatacenter, String destName, VcDatacenter destDatacenter, VcVirtualDiskSpec destSpec, boolean force) VcTask
VcVirtualDiskManager.copyVirtualDisk_Task(String sourceName, VcDatacenter sourceDatacenter, String destName, VcDatacenter destDatacenter, VcVirtualDiskSpec destSpec, boolean force) VcTask
VcVirtualDiskManager.createVirtualDisk_Task(String name, VcDatacenter datacenter, VcVirtualDiskSpec spec) VcTask
VcVirtualDiskManager.defragmentVirtualDisk_Task(String name, VcDatacenter datacenter) VcTask
VcVirtualDiskManager.deleteVirtualDisk_Task(String name, VcDatacenter datacenter) VcTask
VcVirtualDiskManager.eagerZeroVirtualDisk_Task(String name, VcDatacenter datacenter) VcTask
VcVirtualDiskManager.extendVirtualDisk_Task(String name, VcDatacenter datacenter, Number newCapacityKb, boolean eagerZero) VcTask
VcVirtualDiskManager.importUnmanagedSnapshot(String , VcDatacenter , String ) void
VcVirtualDiskManager.inflateVirtualDisk_Task(String name, VcDatacenter datacenter) VcTask
VcVirtualDiskManager.moveVirtualDisk_Task(String sourceName, VcDatacenter sourceDatacenter, String destName, VcDatacenter destDatacenter, boolean force, VcVirtualMachineProfileSpec[] profile) VcTask
VcVirtualDiskManager.moveVirtualDisk_Task(String sourceName, VcDatacenter sourceDatacenter, String destName, VcDatacenter destDatacenter, boolean force, VcVirtualMachineProfileSpec[] profile) VcTask
VcVirtualDiskManager.queryVirtualDiskFragmentation(String name, VcDatacenter datacenter) Number
VcVirtualDiskManager.queryVirtualDiskGeometry(String name, VcDatacenter datacenter) VcHostDiskDimensionsChs
VcVirtualDiskManager.queryVirtualDiskUuid(String name, VcDatacenter datacenter) String
VcVirtualDiskManager.setVirtualDiskUuid(String name, VcDatacenter datacenter, String uuid) void
VcVirtualDiskManager.shrinkVirtualDisk_Task(String name, VcDatacenter datacenter, boolean copy) VcTask
VcVirtualDiskManager.zeroFillVirtualDisk_Task(String name, VcDatacenter datacenter) VcTask