Package com.vmware.vim25.mo

Class CryptoManager

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.CryptoManager

Direct Known Subclasses:

CryptoManagerHost, CryptoManagerKmip

public class CryptoManager
extends ManagedObject

Constructor Summary

Constructors

Constructor	Description
CryptoManager(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Modifier and Type	Method	Description
void	addKey(CryptoKeyPlain key)
CryptoKeyResult[]	addKeys(CryptoKeyPlain[] keys)
boolean	getEnabled()
CryptoKeyId[]	listKeys()	List keys.
CryptoKeyId[]	listKeys(int limit)	List keys.
void	removeKey(CryptoKeyId key, boolean force)
CryptoKeyResult[]	removeKeys(CryptoKeyId[] keys, boolean force)	Remove multiple keys (only the UUID is needed to remove).

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

CryptoManager

public CryptoManager(ServerConnection serverConnection,
 ManagedObjectReference mor)

Method Details

addKey

public void addKey(CryptoKeyPlain key)
            throws AlreadyExists,
InvalidState,
RuntimeFault,
RemoteException

Throws:

AlreadyExists

InvalidState

RuntimeFault

RemoteException

addKeys

public CryptoKeyResult[] addKeys(CryptoKeyPlain[] keys)
                          throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

removeKey

public void removeKey(CryptoKeyId key,
 boolean force)
               throws ResourceInUse,
RuntimeFault,
RemoteException

Throws:

ResourceInUse

RuntimeFault

RemoteException

getEnabled

public boolean getEnabled()

listKeys

public CryptoKeyId[] listKeys()
                       throws RuntimeFault,
RemoteException

List keys. * When executed against the host, lists all the keys added to the host's key cache by AddKey/AddKeys. * When executed against the VC, lists all the keys used by the correctly registered VMs, and the host key.

Returns:

List of known keys.

Throws:

RuntimeFault - Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

RemoteException

listKeys

public CryptoKeyId[] listKeys(int limit)
                       throws RuntimeFault,
RemoteException

List keys. * When executed against the host, lists all the keys added to the host's key cache by AddKey/AddKeys. * When executed against the VC, lists all the keys used by the correctly registered VMs, and the host key.

Parameters:

limit - [in] maximum keys to return.

Returns:

List of known keys.

Throws:

RuntimeFault - Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

RemoteException

removeKeys

public CryptoKeyResult[] removeKeys(CryptoKeyId[] keys,
 boolean force)
                             throws RuntimeFault,
RemoteException

Remove multiple keys (only the UUID is needed to remove). If "force" is set, removal will happen even if they are in use.

Parameters:

keys - [in] List of keys to remove.

force - [in] Remove the key even if in use. Always successful.

Returns:

CryptoKeyResult

Throws:

RuntimeFault - Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

RemoteException