MarkLogic 12 Product Documentation
admin.foreignClusterSetXdqpSslMinAllowTls

admin.foreignClusterSetXdqpSslMinAllowTls(
   config as element(configuration),
   cluster-id as (Number|String),
   value as String
) as element(configuration)

Summary

This function sets the minimum allow TLS protocol for the specified foreign cluster. If it is set to "TLSv1.2", both TLS 1.2 and TLS 1.3 can be used. If it is set to "TLSv1.3", only TLS 1.3 can be used. The default is "TLSv1.2".

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
cluster-id The ID of the foreign cluster.
value The minimum allow TLS protocol: "TLSv1.2" or "TLSv1.3".

Required Privileges

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const cfg = admin.getConfiguration()
  const fcl = admin.clusterGetForeignClusterId(cfg, "ClusterA")
  admin.foreignClusterSetXdqpSslMinAllowTls(cfg, fcl, "TLSv1.2")

  // Set the minimum allow TLS protocol on the foreign cluster. 
  // Use admin.saveConfiguration to save the changes to the configuration or 
  // pass the configuration to other Admin API functionsto make other changes. 
    
Powered by MarkLogic Server | Terms of Use | Privacy Policy