Loading TOC...
JavaScript admin.groupSetAllowDynamicHosts

MarkLogic 12 Product Documentation
admin:group-set-allow-dynamic-hosts

admin:group-set-allow-dynamic-hosts(
   $config as element(configuration),
   $group-id as xs:unsignedLong,
   $value as xs:boolean
) as element(configuration)

Summary

Enables or disables the ability of a group to accept new dynamic hosts from joining this group. Dynamic hosts can only join groups with the allow dynamic hosts option turned on.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
group-id The ID of the group to which the dynamic host will be added.
value When setting the value to true, the group will accept new dynamic hosts to join this group. When setting the value to false, the group will not accept new dynamic hosts to join this group.

Required Privileges

This operation requires the following privilege:

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{id}

Example


  xquery version "1.0-ml";

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

  let $config := admin:get-configuration()
  let $groupid := admin:group-get-id($config, "Default")
  return admin:group-set-allow-dynamic-hosts($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.  :)

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.