qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gmur...@apache.org
Subject [1/7] qpid-site git commit: NO-JIRA - Updated qpid-dispatch-master documentation
Date Mon, 08 Aug 2016 14:00:17 GMT
Repository: qpid-site
Updated Branches:
  refs/heads/asf-site d6ae1f10e -> 3cbe9ebf0


http://git-wip-us.apache.org/repos/asf/qpid-site/blob/3cbe9ebf/input/releases/qpid-dispatch-master/qdstat.8.html.in
----------------------------------------------------------------------
diff --git a/input/releases/qpid-dispatch-master/qdstat.8.html.in b/input/releases/qpid-dispatch-master/qdstat.8.html.in
index 9a8bd4c..c33ee2f 100644
--- a/input/releases/qpid-dispatch-master/qdstat.8.html.in
+++ b/input/releases/qpid-dispatch-master/qdstat.8.html.in
@@ -1,58 +1,83 @@
-<h2>NAME</h2>
-<p>qdstat -
-   show status and statistics for a running 'qdrouterd'
-</p>
-<h2><a name="_synopsis"></a>SYNOPSIS</h2>
-<p><strong>qdstat</strong> [<b>OPTIONS</b>]</p>
-<h2><a name="_description"></a>DESCRIPTION</h2>
-<p>Shows status information about networks of Dispatch routers. It can display
-connections, network nodes and links, and router stats such as memory use.</p>
-<h2><a name="_options"></a>OPTIONS</h2>
-<p>-h, --help
-:   show this help message and exit</p>
-<p>--version
-:   Print version and exit.</p>
-<p>-g, --general
-:   Show General Router Stats</p>
-<p>-c, --connections
-:   Show Connections</p>
-<p>-l, --links
-:   Show Router Links</p>
-<p>-n, --nodes
-:   Show Router Nodes</p>
-<p>-a, --address
-:   Show Router Addresses</p>
-<p>-m, --memory
-:   Show Router Memory Stats</p>
-<p>--autolinks
-:   Show Auto Links</p>
-<p>--linkroutes
-:   Show Link Routes</p>
-<p>-v, --verbose
-:   Show maximum detail</p>
-<p>--log
-:   Show recent log entries</p>
-<p>--limit=LIMIT
-:   Limit number of log entries</p>
-<h3><a name="_connection_options"></a>Connection Options</h3>
-<p>-b URL, --bus=URL
-:   URL of the messaging bus to connect to (default 0.0.0.0)</p>
-<p>-r ROUTER-ID, --router=ROUTER-ID
-:   Router to be queried</p>
-<p>-t SECS, --timeout=SECS
-:   Maximum time to wait for connection in seconds (default 5)</p>
-<p>--ssl-certificate=CERT
-:   Client SSL certificate (PEM Format)</p>
-<p>--ssl-key=KEY
-:   Client SSL private key (PEM Format)</p>
-<p>--ssl-trustfile=TRUSTED-CA-DB
-:   Trusted Certificate Authority Database file (PEM Format)</p>
-<p>--ssl-password=PASSWORD
-:   Certificate password, will be prompted if not specifed.</p>
-<h2><a name="_output_columns"></a>OUTPUT COLUMNS</h2>
-<h3><a name="_qdstat_c"></a>qdstat -c</h3>
-<dl>
-<dt>
+<div class="sect1">
+<h2 id="_synopsis">SYNOPSIS</h2>
+<div class="sectionbody">
+<div class="paragraph"><p><strong>qdstat</strong> [<em>OPTIONS</em>]</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_description">DESCRIPTION</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Shows status information about networks of Dispatch
routers. It can display
+connections, network nodes and links, and router stats such as memory use.</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_options">OPTIONS</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>-h, --help
+:   show this help message and exit</p></div>
+<div class="paragraph"><p>--version
+:   Print version and exit.</p></div>
+<div class="paragraph"><p>-g, --general
+:   Show General Router Stats</p></div>
+<div class="paragraph"><p>-c, --connections
+:   Show Connections</p></div>
+<div class="paragraph"><p>-l, --links
+:   Show Router Links</p></div>
+<div class="paragraph"><p>-n, --nodes
+:   Show Router Nodes</p></div>
+<div class="paragraph"><p>-a, --address
+:   Show Router Addresses</p></div>
+<div class="paragraph"><p>-m, --memory
+:   Show Router Memory Stats</p></div>
+<div class="paragraph"><p>--autolinks
+:   Show Auto Links</p></div>
+<div class="paragraph"><p>--linkroutes
+:   Show Link Routes</p></div>
+<div class="paragraph"><p>-v, --verbose
+:   Show maximum detail</p></div>
+<div class="paragraph"><p>--log
+:   Show recent log entries</p></div>
+<div class="paragraph"><p>--limit=LIMIT
+:   Limit number of log entries</p></div>
+<div class="sect2">
+<h3 id="_connection_options">Connection Options</h3>
+<div class="paragraph"><p>-b URL, --bus=URL
+:   URL of the messaging bus to connect to (default 0.0.0.0)</p></div>
+<div class="paragraph"><p>-r ROUTER-ID, --router=ROUTER-ID
+:   Router to be queried</p></div>
+<div class="paragraph"><p>-t SECS, --timeout=SECS
+:   Maximum time to wait for connection in seconds (default 5)</p></div>
+<div class="paragraph"><p>--ssl-certificate=CERT
+:   Client SSL certificate (PEM Format)</p></div>
+<div class="paragraph"><p>--ssl-key=KEY
+:   Client SSL private key (PEM Format)</p></div>
+<div class="paragraph"><p>--ssl-trustfile=TRUSTED-CA-DB
+:   Trusted Certificate Authority Database file (PEM Format)</p></div>
+<div class="paragraph"><p>--ssl-password=PASSWORD
+:   Certificate password, will be prompted if not specifed.</p></div>
+<div class="paragraph"><p>--ssl-password-file=SSL-PASSWORD-FILE
+:   Certificate password, will be prompted if not specifed.</p></div>
+<div class="paragraph"><p>--sasl-mechanisms=SASL-MECHANISMS
+:   Allowed sasl mechanisms to be supplied during the sasl handshake.</p></div>
+<div class="paragraph"><p>--sasl-username=SASL-USERNAME
+:   User name for SASL plain authentication</p></div>
+<div class="paragraph"><p>--sasl-password=SASL-PASSWORD
+:   Password for SASL plain authentication</p></div>
+<div class="paragraph"><p>--sasl-password-file=SASL-PASSWORD-FILE
+:   Password for SASL plain authentication</p></div>
+<div class="paragraph"><p>--ssl-disable-peer-name-verify
+:   Disables SSL peer name verification. WARNING - This option is insecure and must not be
used in production environments</p></div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_output_columns">OUTPUT COLUMNS</h2>
+<div class="sectionbody">
+<div class="sect2">
+<h3 id="_qdstat_c">qdstat -c</h3>
+<div class="dlist"><dl>
+<dt class="hdlist1">
 id
 </dt>
 <dd>
