Managed Object - HostHealthStatusSystem(vim.host.HealthStatusSystem)

Property of
HostConfigManager
See also
HealthSystemRuntime, SystemEventInfo
Since
VI API 2.5


Managed Object Description

This managed object manages the health state of the host.
See ipmiSupported

Properties

Name Type Description
runtimeHealthSystemRuntime



Methods

Methods defined in this Managed Object
ClearSystemEventLog, FetchSystemEventLog, RefreshHealthStatusSystem, ResetSystemHealthInfo

ClearSystemEventLog(clearSystemEventLog)

Clear the the IPMI System Event Log.
Required Privileges
Host.Config.Settings
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostHealthStatusSystem used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



FetchSystemEventLog

Hardware System Event Log (SEL) information
Required Privileges
Host.Config.Settings
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostHealthStatusSystem used to make the method call.

Return Value

Type Description
SystemEventInfo[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



RefreshHealthStatusSystem(refresh)

Refresh the available runtime hardware health information.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostHealthStatusSystem used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



ResetSystemHealthInfo(resetSystemHealthInfo)

Resets the state of the sensors of the IPMI subsystem. On certain types of hardware IPMI sensor states latch onto unhealthy states and will stay in an unhealth state until the sensor state is reset. This method will explicitly reset the sensors state.
Required Privileges
Host.Config.Settings

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostHealthStatusSystem used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition