MarkLogic Server 11.0 Product Documentation
admin.appserverSetRoot

admin.appserverSetRoot(
   config as element(configuration),
   appserver-id as (Number|String),
   value as String
) as element(configuration)

Summary

This function changes the root for a specified App Server to the newly specified value.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
appserver-id	The ID of the App Server. Typically, this is the result of an `admin.appserverGetId` call.
value	The new value for the root. The root must be either a fully qualified path (for example, `/space/myRoot` or `c:/space/myRoot`) or a relative path (for example, `myRoot`); relative paths are resolved relative to the directory in which MarkLogic Server is installed.

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 groupid = admin.groupGetId(config, "Default")
  admin.appserverSetRoot(config,
         admin.appserverGetId(config, groupid, "myAppServer"),
         "myNewRoot")

   //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 Server 11.0 Product Documentationadmin.appserverSetRoot

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.appserverSetRoot