JavaScript admin.appserverGetSslAllowTls

MarkLogic 10 Product Documentation
admin:appserver-get-ssl-allow-tls

admin:appserver-get-ssl-allow-tls(
   $config as element(configuration),
   $appserver-id as xs:unsignedLong
) as xs:boolean

Summary

This function returns true if the TLS protocol is enabled for the specified App Server, or false if TLS is disabled.

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.

Required Privileges

This operation requires at least one of the following privileges:

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

http://marklogic.com/xdmp/privileges/admin/app-server/{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-get-ssl-allow-tls($config, $appServer)

   (: Returns true if TLS is enabled for the "Docs" App Server.  Otherwise false. :)

MarkLogic 10 Product Documentationadmin:appserver-get-ssl-allow-tls

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:appserver-get-ssl-allow-tls