epadmin-cluster

epadmin cluster target — Manages StreamBase Runtime clusters.

SYNOPSIS

epadmin [globalparameters] command cluster [commandparameters]

DESCRIPTION

Use the cluster target to display information about a StreamBase Runtime cluster, to remove a node from the cluster, or to wait for remote nodes to be discovered.

The cluster target has three commands:

The designation [sn|ad] in syntax examples is a reminder that this command requires either the global parameter ‑‑servicename or the ‑‑adminport and ‑‑hostname combination to identify the node or cluster of interest.

epadmin display cluster

Displays information about a specified cluster.

For example, for a node named A.uk1.nf in a cluster with another node named B.uk1.nf, the display cluster command will output: 

epadmin --servicename=A.uk1.nf display cluster
[A.uk1.nf] Node Name = B.uk1.nf
[A.uk1.nf] Version = 13
[A.uk1.nf] Network Address = IPv4:Sea-Cliff.local:14135,IPv4:Sea-Cliff.local:14134
[A.uk1.nf] Current State = Up
[A.uk1.nf] Last State Change = 2024-08-19 16:48:01
[A.uk1.nf] Number of Connections = 2
[A.uk1.nf] Number of Queued PDUs = 0
[A.uk1.nf] Discovered = Dynamic
[A.uk1.nf] Location Code = 2868698493477

Use the type parameter to narrow the returned information. Valid values are:

  • classmismatches—Display any class mismatch information between the local and discovered remote nodes.

  • configuration—Display local node configuration information.

  • local—Display local node status information.

  • remote—Display information about discovered remote nodes. 

epadmin [sn|ad] display cluster
epadmin [sn|ad] display cluster --type=configuration
epadmin [sn|ad] display cluster --type=local
epadmin [sn|ad] display cluster --type=remote
epadmin [sn|ad] display cluster --type=classmismatches
Command Parameter Description Required
type Specifies optional information type to display. Valid values are one of classmismatches, configuration, local, or remote. No. The default value is remote.

epadmin remove cluster

Removes a discovered node. This command allows a node to removed from a cluster if it is never going to be part of the cluster again, such as when it was permanently removed from service. 

epadmin [sn|ad] remove cluster --remotenode=A.sbuser
Command Parameter Description Required
remotenode Remote node name. The node must be in the Down state. Yes.

epadmin wait cluster

Waits for remote nodes to be discovered. This command waits for every node specified in the nodes parameter to be specified. The command reports Discovered from every active node in the cluster if the specified nodes are discovered, and eventually reports Undiscovered if not.

For example, for a two node cluster, sbuser, with nodes A and B, consider the following command: 

epadmin --servicename=sbuser wait cluster --remotenode=A.sbuser,B.sbuser,C.sbuser

This command quickly returns the first four lines below for the A and B nodes (one response from each active node), then pauses to discover the C node. After a few moments, the command times out and returns the last two lines, one from each active node. 

[A.sbuser] Discovered node A.sbuser
[A.sbuser] Discovered node B.sbuser
[B.sbuser] Discovered node A.sbuser
[B.sbuser] Discovered node B.sbuser
Unable to discover node C.sbuser: Remote node 'C.sbuser' cannot be accessed, current state is 'Undiscovered'
Unable to discover node C.sbuser: Remote node 'C.sbuser' cannot be accessed, current state is 'Undiscovered'

epadmin [sn|ad] wait cluster --nodes=nodename1,nodename2,...
Command Parameter Description Required
nodes Comma-separated list of nodes without spaces, each node in the form nodename.clustername. Quotes around the list of nodes are accepted but not required. Yes.

SEE ALSO

Help System for epadmin
epadmin(1)
epadmin-globals(1)