MarkLogic 12 Product Documentation
admin.hostSetName

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

Summary

This function changes the name of an existing host 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 name of the host.

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}

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const hostid = admin.hostGetId(config, "myOldHostname")
  admin.hostSetName(config, hostid, "myNewHostName")

   //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.

MarkLogic 12 Product Documentationadmin.hostSetName

Summary

Required Privileges

Example

MarkLogic 12 Product Documentation
admin.hostSetName