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

The managed object class corresponding to the one defined in VI SDK API reference.

Author:

Steve JIN (sjin@vmware.com)

Constructor Summary

HostSystem(ServerConnection sc, ManagedObjectReference mor)

Method Summary

HostServiceTicket	acquireCimServicesTicket()
Task	disconnectHost()
void	enterLockdownMode()
Task	enterMaintenanceMode(int timeout, boolean evacuatePoweredOffVms)
void	exitLockdownMode()
Task	exitMaintenanceMode(int timeout)
HostCapability	getCapability()
HostConfigInfo	getConfig()
HostDatastoreBrowser	getDatastoreBrowser()
Datastore[]	getDatastores()
HostHardwareInfo	getHardware()
HostHealthStatusSystem	getHealthStatusSystem()
HostAutoStartManager	getHostAutoStartManager()
HostBootDeviceSystem	getHostBootDeviceSystem()
HostCacheConfigurationManager	getHostCacheConfigurationManager()
HostCpuSchedulerSystem	getHostCpuSchedulerSystem()
HostDatastoreSystem	getHostDatastoreSystem()
HostDateTimeSystem	getHostDateTimeSystem()
HostDiagnosticSystem	getHostDiagnosticSystem()
HostEsxAgentHostManager	getHostEsxAgentHostManager()
HostFirewallSystem	getHostFirewallSystem()
HostFirmwareSystem	getHostFirmwareSystem()
HostImageConfigManager	getHostImageConfigManager()
HostKernelModuleSystem	getHostKernelModuleSystem()
HostMemorySystem	getHostMemorySystem()
HostNetworkSystem	getHostNetworkSystem()
HostPatchManager	getHostPatchManager()
HostPciPassthruSystem	getHostPciPassthruSystem()
HostServiceSystem	getHostServiceSystem()
HostSnmpSystem	getHostSnmpSystem()
HostStorageSystem	getHostStorageSystem()
HostVirtualNicManager	getHostVirtualNicManager()
HostVMotionSystem	getHostVMotionSystem() Deprecated. as of SDK 4.0, use getHostVirtualNicManager instead
IscsiManager	getIscsiManager()
HostLicensableResourceInfo	getLicensableResource()
LicenseManager	getLicenseManager()
Network[]	getNetworks()
OptionManager	getOptionManager()
HostRuntimeInfo	getRuntime()
HostListSummary	getSummary()
HostSystemResourceInfo	getSystemResources()
VirtualMachine[]	getVms()
Task	powerDownHostToStandBy(int timeSec, boolean evacuatePoweredOffVms)
Task	powerUpHostFromStandBy(int timeSec)
HostConnectInfo	queryHostConnectionInfo()
long	queryMemoryOverhead(long memorySize, int videoRamSize, int numVcpus)
long	queryMemoryOverheadEx(VirtualMachineConfigInfo vmConfigInfo)
Task	rebootHost(boolean force)
Task	reconfigureHostForDAS()
Task	reconnectHost_Task(HostConnectSpec hcs)
Task	reconnectHost_Task(HostConnectSpec cnxSpec, HostSystemReconnectSpec reconnectSpec)
long	retrieveHardwareUptime()
Task	shutdownHost_Task(boolean force)
void	updateFlags(HostFlagInfo hfi)
void	updateIpmi(HostIpmiInfo ipmiInfo)
void	updateSystemResources(HostSystemResourceInfo resourceInfo)

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, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

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

Constructor Detail

HostSystem

public HostSystem(ServerConnection sc,
                  ManagedObjectReference mor)

Method Detail

getCapability

public HostCapability getCapability()

getConfig

public HostConfigInfo getConfig()

getDatastores

public Datastore[] getDatastores()
                          throws InvalidProperty,
                                 RuntimeFault,
                                 RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getDatastoreBrowser

public HostDatastoreBrowser getDatastoreBrowser()
                                         throws InvalidProperty,
                                                RuntimeFault,
                                                RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHardware

public HostHardwareInfo getHardware()

