This page was generated
January  28,  2016
4:06  AM
XQuery & XSLT Built-In & Modules Function Reference

Module: Admin Library - Group Functions

Function Summary
admin:get-group-ids This function returns all the group IDs from the configuration.
admin:group-add-module-location Add one or more module namespace to location mappings to a Group configuration.
admin:group-add-namespace Add one or more namespaces to a Group configuration, which will predefine the namespace(s) for all requests evaluated against any App Server in the Group.
admin:group-add-schema This function adds a schema binding definition to the existing schema binding definitions in the configuration for the specified Group.
admin:group-add-trace-event This function adds trace events to the configuration.
admin:group-add-using-namespace Add one or more "using" namespaces to a Group configuration, which add the namespaces to the namespace path for all requests evaluated against any App Server in the Group.
admin:group-copy This function creates a new group specification with the same settings as the group with the specified ID.
admin:group-create This function creates a new group with the specified name in the configuration.
admin:group-delete This function deletes one or more groups in the configuration.
admin:group-delete-module-location Delete one or more module location bindings from a Group configuration.
admin:group-delete-namespace This function deletes the specified namespaces from the configuration for the specified group.
admin:group-delete-schema This function deletes a schema binding definition to the existing schema binding definitions in the configuration for the specified Group.
admin:group-delete-trace-event This function deletes the specified trace events from the configuration.
admin:group-delete-using-namespace Delete one or more "using" namespaces from a Group configuration.
admin:group-disable-audit-event-type This function changes the audit event type(s) enabled setting for the audit configuration.
admin:group-enable-audit-event-type This function changes the audit event type(s) enabled setting for the audit configuration.
admin:group-exists This function determines whether or not the specified Group exists.
admin:group-get-appserver-ids This function returns the IDs of all appservers belonging to the group.
admin:group-get-audit-enabled This function returns the value for the audit enabled setting from the specified group.
admin:group-get-audit-event-type-enabled This function returns the audit event type's enabled setting for the audit configuration.
admin:group-get-audit-excluded-roles This function returns the roles excluded from auditing.
admin:group-get-audit-excluded-uris This function returns the uris excluded from auditing.
admin:group-get-audit-excluded-users This function returns the users excluded from auditing.
admin:group-get-audit-included-roles This function returns the roles included from auditing.
admin:group-get-audit-included-uris This function returns the uris included from auditing.
admin:group-get-audit-included-users This function returns the users included from auditing.
admin:group-get-audit-outcome-restriction This function returns whether auditing events are restricted by a success or failure outcome.
admin:group-get-background-io-limit This function gets the value for the I/O background limit that controls the I/O resoources that I/O tasks (for example, merges) will consume.
admin:group-get-compressed-tree-cache-partitions This function returns the value for the compressed tree cache partitions setting from the specified group.
admin:group-get-compressed-tree-cache-size This function returns the value for the compressed tree cache size setting from the specified group.
admin:group-get-compressed-tree-read-size This function returns the value for the compressed tree read size (in kilobytes) setting from the specified group.
admin:group-get-expanded-tree-cache-partitions This function returns the value for the expanded tree cache partitions setting from the specified group.
admin:group-get-expanded-tree-cache-size This function returns the value for the expanded tree cache size setting from the specified group.
admin:group-get-failover-enable This function returns the value for the failover enable setting from the specified group.
admin:group-get-file-log-level This function returns the value for the file log level setting from the specified group.
admin:group-get-host-ids This function returns the IDs of all hosts belonging to the group.
admin:group-get-host-initial-timeout This function returns the value for the host initial timeout setting from the specified group.
admin:group-get-host-timeout This function returns the value for the host timeout setting from the specified group.
admin:group-get-http-timeout This function returns the value for the http timeout setting from the specified group.
admin:group-get-http-user-agent This function returns the value for the http user agent setting from the specified group.
admin:group-get-httpserver-ids This function returns the IDs of all httpservers belonging to the group.
admin:group-get-id This function returns the ID of the group.
admin:group-get-keep-audit-files This function returns the value for the keep audit files setting from the specified group.
admin:group-get-keep-log-files This function returns the value for the keep log files setting from the specified group.
admin:group-get-list-cache-partitions This function returns the value for the list cache partitions setting from the specified group.
admin:group-get-list-cache-size This function returns the value for the list cache size setting from the specified group.
admin:group-get-metering-enabled This function returns the value of the metering-enabled group setting.
admin:group-get-meters-database This function returns the ID of the meters-database configured for the specified group.
admin:group-get-module-cache-timeout This function returns the number of seconds a module can be unused before being flushed from caches.
admin:group-get-module-locations This function returns the value of any module locations predefined for the specified Group.
admin:group-get-name This function returns the name of the specified group.
admin:group-get-namespaces This function returns the value of any namespace definitions predefined for the specified group.
admin:group-get-odbcserver-ids This function returns the ids of all of the ODBC App Servers in the specified group.
admin:group-get-performance-metering-enabled This function returns the value of the performance-metering-enabled group setting.
admin:group-get-performance-metering-period This function returns the value of the performance-metering-period group setting.
admin:group-get-performance-metering-retain-daily This function returns the value of the performance-metering-retain-daily group setting.
admin:group-get-performance-metering-retain-hourly This function returns the value of the performance-metering-retain-hourly group setting.
admin:group-get-performance-metering-retain-raw This function returns the value of the performance-metering-retain-raw group setting.
admin:group-get-retry-timeout This function returns the value for the number of seconds a request will retry before timing out.
admin:group-get-rotate-audit-files This function returns the value for the rotate audit files setting from the specified group.
admin:group-get-rotate-log-files This function returns the value for the rotate log files setting from the specified group.
admin:group-get-s3-domain This function gets the simple storage service internet domain name for hosts in the group.
admin:group-get-s3-protocol This function gets the simple storage service protocol for hosts in the group.
admin:group-get-s3-server-side-encryption This function gets the method of server side encryption for data at rest on the simple storage service.
admin:group-get-schemas This function returns the value of any schemas definitions predefined for the specified group.
admin:group-get-security-database This function returns the ID of the security database for the specified group from the configuration.
admin:group-get-smtp-relay This function returns the value for the smtp relay setting from the specified group.
admin:group-get-smtp-timeout This function returns the value for the smtp timeout setting from the specified group.
admin:group-get-system-log-level This function returns the value for the system log level setting from the specified group.
admin:group-get-taskserver-id This function returns the ID of of the taskserver belonging to the group.
admin:group-get-trace-events This function returns the value of any trace events activated for the specified group.
admin:group-get-trace-events-activated This function returns the value for the trace events activated setting from the specified group.
admin:group-get-triple-cache-partitions This function returns the number of triple cache partitions configured for the group.
admin:group-get-triple-cache-size This function returns the value of the triple cache size for the group.
admin:group-get-triple-cache-timeout This function gets the timeout value for the triple cache.
admin:group-get-triple-value-cache-partitions This function returns the number of triple value cache partitions configured for the group.
admin:group-get-triple-value-cache-size This function returns the size of triple value cache configured for the group.
admin:group-get-triple-value-cache-timeout This function gets the timeout value for the triple value cache.
admin:group-get-using-namespaces This function returns the value of any "using" namespaces predefined for the specified Group.
admin:group-get-webdavserver-ids This function returns the IDs of all webdavservers belonging to the group.
admin:group-get-xdbcserver-ids This function returns the IDs of all xdbcservers belonging to the group.
admin:group-get-xdqp-ssl-allow-sslv3 This function returns true if the SSL v3 protocol is enabled for the group.
admin:group-get-xdqp-ssl-allow-tls This function returns true if the TLS protocol is enabled for the group.
admin:group-get-xdqp-ssl-ciphers This function returns the SSL ciphers set for the group.
admin:group-get-xdqp-ssl-enabled This function returns true if SSL is enabled for the group.
admin:group-get-xdqp-timeout This function returns the value for the xdqp timeout setting from the specified group.
admin:group-module-location This function constructs a module namespace element with the specified namespace URI and location.
admin:group-namespace This function constructs a namespace element with the specified prefix and URI.
admin:group-schema This function constructs a schema element with the specified prefix and URI.
admin:group-set-audit-enabled This function changes the audit enabled setting for the group in the configuration.
admin:group-set-audit-outcome-restriction This function restricts the audit configuration by auditing events only if they are "success" or "failure" events.
admin:group-set-audit-role-restriction This function restricts the audit configuration by excluding or including by role.
admin:group-set-audit-uri-restriction This function restricts the audit configuration by excluding or including by document uri(s).
admin:group-set-audit-user-restriction This function restricts the audit configuration by excluding or including by user.
admin:group-set-background-io-limit This function sets a limit on the amount of I/O that background tasks (for example, merges) will consume.
admin:group-set-compressed-tree-cache-partitions This function changes the compressed tree cache partitions setting of the group with the specified ID to the specified value.
admin:group-set-compressed-tree-cache-size This function changes the compressed tree cache size setting of the group with the specified ID to the specified value.
admin:group-set-compressed-tree-read-size This function changes the compressed tree read size setting of the group with the specified ID to the specified value.
admin:group-set-expanded-tree-cache-partitions This function changes the expanded tree cache partitions setting of the group with the specified ID to the specified value.
admin:group-set-expanded-tree-cache-size This function changes the expanded tree cache size setting of the group with the specified ID to the specified value.
admin:group-set-failover-enable This function changes the failover enable setting for the group in the configuration.
admin:group-set-file-log-level This function changes the host file log level setting for the group in the configuration.
admin:group-set-host-initial-timeout This function changes the host initial timeout setting (the time the cluster will wait for a host to come online during cluster startup) for the group in the configuration.
admin:group-set-host-timeout This function changes the host timeout setting (the timeout for communication between hosts) for the group in the configuration.
admin:group-set-http-timeout This function changes the HTTP timeout setting for the group in the configuration.
admin:group-set-http-user-agent This function changes the HTTP User-Agent setting for the group in the configuration.
admin:group-set-keep-audit-files This function changes the keep audit files setting for the group in the configuration.
admin:group-set-keep-log-files This function changes the keep log files setting for the group in the configuration.
admin:group-set-list-cache-partitions This function changes the list cache partitions setting of the group with the specified ID to the specified value.
admin:group-set-list-cache-size This function changes the list cache size setting of the group with the specified ID to the specified value.
admin:group-set-metering-enabled This function enables or disables usage metering for all hosts in the specified group.
admin:group-set-meters-database This function specifies the database to be used to store metering data.
admin:group-set-module-cache-timeout This function sets the number of seconds a module can be unused before being flushed from caches.
admin:group-set-name This function changes the name of the group with the specified ID to the specified name.
admin:group-set-performance-metering-enabled This function enables or disables performance metering for all hosts in the specified group.
admin:group-set-performance-metering-period This function sets the period (in number of seconds) between when performance data is gathered.
admin:group-set-performance-metering-retain-daily This function sets the number of days of performance metering data to retain.
admin:group-set-performance-metering-retain-hourly This function sets the number of days to retain hourly performance data.
admin:group-set-performance-metering-retain-raw This function sets the number of days of raw performance data to retain.
admin:group-set-retry-timeout This function changes the number of seconds a request will retry before timing out.
admin:group-set-rotate-audit-files This function changes the rotate audit files setting for the group in the configuration.
admin:group-set-rotate-log-files This function changes the rotate log files setting for the group in the configuration.
admin:group-set-s3-domain This function sets the simple storage service internet domain name for hosts in the group.
admin:group-set-s3-protocol This function sets the simple storage service protocol for hosts in the group.
admin:group-set-s3-server-side-encryption This function gets the method of server side encryption for data at rest on the simple storage service.
admin:group-set-security-database This function sets the security database for a group to the specified database in the configuration.
admin:group-set-smtp-relay This function changes the SMTP relay setting for the group in the configuration.
admin:group-set-smtp-timeout This function changes the SMTP timeout setting for the group in the configuration.
admin:group-set-system-log-level This function changes the host system log level setting for the group in the configuration.
admin:group-set-trace-events-activated This function changes the value for trace events in the group configuration.
admin:group-set-triple-cache-partitions This function sets the number of partitions to allocate for the triple index cache.
admin:group-set-triple-cache-size This function sets the number of triple cache partitions to allocate.
admin:group-set-triple-cache-timeout This function sets the timeout value for the triple cache.
admin:group-set-triple-value-cache-partitions This function sets the number of partitons to allocate for the triple value index cache.
admin:group-set-triple-value-cache-size This function sets the size of the value cache for the triple index.
admin:group-set-triple-value-cache-timeout This function sets the timeout value for the triple value cache.
admin:group-set-xdqp-ssl-allow-sslv3 This function enables or disables the SSL v3 protocol for the specified group.
admin:group-set-xdqp-ssl-allow-tls This function enables or disables the TLS protocol for the specified group.
admin:group-set-xdqp-ssl-ciphers This function sets SSL ciphers for the specified group.
admin:group-set-xdqp-ssl-enabled This function enables or disables SSL for the group.
admin:group-set-xdqp-timeout This function changes the XDQP timeout setting (the timeout for communication between data nodes and evaluator nodes) for the group in the configuration.
admin:group-trace-event This function constructs an event element for the specified event name.
admin:group-using-namespace This function constructs a using namespace element with the specified URI.
Function Detail
admin:get-group-ids(
$config as element(configuration)
)  as   xs:unsignedLong*
Summary:

