Loading TOC...

MarkLogic Server 11.0 Product Documentation
admin.appserverAddRequestBlackout

admin.appserverAddRequestBlackout(
   config as element(configuration),
   appserver-id as (Number|String),
   request-blackouts as element(gr.requestBlackout)[]
) as element(configuration)

Summary

This function adds a request blackout specification for a appserver to a configuration.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
appserver-id The ID of the appserver (for example, xdmp.server("myAppserver")).
request-blackouts The request blackout specification(s), typically the result of an admin:appserverOneTimeRequestBlackout or an admin:appserverRecurringRequestBlackout call

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/app-server

http://marklogic.com/xdmp/privileges/admin/app-server/{id}

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

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const appId = xdmp.server("myAppserver")
  const requestspec = admin.appserverOneTimeRequestBlackout(null,null,
        xs.dateTime("2008-02-14T09:45:00"),
        null, xs.dayTimeDuration("PT3H") )
  admin.appserverAddRequestBlackout(config, appId, requestspec)

   //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.  
  

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.