admin.clusterSetName

admin.clusterSetName(
   config as element(configuration),
   name as String
) as element(configuration)

Summary

This function sets the name for this cluster.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
name The name to be assigned to this cluster. Name will be cast to the xs:token type.

Required Privileges

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const cfg = admin.getConfiguration()
  admin.clusterSetName(cfg, "replica")

   //Assigns 'replica' as the name of this cluster. Use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration to other
   //Admin API functions to make other changes. 
    
Powered by MarkLogic Server | Terms of Use | Privacy Policy