admin:host-set-mode

admin:host-set-mode(
   $config as element(configuration),
   $host-id as xs:unsignedLong,
   $mode as xs:string,
   $description as xs: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


xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
       at "/MarkLogic/admin.xqy";

let $config := admin:get-configuration()
return
  admin:host-set-mode($config, admin:host-get-id($config, xdmp:host-name()),
    "maintenance", "Adding disk space to forest A")

  (: returns the new configuration element -- use admin:save-configuration to save
  the changes to the configuration or pass the configuration to other Admin API
  functions to make other changes.  :)