Cluster Context

Axigen Documentation

The commands available for the Cluster configuration context are:

  • EXIT/QUIT – exits CLI and closes connection to Axigen

  • HELP – prints this help message

  • BACK – cancels any changes made and switches back to the previous context

  • DONE – saves the changes and switches back to previous context

  • SHOW [ATTR <param>] – shows information about this context

  • SHOW STATUS – Show cluster database statistics

  • SHOW configSynchronizer <configSynchronizerName> – Display current status of a synchronization job

  • SET runMode <standAlone|frontEnd|backEnd> – set current machine running mode in cluster

  • SET clusterKey <string> – Set the key used to identify machines belonging to the same cluster

  • LIST clusterAddresses – List addresses of machines in cluster

  • LIST userMap cache – List entries in user map cache

  • LIST hostDefinition cache – List entries in host definition cache

  • LIST configSynchronizers – List registered cluster configuration synchronizing jobs

  • ADD clusterAddress <address> – Add a machine to cluster

  • REMOVE clusterAddress <address> – Remove a machine from cluster

  • UPDATE userMap cache [userAddres [userAddress...]] – Update entries in user map cache

  • UPDATE hostDefinition cache [hostAddress [hostAddress...]] – Update entries in host definition cache

  • UPDATE config <configSynchronizerName> – Push local configuration to all cluster nodes

  • JOIN <clusterKey> runMode <frontEnd|backEnd> [via <hostAddress>] [as <selfHostAddress>] [waitSync] – Join or create a cluster

Note: The legacy commands LIST backendAddresses, LIST frontendAddresses, ADD backendAddress, ADD frontendAddress, REMOVE backendAddress, and REMOVE frontendAddress are still accepted for backwards compatibility but have been superseded by the unified clusterAddresses / clusterAddress commands.