Service - GSSAPIAuthenticator

Class: VMware.Hv.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

GSSAPIAuthenticator_Create

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GSSAPIAuthenticator_Create" type="vdi:GSSAPIAuthenticator_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GSSAPIAuthenticator_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GSSAPIAuthenticatorId"/>
               </sequence>
            </complexType>
         </element>

GSSAPIAuthenticator_Delete

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GSSAPIAuthenticator_Delete" type="vdi:GSSAPIAuthenticator_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GSSAPIAuthenticator_DeleteResponse">
            <complexType/>
         </element>

GSSAPIAuthenticator_Get

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GSSAPIAuthenticator_Get" type="vdi:GSSAPIAuthenticator_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GSSAPIAuthenticator_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GSSAPIAuthenticatorInfo"/>
               </sequence>
            </complexType>
         </element>

GSSAPIAuthenticator_List

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GSSAPIAuthenticator_List" type="vdi:GSSAPIAuthenticator_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GSSAPIAuthenticator_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GSSAPIAuthenticatorInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

GSSAPIAuthenticator_Update

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.

GSSAPIAuthenticatorId

The ID of the GSSAPI authenticator to update.

updates

MapEntry[]

Key value pairs describing attributes to be updated.

This parameter is an update map based on GSSAPIAuthenticatorInfo.

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GSSAPIAuthenticator_Update" type="vdi:GSSAPIAuthenticator_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GSSAPIAuthenticator_UpdateResponse">
            <complexType/>
         </element>