getLicensableResource

public HostLicensableResourceInfo getLicensableResource()

Since:

SDK5.0

getNetworks

public Network[] getNetworks()
                      throws InvalidProperty,
                             RuntimeFault,
                             RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getRuntime

public HostRuntimeInfo getRuntime()

getSummary

public HostListSummary getSummary()

getSystemResources

public HostSystemResourceInfo getSystemResources()

getVms

public VirtualMachine[] getVms()
                        throws InvalidProperty,
                               RuntimeFault,
                               RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

acquireCimServicesTicket

public HostServiceTicket acquireCimServicesTicket()
                                           throws RuntimeFault,
                                                  RemoteException

Throws:

RuntimeFault

RemoteException

disconnectHost

public Task disconnectHost()
                    throws RuntimeFault,
                           RemoteException

Throws:

RuntimeFault

RemoteException

enterLockdownMode

public void enterLockdownMode()
                       throws HostConfigFault,
                              RuntimeFault,
                              RemoteException

Throws:

HostConfigFault

RuntimeFault

RemoteException

Since:

SDK4.1

enterMaintenanceMode

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

Throws:

Timedout

InvalidState

RuntimeFault

RemoteException

exitLockdownMode

public void exitLockdownMode()
                      throws HostConfigFault,
                             RuntimeFault,
                             RemoteException

Throws:

HostConfigFault

RuntimeFault

RemoteException

Since:

SDK4.1

exitMaintenanceMode

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

Throws:

Timedout

InvalidState

RuntimeFault

RemoteException

powerDownHostToStandBy

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

Throws:

RequestCanceled

HostPowerOpFailed

NotSupported

Timedout

InvalidState

RuntimeFault

RemoteException

powerUpHostFromStandBy

public Task powerUpHostFromStandBy(int timeSec)
                            throws HostPowerOpFailed,
                                   NotSupported,
                                   Timedout,
                                   InvalidState,
                                   RuntimeFault,
                                   RemoteException

Throws:

HostPowerOpFailed

NotSupported

Timedout

InvalidState

RuntimeFault

RemoteException

queryHostConnectionInfo

public HostConnectInfo queryHostConnectionInfo()
                                        throws RuntimeFault,
                                               RemoteException

Throws:

RuntimeFault

RemoteException

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

rebootHost

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

Throws:

InvalidState

RuntimeFault

RemoteException

reconfigureHostForDAS

public Task reconfigureHostForDAS()
                           throws DasConfigFault,
                                  RuntimeFault,
                                  RemoteException

Throws:

DasConfigFault

RuntimeFault

RemoteException

reconnectHost_Task

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

Throws:

InvalidName

InvalidLogin

InvalidState

HostConnectFault

RuntimeFault

RemoteException

reconnectHost_Task

public Task reconnectHost_Task(HostConnectSpec cnxSpec,
                               HostSystemReconnectSpec reconnectSpec)
                        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

shutdownHost_Task

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

Throws:

InvalidState

NotSupported

RuntimeFault

RemoteException

updateFlags

public void updateFlags(HostFlagInfo hfi)
                 throws RuntimeFault,
                        RemoteException

Throws:

RuntimeFault

RemoteException

updateSystemResources

public void updateSystemResources(HostSystemResourceInfo resourceInfo)
                           throws RuntimeFault,
                                  RemoteException

Throws:

RuntimeFault

RemoteException

updateIpmi

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

Throws:

InvalidIpmiLoginInfo

InvalidIpmiMacAddress

RuntimeFault

RemoteException

Since:

4.0

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

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

getIscsiManager

public IscsiManager getIscsiManager()
                             throws InvalidProperty,
                                    RuntimeFault,
                                    RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getHostVMotionSystem

public HostVMotionSystem getHostVMotionSystem()
                                       throws InvalidProperty,
                                              RuntimeFault,
                                              RemoteException

Deprecated. as of SDK 4.0, use getHostVirtualNicManager instead

Throws:

InvalidProperty

RuntimeFault

RemoteException