http://git-wip-us.apache.org/repos/asf/qpid-site/blob/3cbe9ebf/content/releases/qpid-dispatch-master/qdstat.8.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-master/qdstat.8.html b/content/releases/qpid-dispatch-master/qdstat.8.html index 1bfeb2b..7018246 100644 --- a/content/releases/qpid-dispatch-master/qdstat.8.html +++ b/content/releases/qpid-dispatch-master/qdstat.8.html @@ -21,7 +21,7 @@ --> - NAME - Apache Qpid™ + SYNOPSIS - Apache Qpid™ @@ -111,64 +111,89 @@ https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/>
- +
-

NAME

-

qdstat - - show status and statistics for a running 'qdrouterd' -

-

SYNOPSIS

-

qdstat [OPTIONS]

-

DESCRIPTION

-

Shows status information about networks of Dispatch routers. It can display -connections, network nodes and links, and router stats such as memory use.

-

OPTIONS

-

-h, --help -: show this help message and exit

-

--version -: Print version and exit.

-

-g, --general -: Show General Router Stats

-

-c, --connections -: Show Connections

-

-l, --links -: Show Router Links

-

-n, --nodes -: Show Router Nodes

-

-a, --address -: Show Router Addresses

-

-m, --memory -: Show Router Memory Stats

-

--autolinks -: Show Auto Links

-

--linkroutes -: Show Link Routes

-

-v, --verbose -: Show maximum detail

-

--log -: Show recent log entries

-

--limit=LIMIT -: Limit number of log entries

-

Connection Options

-

-b URL, --bus=URL -: URL of the messaging bus to connect to (default 0.0.0.0)

-

-r ROUTER-ID, --router=ROUTER-ID -: Router to be queried

-

-t SECS, --timeout=SECS -: Maximum time to wait for connection in seconds (default 5)

-

--ssl-certificate=CERT -: Client SSL certificate (PEM Format)

-

--ssl-key=KEY -: Client SSL private key (PEM Format)

-

--ssl-trustfile=TRUSTED-CA-DB -: Trusted Certificate Authority Database file (PEM Format)

-

--ssl-password=PASSWORD -: Certificate password, will be prompted if not specifed.

-

OUTPUT COLUMNS

-

qdstat -c

-
-
+
+

SYNOPSIS

+
+

qdstat [OPTIONS]

+
+
+
+

DESCRIPTION

+
+

Shows status information about networks of Dispatch routers. It can display +connections, network nodes and links, and router stats such as memory use.

+
+
+
+

OPTIONS

+
+

-h, --help +: show this help message and exit

+

--version +: Print version and exit.

+

-g, --general +: Show General Router Stats

+

-c, --connections +: Show Connections

+

-l, --links +: Show Router Links

+

-n, --nodes +: Show Router Nodes

+

-a, --address +: Show Router Addresses

+

-m, --memory +: Show Router Memory Stats

+

--autolinks +: Show Auto Links

+

--linkroutes +: Show Link Routes

+

-v, --verbose +: Show maximum detail

+

--log +: Show recent log entries

+

--limit=LIMIT +: Limit number of log entries

+
+

Connection Options

+

-b URL, --bus=URL +: URL of the messaging bus to connect to (default 0.0.0.0)

+

-r ROUTER-ID, --router=ROUTER-ID +: Router to be queried

+

-t SECS, --timeout=SECS +: Maximum time to wait for connection in seconds (default 5)

+

--ssl-certificate=CERT +: Client SSL certificate (PEM Format)

+

--ssl-key=KEY +: Client SSL private key (PEM Format)

+

--ssl-trustfile=TRUSTED-CA-DB +: Trusted Certificate Authority Database file (PEM Format)

+

--ssl-password=PASSWORD +: Certificate password, will be prompted if not specifed.

+

--ssl-password-file=SSL-PASSWORD-FILE +: Certificate password, will be prompted if not specifed.

+

--sasl-mechanisms=SASL-MECHANISMS +: Allowed sasl mechanisms to be supplied during the sasl handshake.

+

--sasl-username=SASL-USERNAME +: User name for SASL plain authentication

+

--sasl-password=SASL-PASSWORD +: Password for SASL plain authentication

+

--sasl-password-file=SASL-PASSWORD-FILE +: Password for SASL plain authentication

+

--ssl-disable-peer-name-verify +: Disables SSL peer name verification. WARNING - This option is insecure and must not be used in production environments

+
+
+
+
+

OUTPUT COLUMNS

+
+
+

qdstat -c

+
+
id
@@ -176,7 +201,7 @@ id Unique connection identifier

-
+
host
@@ -184,7 +209,7 @@ host The hostname or internet address of the remotely connected AMQP container

-
+
container
@@ -192,14 +217,14 @@ container The container-name of the remotely connected AMQP container

-
+
role

The configured role of the connection

-
    +
    • normal - Normal connections from client to router @@ -215,16 +240,16 @@ inter-router - Connection between routers to form a network route-container - Connection to/from a Broker or other host to receive link-routes and waypoints

    • -
    +
-
+
dir

The direction of connection establishment

-
    +
    • in - The connection was initiated by the remote container @@ -235,9 +260,9 @@ in - The connection was initiated by the remote container out - The connection was initiated by this router

    • -
    +
-
+
security
@@ -246,7 +271,7 @@ A description of the security/encryption in effect for this connection

-
+
authentication
@@ -255,17 +280,19 @@ The method and user-id of the authenticated user for this connection

- -

qdstat -l

-
-
+
+ +
+

qdstat -l

+
+
type

Type of link

