qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gmur...@apache.org
Subject [4/7] qpid-site git commit: NO-JIRA - Updated qpid-dispatch-master documentation
Date Mon, 08 Aug 2016 14:00:20 GMT
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 @@
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   <head>
-    <title>NAME - Apache Qpid&#8482;</title>
+    <title>SYNOPSIS - Apache Qpid&#8482;</title>
     <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
     <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
     <link rel="stylesheet" href="/site.css" type="text/css" async="async"/>
@@ -111,64 +111,89 @@ https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/>
       </div>
 
       <div id="-middle" class="panel">
-        <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a
href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-dispatch-master/index.html">Qpid
Dispatch Master</a></li><li>NAME</li></ul>
+        <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a
href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-dispatch-master/index.html">Qpid
Dispatch Master</a></li><li>SYNOPSIS</li></ul>
 
         <div id="-middle-content">
-          <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>
@@ -176,7 +201,7 @@ id
 Unique connection identifier
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 host
 </dt>
 <dd>
@@ -184,7 +209,7 @@ host
 The hostname or internet address of the remotely connected AMQP container
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 container
 </dt>
 <dd>
@@ -192,14 +217,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
@@ -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
 </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
@@ -235,9 +260,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>
@@ -246,7 +271,7 @@ A description of the security/encryption in effect for this
 connection
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 authentication
 </dt>
 <dd>
@@ -255,17 +280,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
@@ -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
 </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
@@ -301,9 +328,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>
@@ -312,7 +339,7 @@ Unique identifier of the connection over which this link is
 attached
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 id
 </dt>
 <dd>
@@ -320,7 +347,7 @@ id
 Unique identifier of this link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 peer
 </dt>
 <dd>
@@ -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
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 class
 </dt>
 <dd>
@@ -337,7 +364,7 @@ class
 Class of the address bound to the link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 addr
 </dt>
 <dd>
@@ -345,7 +372,7 @@ addr
 The address bound to the link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 phs
 </dt>
 <dd>
@@ -353,7 +380,7 @@ phs
 The phase of the address bound to the link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 cap
 </dt>
 <dd>
@@ -361,7 +388,7 @@ cap
 The capacity, in deliveries, of the link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 undel
 </dt>
 <dd>
@@ -369,7 +396,7 @@ undel
 The number of undelivered messages stored on the link&#8217;s FIFO
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 unsettled
 </dt>
 <dd>
@@ -377,7 +404,7 @@ unsettled
 The number of unsettled deliveries being tracked by the link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 deliveries
 </dt>
 <dd>
@@ -385,14 +412,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
@@ -403,16 +430,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
@@ -433,9 +460,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>
@@ -443,10 +470,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>
@@ -454,7 +482,7 @@ router-id
 Identifier of the router
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 next-hop
 </dt>
 <dd>
@@ -462,7 +490,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>
@@ -470,7 +498,7 @@ link
 Unique identifier of the link to the neighbor router
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 cost
 </dt>
 <dd>
@@ -478,7 +506,7 @@ cost
 The topology cost to this remote router (with -v option only)
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 neighbors
 </dt>
 <dd>
@@ -486,7 +514,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>
@@ -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)
 </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
@@ -525,9 +556,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>
@@ -535,7 +566,7 @@ addr
 The address text
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 phs
 </dt>
 <dd>
@@ -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.
 </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
@@ -571,9 +602,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>
@@ -581,7 +612,7 @@ in-proc
 The number of in-process consumers for this address
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 local
 </dt>
 <dd>
@@ -589,7 +620,7 @@ local
 The number of local (on this router) consumers for this address
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 remote
 </dt>
 <dd>
@@ -597,7 +628,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>
@@ -605,7 +636,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>
@@ -613,7 +644,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>
@@ -621,7 +652,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>
@@ -629,7 +660,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>
@@ -637,7 +668,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>
@@ -645,10 +676,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>
@@ -656,7 +689,7 @@ prefix
 The prefix for matching addresses of routed links
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 dir
 </dt>
 <dd>
@@ -664,29 +697,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)
@@ -697,12 +730,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>
@@ -710,14 +745,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
@@ -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
 </p>
 </li>
-</ul>
+</ul></div>
 </dd>
-<dt>
+<dt class="hdlist1">
 phs
 </dt>
 <dd>
@@ -738,7 +773,7 @@ phs
 Phase of the address for this auto link
 </p>
 </dd>
-<dt>
+<dt class="hdlist1">
 link
 </dt>
 <dd>
@@ -746,14 +781,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
@@ -784,9 +819,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>
@@ -794,10 +829,17 @@ 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>
 
 
           <hr/>


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


Mime
View raw message