MarkLogic 10 Product Documentationadmin.clusterSetKeystoreKmsType
admin.clusterSetKeystoreKmsType( config as element(configuration), kms-type as String ) as element(configuration)
Summary
This function sets the type of Keystore Management System (KMS) to be used.
By default it is set to internal KMS, if configuring an external KMS,
a KSM host name and port number must also be set.
See
admin.clusterSetKeystoreHostName
, and
admin.clusterClusterSetKeystorePort
| Parameters | |
|---|---|
| config | A configuration specification, typically as returned from one of the Admin module functions. |
| kms-type |
Specifies the type of the KMS
valid values are: internal, and external
|
Example
const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration();
admin.clusterSetKeystoreKmsType(config, 'external');
// Returns the new configuration element -- use admin:save-configuration to save
// the changes to the configuration or pass the configuration to other Admin API
// functions to make other changes.