# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5
filterName P | xsd:string | Since vSphere API 6.5
infoIds* P | xsd:string[] | Since vSphere API 6.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:string |

Faults

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

# AddFilterEntities

Required Privileges
  Host.Inventory.EditCluster

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
filterId P | xsd:string | Since vSphere API 6.5
entities* P | ManagedObjectReference[] to a ManagedEntity[] | Since vSphere API 6.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

# AddMonitoredEntities

Required Privileges
  HealthUpdateProvider.Update

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5
entities* P | ManagedObjectReference[] to a ManagedEntity[] | Since vSphere API 6.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

# HasMonitoredEntity

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5
entity P | ManagedObjectReference to a ManagedEntity | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:boolean |

Faults

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

# HasProvider

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
id P | xsd:string | Since vSphere API 6.5

P Required privilege: id

Return Value

Type | Description
--- | ---
xsd:boolean |

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

# PostHealthUpdates

Required Privileges
  HealthUpdateProvider.Update

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5
updates* P | HealthUpdate[] | Since vSphere API 6.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

# QueryFilterEntities

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
filterId P | xsd:string | Since vSphere API 6.5

P Required privilege: filterId

Return Value

Type | Description
--- | ---
ManagedObjectReference[] to a ManagedEntity[] |

Faults

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

# QueryFilterInfoIds

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
filterId P | xsd:string | Since vSphere API 6.5

P Required privilege: filterId

Return Value

Type | Description
--- | ---
xsd:string[] |

Faults

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

# QueryFilterList

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5

P Required privilege: providerId

Return Value

Type | Description
--- | ---
xsd:string[] |

Faults

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

# QueryFilterName

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
filterId P | xsd:string | Since vSphere API 6.5

P Required privilege: filterId

Return Value

Type | Description
--- | ---
xsd:string |

Faults

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

# QueryHealthUpdateInfos

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5

P Required privilege: providerId

Return Value

Type | Description
--- | ---
HealthUpdateInfo[] |

Faults

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

# QueryHealthUpdates

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5

P Required privilege: providerId

Return Value

Type | Description
--- | ---
HealthUpdate[] |

Faults

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

# QueryMonitoredEntities

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5

P Required privilege: providerId

Return Value

Type | Description
--- | ---
ManagedObjectReference[] to a ManagedEntity[] |

Faults

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

# QueryProviderList

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.

Return Value

Type | Description
--- | ---
xsd:string[] |

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

# QueryProviderName

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
id P | xsd:string | Since vSphere API 6.5

P Required privilege: id

Return Value

Type | Description
--- | ---
xsd:string |

Faults

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

# QueryUnmonitoredHosts

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5
cluster P | ManagedObjectReference to a ClusterComputeResource | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference[] to a HostSystem[] |

Faults

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

# RegisterHealthUpdateProvider

Required Privileges
  HealthUpdateProvider.Register

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
name P | xsd:string | Since vSphere API 6.5
healthUpdateInfo* P | HealthUpdateInfo[] | Since vSphere API 6.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:string |

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

# RemoveFilter

Required Privileges
  Host.Inventory.EditCluster

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
filterId P | xsd:string | Since vSphere API 6.5

P Required privilege: filterId

Return Value

Type | Description
--- | ---
None

Faults

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

# RemoveFilterEntities

Required Privileges
  Host.Inventory.EditCluster

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
filterId P | xsd:string | Since vSphere API 6.5
entities* P | ManagedObjectReference[] to a ManagedEntity[] | Since vSphere API 6.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

# RemoveMonitoredEntities

Required Privileges
  HealthUpdateProvider.Update

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5
entities* P | ManagedObjectReference[] to a ManagedEntity[] | Since vSphere API 6.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

# UnregisterHealthUpdateProvider

Required Privileges
  HealthUpdateProvider.Unregister

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call.
providerId P | xsd:string | Since vSphere API 6.5

P Required privilege: providerId

Return Value

Type | Description
--- | ---
None

Faults

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