Contact Free trial Login

Creating and Managing a Cluster Manually

Mule Runtime Engine versions 3.5, 3.6, and 3.7 reached End of Life on or before January 25, 2020. For more information, contact your Customer Success Manager to determine how you can migrate to the latest Mule version.

*Enterprise Edition*

There are two ways to create and manage clusters:

  • Using the Management Console’s graphical interface

  • Manually, using a configuration file

This page describes manual creation and configuration of a cluster. If you want to create and manage a cluster using the Management Console’s graphical interface, see Creating or Disbanding a Cluster.

Do not attempt mixed management of clusters

If you create a cluster manually, do not attempt to manage it via the Management Console. The Management Console cannot recognize your manually-created cluster, and overwrites your cluster configuration.
All nodes in a cluster must have the same agent version.

Creating a Cluster Manually

Follow this procedure to create a cluster manually, using a configuration file.

  1. Ensure that the node is not running, i.e. Mule ESB Server is stopped.

  2. Create a file named inside the node’s $MULE_HOME/.mule directory.

  3. Edit the file with parameter = value pairs, one per line. See the example below.

  4. Repeat this procedure for all Mule servers that you want to be in the cluster.

  5. Start the Mule servers in the nodes.

For the full list of available parameters, see Cluster Configuration Parameters.

Managing a Cluster Manually

Manual management of a cluster is only possible for clusters that have been manually created, which are not managed by the Mule Management Console.

To manually change the configuration of a cluster node, follow these steps:

  1. Stop the node’s Mule ESB server.

  2. Edit the node’s as desired, then save the file.

  3. Restart the node’s Mule ESB server.

Ensure consistency across nodes

Ensure that the options you apply in the configuration file are valid for all cluster nodes. Failure to do so can cause you to break the cluster configuration and inadvertently disable the cluster.

Cluster Configuration Parameters

The following table lists the parameters of the file.

Property name Description


Mandatory. Unique identifier for the cluster. It can be any alphanumeric string.


Mandatory. Unique ID of the node within the cluster. It can be any integer between 1 and the number of nodes in the cluster.


Comma-separated list of interfaces to use by Hazelcast. Wildcards are supported, as shown below.



The nodes that belong to the cluster, in the form <host:port>, for example, Specifying just one IP address enables the server to join the cluster.

The port number is optional; if not set, the default is 5701. To include more than one host, create a comma-separated list.

This option configures the cluster with the specified fixed IP addresses. Use this option if you are not relying on multicast for cluster node discovery. If using this option, set mule.cluster.multicastenabled to false (see next item in this table).


Two nodes listening on port 9000:,

Two nodes listening on port 5701:,


(Boolean) Enable/disable multicast. Set to false if using fixed IP addresses for cluster node discovery (see option mule.cluster.nodes above).


Multicast group IP address to use.


Multicast port number to use.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub