MarkLogic 12 Product Documentation
admin.foreignClusterSetName

admin.foreignClusterSetName(
   config as element(configuration),
   cluster-id as (Number|String),
   cluster-name as String
) as element(configuration)

Summary

This function sets the name of a foreign cluster.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
cluster-id	The ID of the foreign cluster.
cluster-name	The name to be set for the foreign 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()
  const fcl = admin.clusterGetForeignClusterId(cfg, "ClusterA")
  admin.foreignClusterSetName(cfg, fcl, "replca")

   //Sets the name of the 'ClusterA' foreign cluster to 'replica'.//Use
   //admin.saveConfiguration to save the changes to the configuration or
   //pass the configuration to other Admin API functions to make other changes.

MarkLogic 12 Product Documentationadmin.foreignClusterSetName

Summary

Required Privileges

Example

MarkLogic 12 Product Documentation
admin.foreignClusterSetName