9.2. Cluster management
9.2.1. Cluster Management using qpid-ha
qpid-ha
is a command-line utility that allows you to view information on a cluster and its brokers, disconnect a client connection, shut down a broker in a cluster, or shut down the entire cluster. It accepts a command and options.
qpid-ha
has the following commands and parameters:
Commands
- status
- Print HA status. Returns information whether the specified broker is acting as a primary (active) or a backup (ready). With the
--all
option will list the whole cluster.Examples:# qpid-ha status ready # qpid-ha status --all 192.168.6.60:5672 ready 192.168.6.61:5672 active 192.168.6.62:5672 ready
- ping
- Check if the broker is alive and responding.
- query
- Print HA configuration and status. The following information is returned:
- broker status: primary (active) or backup (ready).
- list of HA broker URLs
- public (virtual) HA URL
- replication status
Example:# qpid-ha query Status: ready Brokers URL: amqp:tcp:192.168.6.60:5672,tcp:192.168.6.61:5672,tcp:192.168.6.62:5672 Public URL: amqp:tcp:192.168.6.251:5672 Replicate: all
- replicate
- Set up replication from <queue> on <remote-broker> to <queue> on the current broker.
Parameters
- --broker=BROKER
- The address of qpidd broker. The syntax is shown below:
[username/password@] hostname | ip-address [:port]
- --sasl-mechanism=SASL_MECH
- SASL mechanism for authentication (e.g. EXTERNAL, ANONYMOUS, PLAIN, CRAM-MD5, DIGEST-MD5, GSSAPI). SASL automatically picks the most secure available mechanism - use this option to override.
- --ssl-certificate=SSL_CERT
- Client SSL certificate (PEM Format).
- --config=CONFIG
- Connect to the local qpidd by reading its configuration file (
/etc/qpid/qpidd.conf
, for example) . - --timeout=SECONDS
- Give up if the broker does not respond within the timeout.
0
means wait forever. The default is10.0
. - --ssl-key=KEY
- Client SSL private key (PEM Format)
- --help-all
- Outputs all of the above commands and parameters.
Each command accepts a variety of options. You can see the options using the
--help-all
option:
$ qpid-ha --help-all