|
| 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
| Methods defined in this Managed Object |
|---|
| GenerateClientCsr, GenerateKey, GenerateSelfSignedClientCert, ListKmipServers, MarkDefault, QueryCryptoKeyStatus, RegisterKmipServer, RemoveKmipServer, RetrieveClientCert, RetrieveClientCsr, RetrieveKmipServerCert, RetrieveKmipServersStatus_Task, RetrieveSelfSignedClientCert, UpdateKmipServer, UpdateKmsSignedCsrClientCert, UpdateSelfSignedClientCert, UploadClientCert, UploadKmipServerCert |
| Methods inherited from CryptoManager |
| AddKey, AddKeys, ListKeys, RemoveKey, RemoveKeys |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the CryptoManagerKmip used to make the method call. |
| cluster | KeyProviderId |
[in] KMIP cluster.
|
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* | KeyProviderId |
[in] Which provider will generate the key.
If omitted, will use the default key provider.
|
Return Value
| Type | Description |
|---|---|
| CryptoKeyResult | The generated key. |
Faults
| Type | Description |
|---|---|
| InvalidArgument | in case of wrong keyServer |
| 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 | KeyProviderId |
[in] KMIP cluster.
|
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. |
| limit* | xsd:int |
[in] maximum clusters to return.
|
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. |
| clusterId | KeyProviderId |
[in] KMIP cluster ID to become default.
|
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| InvalidArgument | Thrown if a cluster with this ID is not registered. |
| 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* | CryptoKeyId[] |
[in] The Crypto Key Ids to query.
|
| checkKeyBitMap | 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.
|
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 | KmipServerSpec |
[in] KMIP server connection information.
|
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| InvalidArgument | in case the server is already registered, or the parameters are not valid. |
| 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 | KeyProviderId |
[in] KMIP cluster ID.
|
| serverName | xsd:string |
[in] KMIP server name.
|
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| InvalidArgument | in case the server 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. |
| cluster | KeyProviderId |
[in] KMIP cluster.
|
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 | KeyProviderId |
[in] KMIP cluster.
|
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 | KeyProviderId |
[in] KMIP cluster in which the server is placed
or will be created.
|
| server | KmipServerInfo |
[in] KMIP server.
|
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* | KmipClusterInfo[] |
[in] KMIP clusters and their servers.
|
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 | KeyProviderId |
[in] KMIP cluster.
|
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. |
| server | KmipServerSpec |
[in] KMIP server connection information.
|
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| InvalidArgument | in case the parameters are not valid, if a server with this clusterId and name is not registered |
| 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 | KeyProviderId |
[in] KMIP cluster.
|
| certificate | xsd:string |
[in] Client certificate.
|
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 | KeyProviderId |
[in] KMIP cluster.
|
| certificate | xsd:string |
[in] Client certificate.
|
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 | KeyProviderId |
[in] KMIP cluster.
|
| certificate | xsd:string |
[in] Client certificate.
|
| privateKey | xsd:string |
[in] Private key.
|
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 | KeyProviderId |
[in] KMIP cluster.
|
| certificate | xsd:string |
[in] Server certificate in PEM encoding.
|
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 |