blob: f7009566b278c4b9c5b2cbc952f666d027868e2e [file]
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH QPID-ROUTE "1" "October 2018" "qpid-route (qpid-cpp) version 1.40.0" "User Commands"
.SH NAME
qpid-route \- Management Tool for QPID Routes
.SH SYNOPSIS
qpid-route [OPTIONS] <commands>
.SH DESCRIPTION
Manages QPID routes.
.IP
qpid\-route [OPTIONS] dynamic del <dest\-broker> <src\-broker> <exchange>
.TP
qpid\-route [OPTIONS] route add
<dest\-broker> <src\-broker> <exchange> <routing\-key> [tag] [exclude\-list] [mechanism]
.TP
qpid\-route [OPTIONS] route del
<dest\-broker> <src\-broker> <exchange> <routing\-key>
.TP
qpid\-route [OPTIONS] queue add
<dest\-broker> <src\-broker> <exchange> <queue> [mechanism]
.TP
qpid\-route [OPTIONS] queue del
<dest\-broker> <src\-broker> <exchange> <queue>
.TP
qpid\-route [OPTIONS] route list
[<dest\-broker>]
.IP
qpid\-route [OPTIONS] route flush [<dest\-broker>]
qpid\-route [OPTIONS] route map [<broker>]
.TP
qpid\-route [OPTIONS] link add
<dest\-broker> <src\-broker> [mechanism]
.TP
qpid\-route [OPTIONS] link del
<dest\-broker> <src\-broker>
.IP
qpid\-route [OPTIONS] link list [<dest\-broker>]
.PP
ADDRESS syntax:
.IP
[username/password@] hostname
ip\-address [:<port>]
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-timeout=\fR<secs>
Maximum time to wait for broker connection (in
seconds)
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Verbose output
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Quiet output, don't print duplicate warnings
.TP
\fB\-d\fR, \fB\-\-durable\fR
Added configuration shall be durable
.TP
\fB\-e\fR, \fB\-\-del\-empty\-link\fR
Delete link after deleting last route on the link
.TP
\fB\-s\fR, \fB\-\-src\-local\fR
Make connection to source broker (push route)
.TP
\fB\-\-ack=\fR<n>
Acknowledge transfers over the bridge in batches of N
.TP
\fB\-\-credit=\fR<msgs>
Maximum number of messages a sender can have
outstanding (0=unlimited)
.TP
\fB\-t\fR <transport>, \fB\-\-transport=\fR<transport>
Transport to use for links, defaults to tcp
.TP
\fB\-\-client\-sasl\-mechanism=\fR<mech>
SASL mechanism for authentication (e.g. EXTERNAL,
ANONYMOUS, PLAIN, CRAM\-MD5, DIGEST\-MD5, GSSAPI). Used
when the client connects to the destination broker
(not for authentication between the source and
destination brokers \- that is specified using the
[mechanisms] argument to 'add route'). SASL
automatically picks the most secure available
mechanism \- use this option to override.
.TP
\fB\-\-sasl\-service\-name\fR=\fI\,SASL_SERVICE_NAME\/\fR
SASL service name to use
.TP
\fB\-\-ssl\-certificate=\fR<cert>
Client SSL certificate (PEM Format)
.TP
\fB\-\-ssl\-key=\fR<key>
Client SSL private key (PEM Format)
.TP
\fB\-\-ha\-admin\fR
Allow connection to a HA backup broker.
.SH AUTHOR
The Apache Qpid Project, dev@qpid.apache.org
.SH "REPORTING BUGS"
Please report bugs to users@qpid.apache.org