Repository: qpid-site Updated Branches: refs/heads/asf-site fa81b737f -> 1b73996fd
DISPATCH-256 - Documentation updates for qpid-dispatch-master in anticipation of 0.6 release Project: http://git-wip-us.apache.org/repos/asf/qpid-site/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-site/commit/1b73996f Tree: http://git-wip-us.apache.org/repos/asf/qpid-site/tree/1b73996f Diff: http://git-wip-us.apache.org/repos/asf/qpid-site/diff/1b73996f Branch: refs/heads/asf-site Commit: 1b73996fd4737a046600379e0759516b9123607b Parents: fa81b73 Author: Ganesh Murthy <[email protected]> Authored: Wed May 11 11:55:24 2016 -0400 Committer: Ganesh Murthy <[email protected]> Committed: Wed May 11 11:55:24 2016 -0400 ---------------------------------------------------------------------- .../qpid-dispatch-master/book/schema.html | 10 +- .../releases/qpid-dispatch-master/index.html | 2 +- .../man/qdrouterd.conf.html | 10 +- .../qpid-dispatch-master/man/qdstat.html | 206 +++++++++++++++++++ .../qpid-dispatch-master/book/schema.html.in | 10 +- input/releases/qpid-dispatch-master/index.md | 2 +- .../man/qdrouterd.conf.html.in | 10 +- .../qpid-dispatch-master/man/qdstat.html.in | 206 +++++++++++++++++++ 8 files changed, 436 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-site/blob/1b73996f/content/releases/qpid-dispatch-master/book/schema.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-master/book/schema.html b/content/releases/qpid-dispatch-master/book/schema.html index d9a0242..9ab172b 100644 --- a/content/releases/qpid-dispatch-master/book/schema.html +++ b/content/releases/qpid-dispatch-master/book/schema.html @@ -154,7 +154,7 @@ running using the <cite>qdrouterd(8)</cite> tool’s <cite>create</cite> ope be modified using the <cite>update</cite> operation, see the entity descriptions below.</p> <div class="section" id="container"> <h3>3.4.1.1. container<a class="headerlink" href="#container" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED)Attributes related to the AMQP container. All container attributes are now available in the router entity. The container entity will be removed in future releases</p> +<p>(DEPRECATED)Attributes related to the AMQP container. This entity has been deprecated. Use the router entity instead.</p> <p>Operations allowed: <cite>READ</cite></p> <dl class="docutils"> <dt><em>containerName</em> (string, <cite>CREATE</cite>)</dt> @@ -319,7 +319,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions <p>Configure logging for a particular module. You can use the <cite>UPDATE</cite> operation to change log settings while the router is running.</p> <p>Operations allowed: <cite>UPDATE</cite>, <cite>READ</cite></p> <dl class="docutils"> -<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required)</dt> +<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required, <cite>UPDATE</cite>)</dt> <dd>Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.</dd> <dt><em>enable</em> (string, default=’default’, required, <cite>UPDATE</cite>)</dt> <dd>Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.</dd> @@ -333,7 +333,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions </div> <div class="section" id="fixedaddress"> <h3>3.4.1.6. fixedAddress<a class="headerlink" href="#fixedaddress" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix.</p> +<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix. This entity has been deprecated. Use router.config.address instead</p> <p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p> <dl class="docutils"> <dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt> @@ -348,7 +348,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions </div> <div class="section" id="waypoint"> <h3>3.4.1.7. waypoint<a class="headerlink" href="#waypoint" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) A remote node that messages for an address pass through.</p> +<p>(DEPRECATED) A remote node that messages for an address pass through. This entity has been deprecated. Use router.config.autoLink instead</p> <p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p> <dl class="docutils"> <dt><em>address</em> (string, required, <cite>CREATE</cite>)</dt> @@ -363,7 +363,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions </div> <div class="section" id="linkroutepattern"> <h3>3.4.1.8. linkRoutePattern<a class="headerlink" href="#linkroutepattern" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node.</p> +<p>(DEPRECATED) An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node. This entity has been deprecated. Use router.config.linkRoute instead</p> <p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p> <dl class="docutils"> <dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/1b73996f/content/releases/qpid-dispatch-master/index.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-master/index.html b/content/releases/qpid-dispatch-master/index.html index 847b28b..aa4f45b 100644 --- a/content/releases/qpid-dispatch-master/index.html +++ b/content/releases/qpid-dispatch-master/index.html @@ -124,7 +124,7 @@ https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/> incomplete. For a smoother experience, see the <a href="/releases/qpid-dispatch-0.5/index.html">current stable release</a>.</p> -<p>This content was generated at 10:38 on Wednesday, 04 May 2016.</p> +<p>This content was generated at 11:48 on Wednesday, 11 May 2016.</p> </div> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/1b73996f/content/releases/qpid-dispatch-master/man/qdrouterd.conf.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-master/man/qdrouterd.conf.html b/content/releases/qpid-dispatch-master/man/qdrouterd.conf.html index f84b896..acdfed9 100644 --- a/content/releases/qpid-dispatch-master/man/qdrouterd.conf.html +++ b/content/releases/qpid-dispatch-master/man/qdrouterd.conf.html @@ -209,7 +209,7 @@ listener { <h2>Configuration Sections<a class="headerlink" href="#configuration-sections" title="Permalink to this headline">.</a></h2> <div class="section" id="container"> <h3>container<a class="headerlink" href="#container" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED)Attributes related to the AMQP container. All container attributes are now available in the router entity. The container entity will be removed in future releases</p> +<p>(DEPRECATED)Attributes related to the AMQP container. This entity has been deprecated. Use the router entity instead.</p> <dl class="docutils"> <dt><em>containerName</em> (string)</dt> <dd>The name of the AMQP container. If not specified, the container name will be set to a value of the container’s choosing. The automatically assigned container name is not guaranteed to be persistent across restarts of the container.</dd> @@ -359,6 +359,8 @@ listener { <h3>log<a class="headerlink" href="#log" title="Permalink to this headline">.</a></h3> <p>Configure logging for a particular module. You can use the <cite>UPDATE</cite> operation to change log settings while the router is running.</p> <dl class="docutils"> +<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required)</dt> +<dd>Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.</dd> <dt><em>enable</em> (string, default=’default’, required)</dt> <dd>Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.</dd> <dt><em>timestamp</em> (boolean)</dt> @@ -371,7 +373,7 @@ listener { </div> <div class="section" id="fixedaddress"> <h3>fixedAddress<a class="headerlink" href="#fixedaddress" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix.</p> +<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix. This entity has been deprecated. Use router.config.address instead</p> <dl class="docutils"> <dt><em>prefix</em> (string, required)</dt> <dd>The address prefix (always starting with ‘/’).</dd> @@ -385,7 +387,7 @@ listener { </div> <div class="section" id="waypoint"> <h3>waypoint<a class="headerlink" href="#waypoint" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) A remote node that messages for an address pass through.</p> +<p>(DEPRECATED) A remote node that messages for an address pass through. This entity has been deprecated. Use router.config.autoLink instead</p> <dl class="docutils"> <dt><em>address</em> (string, required)</dt> <dd>The AMQP address of the waypoint.</dd> @@ -399,7 +401,7 @@ listener { </div> <div class="section" id="linkroutepattern"> <h3>linkRoutePattern<a class="headerlink" href="#linkroutepattern" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node.</p> +<p>(DEPRECATED) An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node. This entity has been deprecated. Use router.config.linkRoute instead</p> <dl class="docutils"> <dt><em>prefix</em> (string, required)</dt> <dd>An address prefix to match against target and source addresses. This pattern must be of the form ‘<text>.<text1>.<textN>’ or ‘<text>’ or ‘<text>.’ and matches any address that contains that prefix. For example, if the prefix is set to org.apache (or org.apache.), any address that has the prefix ‘org.apache’ (like org.apache.dev) will match. Note that a prefix must not start with a (.), can end in a (.) and can contain zero or more dots (.). Any characters between the dots are simply treated as part of the address</dd> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/1b73996f/content/releases/qpid-dispatch-master/man/qdstat.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-master/man/qdstat.html b/content/releases/qpid-dispatch-master/man/qdstat.html index 40eae77..7e44f64 100644 --- a/content/releases/qpid-dispatch-master/man/qdstat.html +++ b/content/releases/qpid-dispatch-master/man/qdstat.html @@ -174,6 +174,212 @@ as memory use.</p> : Certificate password, will be prompted if not specifed.</p> </div> </div> +<div class="section" id="output-columns"> +<h2>Output Columns<a class="headerlink" href="#output-columns" title="Permalink to this headline">.</a></h2> +<div class="section" id="qdstat-c"> +<h3>qdstat -c<a class="headerlink" href="#qdstat-c" title="Permalink to this headline">.</a></h3> +<p>Id +: Unique connection identifier</p> +<p>host +: The hostname or internet address of the remotely connected AMQP container</p> +<p>container +: The container-name of the remotely connected AMQP container</p> +<p>role +: The configured role of the connection</p> +<blockquote> +<div><ul class="simple"> +<li>normal - Normal connections from client to router</li> +<li>inter-router - Connection between routers to form a network</li> +<li>route-container - Connection to/from a Broker or other host to receive link-routes and waypoints</li> +</ul> +</div></blockquote> +<p>dir +: The direction of connection establishment</p> +<blockquote> +<div><ul class="simple"> +<li>in - The connection was initiated by the remote container</li> +<li>out - The connection was initiated by this router</li> +</ul> +</div></blockquote> +<p>security +: A description of the security/encryption in effect for this connection</p> +<p>authentication +: The method and user-id of the authenticated user for this connection</p> +</div> +<div class="section" id="qdstat-l"> +<h3>qdstat -l<a class="headerlink" href="#qdstat-l" title="Permalink to this headline">.</a></h3> +<p>type +: Type of link</p> +<blockquote> +<div><ul class="simple"> +<li>router-control - An inter-router link that is reserved for control messages exchanged between routers</li> +<li>inter-router - An inter-router link that is used for normal message-routed deliveries</li> +<li>endpoint - A normal link to an external endpoint container</li> +</ul> +</div></blockquote> +<p>dir +: The direction of message flow on the link</p> +<blockquote> +<div><ul class="simple"> +<li>in - Deliveries flow inbound to the router</li> +<li>out - Deliveries flow outbound from the router</li> +</ul> +</div></blockquote> +<p>conn id +: Unique identifier of the connection over which this link is attached</p> +<p>id +: Unique identifier of this link</p> +<p>peer +: For link-routed links, the unique identifier of the peer link. In link routing, an inbound link is paired with an outbound link</p> +<p>class +: Class of the address bound to the link</p> +<p>addr +: The address bound to the link</p> +<p>phs +: The phase of the address bound to the link</p> +<p>cap +: The capacity, in deliveries, of the link</p> +<p>undel +: The number of undelivered messages stored on the link’s FIFO</p> +<p>unsettled +: The number of unsettled deliveries being tracked by the link</p> +<p>deliveries +: The total number of deliveries that have transited this link</p> +<p>admin +: The administrative status of the link</p> +<blockquote> +<div><ul class="simple"> +<li>enabled - The link is enabled for normal operation</li> +<li>disabled - The link is disabled and should be quiescing or stopped (not yet supported)</li> +</ul> +</div></blockquote> +<p>oper +: The operational status of the link</p> +<blockquote> +<div><ul class="simple"> +<li>up - The link is operational</li> +<li>down - The link is not attached</li> +<li>quiescing - The link is in the process of quiescing (not yet supported)</li> +<li>idle - The link has completed quiescing and is idle (not yet supported)</li> +</ul> +</div></blockquote> +<p>name +: The link name (only shown if the -v option is provided)</p> +</div> +<div class="section" id="qdstat-n"> +<h3>qdstat -n<a class="headerlink" href="#qdstat-n" title="Permalink to this headline">.</a></h3> +<p>router-id +: Identifier of the router</p> +<p>next-hop +: If this router is not a neighbor, identifies the next-hop neighbor used to reach this router</p> +<p>link +: Unique identifier of the link to the neighbor router</p> +<p>cost +: The topology cost to this remote router (with -v option only)</p> +<p>neighbors +: The list of neighbor routers (the router’s link-state) (with -v option only)</p> +<p>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> +</div> +<div class="section" id="qdstat-a"> +<h3>qdstat -a<a class="headerlink" href="#qdstat-a" title="Permalink to this headline">.</a></h3> +<p>class +: The class of the listed address</p> +<blockquote> +<div><ul class="simple"> +<li>local - Address that is local to this router</li> +<li>topo - Topological address used for router control messages</li> +<li>router - A summary router address used to route messages to a remote router’s local addresses</li> +<li>mobile - A mobile address for an attached consumer or producer</li> +</ul> +</div></blockquote> +<p>addr +: The address text</p> +<p>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> +<p>distrib +: Distribution method used for this address</p> +<blockquote> +<div><ul class="simple"> +<li>multicast - A copy of each message is delivered once to each consumer for the address</li> +<li>closest - Each message is delivered to only one consumer for the address. The closest (lowest cost) consumer will be chosen. If there are multiple lowest-cost consumers, deliveries will be spread across those consumers.</li> +<li>balanced - Each message is delivered to only one consumer for the address. The consumer with the fewest outstanding (unsettled) deliveries will be chosen. The cost of the route to the consumer is a threshold for delivery (i.e. higher cost consumers will only receive deliveries if closer consumers are backed up).</li> +<li>flood - Used only for router-control traffic. This is multicast without prevention of duplicate deliveries.</li> +</ul> +</div></blockquote> +<p>in-proc +: The number of in-process consumers for this address</p> +<p>local +: The number of local (on this router) consumers for this address</p> +<p>remote +: The number of remote routers that have at least one consumer for this address</p> +<p>cntnr +: The number of locally attached containers that are destinations for link-routes on this address</p> +<p>in +: The number of deliveries for this address that entered the network on this router</p> +<p>out +: The number of deliveries for this address that exited the network on this router</p> +<p>thru +: The number of deliveries for this address that were forwarded to other routers</p> +<p>to-proc +: The number of deliveries for this address that were delivered to an in-process consumer</p> +<p>from-proc +: The number of deliveries for this address that were received from an in-process producer</p> +</div> +<div class="section" id="qdstat-linkroutes"> +<h3>qdstat –linkroutes<a class="headerlink" href="#qdstat-linkroutes" title="Permalink to this headline">.</a></h3> +<p>prefix +: The prefix for matching addresses of routed links</p> +<p>dir +: The direction (from the router’s perspective) of matching links</p> +<p>distrib +: The distribution method used for routed links</p> +<blockquote> +<div><ul class="simple"> +<li>linkBalanced - the only supported distribution for routed links</li> +</ul> +</div></blockquote> +<p>status +: Operational status of the link route</p> +<blockquote> +<div><ul class="simple"> +<li>active - Route is actively routing attaches (i.e. ready for use)</li> +<li>inactive - Route is inactive because there is no local destination connected</li> +</ul> +</div></blockquote> +</div> +<div class="section" id="qstat-autolinks"> +<h3>qstat –autolinks<a class="headerlink" href="#qstat-autolinks" title="Permalink to this headline">.</a></h3> +<p>addr +: The address of the auto link</p> +<p>dir +: The direction of message flow for the auto link</p> +<blockquote> +<div><ul class="simple"> +<li>in - Messages flow in from the route-container to the router network</li> +<li>out - Messages flow out to the route-container from the router network</li> +</ul> +</div></blockquote> +<p>phs +: Phase of the address for this auto link</p> +<p>link +: Unique identifier of the link managed by this auto link</p> +<p>status +: The operational status of this auto link</p> +<blockquote> +<div><ul class="simple"> +<li>inactive - There is no connected container for this auto link</li> +<li>attaching - The link is attaching to the container</li> +<li>failed - The link-attach failed</li> +<li>active - The link is operational</li> +<li>quiescing - The link is quiescing (not yet supported)</li> +<li>idle - The link is idle (not yet supported)</li> +</ul> +</div></blockquote> +<p>lastErr +: The description of the last attach failure that occurred on this auto link</p> +</div> +</div> <div class="section" id="see-also"> <h2>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">.</a></h2> <p><em>qdrouterd(8)</em>, <em>qdmanage(8)</em>, <em>qdrouterd.conf(5)</em></p> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/1b73996f/input/releases/qpid-dispatch-master/book/schema.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-master/book/schema.html.in b/input/releases/qpid-dispatch-master/book/schema.html.in index 71bb99c..fc35561 100644 --- a/input/releases/qpid-dispatch-master/book/schema.html.in +++ b/input/releases/qpid-dispatch-master/book/schema.html.in @@ -38,7 +38,7 @@ running using the <cite>qdrouterd(8)</cite> tool’s <cite>create</cite> ope be modified using the <cite>update</cite> operation, see the entity descriptions below.</p> <div class="section" id="container"> <h3>3.4.1.1. container<a class="headerlink" href="#container" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED)Attributes related to the AMQP container. All container attributes are now available in the router entity. The container entity will be removed in future releases</p> +<p>(DEPRECATED)Attributes related to the AMQP container. This entity has been deprecated. Use the router entity instead.</p> <p>Operations allowed: <cite>READ</cite></p> <dl class="docutils"> <dt><em>containerName</em> (string, <cite>CREATE</cite>)</dt> @@ -203,7 +203,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions <p>Configure logging for a particular module. You can use the <cite>UPDATE</cite> operation to change log settings while the router is running.</p> <p>Operations allowed: <cite>UPDATE</cite>, <cite>READ</cite></p> <dl class="docutils"> -<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required)</dt> +<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required, <cite>UPDATE</cite>)</dt> <dd>Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.</dd> <dt><em>enable</em> (string, default=’default’, required, <cite>UPDATE</cite>)</dt> <dd>Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.</dd> @@ -217,7 +217,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions </div> <div class="section" id="fixedaddress"> <h3>3.4.1.6. fixedAddress<a class="headerlink" href="#fixedaddress" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix.</p> +<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix. This entity has been deprecated. Use router.config.address instead</p> <p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p> <dl class="docutils"> <dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt> @@ -232,7 +232,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions </div> <div class="section" id="waypoint"> <h3>3.4.1.7. waypoint<a class="headerlink" href="#waypoint" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) A remote node that messages for an address pass through.</p> +<p>(DEPRECATED) A remote node that messages for an address pass through. This entity has been deprecated. Use router.config.autoLink instead</p> <p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p> <dl class="docutils"> <dt><em>address</em> (string, required, <cite>CREATE</cite>)</dt> @@ -247,7 +247,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions </div> <div class="section" id="linkroutepattern"> <h3>3.4.1.8. linkRoutePattern<a class="headerlink" href="#linkroutepattern" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node.</p> +<p>(DEPRECATED) An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node. This entity has been deprecated. Use router.config.linkRoute instead</p> <p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p> <dl class="docutils"> <dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/1b73996f/input/releases/qpid-dispatch-master/index.md ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-master/index.md b/input/releases/qpid-dispatch-master/index.md index 14447e9..7920240 100644 --- a/input/releases/qpid-dispatch-master/index.md +++ b/input/releases/qpid-dispatch-master/index.md @@ -27,7 +27,7 @@ Code and documentation found here may be unstable, incorrect, or incomplete. For a smoother experience, see the [current stable release]({{current_dispatch_release_url}}/index.html). -This content was generated at 10:38 on Wednesday, 04 May 2016. +This content was generated at 11:48 on Wednesday, 11 May 2016. </div> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/1b73996f/input/releases/qpid-dispatch-master/man/qdrouterd.conf.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-master/man/qdrouterd.conf.html.in b/input/releases/qpid-dispatch-master/man/qdrouterd.conf.html.in index 0b343f7..e39cf60 100644 --- a/input/releases/qpid-dispatch-master/man/qdrouterd.conf.html.in +++ b/input/releases/qpid-dispatch-master/man/qdrouterd.conf.html.in @@ -93,7 +93,7 @@ listener { <h2>Configuration Sections<a class="headerlink" href="#configuration-sections" title="Permalink to this headline">.</a></h2> <div class="section" id="container"> <h3>container<a class="headerlink" href="#container" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED)Attributes related to the AMQP container. All container attributes are now available in the router entity. The container entity will be removed in future releases</p> +<p>(DEPRECATED)Attributes related to the AMQP container. This entity has been deprecated. Use the router entity instead.</p> <dl class="docutils"> <dt><em>containerName</em> (string)</dt> <dd>The name of the AMQP container. If not specified, the container name will be set to a value of the container’s choosing. The automatically assigned container name is not guaranteed to be persistent across restarts of the container.</dd> @@ -243,6 +243,8 @@ listener { <h3>log<a class="headerlink" href="#log" title="Permalink to this headline">.</a></h3> <p>Configure logging for a particular module. You can use the <cite>UPDATE</cite> operation to change log settings while the router is running.</p> <dl class="docutils"> +<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required)</dt> +<dd>Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.</dd> <dt><em>enable</em> (string, default=’default’, required)</dt> <dd>Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.</dd> <dt><em>timestamp</em> (boolean)</dt> @@ -255,7 +257,7 @@ listener { </div> <div class="section" id="fixedaddress"> <h3>fixedAddress<a class="headerlink" href="#fixedaddress" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix.</p> +<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix. This entity has been deprecated. Use router.config.address instead</p> <dl class="docutils"> <dt><em>prefix</em> (string, required)</dt> <dd>The address prefix (always starting with ‘/’).</dd> @@ -269,7 +271,7 @@ listener { </div> <div class="section" id="waypoint"> <h3>waypoint<a class="headerlink" href="#waypoint" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) A remote node that messages for an address pass through.</p> +<p>(DEPRECATED) A remote node that messages for an address pass through. This entity has been deprecated. Use router.config.autoLink instead</p> <dl class="docutils"> <dt><em>address</em> (string, required)</dt> <dd>The AMQP address of the waypoint.</dd> @@ -283,7 +285,7 @@ listener { </div> <div class="section" id="linkroutepattern"> <h3>linkRoutePattern<a class="headerlink" href="#linkroutepattern" title="Permalink to this headline">.</a></h3> -<p>(DEPRECATED) An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node.</p> +<p>(DEPRECATED) An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node. This entity has been deprecated. Use router.config.linkRoute instead</p> <dl class="docutils"> <dt><em>prefix</em> (string, required)</dt> <dd>An address prefix to match against target and source addresses. This pattern must be of the form ‘<text>.<text1>.<textN>’ or ‘<text>’ or ‘<text>.’ and matches any address that contains that prefix. For example, if the prefix is set to org.apache (or org.apache.), any address that has the prefix ‘org.apache’ (like org.apache.dev) will match. Note that a prefix must not start with a (.), can end in a (.) and can contain zero or more dots (.). Any characters between the dots are simply treated as part of the address</dd> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/1b73996f/input/releases/qpid-dispatch-master/man/qdstat.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-master/man/qdstat.html.in b/input/releases/qpid-dispatch-master/man/qdstat.html.in index d55914e..99cd510 100644 --- a/input/releases/qpid-dispatch-master/man/qdstat.html.in +++ b/input/releases/qpid-dispatch-master/man/qdstat.html.in @@ -58,6 +58,212 @@ as memory use.</p> : Certificate password, will be prompted if not specifed.</p> </div> </div> +<div class="section" id="output-columns"> +<h2>Output Columns<a class="headerlink" href="#output-columns" title="Permalink to this headline">.</a></h2> +<div class="section" id="qdstat-c"> +<h3>qdstat -c<a class="headerlink" href="#qdstat-c" title="Permalink to this headline">.</a></h3> +<p>Id +: Unique connection identifier</p> +<p>host +: The hostname or internet address of the remotely connected AMQP container</p> +<p>container +: The container-name of the remotely connected AMQP container</p> +<p>role +: The configured role of the connection</p> +<blockquote> +<div><ul class="simple"> +<li>normal - Normal connections from client to router</li> +<li>inter-router - Connection between routers to form a network</li> +<li>route-container - Connection to/from a Broker or other host to receive link-routes and waypoints</li> +</ul> +</div></blockquote> +<p>dir +: The direction of connection establishment</p> +<blockquote> +<div><ul class="simple"> +<li>in - The connection was initiated by the remote container</li> +<li>out - The connection was initiated by this router</li> +</ul> +</div></blockquote> +<p>security +: A description of the security/encryption in effect for this connection</p> +<p>authentication +: The method and user-id of the authenticated user for this connection</p> +</div> +<div class="section" id="qdstat-l"> +<h3>qdstat -l<a class="headerlink" href="#qdstat-l" title="Permalink to this headline">.</a></h3> +<p>type +: Type of link</p> +<blockquote> +<div><ul class="simple"> +<li>router-control - An inter-router link that is reserved for control messages exchanged between routers</li> +<li>inter-router - An inter-router link that is used for normal message-routed deliveries</li> +<li>endpoint - A normal link to an external endpoint container</li> +</ul> +</div></blockquote> +<p>dir +: The direction of message flow on the link</p> +<blockquote> +<div><ul class="simple"> +<li>in - Deliveries flow inbound to the router</li> +<li>out - Deliveries flow outbound from the router</li> +</ul> +</div></blockquote> +<p>conn id +: Unique identifier of the connection over which this link is attached</p> +<p>id +: Unique identifier of this link</p> +<p>peer +: For link-routed links, the unique identifier of the peer link. In link routing, an inbound link is paired with an outbound link</p> +<p>class +: Class of the address bound to the link</p> +<p>addr +: The address bound to the link</p> +<p>phs +: The phase of the address bound to the link</p> +<p>cap +: The capacity, in deliveries, of the link</p> +<p>undel +: The number of undelivered messages stored on the link’s FIFO</p> +<p>unsettled +: The number of unsettled deliveries being tracked by the link</p> +<p>deliveries +: The total number of deliveries that have transited this link</p> +<p>admin +: The administrative status of the link</p> +<blockquote> +<div><ul class="simple"> +<li>enabled - The link is enabled for normal operation</li> +<li>disabled - The link is disabled and should be quiescing or stopped (not yet supported)</li> +</ul> +</div></blockquote> +<p>oper +: The operational status of the link</p> +<blockquote> +<div><ul class="simple"> +<li>up - The link is operational</li> +<li>down - The link is not attached</li> +<li>quiescing - The link is in the process of quiescing (not yet supported)</li> +<li>idle - The link has completed quiescing and is idle (not yet supported)</li> +</ul> +</div></blockquote> +<p>name +: The link name (only shown if the -v option is provided)</p> +</div> +<div class="section" id="qdstat-n"> +<h3>qdstat -n<a class="headerlink" href="#qdstat-n" title="Permalink to this headline">.</a></h3> +<p>router-id +: Identifier of the router</p> +<p>next-hop +: If this router is not a neighbor, identifies the next-hop neighbor used to reach this router</p> +<p>link +: Unique identifier of the link to the neighbor router</p> +<p>cost +: The topology cost to this remote router (with -v option only)</p> +<p>neighbors +: The list of neighbor routers (the router’s link-state) (with -v option only)</p> +<p>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> +</div> +<div class="section" id="qdstat-a"> +<h3>qdstat -a<a class="headerlink" href="#qdstat-a" title="Permalink to this headline">.</a></h3> +<p>class +: The class of the listed address</p> +<blockquote> +<div><ul class="simple"> +<li>local - Address that is local to this router</li> +<li>topo - Topological address used for router control messages</li> +<li>router - A summary router address used to route messages to a remote router’s local addresses</li> +<li>mobile - A mobile address for an attached consumer or producer</li> +</ul> +</div></blockquote> +<p>addr +: The address text</p> +<p>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> +<p>distrib +: Distribution method used for this address</p> +<blockquote> +<div><ul class="simple"> +<li>multicast - A copy of each message is delivered once to each consumer for the address</li> +<li>closest - Each message is delivered to only one consumer for the address. The closest (lowest cost) consumer will be chosen. If there are multiple lowest-cost consumers, deliveries will be spread across those consumers.</li> +<li>balanced - Each message is delivered to only one consumer for the address. The consumer with the fewest outstanding (unsettled) deliveries will be chosen. The cost of the route to the consumer is a threshold for delivery (i.e. higher cost consumers will only receive deliveries if closer consumers are backed up).</li> +<li>flood - Used only for router-control traffic. This is multicast without prevention of duplicate deliveries.</li> +</ul> +</div></blockquote> +<p>in-proc +: The number of in-process consumers for this address</p> +<p>local +: The number of local (on this router) consumers for this address</p> +<p>remote +: The number of remote routers that have at least one consumer for this address</p> +<p>cntnr +: The number of locally attached containers that are destinations for link-routes on this address</p> +<p>in +: The number of deliveries for this address that entered the network on this router</p> +<p>out +: The number of deliveries for this address that exited the network on this router</p> +<p>thru +: The number of deliveries for this address that were forwarded to other routers</p> +<p>to-proc +: The number of deliveries for this address that were delivered to an in-process consumer</p> +<p>from-proc +: The number of deliveries for this address that were received from an in-process producer</p> +</div> +<div class="section" id="qdstat-linkroutes"> +<h3>qdstat –linkroutes<a class="headerlink" href="#qdstat-linkroutes" title="Permalink to this headline">.</a></h3> +<p>prefix +: The prefix for matching addresses of routed links</p> +<p>dir +: The direction (from the router’s perspective) of matching links</p> +<p>distrib +: The distribution method used for routed links</p> +<blockquote> +<div><ul class="simple"> +<li>linkBalanced - the only supported distribution for routed links</li> +</ul> +</div></blockquote> +<p>status +: Operational status of the link route</p> +<blockquote> +<div><ul class="simple"> +<li>active - Route is actively routing attaches (i.e. ready for use)</li> +<li>inactive - Route is inactive because there is no local destination connected</li> +</ul> +</div></blockquote> +</div> +<div class="section" id="qstat-autolinks"> +<h3>qstat –autolinks<a class="headerlink" href="#qstat-autolinks" title="Permalink to this headline">.</a></h3> +<p>addr +: The address of the auto link</p> +<p>dir +: The direction of message flow for the auto link</p> +<blockquote> +<div><ul class="simple"> +<li>in - Messages flow in from the route-container to the router network</li> +<li>out - Messages flow out to the route-container from the router network</li> +</ul> +</div></blockquote> +<p>phs +: Phase of the address for this auto link</p> +<p>link +: Unique identifier of the link managed by this auto link</p> +<p>status +: The operational status of this auto link</p> +<blockquote> +<div><ul class="simple"> +<li>inactive - There is no connected container for this auto link</li> +<li>attaching - The link is attaching to the container</li> +<li>failed - The link-attach failed</li> +<li>active - The link is operational</li> +<li>quiescing - The link is quiescing (not yet supported)</li> +<li>idle - The link is idle (not yet supported)</li> +</ul> +</div></blockquote> +<p>lastErr +: The description of the last attach failure that occurred on this auto link</p> +</div> +</div> <div class="section" id="see-also"> <h2>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">.</a></h2> <p><em>qdrouterd(8)</em>, <em>qdmanage(8)</em>, <em>qdrouterd.conf(5)</em></p> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
