Package com.vmware.vim25.mo

Class HostAccessManager

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.HostAccessManager

public class HostAccessManager
extends ManagedObject

Constructor Summary

Constructors

Constructor	Description
HostAccessManager(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Modifier and Type	Method	Description
void	changeAccessMode(String principal, boolean isGroup, HostAccessMode accessMode)
void	changeLockdownMode(HostLockdownMode mode)
HostLockdownMode	getLockdownMode()
String[]	queryLockdownExceptions()	Get the list of users which are exceptions for lockdown mode.
String[]	querySystemUsers()	Get the list of local system users.
HostAccessControlEntry[]	retrieveHostAccessControlEntries()	Retrieve access entries.
void	updateLockdownExceptions()
void	updateLockdownExceptions(String[] users)
void	updateSystemUsers()
void	updateSystemUsers(String[] users)

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

HostAccessManager

public HostAccessManager(ServerConnection serverConnection,
 ManagedObjectReference mor)

Method Details

getLockdownMode

public HostLockdownMode getLockdownMode()

changeAccessMode

public void changeAccessMode(String principal,
 boolean isGroup,
 HostAccessMode accessMode)
                      throws AuthMinimumAdminPermission,
UserNotFound,
RuntimeFault,
RemoteException

Throws:

AuthMinimumAdminPermission

UserNotFound

RuntimeFault

RemoteException

changeLockdownMode

public void changeLockdownMode(HostLockdownMode mode)
                        throws AuthMinimumAdminPermission,
RuntimeFault,
RemoteException

Throws:

AuthMinimumAdminPermission

RuntimeFault

RemoteException

updateLockdownExceptions

public void updateLockdownExceptions(String[] users)
                              throws AuthMinimumAdminPermission,
UserNotFound,
RuntimeFault,
RemoteException

Throws:

AuthMinimumAdminPermission

UserNotFound

RuntimeFault

RemoteException

updateSystemUsers

public void updateSystemUsers(String[] users)
                       throws UserNotFound,
RuntimeFault,
RemoteException

Throws:

UserNotFound

RuntimeFault

RemoteException

queryLockdownExceptions

public String[] queryLockdownExceptions()
                                 throws RuntimeFault,
RemoteException

Get the list of users which are exceptions for lockdown mode.

Returns:

The list of users which will not lose their permissions when the host enters lockdown mode.

Throws:

RuntimeFault

RemoteException

See Also:

• UpdateLockdownExceptions.

querySystemUsers

public String[] querySystemUsers()
                          throws RuntimeFault,
RemoteException

Get the list of local system users.

These are special users like 'vpxuser', 'vslauser' and 'dcui', which may be used for authenticating different sub-components of the vSphere system and may be essential for its correct functioning. Usually these users may not be used by human operators to connect directly to the host and the UI may choose to show them only in some "advanced" UI view.

Returns:

The list of local system users.

Throws:

RuntimeFault

RemoteException

retrieveHostAccessControlEntries

public HostAccessControlEntry[] retrieveHostAccessControlEntries()
                                                          throws RuntimeFault,
RemoteException

Retrieve access entries. Returns a list of AccessEntry objects for each VIM user or group which have explicitly assigned permissions on the host. This means that AccessMode#accessNone will not be present in the result.

Returns:

A list of AccessEntry objects.

Throws:

RuntimeFault

RemoteException

updateLockdownExceptions

public void updateLockdownExceptions()
                              throws AuthMinimumAdminPermission,
RuntimeFault,
UserNotFound,
RemoteException

Throws:

AuthMinimumAdminPermission

RuntimeFault

UserNotFound

RemoteException

updateSystemUsers

public void updateSystemUsers()
                       throws InvalidArgument,
RuntimeFault,
UserNotFound,
RemoteException

Throws:

InvalidArgument

RuntimeFault

UserNotFound

RemoteException