MarkLogic 10 Product Documentation
admin:host-set-name

admin:host-set-name(
   $config as element(configuration),
   $host-id as xs:unsignedLong,
   $value as xs: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


  xquery version "1.0-ml";

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

  let $config := admin:get-configuration()
  let $hostid := admin:host-get-id($config, "myOldHostname")
  return
  admin:host-set-name($config, $hostid, "myNewHostName")

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

  
Powered by MarkLogic Server | Terms of Use | Privacy Policy