This function returns all the group IDs from the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.

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:get-group-ids($config)
  (: returns the IDs of all the groups :)
  

admin:group-add-module-location(
$config as element(configuration),
$group-id as xs:unsignedLong,
$module-locations as element(gr:module-location)*
)  as   element(configuration)
Summary:

Add one or more module namespace to location mappings to a Group configuration. The mappings are used to look up a location for an XQuery library module for any request on any App Server in that group when the library module is requested using only the module namespace URI.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$module-locations : A sequence of module location mapping element. Typically these are the result of calls to admin:group-module-location.

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 $group-id := admin:group-get-id($config, "my-group")
return
admin:group-add-module-location($config, $group-id,
     admin:group-module-location("my-namespace", "/my/location/module.xqy"))
  (: 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.  :)  
    

admin:group-add-namespace(
$config as element(configuration),
$group-id as xs:unsignedLong,
$namespaces as element(gr:namespace)*
)  as   element(configuration)
Summary:

Add one or more namespaces to a Group configuration, which will predefine the namespace(s) for all requests evaluated against any App Server in the Group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$namespaces : A list of namespaces to add. Typically the result of an admin:group-namespace call.

Each namespace specification has the following form:
  <namespace xmlns="http://marklogic.com/xdmp/group">
    <prefix>myprefix</prefix>
    <namespace-uri>http://myuri/forthisprefix</namespace-uri>		    
  </namespace>
	 

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:group-add-namespace($config, $groupid,
       <namespace xmlns="http://marklogic.com/xdmp/group">
         <prefix>myprefix</prefix>
         <namespace-uri>http://myuri/forthisprefix</namespace-uri>		    
        </namespace>)
  (: 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.  :)  
  