@@ -60,7 +85,7 @@ id
 Unique connection identifier
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 host
 </dt>
 <dd>
@@ -68,7 +93,7 @@ host
 The hostname or internet address of the remotely connected AMQP container
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 container
 </dt>
 <dd>
@@ -76,14 +101,14 @@ container
 The container-name of the remotely connected AMQP container
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 role
 </dt>
 <dd>
 <p>
 The configured role of the connection
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 normal - Normal connections from client to router
@@ -99,16 +124,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
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 dir
 </dt>
 <dd>
 <p>
 The direction of connection establishment
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 in - The connection was initiated by the remote container
@@ -119,9 +144,9 @@ in - The connection was initiated by the remote container
 out - The connection was initiated by this router
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 security
 </dt>
 <dd>
@@ -130,7 +155,7 @@ A description of the security/encryption in effect for this
 connection
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 authentication
 </dt>
 <dd>
@@ -139,17 +164,19 @@ The method and user-id of the authenticated user for
 this connection
 </p>
 </dd>
-</dl>
-<h3><a name="_qdstat_l"></a>qdstat -l</h3>
-<dl>
-<dt>
+</dl></div>
+</div>
+<div class="sect2">
+<h3 id="_qdstat_l">qdstat -l</h3>
+<div class="dlist"><dl>
+<dt class="hdlist1">
 type
 </dt>
 <dd>
 <p>
 Type of link
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 router-control - An inter-router link that is reserved for control messages exchanged between
routers
@@ -165,16 +192,16 @@ inter-router - An inter-router link that is used for normal message-routed
deliv
 endpoint - A normal link to an external endpoint container
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 dir
 </dt>
 <dd>
 <p>
 The direction of message flow on the link
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 in - Deliveries flow inbound to the router
@@ -185,9 +212,9 @@ in - Deliveries flow inbound to the router
 out - Deliveries flow outbound from the router
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 conn id
 </dt>
 <dd>
