Loading TOC...
JavaScript admin.foreignClusterSetXdqpSslMinAllowTls

MarkLogic 12 Product Documentation
admin:foreign-cluster-set-xdqp-ssl-min-allow-tls

admin:foreign-cluster-set-xdqp-ssl-min-allow-tls(
   $config as element(configuration),
   $cluster-id as xs:unsignedLong,
   $value as xs: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


  xquery version "1.0-ml";

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

  let $cfg := admin:get-configuration()
  let $fcl := admin:cluster-get-foreign-cluster-id($cfg, "ClusterA")

  return admin:foreign-cluster-set-xdqp-ssl-min-allow-tls($cfg, $fcl, "TLSv1.2")

 (: Enables the minimum allow TLS protocol to "TLSv1.2" on the foreign cluster. 
    Use admin:save-configuration 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.