Scripting Object - VcGuestAuthManager

Scripting-object corresponding to
GuestAuthManager
Attribute of
VcGuestOperationsManager

Scripting Object Description

AuthManager is the managed object that provides APIs to manipulate the guest operating authentication.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, acquireCredentialsInGuest, createTrigger, releaseCredentialsInGuest, validateCredentialsInGuest

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

acquireCredentialsInGuest

Authenticates in the guest and returns a {@link GuestAuthentication} object with the acquired credentials for use in subsequent guest operation calls.

This can be used to authenticate inside the guest and obtain a {@link GuestAuthentication} object for supported authentication types. This operation is not needed for Name and Password Authentication. To use Name and Password Authentication, see {@link NamePasswordAuthentication}. For SSPI authentication, requestAuth should be of the type {@link SSPIAuthentication}.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2Number


Return Value

Type Description
VcGuestAuthentication

releaseCredentialsInGuest

Releases session data and resources associated with a {@link GuestAuthentication} object returned by {@link #acquireCredentials}.

This frees any resources and session data associated with a {@link GuestAuthentication} object returned by {@link #acquireCredentials}. The {@link GuestAuthentication} object can no longer be used to authenticate in the guest once released. Currently this operation is only valid for {@link TicketedSessionAuthentication} objects.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication


Return Value

Type Description
None

validateCredentialsInGuest

Validates the {@link GuestAuthentication} credentials.

This can be used to check the authentication data, or validate any authetication that has a timeout is still valid. If the authentication is not valid, {@link vim.fault.GuestPermissionDenied} will be thrown.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication


Return Value

Type Description
None