admin.foreignClusterSetHostTimeout

admin.foreignClusterSetHostTimeout(
   config as element(configuration),
   cluster-id as (Number|String),
   host-timeout as Number
) as element(configuration)

Summary

This function sets the timeout period (in seconds) for communication between domestic hosts and hosts in the specified foreign cluster. By default, the host timeout setting is 30 seconds.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
cluster-id The ID of the foreign cluster.
host-timeout The timeout setting (in seconds).

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.foreignClusterSetHostTimeout(cfg, fcl, 50)

   //Sets the host timeout period for the foreign cluster to 50 seconds. 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