Skip to content

Service - GSSAPIAuthenticator

Java Class

com.omnissa.vdi.vlsi.binding.vdi.infrastructure.GSSAPIAuthenticator

See also

GSSAPIAuthenticatorId, GSSAPIAuthenticatorInfo, GSSAPIAuthenticatorSpec, MapEntry

Since

Horizon 7.13

Service Description

Service for managing GSSAPI authenticators.

Methods

Methods defined in this Service: GSSAPIAuthenticator_Create, GSSAPIAuthenticator_Delete, GSSAPIAuthenticator_Get, GSSAPIAuthenticator_List, GSSAPIAuthenticator_Update

Creates a GSSAPI authenticator.

Privileges

Privilege Description
GLOBAL_CONFIG_MANAGEMENT Global configuration management is required to create a GSSAPI authenticator.

Parameters

Name Type Description
_this ManagedObjectReference A reference to the GSSAPIAuthenticator used to make the method call.
spec GSSAPIAuthenticatorSpec The specification of the GSSAPI authenticator.

Return Value

Type Description
GSSAPIAuthenticatorId The ID of the newly created GSSAPI authenticator.

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.

Events

Event Description
GSSAPI_AUTHENTICATOR_CREATED If the GSSAPI authenticator was successfully created.

Show WSDL type definition

Deletes the specified GSSAPI authenticator.

Privileges

Privilege Description
GLOBAL_CONFIG_MANAGEMENT Global configuration management is required to delete a GSSAPI authenticator.

Parameters

Name Type Description
_this ManagedObjectReference A reference to the GSSAPIAuthenticator used to make the method call.
id GSSAPIAuthenticatorId The ID of the GSSAPI authenticator to delete.

Return Value

Type Description
None

Faults

Type Description
EntityInUse Thrown if the GSSAPI authentication is currently being used by a connection server.
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.

Events

Event Description
GSSAPI_AUTHENTICATOR_DELETED If the GSSAPI authenticator was successfully deleted.

Show WSDL type definition

Retrieves information about a GSSAPI authenticator.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration view is required to retrieve information about a GSSAPI authenticator.

Parameters

Name Type Description
_this ManagedObjectReference A reference to the GSSAPIAuthenticator used to make the method call.
id GSSAPIAuthenticatorId The ID of the GSSAPI authenticator.

Return Value

Type Description
GSSAPIAuthenticatorInfo Information about the specified GSSAPI authenticator.

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

Lists the configured GSSAPI authenticators.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration view is required to list GSSAPI authenticators.

Parameters

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

Return Value

Type Description
GSSAPIAuthenticatorInfo[] Information about the configured GSSAPI authenticators.

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

Updates a GSSAPI authenticator.

Privileges

Privilege Description
GLOBAL_CONFIG_MANAGEMENT Global configuration management is required to update a GSSAPI authenticator.

Parameters

Name Type Description
_this ManagedObjectReference A reference to the GSSAPIAuthenticator used to make the method call.
id GSSAPIAuthenticatorId The ID of the GSSAPI authenticator to update.
updates MapEntry[] Key value pairs describing attributes to be updated. 1

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.

Events

Event Description
GSSAPI_AUTHENTICATOR_UPDATED If the GSSAPI authenticator was successfully updated.

Show WSDL type definition


  1. This parameter is an update map based on GSSAPIAuthenticatorInfo