Search

Class VcHostSystem

Extends com.vmware.vmo.plugin.vi4.model.VimManagedEntity
The HostSystem managed object type provides access to a virtualization host platform.

Invoking destroy on a HostSystem of standalone type throws a NotSupported fault. A standalone HostSystem can be destroyed only by invoking destroy on its parent ComputeResource. Invoking destroy on a failover host throws a VcDisallowedOperationOnFailoverHost fault. See VcClusterFailoverHostAdmissionControlPolicy.

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>.
capability VcHostCapability Host capabilities. This might not be available for a disconnected host.
config VcHostConfigInfo Host configuration information. This might not be available for a disconnected host.
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.
configManager VcHostConfigManager Host configuration systems. 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.
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.
customValue VcCustomFieldValue[] Custom field values.
datastore VcDatastore[] A collection of references to the subset of datastore objects in the datacenter that are available in this HostSystem.
datastoreBrowser VcHostDatastoreBrowser DatastoreBrowser to browse datastores for this host.
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.
events Properties
hardware VcHostHardwareInfo Hardware configuration of the host. This might not be available for a disconnected host.
id String returns the id of this ManagedObject
initialProperties String[]
licensableResource VcHostLicensableResourceInfo Information about all licensable resources, currently present on this host. <p>This information is used mostly by the modules, manipulating information in the <a href="VcLicenseManager.html">VcLicenseManager</a>. Developers of such modules should use this property instead of <a href="VcHostSystem.html#hardware">VcHostSystem</a>. <p>NOTE: The values in this property may not be accurate for pre-5.0 hosts when returned by vCenter 5.0
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 subset of network objects in the datacenter that are available in this HostSystem.
network_DistributedVirtualPortgroup DistributedVirtualPortgroup[] Filtered attribute 'network' with only DistributedVirtualPortgroup objects
network_Network Network[] Filtered attribute 'network' with only Network objects
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
runtime VcHostRuntimeInfo Runtime state information about the host such as connection state.
sdkConnection VcSdkConnection returns the parent SdkConnection
summary VcHostListSummary Basic information about the host, including connection state.
systemResources VcHostSystemResourceInfo Reference for the system resource hierarchy, used for configuring the set of resources reserved to the system and unavailable to virtual machines.
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
vm VcVirtualMachine[] List of virtual machines associated with this host.

Methods

Name Returns
VcHostSystem(com.vmware.vmo.plugin.vi4.model.IVimObjectFactory , VcManagedObjectReference , String ) constructor
acquireCimServicesTicket() VcHostServiceTicket
createTrigger(Number timeout, String filter, String condition, String filterToSync) Trigger
destroy_Task() VcTask
disconnectHost_Task() VcTask
enterLockdownMode() void
enterMaintenanceMode_Task(Number timeout, boolean evacuatePoweredOffVms, VcHostMaintenanceSpec maintenanceSpec) VcTask
exitLockdownMode() void
exitMaintenanceMode_Task(Number timeout) VcTask
powerDownHostToStandBy_Task(Number timeoutSec, boolean evacuatePoweredOffVms) VcTask
powerUpHostFromStandBy_Task(Number timeoutSec) VcTask
queryHostConnectionInfo() VcHostConnectInfo
queryMemoryOverhead(Number memorySize, Number videoRamSize, Number numVcpus) Number
queryMemoryOverheadEx(VcVirtualMachineConfigInfo vmConfigInfo) Number
queryTpmAttestationReport() VcHostTpmAttestationReport
rebootHost_Task(boolean force) VcTask
reconfigureHostForDAS_Task() VcTask
reconnectHost_Task(VcHostConnectSpec cnxSpec, VcHostSystemReconnectSpec reconnectSpec) VcTask
reload() void
rename_Task(String newName) VcTask
retrieveHardwareUptime() Number
setCustomValue(String key, String value) void
shutdownHost_Task(boolean force) VcTask
updateFlags(VcHostFlagInfo flagInfo) void
updateIpmi(VcHostIpmiInfo ipmiInfo) void
updateSystemResources(VcHostSystemResourceInfo resourceInfo) void
updateSystemSwapConfiguration(VcHostSystemSwapConfiguration sysSwapConfig) void

Returned by

Method Returns
VcDistributedVirtualSwitchManager.queryCompatibleHostForExistingDvs(VcManagedEntity container, boolean recursive, VcDistributedVirtualSwitch dvs) VcHostSystem[]
VcDistributedVirtualSwitchManager.queryCompatibleHostForNewDvs(VcManagedEntity container, boolean recursive, VcDistributedVirtualSwitchProductSpec switchProductSpec) VcHostSystem[]
VcPlugin.getAllHostSystems(String[] additionalPropertyFilters, String query) VcHostSystem[]
VcSdkConnection.getAllHostSystems(String[] additionalPropertyFilters, String query) VcHostSystem[]

Referenced in

Method Returns
VcClusterComputeResource.clusterEnterMaintenanceMode(VcHostSystem[] host, VcOptionValue[] option) VcClusterEnterMaintenanceResult
VcClusterComputeResource.moveHostInto_Task(VcHostSystem host, VcResourcePool resourcePool) VcTask
VcClusterComputeResource.moveInto_Task(VcHostSystem[] host) VcTask
VcDiagnosticManager.browseDiagnosticLog(VcHostSystem host, String key, Number start, Number lines) VcDiagnosticManagerLogHeader
VcDiagnosticManager.generateLogBundles_Task(boolean includeDefault, VcHostSystem[] host) VcTask
VcDiagnosticManager.queryDescriptions(VcHostSystem host) VcDiagnosticManagerLogDescriptor[]
VcDistributedVirtualSwitch.rectifyDvsHost_Task(VcHostSystem[] hosts) VcTask
VcDistributedVirtualSwitchManager.queryDvsConfigTarget(VcHostSystem host, VcDistributedVirtualSwitch dvs) VcDVSManagerDvsConfigTarget
VcDistributedVirtualSwitchManager.rectifyDvsOnHost_Task(VcHostSystem[] hosts) VcTask
VcEnvironmentBrowser.queryConfigOption(String key, VcHostSystem host) VcVirtualMachineConfigOption
VcEnvironmentBrowser.queryConfigTarget(VcHostSystem host) VcConfigTarget
VcEnvironmentBrowser.queryTargetCapabilities(VcHostSystem host) VcHostCapability
VcFolder.createVM_Task(VcVirtualMachineConfigSpec config, VcResourcePool pool, VcHostSystem host) VcTask
VcFolder.registerVM_Task(String path, String name, boolean asTemplate, VcResourcePool pool, VcHostSystem host) VcTask
VcHostProfile.executeHostProfile(VcHostSystem host, VcProfileDeferredPolicyOptionParameter[] deferredParam) VcProfileExecuteResult
VcHostProfile.updateReferenceHost(VcHostSystem host) void
VcHostProfileManager.applyHostConfig_Task(VcHostSystem host, VcHostConfigSpec configSpec, VcProfileDeferredPolicyOptionParameter[] userInput) VcTask
VcHostProfileManager.checkAnswerFileStatus_Task(VcHostSystem[] host) VcTask
VcHostProfileManager.exportAnswerFile_Task(VcHostSystem host) VcTask
VcHostProfileManager.generateConfigTaskList(VcHostConfigSpec configSpec, VcHostSystem host) VcHostProfileManagerConfigTaskList
VcHostProfileManager.generateHostProfileTaskList_Task(VcHostConfigSpec configSpec, VcHostSystem host) VcTask
VcHostProfileManager.queryAnswerFileStatus(VcHostSystem[] host) VcAnswerFileStatusResult[]
VcHostProfileManager.retrieveAnswerFile(VcHostSystem host) VcAnswerFile
VcHostProfileManager.retrieveAnswerFileForProfile(VcHostSystem host, VcHostApplyProfile applyProfile) VcAnswerFile
VcHostProfileManager.updateAnswerFile_Task(VcHostSystem host, VcAnswerFileCreateSpec configSpec) VcTask
VcLicenseManager.checkLicenseFeature(VcHostSystem host, String featureKey) boolean
VcLicenseManager.configureLicenseSource(VcHostSystem host, VcLicenseSource licenseSource) void
VcLicenseManager.disableFeature(VcHostSystem host, String featureKey) boolean
VcLicenseManager.enableFeature(VcHostSystem host, String featureKey) boolean
VcLicenseManager.queryLicenseSourceAvailability(VcHostSystem host) VcLicenseAvailabilityInfo[]
VcLicenseManager.queryLicenseUsage(VcHostSystem host) VcLicenseUsageInfo
VcLicenseManager.querySupportedFeatures(VcHostSystem host) VcLicenseFeatureInfo[]
VcLicenseManager.setLicenseEdition(VcHostSystem host, String featureKey) void
VcOvfManager.validateHost(String ovfDescriptor, VcHostSystem host, VcOvfValidateHostParams vhp) VcOvfValidateHostResult
VcPlugin.importOvf(String ovfUri, VcHostSystem hostSystem, String importFolderName, String vmName, VcOvfNetworkMapping[] networks, VcDatastore datastore, VcKeyValue[] props) VcVirtualMachine
VcResourcePool.createChildVM_Task(VcVirtualMachineConfigSpec config, VcHostSystem host) VcTask
VcResourcePool.importVApp(VcImportSpec spec, VcFolder folder, VcHostSystem host) VcHttpNfcLease
VcResourcePool.registerChildVM_Task(String path, String name, VcHostSystem host) VcTask
VcStoragePod.createVM_Task(VcVirtualMachineConfigSpec config, VcResourcePool pool, VcHostSystem host) VcTask
VcStoragePod.registerVM_Task(String path, String name, boolean asTemplate, VcResourcePool pool, VcHostSystem host) VcTask
VcStorageResourceManager.queryIORMConfigOption(VcHostSystem host) VcStorageIORMConfigOption
VcVirtualApp.createChildVM_Task(VcVirtualMachineConfigSpec config, VcHostSystem host) VcTask
VcVirtualApp.importVApp(VcImportSpec spec, VcFolder folder, VcHostSystem host) VcHttpNfcLease
VcVirtualApp.registerChildVM_Task(String path, String name, VcHostSystem host) VcTask
VcVirtualMachine.createSecondaryVM_Task(VcHostSystem host) VcTask
VcVirtualMachine.enableSecondaryVM_Task(VcVirtualMachine vm, VcHostSystem host) VcTask
VcVirtualMachine.markAsVirtualMachine(VcResourcePool pool, VcHostSystem host) void
VcVirtualMachine.migrateVM_Task(VcResourcePool pool, VcHostSystem host, VcVirtualMachineMovePriority priority, VcVirtualMachinePowerState state) VcTask
VcVirtualMachine.powerOnVM_Task(VcHostSystem host) VcTask
VcVirtualMachine.revertToCurrentSnapshot_Task(VcHostSystem host, boolean suppressPowerOn) VcTask
VcVirtualMachineCompatibilityChecker.checkCompatibility_Task(VcVirtualMachine vm, VcHostSystem host, VcResourcePool pool, String[] testType) VcTask
VcVirtualMachineProvisioningChecker.checkMigrate_Task(VcVirtualMachine vm, VcHostSystem host, VcResourcePool pool, VcVirtualMachinePowerState state, String[] testType) VcTask
VcVirtualMachineProvisioningChecker.queryVMotionCompatibilityEx_Task(VcVirtualMachine[] vm, VcHostSystem[] host) VcTask
VcVirtualMachineSnapshot.revertToSnapshot_Task(VcHostSystem host, boolean suppressPowerOn) VcTask
VcVmwareDistributedVirtualSwitch.rectifyDvsHost_Task(VcHostSystem[] hosts) VcTask