XQuery admin:forest-delete-failover-host

MarkLogic 12 Product Documentation
admin.forestDeleteFailoverHost

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

Summary

This function deletes the specified failover host(s) from the failover-host list in the specified configuration.

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 delete. 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');
  const config = admin.getConfiguration()
  admin.forestDeleteFailoverHost(config,
      admin.forestGetId(config, "Documents"),
      xdmp.host("myFailoverHost"))
      => deletes the failover host "myFailoverHost" from 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 12 Product Documentationadmin.forestDeleteFailoverHost

Summary

Required Privileges

Example

MarkLogic 12 Product Documentation
admin.forestDeleteFailoverHost