-
    +
    • router-control - An inter-router link that is reserved for control messages exchanged between routers @@ -281,16 +308,16 @@ inter-router - An inter-router link that is used for normal message-routed deliv endpoint - A normal link to an external endpoint container

    • -
    +
-
+
dir

The direction of message flow on the link

-
-
+
conn id
@@ -312,7 +339,7 @@ Unique identifier of the connection over which this link is attached

-
+
id
@@ -320,7 +347,7 @@ id Unique identifier of this link

-
+
peer
@@ -329,7 +356,7 @@ For link-routed links, the unique identifier of the peer link. In link routing, an inbound link is paired with an outbound link

-
+
class
@@ -337,7 +364,7 @@ class Class of the address bound to the link

-
+
addr
@@ -345,7 +372,7 @@ addr The address bound to the link

-
+
phs
@@ -353,7 +380,7 @@ phs The phase of the address bound to the link

-
+
cap
@@ -361,7 +388,7 @@ cap The capacity, in deliveries, of the link

-
+
undel
@@ -369,7 +396,7 @@ undel The number of undelivered messages stored on the link’s FIFO

-
+
unsettled
@@ -377,7 +404,7 @@ unsettled The number of unsettled deliveries being tracked by the link

-
+
deliveries
@@ -385,14 +412,14 @@ deliveries The total number of deliveries that have transited this link

-
+
admin

The administrative status of the link

-
-
+
oper

The operational status of the link

-
-
+
name
@@ -443,10 +470,11 @@ name The link name (only shown if the -v option is provided)

- -

qdstat -n

-
-
+
+
+

qdstat -n

+
+
router-id
@@ -454,7 +482,7 @@ router-id Identifier of the router

-
+
next-hop
@@ -462,7 +490,7 @@ next-hop If this router is not a neighbor, identifies the next-hop neighbor used to reach this router

-
+
link
@@ -470,7 +498,7 @@ link Unique identifier of the link to the neighbor router

-
+
cost
@@ -478,7 +506,7 @@ cost The topology cost to this remote router (with -v option only)

-
+
neighbors
@@ -486,7 +514,7 @@ neighbors The list of neighbor routers (the router’s link-state) (with -v option only)

-
+
valid-origins
@@ -494,17 +522,20 @@ valid-origins The list of origin routers for which the best path to the listed router passes through this router (with -v option only)

-
-

qdstat -a

-
-
+
+
+ +
+

qdstat -a

+
+
class

The class of the listed address

-
    +
    • local - Address that is local to this router @@ -525,9 +556,9 @@ router - A summary router address used to route messages to a remote router̵ mobile - A mobile address for an attached consumer or producer

    • -
    +
-
+
addr
@@ -535,7 +566,7 @@ addr The address text

-
+
phs
@@ -543,14 +574,14 @@ phs For mobile addresses only, the phase of the address. Direct addresses have only a phase 0. Waypoint addresses have multiple phases, normally 0 and 1.

-
+
distrib

Distribution method used for this address

-
-
+
in-proc
@@ -581,7 +612,7 @@ in-proc The number of in-process consumers for this address

-
+
local
@@ -589,7 +620,7 @@ local The number of local (on this router) consumers for this address

-
+
remote
@@ -597,7 +628,7 @@ remote The number of remote routers that have at least one consumer for this address

-
+
cntnr
@@ -605,7 +636,7 @@ cntnr The number of locally attached containers that are destinations for link-routes on this address

-
+
in
@@ -613,7 +644,7 @@ in The number of deliveries for this address that entered the network on this router

-
+
out
@@ -621,7 +652,7 @@ out The number of deliveries for this address that exited the network on this router

-
+
thru
@@ -629,7 +660,7 @@ thru The number of deliveries for this address that were forwarded to other routers

-
+
to-proc
@@ -637,7 +668,7 @@ to-proc The number of deliveries for this address that were delivered to an in-process consumer

-
+
from-proc
@@ -645,10 +676,12 @@ from-proc The number of deliveries for this address that were received from an in-process producer

- -

qdstat --linkroutes

-
-
+
+ +
+

qdstat --linkroutes

+
+
prefix
@@ -656,7 +689,7 @@ prefix The prefix for matching addresses of routed links

-
+
dir
@@ -664,29 +697,29 @@ dir The direction (from the router’s perspective) of matching links

-
+
distrib

The distribution method used for routed links

-
    +
    • linkBalanced - the only supported distribution for routed links

    • -
    +
-
+
status

Operational status of the link route

-
- -

qstat --autolinks

-
-
+
+ +
+ +
+
addr
@@ -710,14 +745,14 @@ addr The address of the auto link

-
+
dir

The direction of message flow for the auto link

-
    +
    • in - Messages flow in from the route-container to the router network @@ -728,9 +763,9 @@ in - Messages flow in from the route-container to the router network out - Messages flow out to the route-container from the router network

    • -
    +
-
+
phs
@@ -738,7 +773,7 @@ phs Phase of the address for this auto link

-
+
link
@@ -746,14 +781,14 @@ link Unique identifier of the link managed by this auto link

-
+
status

The operational status of this auto link

-
-
+
lastErr
@@ -794,10 +829,17 @@ lastErr The description of the last attach failure that occurred on this auto link

- -

SEE ALSO

-

qdrouterd(8), qdmanage(8), qdrouterd.conf(5)

-

http://qpid.apache.org/components/dispatch-router

+ + + + +
+

SEE ALSO

+
+

qdrouterd(8), qdmanage(8), qdrouterd.conf(5)

+ +
+

--------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org For additional commands, e-mail: commits-help@qpid.apache.org