# Managed Object - CryptoManagerKmip

Extends
  CryptoManager
See also
  CryptoKeyId, CryptoKeyResult, CryptoManagerKmipClusterStatus, CryptoManagerKmipCryptoKeyStatus, CryptoManagerKmipServerCertInfo, KeyProviderId, KmipClusterInfo, KmipServerInfo, KmipServerSpec, ManagedEntity
Since
  vSphere API 6.5

## Managed Object Description

Properties

Name | Type | Description
--- | --- | ---
kmipServers* | KmipClusterInfo[] |
Properties inherited from CryptoManager
enabled

*May not be present

Methods

Methods defined in this Managed Object
GenerateClientCsr, GenerateKey, GenerateSelfSignedClientCert, GetDefaultKmsCluster, IsKmsClusterActive, ListKmipServers, ListKmsClusters, MarkDefault, QueryCryptoKeyStatus, RegisterKmipServer, RegisterKmsCluster, RemoveKmipServer, RetrieveClientCert, RetrieveClientCsr, RetrieveKmipServerCert, RetrieveKmipServersStatus_Task, RetrieveSelfSignedClientCert, SetDefaultKmsCluster, UnregisterKmsCluster, UpdateKmipServer, UpdateKmsSignedCsrClientCert, UpdateSelfSignedClientCert, UploadClientCert, UploadKmipServerCert
Methods inherited from CryptoManager
AddKey, AddKeys, ListKeys, RemoveKey, RemoveKeys

# GenerateClientCsr

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
cluster P | KeyProviderId | Since vSphere API 6.5

P Required privilege: cluster

Return Value

Type | Description
--- | ---
xsd:string |

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

# GenerateKey

Required Privileges
  Cryptographer.ManageKeys

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
keyProvider* P | KeyProviderId | Since vSphere API 6.5

*Need not be set P Required privilege: keyProvider

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

# GenerateSelfSignedClientCert

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
cluster P | KeyProviderId | Since vSphere API 6.5

P Required privilege: cluster

Return Value

Type | Description
--- | ---
xsd:string |

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

# GetDefaultKmsCluster

Required Privileges
  Cryptographer.ManageKeyServers
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
entity* P | ManagedObjectReference to a ManagedEntity | Since vSphere API 7.0
defaultsToParent* P | xsd:boolean | Since vSphere API 7.0

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

Return Value

Type | Description
--- | ---
KeyProviderId |

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

# IsKmsClusterActive

Required Privileges
  Cryptographer.ManageKeyServers
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
cluster* P | KeyProviderId | Since vSphere API 7.0

*Need not be set P Required privilege: cluster

Return Value

Type | Description
--- | ---
xsd:boolean |

Faults

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

# ListKmipServers

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip 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
--- | ---
KmipClusterInfo[] |

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

# ListKmsClusters

Required Privileges
  Cryptographer.ManageKeyServers
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
includeKmsServers* P | xsd:boolean | Since vSphere API 7.0
managementTypeFilter* P | xsd:int | Since vSphere API 7.0
statusFilter* P | xsd:int | Since vSphere API 7.0

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

Return Value

Type | Description
--- | ---
KmipClusterInfo[] |

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

# MarkDefault

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
clusterId P | KeyProviderId | Since vSphere API 6.5

P Required privilege: clusterId

Return Value

Type | Description
--- | ---
None

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

# QueryCryptoKeyStatus

Required Privileges
  Cryptographer.ManageKeys
Since
  vSphere API 6.7.2

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
keyIds* P | CryptoKeyId[] | Since vSphere API 6.7.2
checkKeyBitMap P | xsd:int | Since vSphere API 6.7.2

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

Return Value

Type | Description
--- | ---
CryptoManagerKmipCryptoKeyStatus[] |

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

# RegisterKmipServer

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
server P | KmipServerSpec | Since vSphere API 6.5

P Required privilege: server

Return Value

Type | Description
--- | ---
None

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

# RegisterKmsCluster

Required Privileges
  Cryptographer.ManageKeyServers
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
clusterId P | KeyProviderId | Since vSphere API 7.0
managementType* P | xsd:string | Since vSphere API 7.0

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

Return Value

Type | Description
--- | ---
None

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

# RemoveKmipServer

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
clusterId P | KeyProviderId | Since vSphere API 6.5
serverName P | xsd:string | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

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

# RetrieveClientCert

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
cluster P | KeyProviderId | Since vSphere API 6.5

P Required privilege: cluster

Return Value

Type | Description
--- | ---
xsd:string |

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

# RetrieveClientCsr

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
cluster P | KeyProviderId | Since vSphere API 6.5

P Required privilege: cluster

Return Value

Type | Description
--- | ---
xsd:string |

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

# RetrieveKmipServerCert

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
keyProvider P | KeyProviderId | Since vSphere API 6.5
server P | KmipServerInfo | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
CryptoManagerKmipServerCertInfo |

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

# RetrieveKmipServersStatus_Task

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

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

*Need not be set P Required privilege: clusters

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

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

# RetrieveSelfSignedClientCert

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
cluster P | KeyProviderId | Since vSphere API 6.5

P Required privilege: cluster

Return Value

Type | Description
--- | ---
xsd:string |

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

# SetDefaultKmsCluster

Required Privileges
  Cryptographer.ManageKeyServers
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
entity* P | ManagedObjectReference to a ManagedEntity | Since vSphere API 7.0
clusterId* P | KeyProviderId | Since vSphere API 7.0

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

Return Value

Type | Description
--- | ---
None

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

# UnregisterKmsCluster

Required Privileges
  Cryptographer.ManageKeyServers
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
clusterId P | KeyProviderId | Since vSphere API 7.0

P Required privilege: clusterId

Return Value

Type | Description
--- | ---
None

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

# UpdateKmipServer

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
server P | KmipServerSpec | Since vSphere API 6.5

P Required privilege: server

Return Value

Type | Description
--- | ---
None

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

# UpdateKmsSignedCsrClientCert

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
cluster P | KeyProviderId | Since vSphere API 6.5
certificate P | xsd:string | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

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

# UpdateSelfSignedClientCert

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
cluster P | KeyProviderId | Since vSphere API 6.5
certificate P | xsd:string | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

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

# UploadClientCert

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
cluster P | KeyProviderId | Since vSphere API 6.5
certificate P | xsd:string | Since vSphere API 6.5
privateKey P | xsd:string | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

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

# UploadKmipServerCert

Required Privileges
  Cryptographer.ManageKeyServers

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call.
cluster P | KeyProviderId | Since vSphere API 6.5
certificate P | xsd:string | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

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