Service - GatewayHealth

Class: VMware.Hv.GatewayHealth
See also: GatewayHealthInfo, GatewayId
Since: Horizon 7.7

Service Description

Service for retrieving health information on Gateway.

Methods

Methods defined in this Service
GatewayHealth_Get, GatewayHealth_List

GatewayHealth_Get

Gets the health information of the registered gateway.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GatewayHealth used to make the method call.
id	GatewayId	The Id of the gateway.

Return Value

Type	Description
GatewayHealthInfo	Health information of the specified gateway.

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.
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="GatewayHealth_Get" type="vdi:GatewayHealth_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GatewayHealth_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GatewayHealthInfo"/>
               </sequence>
            </complexType>
         </element>

GatewayHealth_List

Gets the health information of all the registered gateways.

Parameters

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

Return Value

Type	Description
GatewayHealthInfo[]	A list of health information of all the registered gateways.

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.
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="GatewayHealth_List" type="vdi:GatewayHealth_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GatewayHealth_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GatewayHealthInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

View API

Service - GatewayHealth

Service Description

GatewayHealth_Get

GatewayHealth_List