Service - Gateway
Java Class
com.omnissa.vdi.vlsi.binding.vdi.infrastructure.Gateway
See also
Since
Horizon 7.7
Service Description¶
Service interface for Gateway.
Methods
Methods defined in this Service: Gateway_Get, Gateway_List, Gateway_Register, Gateway_Unregister
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
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
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
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