Files

Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation

This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15

2014-06-17 14:07:42 -04:00

7.3 KiB

Raw Blame History

vim.vm.guest.AuthManager

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

since: vSphere API 5.0

Attributes

Methods

ValidateCredentialsInGuest(vm, auth):

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.

Privilege:

Args:

vm (vim.VirtualMachine):: MoRef of the VM to perform the operation on.
auth (vim.vm.guest.GuestAuthentication):: The guest authentication data. See GuestAuthentication .

Returns:

None

Raises:

vim.fault.GuestOperationsFault:

if there is an error processing a guest operation.

vim.fault.InvalidState:

if the operation cannot be performed because of the virtual machine's current state.

vim.fault.TaskInProgress:

if the virtual machine is busy.

vim.fault.GuestOperationsUnavailable:

if the VM agent for guest operations is not running.

vim.fault.InvalidPowerState:

if the VM is not powered on.

vim.fault.GuestComponentsOutOfDate:

if the guest agent is too old to support the operation.

vim.fault.OperationNotSupportedByGuest:

if the operation is not supported by the guest OS.

vim.fault.OperationDisabledByGuest:

if the operation is not enabled due to guest agent configuration.

vim.fault.InvalidGuestLogin:

if the the guest authentication information was not accepted.

AcquireCredentialsInGuest(vm, requestedAuth, sessionID):

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 .

Privilege:

Args:

vm (vim.VirtualMachine):: MoRef of the VM to perform the operation on.
requestedAuth (vim.vm.guest.GuestAuthentication):: The guest authentication data used to acquire credentials. See GuestAuthentication .
sessionID (long, optional):: 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.

Returns:

vim.vm.guest.GuestAuthentication:: Returns a GuestAuthentication object that can be used in guest operation calls.

Raises:

vim.fault.GuestOperationsFault:

if there is an error processing a guest operation.

vim.fault.TaskInProgress:

if the virtual machine is busy.

vim.fault.InvalidState:

if the operation cannot be performed because of the virtual machine's current state.

vim.fault.GuestOperationsUnavailable:

if the VM agent for guest operations is not running.

vim.fault.InvalidPowerState:

if the VM is not powered on.

vim.fault.GuestAuthenticationChallenge:

if the credential information provided requires a challenge to authenticate.

vim.fault.GuestComponentsOutOfDate:

if the guest agent is too old to support the operation.

vim.fault.OperationNotSupportedByGuest:

if the operation is not supported by the guest OS.

vim.fault.OperationDisabledByGuest:

if the operation is not enabled due to guest agent configuration.

vim.fault.TooManyGuestLogons:

if there are too many concurrent login sessions active in the guest.

vim.fault.InvalidGuestLogin:

if the the guest authentication information was not accepted.

ReleaseCredentialsInGuest(vm, auth):

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.

Privilege:

Args:

vm (vim.VirtualMachine):: MoRef of the VM to perform the operation on.
auth (vim.vm.guest.GuestAuthentication):: The guest authentication data. See GuestAuthentication .

Returns:

None

Raises:

vim.fault.GuestOperationsFault:

if there is an error processing a guest operation.

vim.fault.TaskInProgress:

if the virtual machine is busy.

vim.fault.InvalidState:

if the operation cannot be performed because of the virtual machine's current state.

vim.fault.GuestOperationsUnavailable:

if the VM agent for guest operations is not running.

vim.fault.InvalidPowerState:

if the VM is not powered on.

vim.fault.GuestComponentsOutOfDate:

if the guest agent is too old to support the operation.

vim.fault.OperationNotSupportedByGuest:

if the operation is not supported by the guest OS.

vim.fault.OperationDisabledByGuest:

if the operation is not enabled due to guest agent configuration.

vim.fault.InvalidGuestLogin:

if the the guest authentication information was not accepted.

7.3 KiB Raw Blame History

vim.vm.guest.AuthManager

Attributes

Methods

7.3 KiB

Raw Blame History