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

Name	Type	Description
_this	ManagedObjectReference	A reference to the CryptoManager used to make the method call.
key P	CryptoKeyPlain	[in] The cryptographic key to add. *Since* vSphere API 6.5

Name

Type

Description

_this

ManagedObjectReference

A reference to the CryptoManager used to make the method call.

key P

CryptoKeyPlain

[in] The cryptographic key to add.

Since vSphere API 6.5

P Required privilege: key

Return Value

Type	Description
None

Faults

Type	Description
AlreadyExists	in case the key is already in the key cache
InvalidState	in case the host is not Crypto Safe
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AddKey" type="vim25:AddKeyRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AddKeyResponse">
                  <complexType/>
               </element>

AddKeys(addKeys)

Add multiple existing keys.

Required Privileges: Cryptographer.ManageKeys

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the CryptoManager used to make the method call.
keys* P	CryptoKeyPlain[]	[in] List of cryptographic keys to add. *Since* vSphere API 6.5

Name

Type

Description

_this

ManagedObjectReference

A reference to the CryptoManager used to make the method call.

keys* P

CryptoKeyPlain[]

[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
InvalidState	in case the host is not Crypto Safe
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AddKeys" type="vim25:AddKeysRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AddKeysResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:CryptoKeyResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the CryptoManager used to make the method call.
limit* P	xsd:int	[in] maximum keys to return. *Since* vSphere API 6.5

Name

Type

Description

_this

ManagedObjectReference

A reference to the CryptoManager used to make the method call.

limit* P

xsd: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
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ListKeys" type="vim25:ListKeysRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ListKeysResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:CryptoKeyId" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the CryptoManager used to make the method call.
key P	CryptoKeyId	[in] The key to remove. *Since* vSphere API 6.5
force P	xsd:boolean	[in] Remove the key even if in use or not existent. *Since* vSphere API 6.5

Name

Type

Description

_this

ManagedObjectReference

A reference to the CryptoManager used to make the method call.

key P

CryptoKeyId

[in] The key to remove.

Since vSphere API 6.5

force P

xsd: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
ResourceInUse	Thrown if the key is used to encrypt any object and "force" is false.
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveKey" type="vim25:RemoveKeyRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveKeyResponse">
                  <complexType/>
               </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the CryptoManager used to make the method call.
keys* P	CryptoKeyId[]	[in] List of keys to remove. *Since* vSphere API 6.5
force P	xsd:boolean	[in] Remove the key even if in use. Always successful. *Since* vSphere API 6.5

Name

Type

Description

_this

ManagedObjectReference

A reference to the CryptoManager used to make the method call.

keys* P

CryptoKeyId[]

[in] List of keys to remove.

Since vSphere API 6.5

force P

xsd: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
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveKeys" type="vim25:RemoveKeysRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveKeysResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:CryptoKeyResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>