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
runtime	HealthSystemRuntime

Name

Type

Description

runtime

HealthSystemRuntime

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostHealthStatusSystem used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="ClearSystemEventLog" type="pbm:ClearSystemEventLogRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="ClearSystemEventLogResponse">
                  <complexType/>
               </element>

FetchSystemEventLog

Hardware System Event Log (SEL) information

Required Privileges: Host.Config.Settings
Since: vSphere API 6.5

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostHealthStatusSystem used to make the method call.

Return Value

Type	Description
SystemEventInfo[]

Faults

Type	Description
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="FetchSystemEventLog" type="pbm:FetchSystemEventLogRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="FetchSystemEventLogResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:SystemEventInfo" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

RefreshHealthStatusSystem(refresh)

Refresh the available runtime hardware health information.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostHealthStatusSystem used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="RefreshHealthStatusSystem" type="pbm:RefreshHealthStatusSystemRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="RefreshHealthStatusSystemResponse">
                  <complexType/>
               </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostHealthStatusSystem used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="ResetSystemHealthInfo" type="pbm:ResetSystemHealthInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="ResetSystemHealthInfoResponse">
                  <complexType/>
               </element>