Technical References

3-27
CLI Reference Guide for AsyncOS 9.7 for Cisco Email Security Appliances
Chapter 3 The Commands: Reference Examples
Cluster Management
• clusterconfig join [--port=xx] <ip_of_remote_cluster> [<admin_password>]<groupname>
—
This will add this machine to a cluster.
<ip_of_remote_cluster> - The IP address of another machine in the cluster.
<admin_password >- The admin password of the cluster. This should not be
specified if joining over CCS.
<groupname> - The name of the group to join.
<port> - The port of the remote machine to connect to (defaults to 22).
• clusterconfig prepjoin print
This will display the information needed to prepare the joining of this machine to a cluster over a CCS
port.
Cluster Commands
The following commands are available when you are in a cluster.
• clusterconfig addgroup <groupname> — Creates a new cluster group. The group starts off with
no members.
• clusterconfig renamegroup <old_groupname> <new_groupname> — Change the name of a cluster
group.
• clusterconfig deletegroup <groupname> [new_groupname] — Remove a cluster group.
<groupname> - Name of the cluster group to remove.
<new_groupname> - The cluster group to put machines of the old group into.
• clusterconfig setgroup <machinename> <groupname> — Sets (or changes) which group a
machine is a member of.
<machinename> - The name of the machine to set.
<groupname> - The group to set the machine to.
• clusterconfig removemachine <machinename> — Remove a machine from the cluster.
• clusterconfig setname <name> — Changes the name of the cluster to the given name.
• clusterconfig list — Display all the machines currently in the cluster.
• clusterconfig connstatus — Display all the machines currently in the cluster and add routing
details for disconnected machines.
• clusterconfig disconnect <machinename> — This will temporarily detach a machine from the
cluster.
<machinename> - The name of the machine to disconnect.
• clusterconfig reconnect <machinename> - This will restore connections with machines that
were detached with the “disconnect” command.
• clusterconfig prepjoin new <serial_number> <hostname> <user_key> — This will add a new
host that is to join the cluster over the CCSport.
<serial_number> - The serial number of the machine being added.
<hostname> - The host name of the machine being added.