MarkLogic 10 and Data Hub 5.0

Latest MarkLogic releases provide a smarter, simpler, and more secure way to integrate data.

Read Blog →


Stay On Top Of Everything MarkLogic

Be the first to know! News, product information, and events delivered straight to your inbox.

Sign Me Up →

Knowledgebase: Administration
Ops Director Troubleshooting
03 May 2022 05:11 PM

Note: The Ops Director feature has been deprecated as of September 30, 2020 and support ended on November 14, 2021.


Ops Director enables you to monitor MarkLogic clusters ranging from a single node to large multi-node deployments. A single Ops Director server can monitor multiple clusters. Ops Director provides a unified browser-based interface for easy access and navigation.

Ops Director presents a consolidated view of your MarkLogic infrastructure, to streamline monitoring and troubleshooting of clusters with alerting, performance, and log data. Ops Director provides enterprise-grade security of your cluster configuration and performance data with robust role-based access control and information security powered by MarkLogic Server.

Problems installing Ops Director 2.0.0, 2.0.1 & 2.0.1-1


To successfully install Ops Director, the value for mlhost in must have a hostname and that hostname must match the name of one of the hosts in the cluster.  You can not use localhost to install Ops Director, nor can you use a host name other than one that is listed as a host in the cluster as this effects the use of certificates for authentication to the OpsDirectorSystem application server.

Check for App-Services

Ops Director can sometimes encounter errors when attempting to install in groups other than Default. To successfully install, the Ops Director installer needs to be able to connect to the App-Services application server on port 8000 in the group where Ops Director is being installed.  There are two ways to work around this issue:

  • Create a copy of the App-Services app server in the new group, then install Ops Director
    • Be aware this allows QConsole access in the new group, for users with appropriate privileges. 
    • If you wish to prevent QConsole access in that group, the App-Services application server should be deleted after Ops Director has been installed.
  • Install Ops Director in the Default group, then move the host to the new group, and create the OpsDirector app servers in the new group.
    • Be aware this allows Ops Director access to remain in the Default group.
    • If you wish to prevent Ops Director access in the Default, the Ops Director application servers should be deleted from the Default group.
      • To do this you must also copy the scheduled tasks associated with Ops Director over to the new group, and delete the scheduled tasks from the old group

See the attached Workspace OpsDirCopyAppServers.xml which has scripts to do the following:

  • Copy and/or remove the App-Services app server
  • Copy and/or remove the OpsDirectorSystem/OpsDirectorApplication/SecureManage app servers
  • Copy and/or remove the scheduled tasks associated with the Ops Director application.

Also note that Ops Director will install forests on all hosts in the cluster, regardless of group assignments.

Managing a Cluster

Check DNS Settings

When setting up a managed host, it's important to note that the hosts in both the Ops Director cluster, and the cluster being managed must be able to resolve hostnames via DNS.  Modifying the /etc/hosts file is not sufficient.

Check Ops Director Scheduled Tasks

When setting up a managed host, you may encounter a XDMP-DEADLOCK error, or have an issue seeing the data for a managed cluster.  If this occurs do the following:

  • Un-manage the affected cluster.  If there are any issues un-managing the cluster, use the procedures in this KB under the Problems with Un-managing Clusters to un-manage the cluster
  • Disable the scheduled tasks associated with Ops Director
    • /common/tasks/info.xqy
    • /common/tasks/running.xqy
    • /common/tasks/expire.xqy
    • /common/tasks/health.xqy
  • Manage the cluster again
  • Enable the scheduled tasks that were disabled

Verify Necessary Ports are Open

Assuming the default installation ports are in use, verify the following access:

  • 8003 Inbound TCP on the Managed Cluster, accessed by the Ops Director Cluster.
  • 8008 Inbound TCP on the Ops Director Cluster, accessed by the Ops Director Users.
  • 8009 Inbound TCP on the Ops Director Cluster, accessed by the Managed Cluster

Upgrading Ops Director

When upgrading to a new version of Ops Director, it may necessary to uninstall the previous version.  To do that, you must un-manage any clusters being managed by Ops Director, prior to uninstalling the application.

Un-managing Clusters

The first step in uninstalling Ops Director is to remove any clusters from being managed from Ops Director.  This is done via the Admin UI on a host in the managed cluster, as detailed in the Ops Director Guide: Disconnecting a Managed Cluster from Ops Director

Uninstalling Ops Director 2.0.0 & 2.0.1

These versions of Ops Director use the ml-gradle plugin for deployment.  To uninstall these versions, you will also use gradle, as detailed in the Ops Director Guide: Removing Ops Director 2.0.0 and 2.0.1

Uninstalling Ops Director 1.1 or Earlier

If you are using the 1.1  version that was installed via the Admin UI, then it can be uninstalled via the Admin UI as detailed in the Ops Director Guide: Removing Ops Director 1.1 or Earlier

Problems with Uninstalling Ops Director

Occasionally an Ops Director installation may partially fail, due to misconfiguration, or missing dependencies.  Issues can also occur that prevent the standard removal methods from working correctly.  In these cases, Ops Director can be removed manually using the attached QConsole Workspace, OpsDirRemove.xml.  The instructions for running the scripts are contained in the first tab of the workspace.

Problems with Un-managing Clusters

Occasionally, disconnecting a managed cluster from Ops Director may partially fail.  If this occurs, you can use the attached QConsole Workspace, OpsDirUnmanage.xml.  The instructions for running the scripts are contained in the first tab of the workspace.

Further Reading

Installing, Uninstalling, and Configuring Ops Director

Monitoring MarkLogic with Ops Director

 OpsDirRemove.xml (10.29 KB)
 OpsDirUnmanage.xml (6.89 KB)
 OpsDirCopyAppServers.xml (13.35 KB)
(1 vote(s))
Not helpful

Comments (0)