Powered by Zoomin Software. For more details please contactZoomin

Run on Amazon Web Services (AWS)

Use the mlcmd script

  • Last Updated: April 14, 2026
  • 1 minute read
    • MarkLogic Server
    • Version 12.0
    • Documentation

Themlcmdscript supports startup operations and advanced use of the Managed Cluster features. The mlcmd script is installed as an executable script in opt/MarkLogic/mlcmd/bin/mlcmd.

In order to run mlcmd, you must be logged into the host and running as root or with root privileges. You must also have Java installed and the java command in the PATH or JAVA_HOME set to the JRE or JDK home directory. The first time you start MarkLogic on your server the /var/local/mlcmd.conf file is created, which is required to use the mlcmd script. Once the /var/local/mlcmd.conf file is created, it is not necessary to start MarkLogic to use the mlcmd script.

The syntax ofmlcmdis as follows:

mlcmd command

The mlcmd commands are listed below:

mlcmd Command

Description

sync-volumes-from-mdb

Attaches EBS volumes not currently attached to this instance.

sync-volumes-to-mdb

Synchronizes the EBS volumes currently attached to the system and stores them in the Metadata Database.

init-volumes-from-system

Initialize volumes identical to the process performed on startup.

leave-cluster

Removes the host on which it is executed from the cluster. Note that this is a privileged operation, so the user running the script should have the ability to read all information in /etc/marklogic.conf.

TitleResults for “How to create a CRG?”Also Available inAlert