# 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
--- | --- | ---
enabled | xsd:boolean |

Methods

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

# AddKey

Required Privileges
  Cryptographer.ManageKeys

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManager used to make the method call.
key P | CryptoKeyPlain | Since vSphere API 6.5

P Required privilege: key

Return Value

Type | Description
--- | ---
None

Faults

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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManager used to make the method call.
keys* P | CryptoKeyPlain[] | Since vSphere API 6.5

*Need not be set P Required privilege: keys

Return Value

Type | Description
--- | ---
CryptoKeyResult[] |

Faults

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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManager used to make the method call.
limit* P | xsd:int | Since vSphere API 6.5

*Need not be set P Required privilege: limit

Return Value

Type | Description
--- | ---
CryptoKeyId[] |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManager used to make the method call.
key P | CryptoKeyId | Since vSphere API 6.5
force P | xsd:boolean | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManager used to make the method call.
keys* P | CryptoKeyId[] | Since vSphere API 6.5
force P | xsd:boolean | Since vSphere API 6.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
CryptoKeyResult[] |

Faults

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

Events

Type
None