JavaScript admin.appserverGetModuleLocations

MarkLogic 10 Product Documentation
admin:appserver-get-module-locations

admin:appserver-get-module-locations(
   $config as element(configuration),
   $appserver-id as xs:unsignedLong
) as element(gr:module-location)*

Summary

This function returns the value of any module locations predefined for the specified App Server. If none are defined, returns the empty sequence.

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.

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}

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 $appserver-id :=
  admin:appserver-get-id($config,
    admin:group-get-id($config, "Default"), "my-appserver-name")
return
admin:appserver-get-module-locations($config, $appserver-id)
(: returns the location(s), if any, for the specified App Server :)

MarkLogic 10 Product Documentationadmin:appserver-get-module-locations

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:appserver-get-module-locations