Loading TOC...
JavaScript admin.appserverSetSslMinAllowTls

MarkLogic 12 Product Documentation
admin:appserver-set-ssl-min-allow-tls

admin:appserver-set-ssl-min-allow-tls(
   $config as element(configuration),
   $appserver-id as xs:unsignedLong,
   $value as xs:string
) as element(configuration)

Summary

This function sets the minimum allow TLS protocol for the specified App Server. 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.
appserver-id The ID of the App Server. Typically, this is the result of an admin:appserver-get-id call.
value The minimum allow TLS protocol: "TLSv1.2" or "TLSv1.3".

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/app-server-security

http://marklogic.com/xdmp/privileges/admin/app-server-security/{id}

http://marklogic.com/xdmp/privileges/admin/group-security

http://marklogic.com/xdmp/privileges/admin/group-security/{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 $appServer := admin:appserver-get-id($config,
          admin:group-get-id($config, "Default"),
          "Docs")

  return
       admin:appserver-set-ssl-min-allow-tls($config, $appServer, "TLSv1.2")

   (: Set the minimum allow TLS to "TLSv1.2" for the "Docs" App Server. 
      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.