Service - Gateway

Class: VMware.Hv.Gateway
See also: GatewayId, GatewayInfo, GatewaySpec
Since: Horizon 7.7

Service Description

Service interface for Gateway.

Methods

Methods defined in this Service
Gateway_Get, Gateway_List, Gateway_Register, Gateway_Unregister

Gateway_Get

Get the GatewayInfo of registered gateway.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view privilege is required to retrieve information about the gateway.

Parameters

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

Return Value

Type	Description
GatewayInfo	Details of the 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="Gateway_Get" type="vdi:Gateway_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Gateway_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GatewayInfo"/>
               </sequence>
            </complexType>
         </element>

Gateway_List

List the GatewayInfo objects of all the registered gateways.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view privilege is required to retrieve information about the gateways.

Parameters

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

Return Value

Type	Description
GatewayInfo[]	List of all gateway objects.

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

Gateway_Register

Add a gateway to the view instance.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to register/add a gateway.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Gateway used to make the method call.
spec	GatewaySpec	attributes needed to add gateway.

Return Value

Type	Description
GatewayId	unique identifier for the 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="Gateway_Register" type="vdi:Gateway_RegisterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Gateway_RegisterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GatewayId"/>
               </sequence>
            </complexType>
         </element>

Gateway_Unregister

Unregister gateway for the input gateway id.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management privilege is required to unregister the gateway.

Parameters

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

Return Value

Type	Description
None

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="Gateway_Unregister" type="vdi:Gateway_UnregisterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Gateway_UnregisterResponse">
            <complexType/>
         </element>

View API

Service - Gateway

Service Description

Gateway_Get

Gateway_List

Gateway_Register

Gateway_Unregister