Import Provider KMS Providers
Import provider configuration. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ManageKeyServers.
Request
URLURL
https://{api_host}/api/vcenter/crypto-manager/kms/providers?action=import
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
CryptoManagerKmsProvidersImportSpec of mimetype application/json
Required
ImportSpec needed to import a provider.
{
"config": "string",
"constraints": {
"tpm_required": false
},
"dry_run": false,
"password": "string"
}
string
config
Optional
Configuration to import. Currently this is required. Other import methods may be supported in the future.
constraints
Optional
Constraints to impose on the imported provider If unset, the imported provider constraints will match the exported provider constraints.
boolean
dry_run
Optional
Whether to perform a trial import without actuallly creating a provider. If unset, a new provider will be created.
string
password
Optional
Password to decrypt the configuration to import. If unset or empty, configuration to import must be unencrypted.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
CryptoManagerKmsProvidersImportResult
of type application/json
importResult ImportResult.
{
"constraints": {
"tpm_required": false
},
"export_time": "string",
"native_info": {
"key_id": "string"
},
"provider": "string",
"type": "NATIVE"
}
string
export_time
Required
Time when the provider was exported
string
provider
Required
Provider identifier When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.crypto_manager.kms.provider. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.crypto_manager.kms.provider.
type
Required
The Providers.Type enumerated type contains the types of providers.
NATIVE : Native provider
Possible values are: NATIVE
constraints
Optional
The constraints on the provider. If unset, there are no constraints on the provider.
native_info
Optional
Native provider information This field is optional and it is only relevant when the value of Providers.ImportResult.type is NATIVE.
Errors
400
com.vmware.vapi.std.errors.already_exists : if a provider with the same identifier already exists. | com.vmware.vapi.std.errors.invalid_argument : if the config or the password is invalid.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"config":"string","constraints":{"tpm_required":false},"dry_run":false,"password":"string"}' https://{api_host}/api/vcenter/crypto-manager/kms/providers?action=import
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: import_provider
Availability
Added in 7.0.2.0
On This Page
KMS Providers Operations
post
patch
delete
post
