admin.foreignClusterDelete

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

Summary

This function deletes the configuration for the specified 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.

Required Privileges

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  var cfg = admin.getConfiguration()
  var fcl = admin.clusterGetForeignClusterId(cfg, "ClusterA")
  admin.foreignClusterDelete(cfg, fcl)

   //Deletes the configuration for the specified foreign cluster.//Use
   //admin.saveConfiguration to save the changes to the configuration
   //or pass the configuration to other Admin API functions to make
   //other changes.