MarkLogic Server 11.0 Product Documentation
admin:appserver-set-root

admin:appserver-set-root(
   $config as element(configuration),
   $appserver-id as xs:unsignedLong,
   $value as xs: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:appserver-get-id` 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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
		  at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $groupid := admin:group-get-id($config, "Default")
  return
  admin:appserver-set-root($config,
         admin:appserver-get-id($config, $groupid, "myAppServer"),
         "myNewRoot")

  (: 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.  :)

MarkLogic Server 11.0 Product Documentationadmin:appserver-set-root

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin:appserver-set-root