@@ -196,7 +223,7 @@ Unique identifier of the connection over which this link is
 attached
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 id
 </dt>
 <dd>
@@ -204,7 +231,7 @@ id
 Unique identifier of this link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 peer
 </dt>
 <dd>
@@ -213,7 +240,7 @@ For link-routed links, the unique identifier of the peer link. In
 link routing, an inbound link is paired with an outbound link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 class
 </dt>
 <dd>
@@ -221,7 +248,7 @@ class
 Class of the address bound to the link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 addr
 </dt>
 <dd>
@@ -229,7 +256,7 @@ addr
 The address bound to the link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 phs
 </dt>
 <dd>
@@ -237,7 +264,7 @@ phs
 The phase of the address bound to the link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 cap
 </dt>
 <dd>
@@ -245,7 +272,7 @@ cap
 The capacity, in deliveries, of the link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 undel
 </dt>
 <dd>
@@ -253,7 +280,7 @@ undel
 The number of undelivered messages stored on the link&#8217;s FIFO
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 unsettled
 </dt>
 <dd>
@@ -261,7 +288,7 @@ unsettled
 The number of unsettled deliveries being tracked by the link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 deliveries
 </dt>
 <dd>
@@ -269,14 +296,14 @@ deliveries
 The total number of deliveries that have transited this link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 admin
 </dt>
 <dd>
 <p>
 The administrative status of the link
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 enabled - The link is enabled for normal operation
@@ -287,16 +314,16 @@ enabled - The link is enabled for normal operation
 disabled - The link is disabled and should be quiescing or stopped (not yet supported)
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 oper
 </dt>
 <dd>
 <p>
 The operational status of the link
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 up - The link is operational
@@ -317,9 +344,9 @@ quiescing - The link is in the process of quiescing (not yet supported)
 idle - The link has completed quiescing and is idle (not yet supported)
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 name
 </dt>
 <dd>
@@ -327,10 +354,11 @@ name
 The link name (only shown if the -v option is provided)
 </p>
 </dd>
-</dl>
-<h4><a name="_qdstat_n"></a>qdstat -n</h4>
-<dl>
-<dt>
+</dl></div>
+<div class="sect3">
+<h4 id="_qdstat_n">qdstat -n</h4>
+<div class="dlist"><dl>
+<dt class="hdlist1">
 router-id
 </dt>
 <dd>
@@ -338,7 +366,7 @@ router-id
 Identifier of the router
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 next-hop
 </dt>
 <dd>
@@ -346,7 +374,7 @@ next-hop
 If this router is not a neighbor, identifies the next-hop neighbor used to reach this router
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 link
 </dt>
 <dd>
@@ -354,7 +382,7 @@ link
 Unique identifier of the link to the neighbor router
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 cost
 </dt>
 <dd>
@@ -362,7 +390,7 @@ cost
 The topology cost to this remote router (with -v option only)
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 neighbors
 </dt>
 <dd>
@@ -370,7 +398,7 @@ neighbors
 The list of neighbor routers (the router&#8217;s link-state) (with -v option only)
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 valid-origins
 </dt>
 <dd>
@@ -378,17 +406,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)
 </p>
 </dd>
-</dl>
-<h3><a name="_qdstat_a"></a>qdstat -a</h3>
-<dl>
-<dt>
+</dl></div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_qdstat_a">qdstat -a</h3>
+<div class="dlist"><dl>
+<dt class="hdlist1">
 class
 </dt>
 <dd>
 <p>
 The class of the listed address
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 local - Address that is local to this router
@@ -409,9 +440,9 @@ router - A summary router address used to route messages to a remote router&#821
 mobile - A mobile address for an attached consumer or producer
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 addr
 </dt>
 <dd>
@@ -419,7 +450,7 @@ addr
 The address text
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 phs
 </dt>
 <dd>
@@ -427,14 +458,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.
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 distrib
 </dt>
 <dd>
 <p>
 Distribution method used for this address
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 multicast - A copy of each message is delivered once to each consumer for the address
@@ -455,9 +486,9 @@ balanced - Each message is delivered to only one consumer for the address.
 The
 flood - Used only for router-control traffic.  This is multicast without prevention of duplicate
deliveries.
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 in-proc
 </dt>
 <dd>
@@ -465,7 +496,7 @@ in-proc
 The number of in-process consumers for this address
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 local
 </dt>
 <dd>