admin:group-add-schema(
$config as element(configuration),
$group-id as xs:unsignedLong,
$schemas as element(gr:schema)*
)  as   element(configuration)
Summary:

This function adds a schema binding definition to the existing schema binding definitions in the configuration for the specified Group. Schemas with a schema binding definition are automatically imported into queries run against any App Server in the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$schemas : A list of schema specification elements of the form:
<schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        xmlns="http://marklogic.com/xdmp/group">
  <namespace-uri>foo</namespace-uri>
  <schema-location>/foo.xsd</schema-location>
</schema>
Typically the result of an admin:group-schema call.

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:group-add-schema($config, $groupid, 
  <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        xmlns="http://marklogic.com/xdmp/group">
     <namespace-uri>foo</namespace-uri>
     <schema-location>/foo.xsd</schema-location>
  </schema>)
  (: 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.  :)
  

admin:group-add-trace-event(
$config as element(configuration),
$group-id as xs:unsignedLong,
$events as element(gr:event)*
)  as   element(configuration)
Summary:

This function adds trace events to the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$events : Zero or more event specifications, which you can construct with the admin:group-trace-event function.

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:group-add-trace-event($config, 
      admin:group-get-id($config, "Default"), 
      admin:group-trace-event("CPF on-state-enter"))
  (: 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.  :)  
  

admin:group-add-using-namespace(
$config as element(configuration),
$group-id as xs:unsignedLong,
$namespaces as element(gr:using-namespace)*
)  as   element(configuration)
Summary:

Add one or more "using" namespaces to a Group configuration, which add the namespaces to the namespace path for all requests evaluated against any App Server in the Group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$namespaces : A sequence of using namespace elements. Typically these are the result of calls to admin:group-using-namespace().

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 $group := admin:group-get-id($config, "Default")
let $ns := admin:group-using-namespace("my.namespace")
return admin:group-add-using-namespace($config, $group, $ns)
 (: 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.  :)  
    

admin:group-copy(
$config as element(configuration),
$group-id as xs:unsignedLong,
$group-name as xs:string
)  as   element(configuration)
Summary:

This function creates a new group specification with the same settings as the group with the specified ID. The new group configuration will have the specified name.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$group-name : The name of the new group to create.

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:group-copy($config, admin:group-get-id($config, "myOldGroup"), 
                    "myNewGroup")

  (: 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.  :) 
  

admin:group-create(
$config as element(configuration),
$group-name as xs:string
)  as   element(configuration)
Summary:

This function creates a new group with the specified name in the configuration. The new group has the default values.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-name : The name for the new group.

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:group-create($config, "myNewGroup")
  (: 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.  :)  
  

admin:group-delete(
$config as element(configuration),
$group-ids as xs:unsignedLong*
)  as   element(configuration)
Summary:

This function deletes one or more groups in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-ids : The IDs of the groups to be deleted. Typically, this is the result of an admin:group-get-id call.

Usage Notes:

Any group whose ID you pass into this function must not have any hosts belonging to it when the transaction begins, otherwise an exception is thrown. If you need to delete the group, remove its hosts in a separate transaction before calling this function.

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:group-delete($config, admin:group-get-id($config, "myOldGroup"))
  (: 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.  :)  
  

admin:group-delete-module-location(
$config as element(configuration),
$group-id as xs:unsignedLong,
$module-locations as element(gr:module-location)*
)  as   element(configuration)
Summary:

Delete one or more module location bindings from a Group configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$module-locations : A sequence of module location mapping element. Typically these are the result of calls to admin:group-module-location.

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 $group-id := admin:group-get-id($config, "my-group")
return
admin:group-delete-module-location($config, $group-id,
     admin:group-module-location("my-namespace", "/my/location/module.xqy"))
  (: 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.  :)  
    

admin:group-delete-namespace(
$config as element(configuration),
$group-id as xs:unsignedLong,
$namespaces as element(gr:namespace)*
)  as   element(configuration)
Summary:

This function deletes the specified namespaces from the configuration for the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$namespaces :

A list of namespaces to delete. Each namespace specification has the following form:

  <namespace xmlns="http://marklogic.com/xdmp/group">
    <prefix>myprefix</prefix>
    <namespace-uri>http://myuri/forthisprefix</namespace-uri>		    
  </namespace>
	 
Typically the result of an admin:group-namespace call.

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:group-delete-namespace($config, $groupid, 
        admin:group-get-namespaces($config, $groupid))

  (: 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.  :)  
  

admin:group-delete-schema(
$config as element(configuration),
$group-id as xs:unsignedLong,
$schemas as element(gr:schema)*
)  as   element(configuration)
Summary:

This function deletes a schema binding definition to the existing schema binding definitions in the configuration for the specified Group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$schemas : A list of schema specification elements of the form:
<schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        xmlns="http://marklogic.com/xdmp/group">
  <namespace-uri>foo</namespace-uri>
  <schema-location>/foo.xsd</schema-location>
</schema>
Typically the result of an admin:group-schema call.

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:group-delete-schema($config, $groupid, 
  <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        xmlns="http://marklogic.com/xdmp/group">
     <namespace-uri>foo</namespace-uri>
     <schema-location>/foo.xsd</schema-location>
  </schema>)
  (: 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.  :)
  

admin:group-delete-trace-event(
$config as element(configuration),
$group-id as xs:unsignedLong,
$events as element(gr:event)*
)  as   element(configuration)
Summary:

This function deletes the specified trace events from the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$events : Zero or more event specifications, which you can construct with the admin:group-trace-event function.

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:group-delete-trace-event($config, 
      admin:group-get-id($config, "Default"), 
      admin:group-trace-event("CPF on-state-enter"))
  (: 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.  :)  
  

admin:group-delete-using-namespace(
$config as element(configuration),
$group-id as xs:unsignedLong,
$namespaces as element(gr:using-namespace)*
)  as   element(configuration)
Summary:

Delete one or more "using" namespaces from a Group configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$namespaces : A sequence of using namespace elements. Typically these are the result of calls to admin:group-using-namespace().

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 $group := admin:group-get-id($config, "Default")
let $ns := admin:group-using-namespace("my.namespace")
return admin:group-delete-using-namespace($config, $group, $ns)
 (: 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.  :)  
 
    

admin:group-disable-audit-event-type(
$config as element(configuration),
$group-id as xs:unsignedLong,
$event-type as xs:string*
)  as   element(configuration)
Summary:

