| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
kmipServers* | KmipClusterInfo[] |
A list of registered KMIP servers, grouped by clusters.
|
Properties inherited from CryptoManager | ||
enabled |
Methods
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
cluster P | KeyProviderId |
[in] KMIP cluster.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:string | A newly generated CSR. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
keyProvider* P | KeyProviderId |
[in] Which provider will generate the key.
If omitted, will use the default key provider.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
CryptoKeyResult | The generated key. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
cluster P | KeyProviderId |
[in] KMIP cluster.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:string | A new self-signed client certificate. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
entity* P | ManagedObjectReference
to a ManagedEntity |
[in] The entity where the default KMS cluster to get.
If omitted, then return global default KMS cluster.
Since vSphere API 7.0 |
defaultsToParent* P | xsd:boolean |
[in] (Optional, default = false) If set to true,
then get the default kms cluster follow the
entity hierarchy. That means if the entity has
no default kms cluster, then try to get from
its parent.
Since vSphere API 7.0 |
Return Value
Type | Description |
---|---|
KeyProviderId | The default kms cluster of the entity, if any. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
cluster* P | KeyProviderId |
[in] KMIP cluster.
Will use default cluster if omitted.
Since vSphere API 7.0 |
Return Value
Type | Description |
---|---|
xsd:boolean | true if active KMS exists in cluster, false otherwise. |
Faults
Type | Description |
---|---|
InvalidArgument | in case the cluster is not found. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
limit* P | xsd:int |
[in] maximum clusters to return.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
KmipClusterInfo[] | List of known KMIP servers grouped in clusters. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
includeKmsServers* P | xsd:boolean |
[in] Whether to list KMS servers information
in the cluster.
By default will not include the KMS servers
information.
Since vSphere API 7.0 |
managementTypeFilter* P | xsd:int |
[in] The KMS cluster management type filter.
Bit map values:
0x01 - Return VC managed Key Providers
registered in the CryptoManager.
0x02 - Return Trusted Key Providers
registered in the CryptoManager.
0x04 - Return Trusted Key Providers which are
not registered with the CryptoManager.
others - reserved, will be ignored
If omitted or -1, then all kinds of Key Providers
will be returned.
Since vSphere API 7.0 |
statusFilter* P | xsd:int |
[in] The Key Provider status filter.
Bit map values:
0x01 - Return active Key Providers.
0x02 - Return inactive Key Providers.
others - reserved, will be ignored
If omitted or -1, then all status of Key Providers
will be returned.
Since vSphere API 7.0 |
Return Value
Type | Description |
---|---|
KmipClusterInfo[] | List of Key Providers. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
clusterId P | KeyProviderId |
[in] KMIP cluster ID to become default.
Since vSphere API 6.5 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
keyIds* P | CryptoKeyId[] |
[in] The Crypto Key Ids to query.
Since vSphere API 6.7.2 |
checkKeyBitMap P | xsd:int |
[in] The key state to check. Supported value:
0x01. check if key data is available to VC.
0x02. check the VMs which use that key.
0x04. check the hosts using this key as host key.
0x08. Check 3rd party program which use that key.
Other bits - reserved and will be igonred.
Since vSphere API 6.7.2 |
Return Value
Type | Description |
---|---|
CryptoManagerKmipCryptoKeyStatus[] | The structure combined with key status. If bit in parameter is not set when invoke, the returned data in related CryptoKeyStatus will be unknown. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
server P | KmipServerSpec |
[in] KMIP server connection information.
Since vSphere API 6.5 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
clusterId P | KeyProviderId |
[in] KMS cluster ID to register.
Since vSphere API 7.0 |
managementType* P | xsd:string |
[in] Key provider management type
See KmipClusterInfoKmsManagementType
for valid values.
By default trustAuthority.
Since vSphere API 7.0 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
clusterId P | KeyProviderId |
[in] KMIP cluster ID.
Since vSphere API 6.5 |
serverName P | xsd:string |
[in] KMIP server name.
Since vSphere API 6.5 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
cluster P | KeyProviderId |
[in] KMIP cluster.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:string | The client certificate. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
cluster P | KeyProviderId |
[in] KMIP cluster.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:string | The CSR generated previously, if any. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
keyProvider P | KeyProviderId |
[in] KMIP cluster in which the server is placed
or will be created.
Since vSphere API 6.5 |
server P | KmipServerInfo |
[in] KMIP server.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
CryptoManagerKmipServerCertInfo | Information about the server certificate. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
clusters* P | KmipClusterInfo[] |
[in] KMIP clusters and their servers.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
cluster P | KeyProviderId |
[in] KMIP cluster.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
xsd:string | The self signed certificate generated previously, if any. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
entity* P | ManagedObjectReference
to a ManagedEntity |
[in] The managed entity where the default KMS cluster to be
set. Currently the valid managed entity could be
cluster or host folder.
If omitted, then will set global default KMS cluster.
Since vSphere API 7.0 |
clusterId* P | KeyProviderId |
[in] KMS cluster ID to become default.
If omitted, then will clear the default KMS cluster
setting.
Since vSphere API 7.0 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
clusterId P | KeyProviderId |
[in] KMS cluster ID to unregister.
Since vSphere API 7.0 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
server P | KmipServerSpec |
[in] KMIP server connection information.
Since vSphere API 6.5 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
cluster P | KeyProviderId |
[in] KMIP cluster.
Since vSphere API 6.5 |
certificate P | xsd:string |
[in] Client certificate.
Since vSphere API 6.5 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
cluster P | KeyProviderId |
[in] KMIP cluster.
Since vSphere API 6.5 |
certificate P | xsd:string |
[in] Client certificate.
Since vSphere API 6.5 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
cluster P | KeyProviderId |
[in] KMIP cluster.
Since vSphere API 6.5 |
certificate P | xsd:string |
[in] Client certificate.
Since vSphere API 6.5 |
privateKey P | xsd:string |
[in] Private key.
Since vSphere API 6.5 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
cluster P | KeyProviderId |
[in] KMIP cluster.
Since vSphere API 6.5 |
certificate P | xsd:string |
[in] Server certificate in PEM encoding.
Since vSphere API 6.5 |
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 |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |