JavaScript admin.foreignClusterSetHostTimeout

admin:foreign-cluster-set-host-timeout

admin:foreign-cluster-set-host-timeout(
   $config as element(configuration),
   $cluster-id as xs:unsignedLong,
   $host-timeout as xs:unsignedInt
) 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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $cfg := admin:get-configuration()
  let $fcl := admin:cluster-get-foreign-cluster-id($cfg, "ClusterA")

  return  admin:foreign-cluster-set-host-timeout($cfg, $fcl, 50)

  (: Sets the host timeout period for the foreign cluster to 50 seconds. Use
     admin:save-configuration to save the changes to the configuration or pass
     the configuration to other Admin API functions to make other changes. :)