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

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
cluster PKeyProviderId

Since vSphere API 6.5
P Required privilege: cluster

Return Value

Type Description
xsd:string

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



GenerateKey

Required Privileges
Cryptographer.ManageKeys

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
keyProvider* PKeyProviderId

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

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



GenerateSelfSignedClientCert

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
cluster PKeyProviderId

Since vSphere API 6.5
P Required privilege: cluster

Return Value

Type Description
xsd:string

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



GetDefaultKmsCluster

Required Privileges
Cryptographer.ManageKeyServers
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
entity* PManagedObjectReference
to a ManagedEntity

Since vSphere API 7.0
defaultsToParent* Pxsd:boolean

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

Return Value

Type Description
KeyProviderId

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



IsKmsClusterActive

Required Privileges
Cryptographer.ManageKeyServers
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
cluster* PKeyProviderId

Since vSphere API 7.0
*Need not be set P Required privilege: cluster

Return Value

Type Description
xsd:boolean

Faults

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



ListKmipServers

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip 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
KmipClusterInfo[]

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



ListKmsClusters

Required Privileges
Cryptographer.ManageKeyServers
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
includeKmsServers* Pxsd:boolean

Since vSphere API 7.0
managementTypeFilter* Pxsd:int

Since vSphere API 7.0
statusFilter* Pxsd:int

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

Return Value

Type Description
KmipClusterInfo[]

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



MarkDefault

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
clusterId PKeyProviderId

Since vSphere API 6.5
P Required privilege: clusterId

Return Value

Type Description
None

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



QueryCryptoKeyStatus

Required Privileges
Cryptographer.ManageKeys
Since
vSphere API 6.7.2

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
keyIds* PCryptoKeyId[]

Since vSphere API 6.7.2
checkKeyBitMap Pxsd:int

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

Return Value

Type Description
CryptoManagerKmipCryptoKeyStatus[]

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



RegisterKmipServer

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
server PKmipServerSpec

Since vSphere API 6.5
P Required privilege: server

Return Value

Type Description
None

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



RegisterKmsCluster

Required Privileges
Cryptographer.ManageKeyServers
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
clusterId PKeyProviderId

Since vSphere API 7.0
managementType* Pxsd:string

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

Return Value

Type Description
None

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



RemoveKmipServer

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
clusterId PKeyProviderId

Since vSphere API 6.5
serverName Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
None

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



RetrieveClientCert

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
cluster PKeyProviderId

Since vSphere API 6.5
P Required privilege: cluster

Return Value

Type Description
xsd:string

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



RetrieveClientCsr

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
cluster PKeyProviderId

Since vSphere API 6.5
P Required privilege: cluster

Return Value

Type Description
xsd:string

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



RetrieveKmipServerCert

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
keyProvider PKeyProviderId

Since vSphere API 6.5
server PKmipServerInfo

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
CryptoManagerKmipServerCertInfo

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



RetrieveKmipServersStatus_Task

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
clusters* PKmipClusterInfo[]

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

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



RetrieveSelfSignedClientCert

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
cluster PKeyProviderId

Since vSphere API 6.5
P Required privilege: cluster

Return Value

Type Description
xsd:string

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



SetDefaultKmsCluster

Required Privileges
Cryptographer.ManageKeyServers
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
entity* PManagedObjectReference
to a ManagedEntity

Since vSphere API 7.0
clusterId* PKeyProviderId

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

Return Value

Type Description
None

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



UnregisterKmsCluster

Required Privileges
Cryptographer.ManageKeyServers
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
clusterId PKeyProviderId

Since vSphere API 7.0
P Required privilege: clusterId

Return Value

Type Description
None

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



UpdateKmipServer

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
server PKmipServerSpec

Since vSphere API 6.5
P Required privilege: server

Return Value

Type Description
None

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



UpdateKmsSignedCsrClientCert

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
cluster PKeyProviderId

Since vSphere API 6.5
certificate Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
None

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



UpdateSelfSignedClientCert

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
cluster PKeyProviderId

Since vSphere API 6.5
certificate Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
None

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



UploadClientCert

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
cluster PKeyProviderId

Since vSphere API 6.5
certificate Pxsd:string

Since vSphere API 6.5
privateKey Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
None

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



UploadKmipServerCert

Required Privileges
Cryptographer.ManageKeyServers

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CryptoManagerKmip used to make the method call.
cluster PKeyProviderId

Since vSphere API 6.5
certificate Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
None

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