MarkLogic 9 Product Documentation
admin.forestAddFailoverHost

admin.forestAddFailoverHost(
   config as element(configuration),
   forest-id as (Number|String),
   hosts as (Number|String)[]
) as element(configuration)

Summary

This function adds a failover host to the list of failover hosts for the specified forest in the specified configuration. If there are already any hosts specified, this host is added to the end of the list of failover hosts.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
forest-id	The ID of the forest. For example, `xdmp:forest("myForest")` specifies the ID for a forest named "myForest".
hosts	The host ID(s) for the host(s) you want to restart. For example, `xdmp:host()` returns the ID for the current host.

Required Privileges

This operation requires at least one of the following privileges:

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

http://marklogic.com/xdmp/privileges/admin/database/{id}

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

http://marklogic.com/xdmp/privileges/admin/forest/{id}

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  admin.forestAddFailoverHost(config,
      admin.forestGetId(config, "Documents"),
      xdmp.host("myFailoverHost"))
      => add the failover host "myFailoverHost" to the end of the
         list of failover hosts. Use admin.saveConfiguration to save the changes
         to the configuration or pass the configuration to other Admin API
         functions to make other changes.

MarkLogic 9 Product Documentationadmin.forestAddFailoverHost

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin.forestAddFailoverHost