MarkLogic Server 11.0 Product Documentation
admin.foreignClusterCreate

admin.foreignClusterCreate(
   config as element(configuration),
   cluster-id as (Number|String),
   cluster-name as String,
   xdqp-timeout as Number?,
   host-timeout as Number?,
   ssl-certificate as String?,
   xdqp-ssl-enabled as Boolean?,
   xdqp-ssl-allow-sslv3 as Boolean?,
   xdqp-ssl-allow-tls as Boolean?,
   xdqp-ssl-ciphers as String?,
   foreign-bootstrap-hosts as element(cl.foreignHost)[]
) as element(configuration)

Summary

This function creates a complete configuration for a foreign cluster.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
cluster-id	The ID of the foreign cluster, obtained by running the `admin:cluster-get-id` function on the foreign cluster.
cluster-name	The name of the foreign cluster.
xdqp-timeout	The XDQP timeout setting (in seconds) for the foreign cluster.
host-timeout	the host timeout setting (in seconds) for the foreign cluster.
ssl-certificate	The SSL certificate returned by the `admin:cluster-get-xdqp-ssl-certificate` function on the foreign cluster.
xdqp-ssl-enabled	Specify `true` to enable SSL for the foreign cluster or `false` to disable SSL.
xdqp-ssl-allow-sslv3	Specify `true` to enable the SSL v3 protocol for the foreign cluster or `false` to disable the SSL v3 protocol.
xdqp-ssl-allow-tls	Specify `true` to enable the TLS protocol for the foreign cluster or `false` to disable the TLS protocol.
xdqp-ssl-ciphers	The SSL ciphers to set. This can be any standard cipher specification string for OpenSSL.
foreign-bootstrap-hosts	The boot strap host configuration returned from the `admin.foreignHost` function. You can specify multiple bootstrap hosts on a cluster.

Required Privileges

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const cfg = admin.getConfiguration()

   //Obtain foreign cluster id by running admin.clusterGetId on the foreign cluster. 
  const fcl = 15499567556358534770
  const cert = "---BEGIN CERTIFICATE-----\
               MIICzjCCAbagAwIBAgIJAMieG0IJQAWQMA0GCSqGSIb3DQEBBQUAMB8xHTAbBgNV\
               BAMTFDE3MDY0ODkwODY2NTc0NzgxNTcxMB4XDTExMDYwMjIwMjA1M1oXDTIxMDUz\
               MDIwMjA1M1owHzEdMBsGA1UEAxMUMTcwNjQ4OTA4NjY1NzQ3ODE1NzEwggEiMA0G\
               CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDPM9XLSbmVN1Fykz523I7H9Cq4zgO9\
               cUSHI/FArYnWNXUbJIesvDifu2DggfsE7HD6Glwa1ZvkVTBDyZhYv1MZMpBy18Au\
               9McoBbl9NYHOIhtM6bHTJAWNDoHi+TL/rFJzxo5h+bC/JnOjbE40MZKkzSzV944t\
               LbpYT3JfGtMJgcCEWqVLp7vkSRUsKCPuJdPpFfMixDaLA75+W9PVdm01jDvihrgr\
               CZkVjlMzZersHYQDsuNNWwt/9fM1skKabVWUVB0vHV307j2JHwVUJS3+hVxSiT61\
               GaIO3GSL6dVI5ZlYZCCyyFNc0cqPutu0Q3MfZq6MpFlt5Iffm0cWwSkvAgMBAAGj\
               DTALMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQEFBQADggEBAIKRSFrk3a7JBl9bBsBb\
               sWxob3eVM4wh8f6EPjdiIZL0V7HH4dH2hdcvtXB0NdMntiTeJfjm/tdzzMMS0al/\
               LZV3BxxMa7vYk6JtRFUaMdMwwsSa319n2WXKHlqZksWk4H5gC8AH5Vpdex44SKP4\
               GYVh0MO5kIS07yHfuv66PWsTRQiIHQSHYe33Dot/Mfs9BT/sVm1qRJ1ZO5GAf136\
               3iQhwf8fa0PdYGfmN9I1yQMneet3W3k9T4J86mp4RuYl44Z0sv1p3oDCcuiVRgbF\
               ro0dL8n7gE6fW8Hj5tnZQxYzFCwUqy8nhab+MwpOsoACOM8WvULnaMgPdflEklQT\
               VL0=\
               ----END CERTIFICATE-----"
 const host = admin.foreignHost(13134636216063499728, "master.marklogic.com", 7998)
 admin.foreignClusterCreate(cfg, fcl, "master", 15, 35, cert, fn.true(),
                                     fn.false(), fn.false(), "All", host)
  // Creates a compconste configuration for the foreign cluster. Use
  // admin.saveConfiguration to save the changes to the configuration or
  // pass the configuration to other Admin API functions to make other changes.

MarkLogic Server 11.0 Product Documentationadmin.foreignClusterCreate

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.foreignClusterCreate