@@ -473,7 +504,7 @@ local
 The number of local (on this router) consumers for this address
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 remote
 </dt>
 <dd>
@@ -481,7 +512,7 @@ remote
 The number of remote routers that have at least one consumer for this address
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 cntnr
 </dt>
 <dd>
@@ -489,7 +520,7 @@ cntnr
 The number of locally attached containers that are destinations for link-routes on this address
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 in
 </dt>
 <dd>
@@ -497,7 +528,7 @@ in
 The number of deliveries for this address that entered the network on this router
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 out
 </dt>
 <dd>
@@ -505,7 +536,7 @@ out
 The number of deliveries for this address that exited the network on this router
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 thru
 </dt>
 <dd>
@@ -513,7 +544,7 @@ thru
 The number of deliveries for this address that were forwarded to other routers
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 to-proc
 </dt>
 <dd>
@@ -521,7 +552,7 @@ to-proc
 The number of deliveries for this address that were delivered to an in-process consumer
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 from-proc
 </dt>
 <dd>
@@ -529,10 +560,12 @@ from-proc
 The number of deliveries for this address that were received from an in-process producer
 </p>
 </dd>
-</dl>
-<h3><a name="_qdstat_linkroutes"></a>qdstat --linkroutes</h3>
-<dl>
-<dt>
+</dl></div>
+</div>
+<div class="sect2">
+<h3 id="_qdstat_linkroutes">qdstat --linkroutes</h3>
+<div class="dlist"><dl>
+<dt class="hdlist1">
 prefix
 </dt>
 <dd>
@@ -540,7 +573,7 @@ prefix
 The prefix for matching addresses of routed links
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 dir
 </dt>
 <dd>
@@ -548,29 +581,29 @@ dir
 The direction (from the router&#8217;s perspective) of matching links
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 distrib
 </dt>
 <dd>
 <p>
 The distribution method used for routed links
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 linkBalanced - the only supported distribution for routed links
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 status
 </dt>
 <dd>
 <p>
 Operational status of the link route
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 active - Route is actively routing attaches (i.e. ready for use)
@@ -581,12 +614,14 @@ active - Route is actively routing attaches (i.e. ready for use)
 inactive - Route is inactive because there is no local destination connected
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-</dl>
-<h3><a name="_qstat_autolinks"></a>qstat --autolinks</h3>
-<dl>
-<dt>
+</dl></div>
+</div>
+<div class="sect2">
+<h3 id="_qstat_autolinks">qstat --autolinks</h3>
+<div class="dlist"><dl>
+<dt class="hdlist1">
 addr
 </dt>
 <dd>
@@ -594,14 +629,14 @@ addr
 The address of the auto link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 dir
 </dt>
 <dd>
 <p>
 The direction of message flow for the auto link
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 in - Messages flow in from the route-container to the router network
@@ -612,9 +647,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
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 phs
 </dt>
 <dd>
@@ -622,7 +657,7 @@ phs
 Phase of the address for this auto link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 link
 </dt>
 <dd>
@@ -630,14 +665,14 @@ link
 Unique identifier of the link managed by this auto link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 status
 </dt>
 <dd>
 <p>
 The operational status of this auto link
 </p>
-<ul>
+<div class="ulist"><ul>
 <li>
 <p>
 inactive - There is no connected container for this auto link
@@ -668,9 +703,9 @@ quiescing - The link is quiescing (not yet supported)
 idle - The link is idle (not yet supported)
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 lastErr
 </dt>
 <dd>
@@ -678,7 +713,14 @@ lastErr
 The description of the last attach failure that occurred on this auto link
 </p>
 </dd>
-</dl>
-<h2><a name="_see_also"></a>SEE ALSO</h2>
-<p><b>qdrouterd(8)</b>, <b>qdmanage(8)</b>, <b>qdrouterd.conf(5)</b></p>
-<p><a href="http://qpid.apache.org/components/dispatch-router">http://qpid.apache.org/components/dispatch-router</a></p>
+</dl></div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_see_also">SEE ALSO</h2>
+<div class="sectionbody">
+<div class="paragraph"><p><em>qdrouterd(8)</em>, <em>qdmanage(8)</em>,
<em>qdrouterd.conf(5)</em></p></div>
+<div class="paragraph"><p><a href="http://qpid.apache.org/components/dispatch-router">http://qpid.apache.org/components/dispatch-router</a></p></div>
+</div>
+</div>


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


Mime
View raw message