This function changes the audit event type(s) enabled setting for the audit configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$event-type : The event types to disable (must be one of: "amp-usage" "audit-configuration-change" "audit-shutdown" "audit-startup" "authentication-failure" "concurrent-request-denial" "configuration-change" "document-execute" "document-insert" "document-read" "document-update" "estimate" "eval" "exists" "lexicon-read" "no-permission" "no-privilege" "permission-change" "request-blackout-denial" "role-change-failure" "search" "security-access" "server-restart" "server-shutdown" "server-startup" "user-configuration-change" "user-role-addition" "user-role-removal" ).

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:group-disable-audit-event-type($config, $groupid, 
        ("no-permission","no-privilege"))
  (: 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.  :)    
  

admin:group-enable-audit-event-type(
$config as element(configuration),
$group-id as xs:unsignedLong,
$event-type as xs:string*
)  as   element(configuration)
Summary:

This function changes the audit event type(s) enabled setting for the audit configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$event-type : The event types to enable (must be one of: "amp-usage" "audit-configuration-change" "audit-shutdown" "audit-startup" "authentication-failure" "concurrent-request-denial" "configuration-change" "document-execute" "document-insert" "document-read" "document-update" "estimate" "eval" "exists" "lexicon-read" "no-permission" "no-privilege" "permission-change" "request-blackout-denial" "role-change-failure" "search" "security-access" "server-restart" "server-shutdown" "server-startup" "user-configuration-change" "user-role-addition" "user-role-removal" ).

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:group-enable-audit-event-type($config, $groupid, 
        ("no-permission","no-privilege"))
  (: 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.  :)   
  

admin:group-exists(
$config as element(configuration),
$group-name as xs:string
)  as   xs:boolean
Summary:

This function determines whether or not the specified Group exists. Returns true if the Group exists, otherwise false is returned.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-name : The name of the group to check.

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:group-exists($config, "Default")

  (: Returns true, if the Default group exists. :)
    

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

This function returns the IDs of all appservers belonging to the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.

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:group-get-appserver-ids($config, admin:group-get-id($config,"myGroup"))
  (: returns the group's appserver IDs :)  
  

admin:group-get-audit-enabled(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:boolean
Summary:

This function returns the value for the audit enabled setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-audit-enabled($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the failover enable value :)  
  

admin:group-get-audit-event-type-enabled(
$config as element(configuration),
$group-id as xs:unsignedLong,
$event-type as xs:string
)  as   xs:boolean
Summary:

This function returns the audit event type's enabled setting for the audit configuration. A value of true is returned is the specified event type is set. Otherwise false is returned.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$event-type : The event type to check (must be one of: "amp-usage" "audit-configuration-change" "audit-shutdown" "audit-startup" "authentication-failure" "concurrent-request-denial" "configuration-change" "document-execute" "document-insert" "document-read" "document-update" "estimate" "eval" "exists" "lexicon-read" "no-permission" "no-privilege" "permission-change" "request-blackout-denial" "role-change-failure" "search" "security-access" "server-restart" "server-shutdown" "server-startup" "user-configuration-change" "user-role-addition" "user-role-removal" ).

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:group-get-audit-event-type-enabled($config, $groupid, 
        "no-permission")
  (: returns the new enabled status for the No-Permission event-type :)    
  

admin:group-get-audit-excluded-roles(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong*
Summary:

This function returns the roles excluded from auditing. If auditing has a "inclusion" restriction, this function returns the empty sequence.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-audit-excluded-roles($config, $groupid) 
  (: returns a sequence of roles in the excluded role restriction:)    
  

admin:group-get-audit-excluded-uris(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string*
Summary:

This function returns the uris excluded from auditing. If auditing has a "inclusion" restriction, this function returns the empty sequence.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-audit-excluded-uris($config, $groupid) 
  (: returns a sequence of uris in the excluded uri restriction:)    
  

admin:group-get-audit-excluded-users(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong*
Summary:

This function returns the users excluded from auditing. If auditing has a "inclusion" restriction, this function returns the empty sequence.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-audit-excluded-users($config, $groupid) 
  (: returns a sequence of users in the excluded user restriction:)    
  

admin:group-get-audit-included-roles(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong*
Summary:

This function returns the roles included from auditing. If auditing has a "exclusion" restriction, this function returns the empty sequence.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-audit-included-roles($config, $groupid) 
  (: returns a sequence of roles in the included role restriction:)    
  

admin:group-get-audit-included-uris(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string*
Summary:

This function returns the uris included from auditing. If auditing has a "exclusion" restriction, this function returns the empty sequence.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-audit-included-uris($config, $groupid) 
  (: returns a sequence of uris in the included uri restriction:)   
  

admin:group-get-audit-included-users(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong*
Summary:

This function returns the users included from auditing. If auditing has a "exclusion" restriction, this function returns the empty sequence.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-audit-included-users($config, $groupid) 
  (: returns a sequence of users in the included user restriction:)    
  

admin:group-get-audit-outcome-restriction(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function returns whether auditing events are restricted by a success or failure outcome. Returns "success","failure", or "both"

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-audit-outcome-restriction($config, $groupid) 
  (: returns either "success","failure", or "both":)    
  

admin:group-get-background-io-limit(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function gets the value for the I/O background limit that controls the I/O resoources that I/O tasks (for example, merges) will consume. If the limit is reached, then merges are throttled back to limit their maximum I/O. This can help in situations when the I/O system on the computer is maxed out. In normal operations, you should not need to set this parameter.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

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:group-get-background-io-limit($config, $groupid)

  (: Returns the background I/O setting for the Default group. :)
    

admin:group-get-compressed-tree-cache-partitions(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the compressed tree cache partitions setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-compressed-tree-cache-partitions($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the compressed tree cache partitions value :)  


  

admin:group-get-compressed-tree-cache-size(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the compressed tree cache size setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-compressed-tree-cache-size($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the compressed tree cache size value :)  

  

admin:group-get-compressed-tree-read-size(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the compressed tree read size (in kilobytes) setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-compressed-tree-read-size($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the compressed tree read size value :)  

  

admin:group-get-expanded-tree-cache-partitions(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the expanded tree cache partitions setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-expanded-tree-cache-partitions($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the expanded tree cache partitions value :)  


  

admin:group-get-expanded-tree-cache-size(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the expanded tree cache size setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-expanded-tree-cache-size($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the expanded tree cache size value :)  

  

admin:group-get-failover-enable(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:boolean
Summary:

This function returns the value for the failover enable setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-failover-enable($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the failover enable value :)  
  

admin:group-get-file-log-level(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function returns the value for the file log level setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-file-log-level($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the file log level value :)  
  

admin:group-get-host-ids(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong*
Summary:

This function returns the IDs of all hosts belonging to the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.

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:group-get-host-ids($config, admin:group-get-id($config,"myGroup"))
  (: returns the group's host IDs :)  
  

admin:group-get-host-initial-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the host initial timeout setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-host-initial-timeout($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the host initial timeout value :)  
  

admin:group-get-host-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the host timeout setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-host-timeout($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the host timeout value :)  
  

admin:group-get-http-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the http timeout setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-http-timeout($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the http timeout value :)  


  

admin:group-get-http-user-agent(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function returns the value for the http user agent setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-http-user-agent($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the http user agent value :)  


  

admin:group-get-httpserver-ids(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong*
Summary:

This function returns the IDs of all httpservers belonging to the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.

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:group-get-httpserver-ids($config, admin:group-get-id($config,"myGroup"))
  (: returns the group's httpserver IDs :)  
  

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

This function returns the ID of the group. The difference between this function and xdmp:group() is that the ID from this function can come from a group that has not yet been saved (that is, from a group 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 group without the need to first save the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-name : The name of the group.

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:group-get-id($config, "myGroup"))
  (: returns the group ID :)  
  

admin:group-get-keep-audit-files(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the keep audit files setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-keep-audit-files($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the keep audit files value :)  
  

admin:group-get-keep-log-files(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the keep log files setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-keep-log-files($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the keep log files value :)  
  

admin:group-get-list-cache-partitions(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the list cache partitions setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-list-cache-partitions($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the list cache partitions value :)  

  

admin:group-get-list-cache-size(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the list cache size setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-list-cache-size($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the list cache size value :)  

  

admin:group-get-metering-enabled(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:boolean
Summary:

This function returns the value of the metering-enabled group setting.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

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:group-get-metering-enabled($config, 
        admin:group-get-id($config, "Default"))
  (: returns the metering-enabled value :)  
    

admin:group-get-meters-database(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong
Summary:

This function returns the ID of the meters-database configured for the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

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:group-get-meters-database($config, 
        admin:group-get-id($config, "Default"))
  (: returns the database ID for the meters database :)  
    

admin:group-get-module-cache-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the number of seconds a module can be unused before being flushed from caches. Larger values can potentially cause more memory to be used for cached modules. Smaller values can potentially cause more time to be used reloading uncached modules.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-module-cache-timeout($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the module cache timeout value :)  
  

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

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

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

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

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

This function returns the name of the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-name($config, admin:group-get-id($config, "myGroup"))
  (: returns the group name :)  

  

admin:group-get-namespaces(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   element(gr:namespace)*
Summary:

This function returns the value of any namespace definitions predefined for the specified group. If none are defined, returns the empty sequence.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-namespaces($config, $groupid)
  

admin:group-get-odbcserver-ids(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong*
Summary:

This function returns the ids of all of the ODBC App Servers in the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

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:group-get-odbcserver-ids($config, $groupid)

  (: Returns the ids of the ODBC servers in the Default group. :)

     

admin:group-get-performance-metering-enabled(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:boolean
Summary:

This function returns the value of the performance-metering-enabled group setting.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

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:group-get-performance-metering-enabled($config, 
        admin:group-get-id($config, "Default"))
  (: returns the performance-metering-enabled value :) 
    

admin:group-get-performance-metering-period(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value of the performance-metering-period group setting.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

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:group-get-performance-metering-period($config, 
        admin:group-get-id($config, "Default"))
  (: returns the performance-metering-period value :)
    

admin:group-get-performance-metering-retain-daily(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value of the performance-metering-retain-daily group setting.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

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:group-get-performance-metering-retain-daily($config, 
        admin:group-get-id($config, "Default"))
  (: returns the performance-metering-retain-daily setting :)
    

admin:group-get-performance-metering-retain-hourly(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value of the performance-metering-retain-hourly group setting.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

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:group-get-performance-metering-retain-hourly($config, 
        admin:group-get-id($config, "Default"))
  (: returns the performance-metering-retain-hourly setting :)
    

admin:group-get-performance-metering-retain-raw(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value of the performance-metering-retain-raw group setting.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

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:group-get-performance-metering-retain-raw($config, 
        admin:group-get-id($config, "Default"))
  (: returns the performance-metering-retain-raw setting :)

    

admin:group-get-retry-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the number of seconds a request will retry before timing out.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-retry-timeout($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the retry timeout value :)  
  

admin:group-get-rotate-audit-files(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function returns the value for the rotate audit files setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-rotate-audit-files($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the rotate audit files value :)  
  

admin:group-get-rotate-log-files(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function returns the value for the rotate log files setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-rotate-log-files($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the rotate log files value :)  
  

admin:group-get-s3-domain(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function gets the simple storage service internet domain name for hosts in the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-s3-domain($config, $groupid)
  ==> "s3.amazonaws.com"
  

admin:group-get-s3-protocol(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function gets the simple storage service protocol for hosts in the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-s3-protocol($config, $groupid)
  ==> "http"
  

admin:group-get-s3-server-side-encryption(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function gets the method of server side encryption for data at rest on the simple storage service.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-s3-server-side-encryption($config, $groupid)
  ==> "none"
  

admin:group-get-schemas(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   element(gr:schema)*
Summary:

This function returns the value of any schemas definitions predefined for the specified group. If none are defined, returns the empty sequence.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-schemas($config, $groupid)
  

admin:group-get-security-database(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong
Summary:

This function returns the ID of the security database for the specified group from the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-security-database($config, $groupid)
  (: returns the ID of the security database :)

  

admin:group-get-smtp-relay(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function returns the value for the smtp relay setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-smtp-relay($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the smtp relay value :)  


  

admin:group-get-smtp-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the smtp timeout setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-smtp-timeout($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the smtp timeout value :)  


  

admin:group-get-system-log-level(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function returns the value for the system log level setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-system-log-level($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the system log level value :)  
  

admin:group-get-taskserver-id(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong*
Summary:

This function returns the ID of of the taskserver belonging to the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.

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:group-get-taskserver-id($config, admin:group-get-id($config,"myGroup"))
  (: returns the group's taskserver ID :)  
  

admin:group-get-trace-events(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   element(gr:event)*
Summary:

This function returns the value of any trace events activated for the specified group. If none are defined, returns the empty sequence.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-trace-events($config, $groupid)
  

admin:group-get-trace-events-activated(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:boolean
Summary:

This function returns the value for the trace events activated setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-trace-events-activated($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the trace events activated value :)  
  

admin:group-get-triple-cache-partitions(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the number of triple cache partitions configured for the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-triple-cache-partitions($config, $groupid)
(: returns the number of triple cache partitioned configured :)
    

admin:group-get-triple-cache-size(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value of the triple cache size for the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-triple-cache-size($config, $groupid)
(: returns the group cache size for the triple index :)
    

admin:group-get-triple-cache-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function gets the timeout value for the triple cache. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-triple-cache-timeout($config, $groupid)
(: returns the triple cache timeout value configured :)
    

admin:group-get-triple-value-cache-partitions(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the number of triple value cache partitions configured for the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-triple-value-cache-partitions($config, $groupid)
(: returns the number of triple value cache partitioned configured :)
    

admin:group-get-triple-value-cache-size(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the size of triple value cache configured for the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-triple-value-cache-size($config, $groupid)
(: returns the size configured for the triple value cache :)
    

admin:group-get-triple-value-cache-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function gets the timeout value for the triple value cache.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-triple-value-cache-timeout($config, $groupid)
(: returns the triple value cache timeout value configured :)
    

admin:group-get-using-namespaces(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   element(gr:using-namespace)*
Summary:

This function returns the value of any "using" namespaces predefined for the specified Group. If none are defined, returns the empty sequence.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.

Example:

xquery version "1.0-ml"; 
 
import module namespace admin = "http://marklogic.com/xdmp/admin" 
      at "/MarkLogic/admin.xqy";
 
    

admin:group-get-webdavserver-ids(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong*
Summary:

This function returns the IDs of all webdavservers belonging to the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.

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:group-get-webdavserver-ids($config, admin:group-get-id($config,"myGroup"))
  (: returns the group's webdavserver IDs :)  
  

admin:group-get-xdbcserver-ids(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedLong*
Summary:

This function returns the IDs of all xdbcservers belonging to the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.

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:group-get-xdbcserver-ids($config, admin:group-get-id($config,"myGroup"))
  (: returns the group's xdbcserver IDs :)  
  

admin:group-get-xdqp-ssl-allow-sslv3(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:boolean
Summary:

This function returns true if the SSL v3 protocol is enabled for the group. Otherwise, false is returned.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.

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

  return
     admin:group-get-xdqp-ssl-allow-sslv3($config, $group)

  (: Returns 'true' if the SSL v3 protocol is enabled for the Default group.  
     Otherwise, 'false'. :)
    

admin:group-get-xdqp-ssl-allow-tls(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:boolean
Summary:

This function returns true if the TLS protocol is enabled for the group. Otherwise, false is returned.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.

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

  return
     admin:group-get-xdqp-ssl-allow-tls($config, $group)

  (: Returns 'true' if the TLS protocol is enabled for the Default group.  
     Otherwise, 'false'. :)
    

admin:group-get-xdqp-ssl-ciphers(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:string
Summary:

This function returns the SSL ciphers set for the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.

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

  return
     admin:group-get-xdqp-ssl-ciphers($config, $group)

  (: Returns the SSL cipher settings for the Default group. :)
    

admin:group-get-xdqp-ssl-enabled(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:boolean
Summary:

This function returns true if SSL is enabled for the group. Otherwise, false is returned.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.

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

  return
     admin:group-get-xdqp-ssl-enabled($config, $group)
 
  (: Returns 'true' if SSL is enabled for the Default group.  Otherwise, 'false'. :)
    

admin:group-get-xdqp-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong
)  as   xs:unsignedInt
Summary:

This function returns the value for the xdqp timeout setting from the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.

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:group-get-xdqp-timeout($config, 
        admin:group-get-id($config, "myGroup"))
  (: returns the xdqp timeout value :)  
  

admin:group-module-location(
$namespace-uri as xs:string,
$location as xs:string
)  as   element(gr:module-location)
Summary:

This function constructs a module namespace element with the specified namespace URI and location.

Parameters:
$namespace-uri : The namespace URI.
$location : The module location.

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:group-module-location("my-namespace", "/my/location/module.xqy")
  (: returns the module-location specification :)  
    

admin:group-namespace(
$prefix as xs:string,
$namespace-uri as xs:string
)  as   element(gr:namespace)
Summary:

This function constructs a namespace element with the specified prefix and URI.

Parameters:
$prefix : The namespace prefix.
$namespace-uri : The namespace URI.

Example:
  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin" 
		  at "/MarkLogic/admin.xqy";

  admin:group-namespace("myprefix", "http://myuri/namespace")
  (: the namespace element :)

  

admin:group-schema(
$namespace-uri as xs:string,
$schema-location as xs:string
)  as   element(gr:schema)
Summary:

This function constructs a schema element with the specified prefix and URI.

Parameters:
$namespace-uri : The namespace URI for the schema.
$schema-location : The schema location.

Example:
  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin" 
		  at "/MarkLogic/admin.xqy";

  admin:group-schema("http://myuri/namespace", "/some/schema.xsd")
  (: the schema element :)
  

admin:group-set-audit-enabled(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:boolean
)  as   element(configuration)
Summary:

This function changes the audit enabled setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new setting (true to enable auditing for the group, false to disable it).

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:group-set-audit-enabled($config, $groupid, fn:true())
  (: 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.  :)   
  

admin:group-set-audit-outcome-restriction(
$config as element(configuration),
$group-id as xs:unsignedLong,
$outcome as xs:string*
)  as   element(configuration)
Summary:

This function restricts the audit configuration by auditing events only if they are "success" or "failure" events.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$outcome : The outcomes to audit (must be one of: "success" or "failure" or "both").

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:group-set-audit-outcome-restriction($config, $groupid, 
        "failure")
  (: 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.  :)   
  

admin:group-set-audit-role-restriction(
$config as element(configuration),
$group-id as xs:unsignedLong,
$restriction-type as xs:string,
$roles as xs:string*
)  as   element(configuration)
Summary:

This function restricts the audit configuration by excluding or including by role.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$restriction-type : The restriction type (must be one of: "inclusion" or "exclusion").
$roles : The sequence of roles affected by the restriction type.

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:group-set-audit-role-restriction($config, $groupid, 
        "exclusion",("admin-role","developer-role"))
  (: 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.  :)    
  

admin:group-set-audit-uri-restriction(
$config as element(configuration),
$group-id as xs:unsignedLong,
$restriction-type as xs:string,
$uris as xs:string*
)  as   element(configuration)
Summary:

This function restricts the audit configuration by excluding or including by document uri(s).

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$restriction-type : The restriction type (must be one of: "inclusion" or "exclusion").
$uris : The sequence of document-uris affected by the restriction type.

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:group-set-audit-uri-restriction($config, $groupid, 
        "inclusion",("/important/foo.xml","/important/foo1.xml"))
  (: 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.  :)    
  

admin:group-set-audit-user-restriction(
$config as element(configuration),
$group-id as xs:unsignedLong,
$restriction-type as xs:string,
$users as xs:string*
)  as   element(configuration)
Summary:

This function restricts the audit configuration by excluding or including by user.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$restriction-type : The restriction type (must be one of: "inclusion" or "exclusion").
$users : The sequence of users affected by the restriction type.

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:group-set-audit-user-restriction($config, $groupid, 
        "exclusion",("admin1","admin2"))
  (: 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.  :)    
  

admin:group-set-background-io-limit(
$config as element(configuration),
$group-id as xs:unsignedLong,
$max-megabytes-per-second as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets a limit on the amount of I/O that background tasks (for example, merges) will consume. If the limit is reached, then merges are throttled back to limit their maximum I/O. This can help in situations when the I/O system on the computer is maxed out. In normal operations, you should not need to set this parameter.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$max-megabytes-per-second : A number representing the maximum amount of I/O, in megabytes-per-second, to allow for each host in the group.

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:group-set-background-io-limit($config, $groupid, 100)
  (: 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.  :)  
    

admin:group-set-compressed-tree-cache-partitions(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the compressed tree cache partitions setting of the group with the specified ID to the specified value. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : A new value for the number of cache partitions.

Usage Notes:

The server may use fewer or more partitions than the configured value to keep partition sizes between 512 and 12288 megabytes.

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:group-set-compressed-tree-cache-partitions($config, $groupid, 2)
  (: 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.  :)  
  

admin:group-set-compressed-tree-cache-size(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the compressed tree cache size setting of the group with the specified ID to the specified value. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new cache value (in megabytes).

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:group-set-compressed-tree-cache-size($config, $groupid, 256)
  (: 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.  :)  
  

admin:group-set-compressed-tree-read-size(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the compressed tree read size setting of the group with the specified ID to the specified value. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new read size value (in kilobytes).

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:group-set-compressed-tree-read-size($config, $groupid, 256)
  (: 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.  :)  
  

admin:group-set-expanded-tree-cache-partitions(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the expanded tree cache partitions setting of the group with the specified ID to the specified value. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : A new value for the number of cache partitions.

Usage Notes:

The server may use fewer or more partitions than the configured value to keep partition sizes between 1024 and 12288 megabytes.

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:group-set-expanded-tree-cache-partitions($config, $groupid, 2)
  (: 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.  :)  
  

admin:group-set-expanded-tree-cache-size(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the expanded tree cache size setting of the group with the specified ID to the specified value. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new cache value (in megabytes).

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:group-set-expanded-tree-cache-size($config, $groupid, 256)
  (: 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.  :)  
  

admin:group-set-failover-enable(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:boolean
)  as   element(configuration)
Summary:

This function changes the failover enable setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new setting (true to enable failover for the group, false to disable it).

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:group-set-failover-enable($config, $groupid, fn:true())
  (: 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.  :)   
  

admin:group-set-file-log-level(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:string
)  as   element(configuration)
Summary:

This function changes the host file log level setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new log level (must be one of finest, finer, fine, debug, config, info, notice, warning, error, critical, alert, emergency).

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:group-set-file-log-level($config, $groupid, "debug")
  (: 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.  :)  
  

admin:group-set-host-initial-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the host initial timeout setting (the time the cluster will wait for a host to come online during cluster startup) for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new timeout setting (in seconds).

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:group-set-host-initial-timeout($config, $groupid, 300)
  (: 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.  :)  
  

admin:group-set-host-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the host timeout setting (the timeout for communication between hosts) for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new timeout setting (in seconds).

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:group-set-host-timeout($config, $groupid, 60)
  (: 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.  :)  
  

admin:group-set-http-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the HTTP timeout setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new timeout setting (in seconds).

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:group-set-http-timeout($config, $groupid, 60)
  (: 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.  :)  
  

admin:group-set-http-user-agent(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:string
)  as   element(configuration)
Summary:

This function changes the HTTP User-Agent setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new value for the HTTP User-Agent.

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:group-set-http-user-agent($config, $groupid, "MarkLogic")
  (: 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.  :)  
  

admin:group-set-keep-audit-files(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the keep audit files setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : A number indicating the number of audit log files to keep before deleting them.

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:group-set-keep-audit-files($config, $groupid, 20)
  (: 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.  :)  
  

admin:group-set-keep-log-files(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the keep log files setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : A number indicating the number of log files to keep before deleting them.

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:group-set-keep-log-files($config, $groupid, 20)
  (: 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.  :)  
  

admin:group-set-list-cache-partitions(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the list cache partitions setting of the group with the specified ID to the specified value. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : A new value for the number of cache partitions.

Usage Notes:

The server may use fewer or more partitions than the configured value to keep partition sizes between 2048 and 12288 megabytes.

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:group-set-list-cache-partitions($config, $groupid, 2)
  (: 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.  :)  
  

admin:group-set-list-cache-size(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the list cache size setting of the group with the specified ID to the specified value. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new list cache value (in megabytes).

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:group-set-list-cache-size($config, $groupid, 256)
  (: 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.  :)  
  

admin:group-set-metering-enabled(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:boolean
)  as   element(configuration)
Summary:

This function enables or disables usage metering for all hosts in the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$value : A boolean value specifying whether metering is enabled for all hosts in this group.

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:group-set-metering-enabled($config, $groupid, fn:true())
  (: 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.  :)  
    

admin:group-set-meters-database(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedLong
)  as   element(configuration)
Summary:

This function specifies the database to be used to store metering data.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$value : The database ID for the database to set as the meters database.

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:group-set-meters-database($config, $groupid, xdmp:database("Meters"))
  (: 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.  :)  
    

admin:group-set-module-cache-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the number of seconds a module can be unused before being flushed from caches. Larger values can potentially cause more memory to be used for cached modules. Smaller values can potentially cause more time to be used reloading uncached modules.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new timeout setting (in seconds).

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:group-set-module-cache-timeout($config, $groupid, 600)
  (: 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.  :)  
  

admin:group-set-name(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:string
)  as   element(configuration)
Summary:

This function changes the name of the group with the specified ID to the specified name.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new name for the group.

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:group-set-name($config, $groupid, "myNewGroupName")
  (: 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.  :)  
  

admin:group-set-performance-metering-enabled(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:boolean
)  as   element(configuration)
Summary:

This function enables or disables performance metering for all hosts in the specified group. Performance metering will save data into the meters database which can be used to analyze your system performance over time.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$value : A boolean value specifying whether performance metering is enabled for all hosts in this group.

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:group-set-performance-metering-enabled($config, $groupid, fn:true())
  (: 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.  :)  
    

admin:group-set-performance-metering-period(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the period (in number of seconds) between when performance data is gathered. setting it to a higher number stores less data but also gives less grainular data; setting it to a lower number stores more data but provides higher grainularity.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$value : The number of seconds between data samples. This value must be 60 or greater, in multiples of 60 (one minute increments).

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:group-set-performance-metering-period($config, $groupid, 60)
  (: 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.  :)  
    

admin:group-set-performance-metering-retain-daily(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the number of days of performance metering data to retain.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$value : The number of days of data to retain.

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:group-set-performance-metering-retain-daily($config, $groupid, 31)
  (: 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.  :)


    

admin:group-set-performance-metering-retain-hourly(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the number of days to retain hourly performance data.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$value : The number of hours of data to retain.

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:group-set-performance-metering-retain-hourly($config, $groupid, 8)
  (: 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.  :)
    

admin:group-set-performance-metering-retain-raw(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the number of days of raw performance data to retain.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
$value : The number of days worth of raw data to retain.

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:group-set-performance-metering-retain-raw($config, $groupid, 5)
  (: 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.  :)  

    

admin:group-set-retry-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the number of seconds a request will retry before timing out.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new timeout setting (in seconds).

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:group-set-retry-timeout($config, $groupid, 180)
  (: 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.  :)  
  

admin:group-set-rotate-audit-files(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:string
)  as   element(configuration)
Summary:

This function changes the rotate audit files setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new audit level (must be one of never, daily, monday, tuesday, wednesday, thursday, friday, saturday, sunday, monthly).

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:group-set-rotate-audit-files($config, $groupid, "wednesday")
  (: 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.  :)  
  

admin:group-set-rotate-log-files(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:string
)  as   element(configuration)
Summary:

This function changes the rotate log files setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new log level (must be one of never, daily, monday, tuesday, wednesday, thursday, friday, saturday, sunday, monthly).

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:group-set-rotate-log-files($config, $groupid, "wednesday")
  (: 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.  :)  
  

admin:group-set-s3-domain(
$config as element(configuration),
$group-id as xs:unsignedLong,
$domain as xs:string
)  as   element(configuration)
Summary:

This function sets the simple storage service internet domain name for hosts in the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$domain : A string specifying the internet domain name of the simple storage service. To access a different simple storage services that is API compatible with Amazon S3, specify it here.

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:group-set-s3-domain($config, $groupid, "my.domain.name")
  (: 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.  :)  
    

admin:group-set-s3-protocol(
$config as element(configuration),
$group-id as xs:unsignedLong,
$protocol as xs:string
)  as   element(configuration)
Summary:

This function sets the simple storage service protocol for hosts in the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$protocol : A string specifying the protocol to use when accessing the simple storage service. The choices are "http" and "https". The default is "http". To use a more secure protocol when accessing the simple storage service, choose "https".

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:group-set-s3-protocol($config, $groupid, "https")
  (: 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.  :)  
    

admin:group-set-s3-server-side-encryption(
$config as element(configuration),
$group-id as xs:unsignedLong,
$protocol as xs:string
)  as   element(configuration)
Summary:

This function gets the method of server side encryption for data at rest on the simple storage service.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$protocol : A string specifying the method of server side encryption for data at rest on the simple storage service. The choices are "none" and "aes256". The default is "none". To specify server side encryption for data at rest on the simple storage service, choose "aes256".

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:group-set-s3-server-side-encryption($config, $groupid, "aes256")
  (: 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.  :)  
    

admin:group-set-security-database(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedLong
)  as   element(configuration)
Summary:

This function sets the security database for a group to the specified database in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new database ID for the auxiliary database.

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")
  let $dbid := xdmp:database("myDatabase"))
  return admin:group-set-security-database($config, $groupid, $dbid)
  (: 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.  :)
  

admin:group-set-smtp-relay(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:string
)  as   element(configuration)
Summary:

This function changes the SMTP relay setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new value for the SMTP relay host.

Example:
  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin" 
		  at "/MarkLogic/admin.xqy";
		  at "/MarkLogic/admin.xqy";
		
  let $config := admin:get-configuration()
  let $groupid := admin:group-get-id($config, "Default")
  return
  admin:group-set-smtp-relay($config, $groupid, "mail")
  (: 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.  :)  
  

admin:group-set-smtp-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the SMTP timeout setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new SMTP response timeout (in seconds).

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:group-set-smtp-timeout($config, $groupid, 30)
  (: 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.  :)  
  

admin:group-set-system-log-level(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:string
)  as   element(configuration)
Summary:

This function changes the host system log level setting for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new log level (must be one of finest, finer, fine, debug, config, info, notice, warning, error, critical, alert, emergency).

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:group-set-system-log-level($config, $groupid, "debug")
  (: 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.  :)  
  

admin:group-set-trace-events-activated(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:boolean
)  as   element(configuration)
Summary:

This function changes the value for trace events in the group configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new trace event value (true for enabled, false for disabled).

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:group-set-trace-events-activated($config, $groupid, fn:true())
  (: 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.  :)  
  

admin:group-set-triple-cache-partitions(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the number of partitions to allocate for the triple index cache. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : A new value for the number of cache partitions.

Usage Notes:

The server may use fewer or more partitions than the configured value to keep partition sizes between 1024 and 12288 megabytes.

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 $group-id := admin:group-get-id($config, "Default")
return 
admin:group-set-triple-cache-partitions($config, $group-id, 1)
(: 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.  :)
    

admin:group-set-triple-cache-size(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the number of triple cache partitions to allocate. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The size (in megabytes) to set the triple cache.

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 $group-id := admin:group-get-id($config, "Default")
return 
admin:group-set-triple-cache-size($config, $group-id, 128)
(: 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.  :)
    

admin:group-set-triple-cache-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the timeout value for the triple cache. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The time, in seconds, before a cached page can be flushed to disk.

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 $group-id := admin:group-get-id($config, "Default")
return 
admin:group-set-triple-cache-timeout($config, $group-id, 300)
(: 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.  :)
    

admin:group-set-triple-value-cache-partitions(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the number of partitons to allocate for the triple value index cache. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : A new value for the number of cache partitions.

Usage Notes:

The server may use fewer or more partitions than the configured value to keep partition sizes between 512 and 12288 megabytes.

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 $group-id := admin:group-get-id($config, "Default")
return 
admin:group-set-triple-value-cache-partitions($config, $group-id, 1)
(: 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.  :)
    

admin:group-set-triple-value-cache-size(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the size of the value cache for the triple index. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The size (in megabytes) to set the triple value cache.

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 $group-id := admin:group-get-id($config, "Default")
return 
admin:group-set-triple-value-cache-size($config, $group-id, 64)
(: 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.  :)
    

admin:group-set-triple-value-cache-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function sets the timeout value for the triple value cache. This is a "cold" operation; when you use admin:save-configuration to save the configuration, it will automatically restart MarkLogic Server.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The time, in seconds, before a cached page can be flushed to disk.

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 $group-id := admin:group-get-id($config, "Default")
return 
admin:group-set-triple-value-cache-timeout($config, $group-id, 300)
(: 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.  :)
    

admin:group-set-xdqp-ssl-allow-sslv3(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:boolean
)  as   element(configuration)
Summary:

This function enables or disables the SSL v3 protocol for the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
$value : Specify true to enable the SSL v3 protocol for the group or false to disable the SSL v3 protocol.

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

  return
        admin:group-set-xdqp-ssl-allow-sslv3($config, $group, fn:false())

  (: Disables the SSL v3 protocol on the Default group. :)
    

admin:group-set-xdqp-ssl-allow-tls(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:boolean
)  as   element(configuration)
Summary:

This function enables or disables the TLS protocol for the specified group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
$value : Specify true to enable the TLS protocol for the group or false to disable the TLS protocol.

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

  return
        admin:group-set-xdqp-ssl-allow-tls($config, $group, fn:true())

  (: Enables the TLS protocol on the Default group. :)
    

admin:group-set-xdqp-ssl-ciphers(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:string
)  as   element(configuration)
Summary:

This function sets SSL ciphers for the specified group. This is the standard cipher specification string for OpenSSL.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
$value : The SSL ciphers to set.

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

  return
        admin:group-set-xdqp-ssl-ciphers($config, $group, "All") 

  (: Sets the ciphers for the Default group to "All".  :)
    

admin:group-set-xdqp-ssl-enabled(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:boolean
)  as   element(configuration)
Summary:

This function enables or disables SSL for the group.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
$value : Specify true to enable SSL for the group or false to disable SSL.

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

  return
        admin:group-set-xdqp-ssl-enabled($config, $group, fn:false()) 

  (: Disables SSL on the Default group. :)
    

admin:group-set-xdqp-timeout(
$config as element(configuration),
$group-id as xs:unsignedLong,
$value as xs:unsignedInt
)  as   element(configuration)
Summary:

This function changes the XDQP timeout setting (the timeout for communication between data nodes and evaluator nodes) for the group in the configuration.

Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an admin:group-get-id call.
$value : The new timeout setting (in seconds).

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:group-set-xdqp-timeout($config, $groupid, 20)
  (: 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.  :)  
  

admin:group-trace-event(
$event-id as xs:string
)  as   element(gr:event)
Summary:

This function constructs an event element for the specified event name.

Parameters:
$event-id : The exact name of the trace event.

Example:
  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin" 
		  at "/MarkLogic/admin.xqy";

  admin:group-trace-event("CPF on-state-enter")		
  (: returns the event element for the CPF on state enter trace event :)
  

admin:group-using-namespace(
$namespace-uri as xs:string
)  as   element(gr:using-namespace)
Summary:

This function constructs a using namespace element with the specified URI.

Parameters:
$namespace-uri : The namespace URI.

Example:

xquery version "1.0-ml"; 
 
import module namespace admin = "http://marklogic.com/xdmp/admin" 
   at "/MarkLogic/admin.xqy";

admin:group-using-namespace("my.namespace")
(: Returns the namespace specification :)