How to connect to TIBCO BusinessEvents cluster through as-admin?

How to connect to TIBCO BusinessEvents cluster through as-admin?

book

Article ID: KB0082097

calendar_today

Updated On:

Products Versions
TIBCO BusinessEvents Enterprise Edition 5.2.2, 5.3.0, 5.4.x, 5.5.0

Description

When you install TIBCO ActiveSpaces which is default cache provider and a pre-requisite for TIBCO BusinessEvents clusters you will get as-admin utility inside the AS_HOME/bin folder and an executable JAR in AS_HOME/lib.

You can use the admin CLI to connect to your TIBCO BusinessEvents cluster and collect useful information to help gather important cluster specific details.

Issue/Introduction

How to use as-admin to connect to TIBCO BusinessEvents cluster and execute basic commands

Environment

All Supported Environments

Resolution

Detailed instructions to connect to cluster and collect as-admin stats:

1. Set environment:

Windows
set AS_HOME=<TIBCO_HOME>/as/<version>
set PATH=%AS_HOME%/lib;%PATH%
Linux
export AS_HOME=<TIBCO_HOME>/as/<version>
export LD_LIBRARY_PATH=$AS_HOME/lib:$LD_LIBRARY_PATH

2. Run as-admin executable in AS_HOME/bin folder or in case of older versions as-admin.jar in AS_HOME/lib folder (java -jar as-admin.jar)

3. connect to your cluster using following simple command at as-admin command prompt
as-admin> connect name "<Cluster_Name>" discovery "<Discovery_URL>" listen "<Listen_URL_For_As_Admin>"
Full Syntax:
connect [name <string>] [discovery <string>] [listen <string>] 
[member_name <string>] [security_token <string>] 
[security_policy <string>] [identity_password <string>]
[authentication_domain <string>]
[authentication_username <string>]
[authentication_password <string>]
[authentication_keyfile <string>]
4. Once connected you an run sample commands to get necessary details.

     Show Members
as-admin> show members
Lists all members (including as-admin) which are part of the cluster
     Show Spaces
as-admin> show spaces
Lists all the spaces
    Show Space
as-admin> show space "<space_name>"
This will give you information on number of entries, replicas and specific operation summary on specific space.

     qldump
as-admin>qldump
qldump lists all the spaces and their recovery status.
The following columns make up result of "qldump" command:

*State: Space state

*Recovery policy: Recovery policy you used for your last recovery(you can find more details in document for recovery policies), default for TIBCO BusinessEvents cluster is no_data_loss

*Seed: shows if seed is okay.

*Quorum: shows if last recovery matched the recovery quorum

* Persist: shows if persist is okay.

*Loaded:shows if data loaded from persistent file

*DataLost: shows if any data loss for the last recovery

*LoadOk: shows if the last load is successfully loaded

*View: we have View number for all persistent file to sync the persistent files.

*Seeders: shows how many seeders joined space

*Quorum: shows the quorum you used for last recovery

*Exception: shows if any exceptions during recovery
 
Note: The usage information for as-admin can be obtained by invoking as-admin -help from the ActiveSpaces bin directory in a command window.

Additional Information

https://docs.tibco.com/pub/activespaces/2.3.0/doc/html/GUID-6BE67372-9D9F-4FC7-BF6D-FEAC52FFF13F.html