| 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 | xsd:string |
The provider identifier.
|
filterName | xsd:string |
The filter name.
|
infoIds* | xsd:string[] |
The list of HealthUpdateInfo IDs that should be
filtered.
|
Return Value
Type | Description |
---|---|
xsd:string | The 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. |
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 | xsd:string |
The filter id.
|
entities* | ManagedObjectReference[]
to a ManagedEntity[] |
The list of additional managed entities. Only
entities of type HostSystem or
ClusterComputeResource are valid.
|
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. |
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 | xsd:string |
The provider id.
|
entities* | ManagedObjectReference[]
to a ManagedEntity[] |
The entities that are newly monitored by this
provider.
|
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. |
NotFound | Thrown if no provider with this id is registered. |
NotSupported | Thrown if the http session user does not match the user who registered the provider, or if the http session cannot be retrieved. |
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 | xsd:string |
The provider id.
|
entity | ManagedObjectReference
to a ManagedEntity |
An entity of type HostSystem.
|
Return Value
Type | Description |
---|---|
xsd:boolean | True iff the entity is monitored by this provider. |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the specified entity is not of type HostSystem. |
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 | xsd:string |
The provider id.
|
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 | xsd:string |
The provider id.
|
updates* | HealthUpdate[] |
The changes in health states.
|
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. |
NotFound | Thrown if no provider with this id is registered. |
NotSupported | Thrown if the http session user does not match the user who registered the provider, or if the http session cannot be retrieved. |
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 | xsd:string |
The filter id.
|
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 | xsd:string |
The filter id.
|
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 | xsd:string |
The provider id.
|
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 | xsd:string |
The filter id.
|
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 | xsd:string |
The provider id.
|
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 | xsd:string |
The provider id.
|
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 | xsd:string |
The provider id.
|
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 | xsd:string |
|
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 | xsd:string |
The provider id.
|
cluster | ManagedObjectReference
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 |
---|---|
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 | xsd: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.
|
Return Value
Type | Description |
---|---|
xsd:string | The 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. |
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 | xsd:string |
The filter id.
|
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 | xsd:string |
The filter id.
|
entities* | ManagedObjectReference[]
to a ManagedEntity[] |
The list of removed managed entities.
|
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. |
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 | xsd:string |
The provider id.
|
entities* | ManagedObjectReference[]
to a ManagedEntity[] |
The entities that are no longer monitored by
this provider.
|
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. |
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. |
NotSupported | Thrown if the http session user does not match the user who registered the provider, or if the http session cannot be retrieved. |
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 | xsd:string |
The provider id.
|
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 |