Package com.vmware.vim25.mo

Class HostSystem

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.ExtensibleManagedObject

com.vmware.vim25.mo.ManagedEntity

com.vmware.vim25.mo.HostSystem

public class HostSystem
extends ManagedEntity

Constructor Summary

Constructors

Constructor	Description
HostSystem(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Modifier and Type	Method	Description
HostServiceTicket	acquireCimServicesTicket()
void	configureCryptoKey(CryptoKeyId keyId)
Task	disconnectHost_Task()
void	enableCrypto(CryptoKeyPlain keyPlain)
void	enterLockdownMode()
Task	enterMaintenanceMode_Task(int timeout, boolean evacuatePoweredOffVms)	keep the old signature for compatibility
Task	enterMaintenanceMode_Task(int timeout, boolean evacuatePoweredOffVms, HostMaintenanceSpec maintenanceSpec)
void	exitLockdownMode()
Task	exitMaintenanceMode_Task(int timeout)
AnswerFileStatusResult	getAnswerFileValidationResult()
AnswerFileStatusResult	getAnswerFileValidationState()
HostCapability	getCapability()
ComplianceResult	getComplianceCheckResult()
HostSystemComplianceCheckState	getComplianceCheckState()
HostConfigInfo	getConfig()
Datastore[]	getDatastore()
HostDatastoreBrowser	getDatastoreBrowser()
Datastore[]	getDatastores()	Backward-compat alias for getDatastore().
HostHardwareInfo	getHardware()
HostHealthStatusSystem	getHealthStatusSystem()
HostAutoStartManager	getHostAutoStartManager()
HostBootDeviceSystem	getHostBootDeviceSystem()
HostCacheConfigurationManager	getHostCacheConfigurationManager()
HostCpuSchedulerSystem	getHostCpuSchedulerSystem()
HostDatastoreSystem	getHostDatastoreSystem()
HostDateTimeSystem	getHostDateTimeSystem()
HostDiagnosticSystem	getHostDiagnosticSystem()
HostEsxAgentHostManager	getHostEsxAgentHostManager()
HostFirewallSystem	getHostFirewallSystem()
HostFirmwareSystem	getHostFirmwareSystem()
HostGraphicsManager	getHostGraphicsManager()
HostImageConfigManager	getHostImageConfigManager()
HostKernelModuleSystem	getHostKernelModuleSystem()
HostMemorySystem	getHostMemorySystem()
HostNetworkSystem	getHostNetworkSystem()
HostPatchManager	getHostPatchManager()
HostPciPassthruSystem	getHostPciPassthruSystem()
HostServiceSystem	getHostServiceSystem()
HostSnmpSystem	getHostSnmpSystem()
HostStorageSystem	getHostStorageSystem()
HostVFlashManager	getHostVFlashManager()
HostVirtualNicManager	getHostVirtualNicManager()
HostVMotionSystem	getHostVMotionSystem()	Deprecated. as of SDK 4.0, use getHostVirtualNicManager instead
HostVsanInternalSystem	getHostVsanInternalSystem()
HostVsanSystem	getHostVsanSystem()
IscsiManager	getIscsiManager()
HostLicensableResourceInfo	getLicensableResource()
LicenseManager	getLicenseManager()
Network[]	getNetwork()
Network[]	getNetworks()	Backward-compat alias for getNetwork().
OptionManager	getOptionManager()
ApplyHostProfileConfigurationSpec	getPrecheckRemediationResult()
ApplyHostProfileConfigurationResult	getRemediationResult()
HostSystemRemediationState	getRemediationState()
HostRuntimeInfo	getRuntime()
HostListSummary	getSummary()
HostSystemResourceInfo	getSystemResources()
VirtualMachine[]	getVm()
VirtualMachine[]	getVms()	Backward-compat alias for getVm().
Task	powerDownHostToStandBy_Task(int timeoutSec, boolean evacuatePoweredOffVms)
Task	powerUpHostFromStandBy_Task(int timeoutSec)
void	prepareCrypto()
HostConnectInfo	queryHostConnectionInfo()
long	queryMemoryOverhead(long memorySize, int videoRamSize, int numVcpus)
long	queryMemoryOverheadEx(VirtualMachineConfigInfo vmConfigInfo)
String	queryProductLockerLocation()
HostTpmAttestationReport	queryTpmAttestationReport()
Task	rebootHost_Task(boolean force)
Task	reconfigureHostForDAS_Task()
Task	reconnectHost_Task(HostConnectSpec hcs)
Task	reconnectHost_Task(HostConnectSpec cnxSpec, HostSystemReconnectSpec reconnectSpec)
long	retrieveFreeEpcMemory()
long	retrieveHardwareUptime()
Task	shutdownHost_Task(boolean force)
void	updateFlags(HostFlagInfo flagInfo)
void	updateIpmi(HostIpmiInfo ipmiInfo)
Task	updateProductLockerLocation_Task(String path)
void	updateSystemResources(HostSystemResourceInfo resourceInfo)
void	updateSystemSwapConfiguration(HostSystemSwapConfiguration sysSwapConfig)

Methods inherited from class com.vmware.vim25.mo.ManagedEntity

destroy_Task, getAlarmActionEabled, getConfigIssue, getConfigStatus, getCustomValue, getDeclaredAlarmState, getDisabledMethod, getEffectiveRole, getName, getOverallStatus, getParent, getPermission, getRecentTasks, getTag, getTriggeredAlarmState, reload, rename_Task

Methods inherited from class com.vmware.vim25.mo.ExtensibleManagedObject

getAvailableField, getValues, setCustomValue

Methods inherited from class com.vmware.vim25.mo.ManagedObject

convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setCachedProperty, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

HostSystem

public HostSystem(ServerConnection serverConnection,
 ManagedObjectReference mor)

Method Details

getAnswerFileValidationResult

public AnswerFileStatusResult getAnswerFileValidationResult()

getAnswerFileValidationState

public AnswerFileStatusResult getAnswerFileValidationState()

getCapability

public HostCapability getCapability()

getComplianceCheckResult

public ComplianceResult getComplianceCheckResult()

getComplianceCheckState

public HostSystemComplianceCheckState getComplianceCheckState()

getConfig

public HostConfigInfo getConfig()

getDatastore

public Datastore[] getDatastore()

getDatastoreBrowser

public HostDatastoreBrowser getDatastoreBrowser()

getHardware

public HostHardwareInfo getHardware()

getLicensableResource

public HostLicensableResourceInfo getLicensableResource()

getNetwork

public Network[] getNetwork()

getPrecheckRemediationResult

public ApplyHostProfileConfigurationSpec getPrecheckRemediationResult()

getRemediationResult

public ApplyHostProfileConfigurationResult getRemediationResult()

getRemediationState

public HostSystemRemediationState getRemediationState()

getRuntime

public HostRuntimeInfo getRuntime()

getSummary

public HostListSummary getSummary()

getSystemResources

public HostSystemResourceInfo getSystemResources()

getVm

public VirtualMachine[] getVm()

configureCryptoKey

public void configureCryptoKey(CryptoKeyId keyId)
                        throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

disconnectHost_Task

public Task disconnectHost_Task()
                         throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

enableCrypto

public void enableCrypto(CryptoKeyPlain keyPlain)
                  throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

enterLockdownMode

public void enterLockdownMode()
                       throws HostConfigFault,
RuntimeFault,
RemoteException

Throws:

HostConfigFault

RuntimeFault

RemoteException

enterMaintenanceMode_Task

public Task enterMaintenanceMode_Task(int timeout,
 boolean evacuatePoweredOffVms,
 HostMaintenanceSpec maintenanceSpec)
                               throws InvalidState,
Timedout,
RuntimeFault,
RemoteException

Throws:

InvalidState

Timedout

RuntimeFault

RemoteException

powerDownHostToStandBy_Task

public Task powerDownHostToStandBy_Task(int timeoutSec,
 boolean evacuatePoweredOffVms)
                                 throws HostPowerOpFailed,
InvalidState,
NotSupported,
RequestCanceled,
Timedout,
RuntimeFault,
RemoteException

Throws:

HostPowerOpFailed

InvalidState

NotSupported

RequestCanceled

Timedout

RuntimeFault

RemoteException

exitLockdownMode

public void exitLockdownMode()
                      throws HostConfigFault,
RuntimeFault,
RemoteException

Throws:

HostConfigFault

RuntimeFault

RemoteException

exitMaintenanceMode_Task

public Task exitMaintenanceMode_Task(int timeout)
                              throws InvalidState,
Timedout,
RuntimeFault,
RemoteException

Throws:

InvalidState

Timedout

RuntimeFault

RemoteException

powerUpHostFromStandBy_Task

public Task powerUpHostFromStandBy_Task(int timeoutSec)
                                 throws HostPowerOpFailed,
InvalidState,
NotSupported,
Timedout,
RuntimeFault,
RemoteException

Throws:

HostPowerOpFailed

InvalidState

NotSupported

Timedout

RuntimeFault

RemoteException

prepareCrypto

public void prepareCrypto()
                   throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

queryProductLockerLocation

public String queryProductLockerLocation()
                                  throws HostConfigFault,
RuntimeFault,
RemoteException

Throws:

HostConfigFault

RuntimeFault

RemoteException

rebootHost_Task

public Task rebootHost_Task(boolean force)
                     throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

reconfigureHostForDAS_Task

public Task reconfigureHostForDAS_Task()
                                throws DasConfigFault,
RuntimeFault,
RemoteException

Throws:

DasConfigFault

RuntimeFault

RemoteException

reconnectHost_Task

public Task reconnectHost_Task(HostConnectSpec cnxSpec,
 HostSystemReconnectSpec reconnectSpec)
                        throws HostConnectFault,
InvalidLogin,
InvalidName,
InvalidState,
RuntimeFault,
RemoteException

Throws:

HostConnectFault

InvalidLogin

InvalidName

InvalidState

RuntimeFault

RemoteException

retrieveFreeEpcMemory

public long retrieveFreeEpcMemory()
                           throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

shutdownHost_Task

public Task shutdownHost_Task(boolean force)
                       throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

updateFlags

public void updateFlags(HostFlagInfo flagInfo)
                 throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

updateIpmi

public void updateIpmi(HostIpmiInfo ipmiInfo)
                throws InvalidIpmiLoginInfo,
InvalidIpmiMacAddress,
RuntimeFault,
RemoteException

Throws:

InvalidIpmiLoginInfo

InvalidIpmiMacAddress

RuntimeFault

RemoteException

updateProductLockerLocation_Task

public Task updateProductLockerLocation_Task(String path)
                                      throws FileNotFound,
HostConfigFault,
InvalidArgument,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

FileNotFound

HostConfigFault

InvalidArgument

TaskInProgress

RuntimeFault

RemoteException

updateSystemResources

public void updateSystemResources(HostSystemResourceInfo resourceInfo)
                           throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

updateSystemSwapConfiguration

public void updateSystemSwapConfiguration(HostSystemSwapConfiguration sysSwapConfig)
                                   throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

acquireCimServicesTicket

public HostServiceTicket acquireCimServicesTicket()
                                           throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

enterMaintenanceMode_Task

public Task enterMaintenanceMode_Task(int timeout,
 boolean evacuatePoweredOffVms)
                               throws Timedout,
InvalidState,
RuntimeFault,
RemoteException

keep the old signature for compatibility

Throws:

Timedout

InvalidState

RuntimeFault

RemoteException

queryHostConnectionInfo

public HostConnectInfo queryHostConnectionInfo()
                                        throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

queryTpmAttestationReport

public HostTpmAttestationReport queryTpmAttestationReport()
                                                   throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

Since:

SDK5.1

queryMemoryOverhead

public long queryMemoryOverhead(long memorySize,
 int videoRamSize,
 int numVcpus)
                         throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

queryMemoryOverheadEx

public long queryMemoryOverheadEx(VirtualMachineConfigInfo vmConfigInfo)
                           throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

reconnectHost_Task

public Task reconnectHost_Task(HostConnectSpec hcs)
                        throws InvalidName,
InvalidLogin,
InvalidState,
HostConnectFault,
RuntimeFault,
RemoteException

Throws:

InvalidName

InvalidLogin

InvalidState

HostConnectFault

RuntimeFault

RemoteException

retrieveHardwareUptime

public long retrieveHardwareUptime()
                            throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

Since:

SDK4.1

getOptionManager

public OptionManager getOptionManager()
                               throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostAutoStartManager

public HostAutoStartManager getHostAutoStartManager()
                                             throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostBootDeviceSystem

public HostBootDeviceSystem getHostBootDeviceSystem()
                                             throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostDateTimeSystem

public HostDateTimeSystem getHostDateTimeSystem()
                                         throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostDiagnosticSystem

public HostDiagnosticSystem getHostDiagnosticSystem()
                                             throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostEsxAgentHostManager

public HostEsxAgentHostManager getHostEsxAgentHostManager()
                                                   throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostCacheConfigurationManager

public HostCacheConfigurationManager getHostCacheConfigurationManager()
                                                               throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostCpuSchedulerSystem

public HostCpuSchedulerSystem getHostCpuSchedulerSystem()
                                                 throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostDatastoreSystem

public HostDatastoreSystem getHostDatastoreSystem()
                                           throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostFirmwareSystem

public HostFirmwareSystem getHostFirmwareSystem()
                                         throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostGraphicsManager

public HostGraphicsManager getHostGraphicsManager()
                                           throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK5.5

getHostKernelModuleSystem

public HostKernelModuleSystem getHostKernelModuleSystem()
                                                 throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK4.0

getLicenseManager

public LicenseManager getLicenseManager()
                                 throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK4.0

getHostPciPassthruSystem

public HostPciPassthruSystem getHostPciPassthruSystem()
                                               throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK4.0

getHostVirtualNicManager

public HostVirtualNicManager getHostVirtualNicManager()
                                               throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK4.0

getHealthStatusSystem

public HostHealthStatusSystem getHealthStatusSystem()
                                             throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostFirewallSystem

public HostFirewallSystem getHostFirewallSystem()
                                         throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostImageConfigManager

public HostImageConfigManager getHostImageConfigManager()
                                                 throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostMemorySystem

public HostMemorySystem getHostMemorySystem()
                                     throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostNetworkSystem

public HostNetworkSystem getHostNetworkSystem()
                                       throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostPatchManager

public HostPatchManager getHostPatchManager()
                                     throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostServiceSystem

public HostServiceSystem getHostServiceSystem()
                                       throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostSnmpSystem

public HostSnmpSystem getHostSnmpSystem()
                                 throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostStorageSystem

public HostStorageSystem getHostStorageSystem()
                                       throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostVFlashManager

public HostVFlashManager getHostVFlashManager()
                                       throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK5.5

getIscsiManager

public IscsiManager getIscsiManager()
                             throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostVMotionSystem

@Deprecated
public HostVMotionSystem getHostVMotionSystem()
                                       throws InvalidProperty,
RuntimeFault,
RemoteException

Deprecated.

as of SDK 4.0, use getHostVirtualNicManager instead

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostVsanInternalSystem

public HostVsanInternalSystem getHostVsanInternalSystem()
                                                 throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK5.5

getHostVsanSystem

public HostVsanSystem getHostVsanSystem()
                                 throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK5.5

getNetworks

public Network[] getNetworks()

Backward-compat alias for getNetwork().

getDatastores

public Datastore[] getDatastores()

Backward-compat alias for getDatastore().

getVms

public VirtualMachine[] getVms()

Backward-compat alias for getVm().