MarkLogic 9 Product Documentation
admin.hostSetMode

admin.hostSetMode(
   config as element(configuration),
   host-id as (Number|String),
   mode as String,
   description as String?
) as element(configuration)

Summary

This function sets the mode and description for the host with the specified ID

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
host-id	The host ID. Typically, the result of an `admin:host-get-id` call.
mode	New mode for the host. Valid values are `normal` or `maintenance`.
description	A description of the reason for the new mode.

Example


  const admin = require('/MarkLogic/admin.xqy');
var config = admin.getConfiguration()
  admin.hostSetMode(config, admin.hostGetId(config, xdmp.hostName()),
    "maintenance", "Adding disk space to forest A")

   //returns the new configuration element -- 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.hostSetMode

Summary

Example

MarkLogic 9 Product Documentation
admin.hostSetMode