Service - GatewayAccessUserOrGroup

Class
VMware.Hv.GatewayAccessUserOrGroup
See also
GatewayAccessUserOrGroupData, GatewayAccessUserOrGroupInfo, UserOrGroupId
Since
Horizon 7.4


Service Description

Interface for Gateway Access user or group.

Methods

Methods defined in this Service
GatewayAccessUserOrGroup_Create, GatewayAccessUserOrGroup_Delete, GatewayAccessUserOrGroup_Get, GatewayAccessUserOrGroup_List

GatewayAccessUserOrGroup_Create

Creates Gateway Access user or group using user or group data. Only sid field is required/used for creating Gateway Access user or group. All other fields will be ignored/unused during create operation.

Privileges

Privilege Description
GLOBAL_CONFIG_MANAGEMENT is required to create Gateway Access user/group.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GatewayAccessUserOrGroup used to make the method call.
dataGatewayAccessUserOrGroupData

attributes needed to create a Gateway Access user or group.

Return Value

Type Description
UserOrGroupId

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if user or group is already an Gateway Access user or group.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_GATEWAY_ACCESS_USER_GROUP_CREATED If the Gateway Access user or group was successfully created.
VLSI_GATEWAY_ACCESS_USER_GROUP_CREATE_FAILED If the Gateway Access user or group could not be created.

Show WSDL type definition



GatewayAccessUserOrGroup_Delete

Deletes Gateway Access user or group entry.

Privileges

Privilege Description
GLOBAL_CONFIG_MANAGEMENT is required to delete Gateway Access user/group.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GatewayAccessUserOrGroup used to make the method call.
idUserOrGroupId

User id of Gateway Access user or group.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if user or group is not an Gateway Access user or group.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_GATEWAY_ACCESS_USER_GROUP_DELETED If the Gateway Access user or group was successfully deleted.
VLSI_GATEWAY_ACCESS_USER_GROUP_DELETE_FAILED If the Gateway Access user or group could not be deleted.

Show WSDL type definition



GatewayAccessUserOrGroup_Get

Gets Gateway Access user info using id.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global config view privilege is required to read a Gateway Access user or group info.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GatewayAccessUserOrGroup used to make the method call.
idUserOrGroupId

User id of Gateway Access user or group.

Return Value

Type Description
GatewayAccessUserOrGroupInfoGatewayAccessUserOrGroupInfo for the user or group with the given user or group id.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



GatewayAccessUserOrGroup_List

Lists all Gateway Access users and groups.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global config view privilege is required to list the Gateway Access users or groups information.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GatewayAccessUserOrGroup used to make the method call.

Return Value

Type Description
GatewayAccessUserOrGroupInfo[]The list of all the Gateway Access users/groups info.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition