View API

			Local Methods
Service Types	Data Object Types	All Properties	All Methods

Service - PodHealth

Class

VMware.Hv.PodHealth

See also

PodHealthInfo, PodId

Since

Horizon View 6.0

Service Description

Representing status and health information for PodFederation.

Methods

Methods defined in this Service
PodHealth_Get, PodHealth_List

PodHealth_Get

Get health status on a specified pod.
This operation can only be performed if the current pod is a member pod of a Pod Federation.

Privileges

Privilege	Description
FEDERATED_LDAP_VIEW	Global LDAP read is required to read the health of a pod.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PodHealth used to make the method call.
id	PodId	pod to get health status for. Cannot be local pod.

Return Value

Type	Description
PodHealthInfo	PodHealthInfo containing health/status information the specified pod

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidState	Thrown if the Pod Federation has not been initialized
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="PodHealth_Get" type="vdi:PodHealth_GetRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="PodHealth_GetResponse"> <complexType> <sequence> <element name="returnval" type="vdi:PodHealthInfo"/> </sequence> </complexType> </element>

PodHealth_List

Get health status on all remote pods in the Multi-DataCenter View Pod Federation.
This operation can only be performed if the current pod is a member pod of a Pod Federation.

Privileges

Privilege	Description
FEDERATED_LDAP_VIEW	Global LDAP read is required to list pod health.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PodHealth used to make the method call.

Return Value

Type	Description
PodHealthInfo[]	list of PodHealthInfo containing health/status information for all pods except for the local pod.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidState	Thrown if this pod is not in the valid state to perform getStatus operation.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="PodHealth_List" type="vdi:PodHealth_ListRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="PodHealth_ListResponse"> <complexType> <sequence> <element name="returnval" type="vdi:PodHealthInfo" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

Top of page			Local Methods
Service Types	Data Object Types	All Properties	All Methods