Managed Object - CryptoManager(vim.encryption.CryptoManager)

Property of
HostConfigManager, ServiceContent
Extended by
CryptoManagerHost, CryptoManagerKmip
See also
CryptoKeyId, CryptoKeyPlain, CryptoKeyResult
Since
vSphere API 6.5


Managed Object Description

Singleton Managed Object used to manage cryptographic keys.

Properties

Name Type Description
enabledxsd:boolean

Indicate if the encryption feature is enabled.

Methods

Methods defined in this Managed Object
AddKey, AddKeys, ListKeys, RemoveKey, RemoveKeys

AddKey(addKey)

Add an existing key.
Required Privileges
Cryptographer.ManageKeys

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManager used to make the method call.
key PCryptoKeyPlain

[in] The cryptographic key to add.

Since vSphere API 6.5
P Required privilege: key

Return Value

Type Description
None

Faults

Type Description
AlreadyExistsin case the key is already in the key cache
InvalidStatein case the host is not Crypto Safe
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



AddKeys(addKeys)

Add multiple existing keys.
Required Privileges
Cryptographer.ManageKeys

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManager used to make the method call.
keys* PCryptoKeyPlain[]

[in] List of cryptographic keys to add.

Since vSphere API 6.5
*Need not be set P Required privilege: keys

Return Value

Type Description
CryptoKeyResult[]The result for each key operation.

Faults

Type Description
InvalidStatein case the host is not Crypto Safe
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



ListKeys(listKeys)

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.
Required Privileges
Cryptographer.ManageKeys

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManager used to make the method call.
limit* Pxsd:int

[in] maximum keys to return.

Since vSphere API 6.5
*Need not be set P Required privilege: limit

Return Value

Type Description
CryptoKeyId[]List of known keys.

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



RemoveKey(removeKey)

Remove a key (only the UUID is needed to remove). If "force" is set, removal will happen even if the key is in use.
Required Privileges
Cryptographer.ManageKeys

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManager used to make the method call.
key PCryptoKeyId

[in] The key to remove.

Since vSphere API 6.5
force Pxsd:boolean

[in] Remove the key even if in use or not existent.

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
ResourceInUseThrown if the key is used to encrypt any object and "force" is false.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



RemoveKeys(removeKeys)

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManager used to make the method call.
keys* PCryptoKeyId[]

[in] List of keys to remove.

Since vSphere API 6.5
force Pxsd:boolean

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

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
CryptoKeyResult[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition