Managed Object - CryptoManager

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


Managed Object Description

Properties

Name Type Description
enabledxsd:boolean



Methods

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

AddKey

Required Privileges
Cryptographer.ManageKeys

Parameters

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

Since vSphere API 6.5
P Required privilege: key

Return Value

Type Description
None

Faults

Type Description
AlreadyExists
InvalidState
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



AddKeys

Required Privileges
Cryptographer.ManageKeys

Parameters

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

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

Return Value

Type Description
CryptoKeyResult[]

Faults

Type Description
InvalidState
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



ListKeys

Required Privileges
Cryptographer.ManageKeys

Parameters

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

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

Return Value

Type Description
CryptoKeyId[]

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



RemoveKey

Required Privileges
Cryptographer.ManageKeys

Parameters

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

Since vSphere API 6.5
force Pxsd:boolean

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
ResourceInUse
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



RemoveKeys

Required Privileges
Cryptographer.ManageKeys

Parameters

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

Since vSphere API 6.5
force Pxsd:boolean

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