Managed Object - HealthUpdateManager(vim.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(addFilter)

Adds health update filters.
Required Privileges
Host.Inventory.EditCluster

Parameters

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

The provider identifier.
filterNamexsd:string

The filter name.
infoIds*xsd:string[]

The list of HealthUpdateInfo IDs that should be filtered.
*Need not be set

Return Value

Type Description
xsd:stringThe filter identifier.

Faults

Type Description
InvalidArgument- If filter name exceeds the maximum length limit of 56 characters. - If a filter with this name already exists for this provider. - If infoIds list contains a HealthUpdateInfo id which is not associated with the specified provider. - If there are duplicate HealthUpdateInfo ids in the infoIds list.
NotFoundThrown if no provider with this id is registered.
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



AddFilterEntities(addFilterEntities)

Add entities on which this filter is configured.
Required Privileges
Host.Inventory.EditCluster

Parameters

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

The filter id.
entities*ManagedObjectReference[]
to a ManagedEntity[]

The list of additional managed entities. Only entities of type HostSystem or ClusterComputeResource are valid.
*Need not be set

Return Value

Type Description
None

Faults

Type Description
InvalidArgument- If any of the entities is already associated with the specified filter. - If there are duplicate entities in the given entities list. - If the entities list contains an entity of type other than HostSystem and ClusterComputeResource.
NotFoundThrown if no filter with this id is registered.
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



AddMonitoredEntities(addMonitoredEntities)

The provider monitors additional managed entities. A particular managed entity can be monitored by multiple providers.
Required Privileges
HealthUpdateProvider.Update

Parameters

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

The provider id.
entities*ManagedObjectReference[]
to a ManagedEntity[]

The entities that are newly monitored by this provider.
*Need not be set

Return Value

Type Description
None

Faults

Type Description
InvalidArgument- If any of the entities is not of type HostSystem. - If there are duplicate entities in the given entities list. - If any of the entities is already monitored by the specified provider.
NotFoundThrown if no provider with this id is registered.
NotSupportedThrown if the http session user does not match the user who registered the provider, or if the http session cannot be retrieved.
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



HasMonitoredEntity(hasMonitoredEntity)

Check if the managed entity is monitored by the provider.
Required Privileges
System.View

Parameters

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

The provider id.
entityManagedObjectReference
to a ManagedEntity

An entity of type HostSystem.

Return Value

Type Description
xsd:booleanTrue iff the entity is monitored by this provider.

Faults

Type Description
InvalidArgumentThrown if the specified entity is not of type HostSystem.
NotFoundThrown if no provider with this id is registered.
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



HasProvider(hasProvider)

Verifies if the given provider is registered.
Required Privileges
System.View

Parameters

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

The provider id.

Return Value

Type Description
xsd:booleanTrue iff the provider is registered.

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



PostHealthUpdates(postHealthUpdates)

Report a change in health status.
Required Privileges
HealthUpdateProvider.Update

Parameters

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

The provider id.
updates*HealthUpdate[]

The changes in health states.
*Need not be set

Return Value

Type Description
None

Faults

Type Description
InvalidArgument- If an unknown HealthUpdate id is given. - If updates list contains a HealthUpdate for a host which is not monitored by the specified provider. - If updates list contains multiple HealthUpdates with the same id. - If an existing HealthUpdate id is used in the given updates. - If there is a HealthUpdate with green status and non-empty remediation. - If there is a HealthUpdate with gray status.
NotFoundThrown if no provider with this id is registered.
NotSupportedThrown if the http session user does not match the user who registered the provider, or if the http session cannot be retrieved.
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



QueryFilterEntities(queryFilterEntities)

Returns the list of entities on which this filter is configured.
Required Privileges
System.View

Parameters

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

The filter id.

Return Value

Type Description
ManagedObjectReference[]
to a ManagedEntity[]
The list of managed entities.

Faults

Type Description
NotFoundThrown if no filter with this id is registered.
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



QueryFilterInfoIds(queryFilterInfoIds)

Returns the list of HealthUpdateInfos configured for this filter.
Required Privileges
System.View

Parameters

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

The filter id.

Return Value

Type Description
xsd:string[]The list of identifiers of the configured HealthUpdateInfos.

Faults

Type Description
NotFoundThrown if no filter with this id is registered.
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



QueryFilterList(queryFilterList)

Returns the list of filters.
Required Privileges
System.View

Parameters

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

The provider id.

Return Value

Type Description
xsd:string[]The list of filters identifiers.

Faults

Type Description
NotFoundThrown if no provider with this id is registered.
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



QueryFilterName(queryFilterName)

Returns the filter name.
Required Privileges
System.View

Parameters

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

The filter id.

Return Value

Type Description
xsd:stringThe name of the filter.

Faults

Type Description
NotFoundThrown if no filter with this id is registered.
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



QueryHealthUpdateInfos(queryHealthUpdateInfos)

Returns the list of HealthUpdateInfo configured for the given provider.
Required Privileges
System.View

Parameters

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

The provider id.

Return Value

Type Description
HealthUpdateInfo[]The list of configured HealthUpdateInfo.

Faults

Type Description
NotFoundThrown if no provider with this id is registered.
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



QueryHealthUpdates(queryHealthUpdates)

Returns the list of health updates reported by the given provider.
Required Privileges
System.View

Parameters

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

The provider id.

Return Value

Type Description
HealthUpdate[]The list of current health updates by this provider.

Faults

Type Description
NotFoundThrown if no provider with this id is registered.
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



QueryMonitoredEntities(queryMonitoredEntities)

Returns the list of managed entities monitored by the given provider.
Required Privileges
System.View

Parameters

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

The provider id.

Return Value

Type Description
ManagedObjectReference[]
to a ManagedEntity[]
The list of monitored managed entities.

Faults

Type Description
NotFoundThrown if no provider with this id is registered.
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



QueryProviderList(queryProviderList)

The providers.
Required Privileges
System.View

Parameters

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

Return Value

Type Description
xsd:string[]The list of identifiers of registered providers.

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



QueryProviderName(queryProviderName)

Query the name of the provider.
Required Privileges
System.View

Parameters

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



Return Value

Type Description
xsd:stringThe name of the provider.

Faults

Type Description
NotFoundThrown if no provider with this id is registered.
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



QueryUnmonitoredHosts(queryUnmonitoredHosts)

The set of hosts that are in the cluster, but not monitored by the provider.
Required Privileges
System.View

Parameters

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

The provider id.
clusterManagedObjectReference
to a ClusterComputeResource

The cluster.

Return Value

Type Description
ManagedObjectReference[]
to a HostSystem[]
The hosts in the cluster that are not monitored by the provider.

Faults

Type Description
NotFoundThrown if no provider with this id is registered.
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



RegisterHealthUpdateProvider(registerProvider)

Registers provider.
Required Privileges
HealthUpdateProvider.Register

Parameters

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

The provider name. Should follow Java package naming convention to minimize name clashes with currently registered providers. For example, "com.vmware.HealthUpdateProvider".
healthUpdateInfo*HealthUpdateInfo[]

The list of healthUpdateInfo that can be reported in healthUpdates.
*Need not be set

Return Value

Type Description
xsd:stringThe identifier for the registered provider.

Faults

Type Description
InvalidArgument- If provider with this name is currently already registered. - If provider name exceeds the maximum length limit of 56 characters. - If healthUpdateInfo list contains multiple HealthUpdateInfos with the same id. - If healthUpdateInfo list contains a HealthUpdateInfo whose id exceeds the maximum length limit of 56 characters. - If healthUpdateInfo list contains a HealthUpdateInfo whose description exceeds the maximum length limit of 255 characters. - If healthUpdateInfo list contains a HealthUpdateInfo whose component is not a valid type defined in ComponentType.
NotSupported- If http user session cannot be retrieved. - If http user name exceeds the maximum length limit of 255 characters.
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



RemoveFilter(removeFilter)

Removes the specified filter.
Required Privileges
Host.Inventory.EditCluster

Parameters

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

The filter id.

Return Value

Type Description
None

Faults

Type Description
NotFoundThrown if no filter with this id is registered.
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



RemoveFilterEntities(removeFilterEntities)

Remove entities on which this filter is configured.
Required Privileges
Host.Inventory.EditCluster

Parameters

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

The filter id.
entities*ManagedObjectReference[]
to a ManagedEntity[]

The list of removed managed entities.
*Need not be set

Return Value

Type Description
None

Faults

Type Description
InvalidArgument- If there are duplicate managed entities in the given entities list. - If there is a managed entity of type other than HostSystem and ClusterComputeResource. - If the entities list contains an entity which is not associated with the specified filter.
NotFoundThrown if no filter with this id is registered.
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



RemoveMonitoredEntities(removeMonitoredEntities)

The provider monitors fewer managed entities.
Required Privileges
HealthUpdateProvider.Update

Parameters

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

The provider id.
entities*ManagedObjectReference[]
to a ManagedEntity[]

The entities that are no longer monitored by this provider.
*Need not be set

Return Value

Type Description
None

Faults

Type Description
InvalidArgument- If any of the specified entities is not of type HostSystem. - If there are duplicate entities in the given entities list. - If any of the entities is already not being monitored by the specified provider.
InvalidStateThrown if any of the entities is a part of an InfraUpdateHa cluster that has the provider enabled.
NotFoundThrown if no provider with this id is registered.
NotSupportedThrown if the http session user does not match the user who registered the provider, or if the http session cannot be retrieved.
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



UnregisterHealthUpdateProvider(unregisterProvider)

Unregisters the specified provider, if it exists. A VirtualCenter Server restart implicitly unregisters all providers.
Required Privileges
HealthUpdateProvider.Unregister

Parameters

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

The provider id.

Return Value

Type Description
None

Faults

Type Description
InvalidStateThrown if the specified provider is still used in an InfraUpdateHa cluster.
NotFoundThrown if the specified provider is not registered.
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