---
schema_version: "1"
id: b3396b80d499a2c0ac01a154be4850588013d7b4fe2c461885bf784e6a6e9c9e
title: CLI for Local Cluster Servers
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/anypoint-cli/3.x/server-clusters.md
canonical_url: https://docs.mulesoft.com/anypoint-cli/3.x/server-clusters
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 23515994dc87cb4f5c1239645b8dfd24daa37df736ee4d1db1510a98b092bd2b
description: MuleSoft Documentation Site
release: 3.x
latest: false
---
---
product: Anypoint CLI
version: 3.x
---

# CLI for Local Cluster Servers

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#runtime-mgr-cluster-add-server">runtime-mgr cluster add server</a></p></div></div></td><td><div><div><p>Adds server to cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-delete">runtime-mgr cluster delete</a></p></div></div></td><td><div><div><p>Deletes cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-list">runtime-mgr cluster list</a></p></div></div></td><td><div><div><p>Lists all clusters in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-remove-server">runtime-mgr cluster remove server</a></p></div></div></td><td><div><div><p>Removes server from a cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-create">runtime-mgr cluster create</a></p></div></div></td><td><div><div><p>Creates new cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-describe">runtime-mgr cluster describe</a></p></div></div></td><td><div><div><p>Describes server cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-modify">runtime-mgr cluster modify</a></p></div></div></td><td><div><div><p>Modifies cluster</p></div></div></td></tr></tbody></table>

## runtime-mgr cluster add server

\> runtime-mgr cluster add server \[options\] <clusterId> <serverId>

This command adds the cluster in `clusterId` to the server passed in `serverId`.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cluster delete

\> runtime-mgr cluster delete \[options\] <clusterId>

This command deletes the cluster passed in `clusterId`.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

> [!WARNING] This command does not prompt twice before deleting. If you send a delete instruction,
> it does not ask for confirmation.

## runtime-mgr cluster list

\> runtime-mgr cluster list \[options\]

This command lists all clusters in the environment.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cluster remove server

\> runtime-mgr cluster remove server \[options\] <clusterId> <serverId>

This command removes the server passed in `serverId` from the cluster passed in `clusterId`.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cluster create

\> runtime-mgr cluster create \[options\] <name>

This command creates a cluster using the id passed in `name`.

Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td><p><code>--multicast</code></p></td><td><p>Whether cluster should be multicast</p></td></tr><tr><td><p><code>--server &lt;id:ip&gt;</code></p></td><td><p>Pair of server ID and IP address. Latter is optional for multicast cluster. Provide multiple values to add multiple servers</p></td></tr></tbody></table>

## runtime-mgr cluster describe

\> runtime-mgr cluster describe \[options\] <clusterId>

This command describes the cluster passed in `clusterId`.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cluster modify

\> runtime-mgr cluster modify \[options\] <clusterId>

This command modifies the cluster passed in `clusterId`.  
In order to update the id for the cluster, you need to pass the `--name` option.

Besides the `--name` option, this command also takes the default `--help`, `-f`/`--fields` and
`-o`/`--output` options.
