| XQUERY/XSLT API DOCUMENTATION 4.2 |
All XQuery & XSLT Functions MarkLogic Built-In Functions Admin (xdmp:) AppServer (xdmp:) Classifier (cts:) Debug (dbg:) Document Conversion (xdmp:) Extension (xdmp:) Documents, Directories, Properties, and Locks Functions Extension Functions Function Values Functions HTTP Functions JSON Functions MarkLogic Server Functions Search Functions XML Functions XQuery Context Functions XSLT Functions map (map:) Math (math:) Profile (prof:) Search (cts:) cts:query Constructors Functions Geospatial Functions Geospatial Lexicon Functions Lexicon Functions Search Functions Search Clustering Functions Security (xdmp:) Server Monitoring (xdmp:) Spell (spell:) Update (xdmp:) XQuery Library Modules Admin Library (admin:) Actions Functions Appserver Functions Database Functions Forest Functions Group Functions Host Functions Mimetypes Functions Scheduler Functions Alerting (alert:) Elastic Compute Cloud (ec2:) Entity Enrichment (entity:) Flexible Replication (flexrep:) Geospatial Supporting Functions GEO Functions GeoRSS Functions GML Functions KML Functions MCGM Functions Information Studio (info:) Information Studio Developer (infodev:) Library Services (dls:) cts:query Constructor Functions Document Management Functions Document Update Functions Retention Policy Functions XInclude Functions Modular Documents XInclude Functions XPointer Functions PKI (pki:) Plugin (plugin:) Search (search:) Security-sec (sec:) Spelling Dictionary Management (spell:) Thesaurus (thsr:) Triggers (trgr:) Triggers Library (trgr:) WordProcessingML (ooxml:) ZIP Package (ooxml:) CPF Functions Content Processing Framework (cpf:) CSS Conversion (css:) DocBook Conversion (dbk:) Domains (dom:) Excel Conversion (excel:) Generic Conversion (cvt:) Links (lnk:) MSWord Conversion (msword:) PDF Conversion (pdf:) Pipelines (p:) Powerpoint Conversion (ppt:) XHTML Conversion (xhtml:) W3C-Standard Functions Accessor (fn:) AnyURI (fn:) Boolean (fn:) Context (fn:) DurationDateTime (fn:) Error and Trace (fn:) Node (fn:) Numeric (fn:) QName (fn:) Sequence (fn:) String (fn:) XSLT (fn:) W3C XQuery/XSLT Reference W3C XQuery Functions W3C XQuery Language W3C XSLT Language
This page was generated September 12, 2012 5:59 AM | XQuery & XSLT Built-In & Modules Function Reference
Module: Admin Library - Group Functions
The Admin module is an XQuery library module that allows you to script administrative tasks that you otherwise would need the Admin Interface to perform. Most functions in this library perform adminstrative tasks and therefore require the user who runs the XQuery program to have the Admin role. Many of these functions provide new configuration information. In most cases, you must save the configuration (with `admin:save-configuration`, for example) in the same statement that you use the functions in order for them to take effect. To use the Admin module as part of your own XQuery module, include the following line in your XQuery prolog: `import module namespace admin = "http://marklogic.com/xdmp/admin" at "/MarkLogic/admin.xqy" ;` The library namespace prefix `admin` is not predefined in the server.
Function Summary
admin:get-group-ids | This function returns all the group IDs from the 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-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-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-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-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-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-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-schemas | This function returns the value of any schemas definitions predefined for the specified group.
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-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-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-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-name | This function changes the name of the group with the specified ID to the specified name.
admin:group-set-retry-timeout | This function changes the 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-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-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.
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-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-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-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-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-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-timout($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-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-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-host-retry-timout($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the host initial 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-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-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-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-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-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.
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 partions.
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.
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.
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.
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 partions.
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.
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-timout($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-timout($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.
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 partions.
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.
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-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-retry-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the 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-timout($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-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-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-timout($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 :)

© Copyright 2002-2012 MarkLogic Corporation. All rights reserved.