JavaScript admin.clusterSetKeystoreBackupOption

MarkLogic 10 Product Documentation
admin:cluster-set-keystore-backup-option

admin:cluster-set-keystore-backup-option(
   $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


xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin" at "/MarkLogic/admin.xqy";

let $option := "exclude"
let $config := admin:get-configuration()
return
  admin:cluster-set-keystore-backup-option($config,$option)

  (: 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. :)

MarkLogic 10 Product Documentationadmin:cluster-set-keystore-backup-option

Summary

Example

MarkLogic 10 Product Documentation
admin:cluster-set-keystore-backup-option