XQuery admin:cluster-set-keystore-backup-option

MarkLogic Server 11.0 Product Documentation
admin.clusterSetKeystoreBackupOption

admin.clusterSetKeystoreBackupOption(
   config as element(configuration),
   backup-option as xs.NMTOKEN
) as element(configuration)

Summary

This function is used to set the backup option for the embedded PKCS#11 wallet.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
backup-option	The backup option to use. Valid values are: `include` and `exclude` By default the embedded KMS (PKCS#11 wallet) is automatically included in backups. Setting the option to `exclude` will prevent the embedded KMS from being included in the backups.

Example

const admin = require('/MarkLogic/admin.xqy');
const option = "exclude"
const config = admin.getConfiguration()
  admin.clusterSetKeystoreBackupOption(config,option)

   //returns the new configuration element -- use admin.saveConfiguration to save
//the changes to the configuration or pass the configuration to other Admin API
//functions to make other changes.

MarkLogic Server 11.0 Product Documentationadmin.clusterSetKeystoreBackupOption

Summary

Example

MarkLogic Server 11.0 Product Documentation
admin.clusterSetKeystoreBackupOption