Loading TOC...

admin.hostSetGroup

admin.hostSetGroup(
   $config as element(configuration),
   $host-id as (Number|String),
   $value as (Number|String)
) as element(configuration)

Summary

This function changes the group to which an existing host belongs to the newly specified value.

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

Required Privileges

This operation requires at least one of the following privileges:

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

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

Usage Notes

Any group whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the group, do so in a separate transaction before using them in in this function.

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var hostid = admin.hostGetId(config, xdmp.hostName())
  admin.hostSetGroup(config, hostid,
      admin.groupGetId(config, "Default"))

   //returns the new configuration element -- use admin.saveConfiguration
   //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.