| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider identifier.
Since vSphere API 6.5 |
filterName P | xsd:string |
The filter name.
Since vSphere API 6.5 |
infoIds* P | xsd:string[] |
The list of HealthUpdateInfo IDs that should be
filtered.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:string | The filter identifier. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
filterId P | xsd:string |
The filter id.
Since vSphere API 6.5 |
entities* P | ManagedObjectReference[]
to a ManagedEntity[] |
The list of additional managed entities. Only
entities of type HostSystem or
ClusterComputeResource are valid.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
NotFound | Thrown if no filter with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider id.
Since vSphere API 6.5 |
entities* P | ManagedObjectReference[]
to a ManagedEntity[] |
The entities that are newly monitored by this
provider.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider id.
Since vSphere API 6.5 |
entity P | ManagedObjectReference
to a ManagedEntity |
An entity of type HostSystem.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:boolean | True iff the entity is monitored by this provider. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
id P | xsd:string |
The provider id.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:boolean | True iff the provider is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider id.
Since vSphere API 6.5 |
updates* P | HealthUpdate[] |
The changes in health states.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
filterId P | xsd:string |
The filter id.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a ManagedEntity[] | The list of managed entities. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no filter with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
filterId P | xsd:string |
The filter id.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:string[] | The list of identifiers of the configured HealthUpdateInfos. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no filter with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider id.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:string[] | The list of filters identifiers. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
filterId P | xsd:string |
The filter id.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:string | The name of the filter. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no filter with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider id.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
HealthUpdateInfo[] | The list of configured HealthUpdateInfo. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider id.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
HealthUpdate[] | The list of current health updates by this provider. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider id.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a ManagedEntity[] | The list of monitored managed entities. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | 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 |
---|---|
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 |
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 |
Return Value
Type | Description |
---|---|
xsd:string | The name of the provider. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider id.
Since vSphere API 6.5 |
cluster P | ManagedObjectReference
to a ClusterComputeResource |
The cluster.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a HostSystem[] | The hosts in the cluster that are not monitored by the provider. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
name P | xsd:string |
The provider name. Should follow Java package
naming convention to minimize name clashes with
currently registered providers.
For example, "com.vmware.HealthUpdateProvider".
Since vSphere API 6.5 |
healthUpdateInfo* P | HealthUpdateInfo[] |
The list of healthUpdateInfo that can be
reported in healthUpdates.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:string | The identifier for the registered provider. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
filterId P | xsd:string |
The filter id.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
NotFound | Thrown if no filter with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
filterId P | xsd:string |
The filter id.
Since vSphere API 6.5 |
entities* P | ManagedObjectReference[]
to a ManagedEntity[] |
The list of removed managed entities.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
NotFound | Thrown if no filter with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider id.
Since vSphere API 6.5 |
entities* P | ManagedObjectReference[]
to a ManagedEntity[] |
The entities that are no longer monitored by
this provider.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if any of the entities is a part of an InfraUpdateHa cluster that has the provider enabled. |
NotFound | Thrown if no provider with this id is registered. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HealthUpdateManager used to make the method call. |
providerId P | xsd:string |
The provider id.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the specified provider is still used in an InfraUpdateHa cluster. |
NotFound | Thrown if the specified provider is not registered. |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |