XQuery admin:appserver-set-ssl-min-allow-tls

MarkLogic 12 Product Documentation
admin.appserverSetSslMinAllowTls

admin.appserverSetSslMinAllowTls(
   config as element(configuration),
   appserver-id as (Number|String),
   value as 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.appserverGetId` 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

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const appServer = admin.appserverGetId(config,
          admin.groupGetId(config, "Default"),
          "Docs")
       admin.appserverSetSslAllowTls(config, appServer, fn.true())

    //Enables TLS for the "Docs" App Server. Use admin.saveConfiguration to
    //save the changes to the configuration or pass the configuration to other
    //Admin API functions to make other changes.

MarkLogic 12 Product Documentationadmin.appserverSetSslMinAllowTls

Summary

Required Privileges

Example

MarkLogic 12 Product Documentation
admin.appserverSetSslMinAllowTls