admin:appserver-get-id

admin:appserver-get-id(
   $config as element(configuration),
   $group-ids as xs:unsignedLong*,
   $appserver-name as xs:string
) as xs:unsignedLong*

Summary

This function returns the ID of the specified App Server (HTTP, XDBC, or ODBC). The difference between this function and xdmp:server is that the ID from this function can come from an appserver that has not yet been saved (that is, from an appserver that has been created in the same query with the Admin library but has not yet been saved to the cluster configuration files). This ID enables you to completely configure a newly created App Server without the need to first save the configuration.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
group-ids The optional group-ids in which to restrict the appserver ids returned. If no group-id is specified, this function will return all matching appservers across all groups.
appserver-name The name of the App Server.

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()
  return
  admin:appserver-get-id($config, admin:group-get-id($config, "Default"),
         "myAppServer")

  
Powered by MarkLogic Server | Terms of Use | Privacy Policy