Loading TOC...

admin.appserverSetSslAllowTls

admin.appserverSetSslAllowTls(
   $config as element(configuration),
   $appserver-id as (Number|String),
   $value as Boolean
) as element(configuration)

Summary

This function enables or disables the TLS protocol for the specified App Server.

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 A boolean value, fn:true() to enable, fn:false() to disable.

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');
  var config = admin.getConfiguration()
  var 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. 
     

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.