usage: akka <subcommand> <arguments>

This command allows you to manage Akka clusters. For further information on Akka clusters, see 1.7 Akka Cluster in the System Administration guide.

The akka command has eight subcommands: cluster-status, down, is-available, is-singleton, leaders, members, member-status and unreachable. You must provide the name of the cluster and an SC in regex for all of the subcommands.

You can use the following subcommands with the akka command:

• cluster-status
• down
• is-available
• is-singleton
• leader
• members
• member-status
• unreachable

Arguments

cluster-status

usage: akka cluster-status <cluster name> <sc in regex>

Use akka cluster-status to get the current status for a specific akka cluster, e g information is provided on the member ring, available nodes, meta data etc. 

$ mzsh akka cluster-status si sc5

{
  "sc5": {
    "leader": "akka.tcp://si@172.27.239.120:6101",
    "members": [{
      "address": "akka.tcp://si@172.27.239.120:6101",
      "roles": ["si"]
    }],
    "unreachable": [],
    "roles": [{
      "name": "si",
      "leader": "akka.tcp://si@172.27.239.120:6101"
    }]
  }
}

down

usage: akka down <cluster name> <sc in regex> <cluster node address>

Use akka down to send a request to mark the node with the address that you provide as DOWN. For example, if one node in a cluster fails in a cluster of several nodes, you can tell the reachable nodes to remove the unreachable node using this command. For an example scenario, see 2.7.6 Managing Akka Cluster Failure.

$ mzsh akka down si sc5 akka.tcp://si@172.17.0.1:6151

is-available

usage: akka is-available <cluster name> <sc in regex>

Use akka is-available to find out if the availability of a node or nodes on a specific cluster. The output that you receive is true or false.

is-singleton

usage: akka is-singleton <cluster name> <sc in regex>

Use akka is-singlementon to find out if a specific cluster has a single node or not. The output that you receive is true or false.

leader

usage: akka leader <cluster name> <sc in regex

Use akka leader to find out who the current leader is for a cluster. The cluster address of the leader is returned.

$ mzsh akka leader akka-trace-cluster ".*"

"sc1": "akka.tcp://akka-trace-cluster@172.27.239.120:5501"
"sc2": "akka.tcp://akka-trace-cluster@172.27.239.120:5501"
"sc3": "akka.tcp://akka-trace-cluster@172.27.239.120:5501"

members

usage: akka members <cluster name> <sc in regex>

Use akka members to list the addresses of the members for a specific cluster.

$ mzsh akka members akka-trace-cluster sc1

{
  "sc1": [{
    "address": "akka.tcp://akka-trace-cluster@172.27.239.120:5501",
    "roles": ["default"]
  }, {
    "address": "akka.tcp://akka-trace-cluster@172.27.239.120:5551",
    "roles": ["default"]
  }, {
    "address": "akka.tcp://akka-trace-cluster@172.27.239.120:5601",
    "roles": ["default"]
  }, {
    "address": "akka.tcp://akka-trace-cluster@172.27.239.120:6051",
    "roles": ["default"]
  }]
}

member-status

usage: akka member-status <cluster name> <sc in regex>

Use akka member-status to request the current status of a member node or member nodes. The output that you receive is Up or Down.

unreachable

usage: akka unreachable <cluster name> <sc in regex>

Use akka unreachable to find out which members of a specific cluster are unreachable. 

Return Codes

Listed below are the different return codes for the akka command: