cluster leave

cluster leave takes a single optional argument: the address of the node we wish to have leave the cluster.

Argument Name

Switches

Mandatory?

Allow Multiple?

Is Flag?

Description

address

-a or -A

no

no

no

The Akka.NET address of the node attempting to leave the cluster. If left blank, the current node will leave. Should be in the form of 'akka[scheme]://[actor system name]@[host]:[port]', i.e. 'akka.tcp://[email protected]:9001'

If the specified node is not already a member of an Akka.NET Cluster, the cluster leave command will fail with an error message.

cluster down

cluster down is a useful tool in scenarios where a node in your cluster have become unreachable and it needs to be manually downed so the cluster can achieve convergence again and begin marking new members as up.

cluster down takes the following arguments:

Argument Name

Switches

Mandatory?

Allow Multiple?

Is Flag?

Description

address

-a or -A

yes

yes

no

The Akka.NET address of the node we're going to attempt to down. Should be in the form of 'akka[scheme]://[actor system name]@[host]:[port]', i.e. 'akka.tcp://[email protected]:9001'

Examples
Downing two unreachable nodes in a cluster via their addresses.

cluster down-unreachable

cluster down-unreachable is special version of the cluster down command that doesn't require the end-user to specify any node addresses. Instead, the currently connected node will automatically down all nodes in the cluster who currently have a status of UNREACHABLE. If there are no unreachable nodes at the time this command is issued, it simply behaves as a no-op.

Examples
Downing two unreachable nodes in a cluster.

pbm [host:port] cluster down-unreachable

cluster show

cluster show can be used to help visualize the current state of the cluster. It will provide the pbm client with the list of all other members of the same cluster as the Petabridge.Cmd.Host and will also include data such as each node's roles, reachability, and address.

Argument Name

Switches

Mandatory?

Allow Multiple?

Is Flag?

Description

role

-r or -R

no

yes

no

Shows only nodes with 1 or more specified role names

status

-s or -S

no

yes

no

SShows only nodes with 1 or more specified member statuses. Valid values are [up, exiting, leaving, joining].

unreachable

u or -U/td>

no

yes

yes

Show only nodes that are UNREACHABLE.

reachable

-a or -A

no

yes

yes

Show only nodes that are REACHABLE.

Examples
Show all nodes in the cluster regardless of status, role, or reachability.

pbm [host:port] cluster show

Show all nodes in the cluster that are unreachable.

pbm [host:port] cluster show -U

Show all nodes in the cluster in role "web" that are unreachable.

pbm [host:port] cluster show -U -r "web"

cluster status

cluster status is a lightweight version of cluster show that shows just the status of the current node the pbm client is connected to. cluster status takes no arguments.

cluster leader

cluster leader will just return the Address of the node who is currently the leader of the cluster. It takes no arguments.