Loading TOC...

admin.forestGetAvailability

admin.forestGetAvailability(
   $config as element(configuration),
   $forest-id as (Number|String)
) as String

Summary

This function gets the availability state of the forest, for use in Tiered Storage. A forest can have an availability state of online or offline.

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$forest-id The ID of the forest.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/forest

http://marklogic.com/xdmp/privileges/admin/forest/{id}

Example

const admin = require('/MarkLogic/admin.xqy');
admin.forestGetAvailability(admin.getConfiguration(),
      xdmp.forest("Documents"))
=> online

    

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