XQuery admin:cluster-set-external-config-encryption-key-id

MarkLogic 10 Product Documentation
admin.clusterSetExternalConfigEncryptionKeyId

admin.clusterSetExternalConfigEncryptionKeyId(
   config as element(configuration),
   external-config-encryption-key-id as String
) as element(configuration)

Summary

This function sets the encryption key ID to use for encryption of configuration files when the kms-type is external.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
external-config-encryption-key-id	An string identifying the encryption key at the KMS that should be used to encrypt configuration files. The string must be a URN representation of a UUID as defined by RFC4122: http://www.ietf.org/rfc/rfc4122.txt Example URN: 06ea22c9-b972-4652-8d0f-9e58c62e0f7f

Required Privileges

http://marklogic.com/xdmp/privileges/admin/cluster

Example

const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
return
  admin.clusterSetExternalConfigEncryptionKeyId(config, "c5c37ee231f44bbaAb8e98352f900a17")

   //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.

Example


const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration();

admin.clusterSetExternalConfigEncryptionKeyId(config, 'c5c37ee2-31f4-4bba-ab8e-98352f900a17');

// 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 10 Product Documentationadmin.clusterSetExternalConfigEncryptionKeyId

Summary

Required Privileges

Example

Example

MarkLogic 10 Product Documentation
admin.clusterSetExternalConfigEncryptionKeyId