⇨

SEND US FEEDBACK!

vSphere API/SDK Documentation > vSphere Management SDK > vSphere Web Services SDK Documentation > VMware vSphere API Reference > Managed Object Types > H

1 2 3 4 5
0 Ratings

Local Methods

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

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

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.

*Need not be set

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AddFilter" type="vim25:AddFilterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AddFilterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>

AddFilterEntities(addFilterEntities)

Add entities on which this filter is configured.

Required Privileges: Host.Inventory.EditCluster

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.

*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.
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AddFilterEntities" type="vim25:AddFilterEntitiesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AddFilterEntitiesResponse">
            <complexType/>
         </element>

AddMonitoredEntities(addMonitoredEntities)

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

Required Privileges: HealthUpdateProvider.Update

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.

*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.
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AddMonitoredEntities" type="vim25:AddMonitoredEntitiesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AddMonitoredEntitiesResponse">
            <complexType/>
         </element>

HasMonitoredEntity(hasMonitoredEntity)

Check if the managed entity is monitored by the provider.

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HasMonitoredEntity" type="vim25:HasMonitoredEntityRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HasMonitoredEntityResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:boolean"/>
               </sequence>
            </complexType>
         </element>

HasProvider(hasProvider)

Verifies if the given provider is registered.

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HasProvider" type="vim25:HasProviderRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HasProviderResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:boolean"/>
               </sequence>
            </complexType>
         </element>

PostHealthUpdates(postHealthUpdates)

Report a change in health status.

Required Privileges: HealthUpdateProvider.Update

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.

*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.
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="PostHealthUpdates" type="vim25:PostHealthUpdatesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="PostHealthUpdatesResponse">
            <complexType/>
         </element>

QueryFilterEntities(queryFilterEntities)

Returns the list of entities on which this filter is configured.

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryFilterEntities" type="vim25:QueryFilterEntitiesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryFilterEntitiesResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

QueryFilterInfoIds(queryFilterInfoIds)

Returns the list of HealthUpdateInfos configured for this filter.

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryFilterInfoIds" type="vim25:QueryFilterInfoIdsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryFilterInfoIdsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

QueryFilterList(queryFilterList)

Returns the list of filters.

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryFilterList" type="vim25:QueryFilterListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryFilterListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

QueryFilterName(queryFilterName)

Returns the filter name.

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryFilterName" type="vim25:QueryFilterNameRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryFilterNameResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>

QueryHealthUpdateInfos(queryHealthUpdateInfos)

Returns the list of HealthUpdateInfo configured for the given provider.

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryHealthUpdateInfos" type="vim25:QueryHealthUpdateInfosRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryHealthUpdateInfosResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:HealthUpdateInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

QueryHealthUpdates(queryHealthUpdates)

Returns the list of health updates reported by the given provider.

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryHealthUpdates" type="vim25:QueryHealthUpdatesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryHealthUpdatesResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:HealthUpdate" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

QueryMonitoredEntities(queryMonitoredEntities)

Returns the list of managed entities monitored by the given provider.

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryMonitoredEntities" type="vim25:QueryMonitoredEntitiesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryMonitoredEntitiesResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

QueryProviderList(queryProviderList)

The providers.

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[]	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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryProviderList" type="vim25:QueryProviderListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryProviderListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

QueryProviderName(queryProviderName)

Query the name of the provider.

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryProviderName" type="vim25:QueryProviderNameRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryProviderNameResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>

QueryUnmonitoredHosts(queryUnmonitoredHosts)

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

Required Privileges: System.View

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryUnmonitoredHosts" type="vim25:QueryUnmonitoredHostsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryUnmonitoredHostsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

RegisterHealthUpdateProvider(registerProvider)

Registers provider.

Required Privileges: HealthUpdateProvider.Register

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.

*Need not be set

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RegisterHealthUpdateProvider" type="vim25:RegisterHealthUpdateProviderRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RegisterHealthUpdateProviderResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>

RemoveFilter(removeFilter)

Removes the specified filter.

Required Privileges: Host.Inventory.EditCluster

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveFilter" type="vim25:RemoveFilterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveFilterResponse">
            <complexType/>
         </element>

RemoveFilterEntities(removeFilterEntities)

Remove entities on which this filter is configured.

Required Privileges: Host.Inventory.EditCluster

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.

*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.
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveFilterEntities" type="vim25:RemoveFilterEntitiesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveFilterEntitiesResponse">
            <complexType/>
         </element>

RemoveMonitoredEntities(removeMonitoredEntities)

The provider monitors fewer managed entities.

Required Privileges: HealthUpdateProvider.Update

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.

*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.
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveMonitoredEntities" type="vim25:RemoveMonitoredEntitiesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveMonitoredEntitiesResponse">
            <complexType/>
         </element>

UnregisterHealthUpdateProvider(unregisterProvider)

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

Required Privileges: HealthUpdateProvider.Unregister

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UnregisterHealthUpdateProvider" type="vim25:UnregisterHealthUpdateProviderRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UnregisterHealthUpdateProviderResponse">
            <complexType/>
         </element>

Feedback

1 2 3 4 5
0 Ratings