Managed Object - HealthUpdateManager

Property of
ServiceContent
See also
ClusterComputeResource, HealthUpdate, HealthUpdateInfo, HostSystem, ManagedEntity
Since
vSphere API 6.5


Managed Object Description

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
AddFilter, AddFilterEntities, AddMonitoredEntities, HasMonitoredEntity, HasProvider, PostHealthUpdates, QueryFilterEntities, QueryFilterInfoIds, QueryFilterList, QueryFilterName, QueryHealthUpdateInfos, QueryHealthUpdates, QueryMonitoredEntities, QueryProviderList, QueryProviderName, QueryUnmonitoredHosts, RegisterHealthUpdateProvider, RemoveFilter, RemoveFilterEntities, RemoveMonitoredEntities, UnregisterHealthUpdateProvider

AddFilter

Required Privileges
Host.Inventory.EditCluster

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
filterName Pxsd:string

Since vSphere API 6.5
infoIds* Pxsd:string[]

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:string

Faults

Type Description
NotFound
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



AddFilterEntities

Required Privileges
Host.Inventory.EditCluster

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
filterId Pxsd:string

Since vSphere API 6.5
entities* PManagedObjectReference[]
to a ManagedEntity[]

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
NotFound
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



AddMonitoredEntities

Required Privileges
HealthUpdateProvider.Update

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
entities* PManagedObjectReference[]
to a ManagedEntity[]

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
NotFound
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



HasMonitoredEntity

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
entity PManagedObjectReference
to a ManagedEntity

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:boolean

Faults

Type Description
NotFound
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



HasProvider

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
id Pxsd:string

Since vSphere API 6.5
P Required privilege: id

Return Value

Type Description
xsd:boolean

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



PostHealthUpdates

Required Privileges
HealthUpdateProvider.Update

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
updates* PHealthUpdate[]

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
NotFound
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



QueryFilterEntities

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
filterId Pxsd:string

Since vSphere API 6.5
P Required privilege: filterId

Return Value

Type Description
ManagedObjectReference[]
to a ManagedEntity[]

Faults

Type Description
NotFound
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



QueryFilterInfoIds

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
filterId Pxsd:string

Since vSphere API 6.5
P Required privilege: filterId

Return Value

Type Description
xsd:string[]

Faults

Type Description
NotFound
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



QueryFilterList

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
P Required privilege: providerId

Return Value

Type Description
xsd:string[]

Faults

Type Description
NotFound
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



QueryFilterName

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
filterId Pxsd:string

Since vSphere API 6.5
P Required privilege: filterId

Return Value

Type Description
xsd:string

Faults

Type Description
NotFound
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



QueryHealthUpdateInfos

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
P Required privilege: providerId

Return Value

Type Description
HealthUpdateInfo[]

Faults

Type Description
NotFound
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



QueryHealthUpdates

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
P Required privilege: providerId

Return Value

Type Description
HealthUpdate[]

Faults

Type Description
NotFound
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



QueryMonitoredEntities

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
P Required privilege: providerId

Return Value

Type Description
ManagedObjectReference[]
to a ManagedEntity[]

Faults

Type Description
NotFound
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



QueryProviderList

Required Privileges
System.View

Parameters

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

Return Value

Type Description
xsd:string[]

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



QueryProviderName

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
id Pxsd:string

Since vSphere API 6.5
P Required privilege: id

Return Value

Type Description
xsd:string

Faults

Type Description
NotFound
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



QueryUnmonitoredHosts

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
cluster PManagedObjectReference
to a ClusterComputeResource

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference[]
to a HostSystem[]

Faults

Type Description
NotFound
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



RegisterHealthUpdateProvider

Required Privileges
HealthUpdateProvider.Register

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
name Pxsd:string

Since vSphere API 6.5
healthUpdateInfo* PHealthUpdateInfo[]

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:string

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



RemoveFilter

Required Privileges
Host.Inventory.EditCluster

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
filterId Pxsd:string

Since vSphere API 6.5
P Required privilege: filterId

Return Value

Type Description
None

Faults

Type Description
NotFound
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



RemoveFilterEntities

Required Privileges
Host.Inventory.EditCluster

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
filterId Pxsd:string

Since vSphere API 6.5
entities* PManagedObjectReference[]
to a ManagedEntity[]

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
NotFound
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



RemoveMonitoredEntities

Required Privileges
HealthUpdateProvider.Update

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
entities* PManagedObjectReference[]
to a ManagedEntity[]

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
InvalidState
NotFound
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



UnregisterHealthUpdateProvider

Required Privileges
HealthUpdateProvider.Unregister

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HealthUpdateManager used to make the method call.
providerId Pxsd:string

Since vSphere API 6.5
P Required privilege: providerId

Return Value

Type Description
None

Faults

Type Description
InvalidState
NotFound
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