admin.hostGetMode

admin.hostGetMode(
   config as element(configuration),
   host-id as (Number|String)
) as String

Summary

This function return the mode 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.

Required Privileges

This operation requires at least one of the following privileges:

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

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

Example

const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
  admin.hostGetMode(config, admin.hostGetId(config, xdmp.hostName()))

   //returns the mode for the host, either normal or maintenance