Managed Object - GuestAuthManager

Property of: GuestOperationsManager
See also: GuestAuthentication, VirtualMachine
Since: vSphere API 5.0

Managed Object Description

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

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
AcquireCredentialsInGuest, ReleaseCredentialsInGuest, ValidateCredentialsInGuest

AcquireCredentialsInGuest

Authenticates in the guest and returns a 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 GuestAuthentication object for supported authentication types. This operation is not needed for Name and Password Authentication. To use Name and Password Authentication, see NamePasswordAuthentication. For SSPI authentication, requestAuth should be of the type SSPIAuthentication.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GuestAuthManager used to make the method call.
vm P	ManagedObjectReference to a VirtualMachine	MoRef of the VM to perform the operation on.
requestedAuth	GuestAuthentication	The guest authentication data used to acquire credentials. See GuestAuthentication.
sessionID*	xsd:long	The sessionID number should be provided only when responding to a server challenge. The sessionID number to be used with the challenge is found in the GuestAuthenticationChallenge object.

*Need not be set P Required privilege: VirtualMachine.GuestOperations.Query

Return Value

Type	Description
GuestAuthentication	Returns a GuestAuthentication object that can be used in guest operation calls.

Faults

Type	Description
GuestAuthenticationChallenge	Thrown if the credential information provided requires a challenge to authenticate.
GuestComponentsOutOfDate	Thrown if the guest agent is too old to support the operation.
GuestOperationsFault	Thrown if there is an error processing a guest operation.
GuestOperationsUnavailable	Thrown if the VM agent for guest operations is not running.
InvalidGuestLogin	Thrown if the the guest authentication information was not accepted.
InvalidPowerState	Thrown if the VM is not powered on.
InvalidState	Thrown if the operation cannot be performed because of the virtual machine's current state.
OperationDisabledByGuest	Thrown if the operation is not enabled due to guest agent configuration.
OperationNotSupportedByGuest	Thrown if the operation is not supported by the guest OS.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if the virtual machine is busy.
TooManyGuestLogons	Thrown if there are too many concurrent login sessions active in the guest.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AcquireCredentialsInGuest" type="vim25:AcquireCredentialsInGuestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AcquireCredentialsInGuestResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:GuestAuthentication"/>
               </sequence>
            </complexType>
         </element>

ReleaseCredentialsInGuest

Releases session data and resources associated with a GuestAuthentication object returned by AcquireCredentialsInGuest.

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

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GuestAuthManager used to make the method call.
vm P	ManagedObjectReference to a VirtualMachine	MoRef of the VM to perform the operation on.
auth	GuestAuthentication	The guest authentication data. See GuestAuthentication.

P Required privilege: VirtualMachine.GuestOperations.Query

Return Value

Type	Description
None

Faults

Type	Description
GuestComponentsOutOfDate	Thrown if the guest agent is too old to support the operation.
GuestOperationsFault	Thrown if there is an error processing a guest operation.
GuestOperationsUnavailable	Thrown if the VM agent for guest operations is not running.
InvalidGuestLogin	Thrown if the the guest authentication information was not accepted.
InvalidPowerState	Thrown if the VM is not powered on.
InvalidState	Thrown if the operation cannot be performed because of the virtual machine's current state.
OperationDisabledByGuest	Thrown if the operation is not enabled due to guest agent configuration.
OperationNotSupportedByGuest	Thrown if the operation is not supported by the guest OS.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if the virtual machine is busy.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ReleaseCredentialsInGuest" type="vim25:ReleaseCredentialsInGuestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ReleaseCredentialsInGuestResponse">
            <complexType/>
         </element>

ValidateCredentialsInGuest

Validates the 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, GuestPermissionDenied will be thrown.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GuestAuthManager used to make the method call.
vm P	ManagedObjectReference to a VirtualMachine	MoRef of the VM to perform the operation on.
auth	GuestAuthentication	The guest authentication data. See GuestAuthentication.

P Required privilege: VirtualMachine.GuestOperations.Query

Return Value

Type	Description
None

Faults

Type	Description
GuestComponentsOutOfDate	Thrown if the guest agent is too old to support the operation.
GuestOperationsFault	Thrown if there is an error processing a guest operation.
GuestOperationsUnavailable	Thrown if the VM agent for guest operations is not running.
InvalidGuestLogin	Thrown if the the guest authentication information was not accepted.
InvalidPowerState	Thrown if the VM is not powered on.
InvalidState	Thrown if the operation cannot be performed because of the virtual machine's current state.
OperationDisabledByGuest	Thrown if the operation is not enabled due to guest agent configuration.
OperationNotSupportedByGuest	Thrown if the operation is not supported by the guest OS.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if the virtual machine is busy.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ValidateCredentialsInGuest" type="vim25:ValidateCredentialsInGuestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ValidateCredentialsInGuestResponse">
            <complexType/>
         </element>