Package com.vmware.vim25.mo

Class GuestAliasManager

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.GuestAliasManager

public class GuestAliasManager
extends ManagedObject

Constructor Summary

Constructors

Constructor	Description
GuestAliasManager(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Modifier and Type	Method	Description
void	addGuestAlias(VirtualMachine vm, GuestAuthentication auth, String username, boolean mapCert, String base64Cert, GuestAuthAliasInfo aliasInfo)
GuestAliases[]	listGuestAliases(VirtualMachine vm, GuestAuthentication auth, String userName)	Lists the GuestAliases for a specified user in the guest that can be used for authentication of guest operations.
GuestMappedAliases[]	listGuestMappedAliases(VirtualMachine vm, GuestAuthentication auth)	Lists the GuestMappedAliases in the guest that can be used for authentication of guest operations.
void	removeGuestAlias(VirtualMachine vm, GuestAuthentication auth, String username, String base64Cert, GuestAuthSubject subject)
void	removeGuestAliasByCert(VirtualMachine vm, GuestAuthentication auth, String username, String base64Cert)

Methods inherited from class com.vmware.vim25.mo.ManagedObject

convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setCachedProperty, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

GuestAliasManager

public GuestAliasManager(ServerConnection serverConnection,
 ManagedObjectReference mor)

Method Details

addGuestAlias

public void addGuestAlias(VirtualMachine vm,
 GuestAuthentication auth,
 String username,
 boolean mapCert,
 String base64Cert,
 GuestAuthAliasInfo aliasInfo)
                   throws GuestOperationsFault,
InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

GuestOperationsFault

InvalidState

TaskInProgress

RuntimeFault

RemoteException

removeGuestAlias

public void removeGuestAlias(VirtualMachine vm,
 GuestAuthentication auth,
 String username,
 String base64Cert,
 GuestAuthSubject subject)
                      throws GuestOperationsFault,
InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

GuestOperationsFault

InvalidState

TaskInProgress

RuntimeFault

RemoteException

removeGuestAliasByCert

public void removeGuestAliasByCert(VirtualMachine vm,
 GuestAuthentication auth,
 String username,
 String base64Cert)
                            throws GuestOperationsFault,
InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

GuestOperationsFault

InvalidState

TaskInProgress

RuntimeFault

RemoteException

listGuestAliases

public GuestAliases[] listGuestAliases(VirtualMachine vm,
 GuestAuthentication auth,
 String userName)
                                throws GuestComponentsOutOfDate,
GuestOperationsFault,
GuestOperationsUnavailable,
GuestPermissionDenied,
InvalidGuestLogin,
InvalidPowerState,
InvalidState,
OperationDisabledByGuest,
OperationNotSupportedByGuest,
RuntimeFault,
TaskInProgress,
RemoteException

Lists the GuestAliases for a specified user in the guest that can be used for authentication of guest operations.

Parameters:

vm - Virtual machine to perform the operation on.

auth - The guest authentication data for this operation. See GuestAuthentication. These credentials must satisfy authentication requirements for a guest account on the specified virtual machine.

userName - The guest user whose Alias store is being queried.

Returns:

GuestAliases[]

Throws:

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 agent for guest operations is not running.

GuestPermissionDenied - Thrown if there are insufficient permissions in the guest OS.

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.

RemoteException

listGuestMappedAliases

public GuestMappedAliases[] listGuestMappedAliases(VirtualMachine vm,
 GuestAuthentication auth)
                                            throws GuestComponentsOutOfDate,
GuestOperationsFault,
GuestOperationsUnavailable,
GuestPermissionDenied,
InvalidGuestLogin,
InvalidPowerState,
InvalidState,
OperationDisabledByGuest,
OperationNotSupportedByGuest,
RuntimeFault,
TaskInProgress,
RemoteException

Lists the GuestMappedAliases in the guest that can be used for authentication of guest operations.

Parameters:

vm - VirtualMachine to perform the operation on.

auth - GuestAuthentication The guest authentication data for this operation. These credentials must satisfy authentication requirements for a guest account on the specified virtual machine.

Returns:

GuestMappedAliases[]

Throws:

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.

GuestPermissionDenied - Thrown if there are insufficient permissions in the guest OS.

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.

RemoteException