You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ac...@apache.org on 2015/02/10 21:33:27 UTC
svn commit: r1658800 [4/4] - in /qpid/site: docs/releases/qpid-dispatch-0.3/
docs/releases/qpid-dispatch-trunk/ docs/releases/qpid-dispatch-trunk/api/
docs/releases/qpid-dispatch-trunk/api/search/
input/releases/qpid-dispatch-0.3/ input/releases/qpid-d...
Modified: qpid/site/input/releases/qpid-dispatch-trunk/book.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-trunk/book.html.in?rev=1658800&r1=1658799&r2=1658800&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-trunk/book.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-trunk/book.html.in Tue Feb 10 20:33:25 2015
@@ -55,11 +55,12 @@ under the License.
<li><a href="#amqp-mapping"><span class="toc-section-number">4</span> AMQP Mapping</a><ul>
<li><a href="#message-annotations"><span class="toc-section-number">4.1</span> Message Annotations</a></li>
<li><a href="#sourcetarget-capabilities"><span class="toc-section-number">4.2</span> Source/Target Capabilities</a></li>
-<li><a href="#addresses-and-address-formats"><span class="toc-section-number">4.3</span> Addresses and Address Formats</a><ul>
-<li><a href="#address-patterns"><span class="toc-section-number">4.3.1</span> Address Patterns</a></li>
-<li><a href="#supported-addresses"><span class="toc-section-number">4.3.2</span> Supported Addresses</a></li>
+<li><a href="#dynamic-node-properties"><span class="toc-section-number">4.3</span> Dynamic-Node-Properties</a></li>
+<li><a href="#addresses-and-address-formats"><span class="toc-section-number">4.4</span> Addresses and Address Formats</a><ul>
+<li><a href="#address-patterns"><span class="toc-section-number">4.4.1</span> Address Patterns</a></li>
+<li><a href="#supported-addresses"><span class="toc-section-number">4.4.2</span> Supported Addresses</a></li>
</ul></li>
-<li><a href="#implementation-of-the-amqp-management-specification"><span class="toc-section-number">4.4</span> Implementation of the AMQP Management Specification</a></li>
+<li><a href="#implementation-of-the-amqp-management-specification"><span class="toc-section-number">4.5</span> Implementation of the AMQP Management Specification</a></li>
</ul></li>
<li><a href="#management-schema"><span class="toc-section-number">5</span> Management Schema</a><ul>
<li><a href="#configuration-entities"><span class="toc-section-number">5.1</span> Configuration Entities</a><ul>
@@ -70,13 +71,21 @@ under the License.
<li><a href="#log"><span class="toc-section-number">5.1.5</span> log</a></li>
<li><a href="#fixedaddress"><span class="toc-section-number">5.1.6</span> fixedAddress</a></li>
<li><a href="#waypoint"><span class="toc-section-number">5.1.7</span> waypoint</a></li>
+<li><a href="#linkroutepattern"><span class="toc-section-number">5.1.8</span> linkRoutePattern</a></li>
</ul></li>
<li><a href="#operational-entities"><span class="toc-section-number">5.2</span> Operational Entities</a><ul>
-<li><a href="#router.link"><span class="toc-section-number">5.2.1</span> router.link</a></li>
-<li><a href="#router.address"><span class="toc-section-number">5.2.2</span> router.address</a></li>
-<li><a href="#router.node"><span class="toc-section-number">5.2.3</span> router.node</a></li>
-<li><a href="#connection"><span class="toc-section-number">5.2.4</span> connection</a></li>
-<li><a href="#allocator"><span class="toc-section-number">5.2.5</span> allocator</a></li>
+<li><a href="#org.amqp.management"><span class="toc-section-number">5.2.1</span> org.amqp.management</a></li>
+<li><a href="#management"><span class="toc-section-number">5.2.2</span> management</a></li>
+<li><a href="#router.link"><span class="toc-section-number">5.2.3</span> router.link</a></li>
+<li><a href="#router.address"><span class="toc-section-number">5.2.4</span> router.address</a></li>
+<li><a href="#router.node"><span class="toc-section-number">5.2.5</span> router.node</a></li>
+<li><a href="#connection"><span class="toc-section-number">5.2.6</span> connection</a></li>
+<li><a href="#allocator"><span class="toc-section-number">5.2.7</span> allocator</a></li>
+</ul></li>
+<li><a href="#management-operations"><span class="toc-section-number">5.3</span> Management Operations</a><ul>
+<li><a href="#operations-for-all-entity-types"><span class="toc-section-number">5.3.1</span> Operations for all entity types</a></li>
+<li><a href="#operations-for-org.amqp.management-entity-type"><span class="toc-section-number">5.3.2</span> Operations for <code>org.amqp.management</code> entity type</a></li>
+<li><a href="#operations-for-management-entity-type"><span class="toc-section-number">5.3.3</span> Operations for <code>management</code> entity type</a></li>
</ul></li>
</ul></li>
</ul>
@@ -474,9 +483,25 @@ under the License.
</tr>
</tbody>
</table>
-<h2 id="addresses-and-address-formats"><span class="header-section-number">4.3</span> Addresses and Address Formats</h2>
+<h2 id="dynamic-node-properties"><span class="header-section-number">4.3</span> Dynamic-Node-Properties</h2>
+<p>The following dynamic-node-properties are used by Dispatch in Sources.</p>
+<table>
+<thead>
+<tr class="header">
+<th align="left"><em>Property</em></th>
+<th align="left"><em>Description</em></th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td align="left">x-opt-qd.address</td>
+<td align="left">The node address describing the destination desired for a dynamic source. If this is absent, the router will terminate any dynamic receivers. If this address is present, the router will use the address to route the dynamic link attach to the proper destination container.</td>
+</tr>
+</tbody>
+</table>
+<h2 id="addresses-and-address-formats"><span class="header-section-number">4.4</span> Addresses and Address Formats</h2>
<p>The following AMQP addresses and address patterns are used within Dispatch Router.</p>
-<h3 id="address-patterns"><span class="header-section-number">4.3.1</span> Address Patterns</h3>
+<h3 id="address-patterns"><span class="header-section-number">4.4.1</span> Address Patterns</h3>
<table>
<thead>
<tr class="header">
@@ -499,7 +524,7 @@ under the License.
</tr>
</tbody>
</table>
-<h3 id="supported-addresses"><span class="header-section-number">4.3.2</span> Supported Addresses</h3>
+<h3 id="supported-addresses"><span class="header-section-number">4.4.2</span> Supported Addresses</h3>
<table>
<thead>
<tr class="header">
@@ -530,22 +555,21 @@ under the License.
</tr>
</tbody>
</table>
-<h2 id="implementation-of-the-amqp-management-specification"><span class="header-section-number">4.4</span> Implementation of the AMQP Management Specification</h2>
+<h2 id="implementation-of-the-amqp-management-specification"><span class="header-section-number">4.5</span> Implementation of the AMQP Management Specification</h2>
<p>Qpid Dispatch is manageable remotely via AMQP. It is compliant with the emerging AMQP Management specification (draft 9).</p>
<p>Differences from the specification:</p>
<ul>
<li>The "name" attribute is not required when an entity is created. If not supplied it will be set to the same value as the system-generated "identity" attribute. Otherwise it is treated as per the standard.</li>
-<li>The REGISTER operation is not implementd. The router has its own mechansm to discover peers that does not require this operation.</li>
-<li>The DEREGISTER operation is not implementd. The router has its own mechansm to discover peers that does not require this operation.</li>
+<li>The REGISTER and DEREGISTER operations are not implementd. The router automatically discovers peer routers via the router network and makes their managment addresses available via the standard GET-MGMT-NODES operation.</li>
</ul>
<h1 id="management-schema"><span class="header-section-number">5</span> Management Schema</h1>
-<p>This chapter documents the set of <em>management entity types</em> that define configuration and management of a Dispatch Router.</p>
-<p>All management entity types have the following attributes:</p>
+<p>This chapter documents the set of <em>management entity types</em> that define configuration and management of a Dispatch Router. A management entity type has a set of <em>attributes</em> that can be read, some attributes can also be updated. Some entity types also support <em>operations</em> that can be called.</p>
+<p>All management entity types have the following standard attributes:</p>
<ul>
-<li><p><em>type</em>: The fully qualified type of the entity, e.g. <code>org.apache.qpid.dispatch.router</code>. In this documentation and when using dispatch tools you can use the short name of the type, e.g. <code>router</code></p></li>
+<li><p><em>type</em>: The fully qualified type of the entity, e.g. <code>org.apache.qpid.dispatch.router</code>. This document uses the short name without the <code>org.apache.qpid.dispatch</code> prefix e.g. <code>router</code>. The dispatch tools will accept the short or long name.</p></li>
<li><p><em>identity</em>: A system-generated identity of the entity. It includes the short type name and some identifying information. E.g. <code>log/AGENT</code> or <code>listener/localhost:amqp</code></p></li>
</ul>
-<p>There are two kinds of management entity type.</p>
+<p>There are two main categories of management entity type.</p>
<ul>
<li><p><em>Configuration</em> Entities: Parameters that can be set in the configuration file (see <code>qdrouterd.conf(5)</code> man page) or set at run-time with the <code>qdmanage(8)</code> tool.</p></li>
<li><p><em>Operational</em> Entities: Run-time status values that can be queried using <code>qdstat(8)</code> or <code>qdmanage(8)</code> tools.</p></li>
@@ -554,246 +578,575 @@ under the License.
<p>Configuration entities define the attributes allowed in the configuration file (see <code>qdrouterd.conf(5)</code>) but you can also create entities once the router is running using the <code>qdrouterd(8)</code> tool's <code>create</code> operation. Some entities can also be modified using the <code>update</code> operation, see the entity descriptions below.</p>
<h3 id="container"><span class="header-section-number">5.1.1</span> container</h3>
<p>Attributes related to the AMQP container.</p>
+<p>Operations allowed: <code>READ</code></p>
<dl>
-<dt><em>containerName</em> (String)</dt>
+<dt><em>containerName</em> (string, <code>CREATE</code>)</dt>
<dd><p>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.</p>
</dd>
-<dt><em>workerThreads</em> (Integer, default=1)</dt>
+<dt><em>workerThreads</em> (integer, default=1, <code>CREATE</code>)</dt>
<dd><p>The number of threads that will be created to process message traffic and other application work (timers, non-amqp file descriptors, etc.) .</p>
</dd>
-<dt><em>debugDump</em> (String)</dt>
+<dt><em>debugDump</em> (string, <code>CREATE</code>)</dt>
<dd><p>A file to dump debugging information that can't be logged normally.</p>
</dd>
</dl>
-<p>Operations allowed: READ</p>
<h3 id="router"><span class="header-section-number">5.1.2</span> router</h3>
<p>Tracks peer routers and computes routes to destinations.</p>
+<p>Operations allowed: <code>READ</code></p>
<dl>
-<dt><em>routerId</em> (String)</dt>
+<dt><em>routerId</em> (string, <code>CREATE</code>)</dt>
<dd><p>Router's unique identity.</p>
</dd>
-<dt><em>mode</em> (One of ['standalone', 'interior', 'edge', 'endpoint'], default='standalone')</dt>
-<dd><p>In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not coorperate with other routers. In interior mode, the router operates in cooreration with other interior routers in an interconnected network. In edge mode, the router operates with an uplink into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.</p>
+<dt><em>mode</em> (One of ['standalone', 'interior', 'edge', 'endpoint'], default='standalone', <code>CREATE</code>)</dt>
+<dd><p>In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not cooperate with other routers. In interior mode, the router operates in cooperation with other interior routers in an interconnected network. In edge mode, the router operates with an up link into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.</p>
</dd>
-<dt><em>area</em> (String)</dt>
+<dt><em>area</em> (string)</dt>
<dd><p>Unused placeholder.</p>
</dd>
-<dt><em>helloInterval</em> (Integer, default=1)</dt>
+<dt><em>helloInterval</em> (integer, default=1, <code>CREATE</code>)</dt>
<dd><p>Interval in seconds between HELLO messages sent to neighbor routers.</p>
</dd>
-<dt><em>helloMaxAge</em> (Integer, default=3)</dt>
+<dt><em>helloMaxAge</em> (integer, default=3, <code>CREATE</code>)</dt>
<dd><p>Time in seconds after which a neighbor is declared lost if no HELLO is received.</p>
</dd>
-<dt><em>raInterval</em> (Integer, default=30)</dt>
+<dt><em>raInterval</em> (integer, default=30, <code>CREATE</code>)</dt>
<dd><p>Interval in seconds between Router-Advertisements sent to all routers in a stable network.</p>
</dd>
-<dt><em>raIntervalFlux</em> (Integer, default=4)</dt>
+<dt><em>raIntervalFlux</em> (integer, default=4, <code>CREATE</code>)</dt>
<dd><p>Interval in seconds between Router-Advertisements sent to all routers during topology fluctuations.</p>
</dd>
-<dt><em>remoteLsMaxAge</em> (Integer, default=60)</dt>
+<dt><em>remoteLsMaxAge</em> (integer, default=60, <code>CREATE</code>)</dt>
<dd><p>Time in seconds after which link state is declared stale if no RA is received.</p>
</dd>
-<dt><em>mobileAddrMaxAge</em> (Integer, default=60)</dt>
+<dt><em>mobileAddrMaxAge</em> (integer, default=60, <code>CREATE</code>)</dt>
<dd><p>Deprecated - This value is no longer used in the router.</p>
</dd>
-<dt><em>addrCount</em> (Integer)</dt>
+<dt><em>addrCount</em> (integer)</dt>
<dd><p>Number of addresses known to the router.</p>
</dd>
-<dt><em>linkCount</em> (Integer)</dt>
+<dt><em>linkCount</em> (integer)</dt>
<dd><p>Number of links attached to the router node.</p>
</dd>
-<dt><em>nodeCount</em> (Integer)</dt>
+<dt><em>nodeCount</em> (integer)</dt>
<dd><p>Number of known peer router nodes.</p>
</dd>
</dl>
-<p>Operations allowed: READ</p>
<h3 id="listener"><span class="header-section-number">5.1.3</span> listener</h3>
<p>Listens for incoming connections to the router.</p>
+<p>Operations allowed: <code>CREATE</code>, <code>READ</code></p>
<dl>
-<dt><em>addr</em> (String, default='0.0.0.0')</dt>
-<dd><p>Host address: ipv4 or ipv6 literal or a host name.</p>
+<dt><em>addr</em> (string, default='0.0.0.0', <code>CREATE</code>)</dt>
+<dd><p>IP address: ipv4 or ipv6 literal or a host name.</p>
</dd>
-<dt><em>port</em> (String, default='amqp')</dt>
+<dt><em>port</em> (string, default='amqp', <code>CREATE</code>)</dt>
<dd><p>Port number or symbolic service name.</p>
</dd>
-<dt><em>role</em> (One of ['normal', 'inter-router', 'on-demand'], default='normal')</dt>
-<dd><p>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over interRouter connections.</p>
+<dt><em>role</em> (One of ['normal', 'inter-router', 'on-demand'], default='normal', <code>CREATE</code>)</dt>
+<dd><p>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.</p>
</dd>
-<dt><em>certDb</em> (String)</dt>
-<dd><p>The path to the database that contains the public certificates of trusted certificate authorities (CAs).</p>
+<dt><em>certDb</em> (string, <code>CREATE</code>)</dt>
+<dd><p>The path to the database that contains the public certificates of trusted certificate authorities (CA).</p>
</dd>
-<dt><em>certFile</em> (String)</dt>
+<dt><em>certFile</em> (string, <code>CREATE</code>)</dt>
<dd><p>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</p>
</dd>
-<dt><em>keyFile</em> (String)</dt>
+<dt><em>keyFile</em> (string, <code>CREATE</code>)</dt>
<dd><p>The path to the file containing the PEM-formatted private key for the above certificate.</p>
</dd>
-<dt><em>passwordFile</em> (String)</dt>
+<dt><em>passwordFile</em> (string, <code>CREATE</code>)</dt>
<dd><p>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</p>
</dd>
-<dt><em>password</em> (String)</dt>
+<dt><em>password</em> (string, <code>CREATE</code>)</dt>
<dd><p>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the 'password' option. Don't use both password and passwordFile in the same profile.</p>
</dd>
-<dt><em>saslMechanisms</em> (String, required)</dt>
+<dt><em>saslMechanisms</em> (string, required, <code>CREATE</code>)</dt>
<dd><p>Comma separated list of accepted SASL authentication mechanisms.</p>
</dd>
-<dt><em>requirePeerAuth</em> (Boolean, default=True)</dt>
+<dt><em>requirePeerAuth</em> (boolean, default=True, <code>CREATE</code>)</dt>
<dd><p>Only for listeners using SSL. If set to 'yes', attached clients will be required to supply a certificate. If the certificate is not traceable to a CA in the ssl profile's cert-db, authentication fails for the connection.</p>
</dd>
-<dt><em>trustedCerts</em> (String)</dt>
+<dt><em>trustedCerts</em> (string, <code>CREATE</code>)</dt>
<dd><p>This optional setting can be used to reduce the set of available CAs for client authentication. If used, this setting must provide a path to a PEM file that contains the trusted certificates.</p>
</dd>
-<dt><em>allowUnsecured</em> (Boolean)</dt>
-<dd><p>For listeners using SSL only. If set to 'yes', this option causes the listener to watch the initial network traffic to determine if the client is using SSL or is running in-the-clear. The listener will enable SSL only if the client uis using SSL.</p>
+<dt><em>allowUnsecured</em> (boolean, <code>CREATE</code>)</dt>
+<dd><p>For listeners using SSL only. If set to 'yes', this option causes the listener to watch the initial network traffic to determine if the client is using SSL or is running in-the-clear. The listener will enable SSL only if the client is using SSL.</p>
</dd>
-<dt><em>allowNoSasl</em> (Boolean)</dt>
+<dt><em>allowNoSasl</em> (boolean, <code>CREATE</code>)</dt>
<dd><p>If set to 'yes', this option causes the listener to allow clients to connect even if they skip the SASL authentication protocol.</p>
</dd>
-<dt><em>maxFrameSize</em> (Integer, default=65536)</dt>
-<dd><p>Defaults to 65536. If specified, it is the maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uniterruptible data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.</p>
+<dt><em>maxFrameSize</em> (integer, default=65536, <code>CREATE</code>)</dt>
+<dd><p>Defaults to 65536. If specified, it is the maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.</p>
</dd>
</dl>
-<p>Operations allowed: CREATE, READ</p>
<h3 id="connector"><span class="header-section-number">5.1.4</span> connector</h3>
<p>Establishes an outgoing connections from the router.</p>
+<p>Operations allowed: <code>CREATE</code>, <code>READ</code></p>
<dl>
-<dt><em>addr</em> (String, default='0.0.0.0')</dt>
-<dd><p>Host address: ipv4 or ipv6 literal or a host name.</p>
+<dt><em>addr</em> (string, default='0.0.0.0', <code>CREATE</code>)</dt>
+<dd><p>IP address: ipv4 or ipv6 literal or a host name.</p>
</dd>
-<dt><em>port</em> (String, default='amqp')</dt>
+<dt><em>port</em> (string, default='amqp', <code>CREATE</code>)</dt>
<dd><p>Port number or symbolic service name.</p>
</dd>
-<dt><em>role</em> (One of ['normal', 'inter-router', 'on-demand'], default='normal')</dt>
-<dd><p>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over interRouter connections.</p>
+<dt><em>role</em> (One of ['normal', 'inter-router', 'on-demand'], default='normal', <code>CREATE</code>)</dt>
+<dd><p>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.</p>
</dd>
-<dt><em>certDb</em> (String)</dt>
-<dd><p>The path to the database that contains the public certificates of trusted certificate authorities (CAs).</p>
+<dt><em>certDb</em> (string, <code>CREATE</code>)</dt>
+<dd><p>The path to the database that contains the public certificates of trusted certificate authorities (CA).</p>
</dd>
-<dt><em>certFile</em> (String)</dt>
+<dt><em>certFile</em> (string, <code>CREATE</code>)</dt>
<dd><p>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</p>
</dd>
-<dt><em>keyFile</em> (String)</dt>
+<dt><em>keyFile</em> (string, <code>CREATE</code>)</dt>
<dd><p>The path to the file containing the PEM-formatted private key for the above certificate.</p>
</dd>
-<dt><em>passwordFile</em> (String)</dt>
+<dt><em>passwordFile</em> (string, <code>CREATE</code>)</dt>
<dd><p>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</p>
</dd>
-<dt><em>password</em> (String)</dt>
+<dt><em>password</em> (string, <code>CREATE</code>)</dt>
<dd><p>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the 'password' option. Don't use both password and passwordFile in the same profile.</p>
</dd>
-<dt><em>saslMechanisms</em> (String, required)</dt>
+<dt><em>saslMechanisms</em> (string, required, <code>CREATE</code>)</dt>
<dd><p>Comma separated list of accepted SASL authentication mechanisms.</p>
</dd>
-<dt><em>allowRedirect</em> (Boolean, default=True)</dt>
+<dt><em>allowRedirect</em> (boolean, default=True, <code>CREATE</code>)</dt>
<dd><p>Allow the peer to redirect this connection to another address.</p>
</dd>
-<dt><em>maxFrameSize</em> (Integer, default=65536)</dt>
-<dd><p>Maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uniterruptible data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.</p>
+<dt><em>maxFrameSize</em> (integer, default=65536, <code>CREATE</code>)</dt>
+<dd><p>Maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.</p>
</dd>
</dl>
-<p>Operations allowed: CREATE, READ</p>
<h3 id="log"><span class="header-section-number">5.1.5</span> log</h3>
-<p>Configure logging for a particular module.</p>
+<p>Configure logging for a particular module. You can use the <code>UPDATE</code> operation to change log settings while the router is running.</p>
+<p>Operations allowed: <code>UPDATE</code>, <code>READ</code></p>
<dl>
<dt><em>module</em> (One of ['ROUTER', 'ROUTER_HELLO', 'ROUTER_LS', 'ROUTER_MA', 'MESSAGE', 'SERVER', 'AGENT', 'CONTAINER', 'CONFIG', 'ERROR', 'DISPATCH', 'DEFAULT'], required)</dt>
<dd><p>Module to configure. The special module 'DEFAULT' specifies defaults for all modules.</p>
</dd>
-<dt><em>enable</em> (String, required, default='default')</dt>
+<dt><em>enable</em> (string, default='default', required, <code>UPDATE</code>)</dt>
<dd><p>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.</p>
</dd>
-<dt><em>timestamp</em> (Boolean)</dt>
+<dt><em>timestamp</em> (boolean, <code>UPDATE</code>)</dt>
<dd><p>Include timestamp in log messages.</p>
</dd>
-<dt><em>source</em> (Boolean)</dt>
+<dt><em>source</em> (boolean, <code>UPDATE</code>)</dt>
<dd><p>Include source file and line number in log messages.</p>
</dd>
-<dt><em>output</em> (String)</dt>
+<dt><em>output</em> (string, <code>UPDATE</code>)</dt>
<dd><p>Where to send log messages. Can be 'stderr', 'syslog' or a file name.</p>
</dd>
</dl>
-<p>Operations allowed: CREATE, READ, UPDATE</p>
<h3 id="fixedaddress"><span class="header-section-number">5.1.6</span> fixedAddress</h3>
<p>Establishes semantics for addresses starting with a prefix.</p>
+<p>Operations allowed: <code>CREATE</code>, <code>READ</code></p>
<dl>
-<dt><em>prefix</em> (String, required)</dt>
+<dt><em>prefix</em> (string, required, <code>CREATE</code>)</dt>
<dd><p>The address prefix (always starting with '/').</p>
</dd>
-<dt><em>phase</em> (Integer)</dt>
+<dt><em>phase</em> (integer, <code>CREATE</code>)</dt>
<dd><p>The phase of a multi-hop address passing through one or more waypoints.</p>
</dd>
-<dt><em>fanout</em> (One of ['multiple', 'single'], default='multiple')</dt>
+<dt><em>fanout</em> (One of ['multiple', 'single'], default='multiple', <code>CREATE</code>)</dt>
<dd><p>One of 'multiple' or 'single'. Multiple fanout is a non-competing pattern. If there are multiple consumers using the same address, each consumer will receive its own copy of every message sent to the address. Single fanout is a competing pattern where each message is sent to only one consumer.</p>
</dd>
-<dt><em>bias</em> (One of ['closest', 'spread'], default='closest')</dt>
+<dt><em>bias</em> (One of ['closest', 'spread'], default='closest', <code>CREATE</code>)</dt>
<dd><p>Only if fanout is single. One of 'closest' or 'spread'. Closest bias means that messages to an address will always be delivered to the closest (lowest cost) subscribed consumer. Spread bias will distribute the messages across subscribers in an approximately even manner.</p>
</dd>
</dl>
-<p>Operations allowed: CREATE, READ</p>
<h3 id="waypoint"><span class="header-section-number">5.1.7</span> waypoint</h3>
<p>A remote node that messages for an address pass through.</p>
+<p>Operations allowed: <code>CREATE</code>, <code>READ</code></p>
<dl>
-<dt><em>address</em> (String, required)</dt>
+<dt><em>address</em> (string, required, <code>CREATE</code>)</dt>
<dd><p>The AMQP address of the waypoint.</p>
</dd>
-<dt><em>connector</em> (String, required)</dt>
+<dt><em>connector</em> (string, required, <code>CREATE</code>)</dt>
<dd><p>The name of the on-demand connector used to reach the waypoint's container.</p>
</dd>
-<dt><em>inPhase</em> (Integer, default=-1)</dt>
+<dt><em>inPhase</em> (integer, default=-1, <code>CREATE</code>)</dt>
<dd><p>The phase of the address as it is routed <em>to</em> the waypoint.</p>
</dd>
-<dt><em>outPhase</em> (Integer, default=-1)</dt>
+<dt><em>outPhase</em> (integer, default=-1, <code>CREATE</code>)</dt>
<dd><p>The phase of the address as it is routed <em>from</em> the waypoint.</p>
</dd>
</dl>
-<p>Operations allowed: CREATE, READ</p>
+<h3 id="linkroutepattern"><span class="header-section-number">5.1.8</span> linkRoutePattern</h3>
+<p>A pattern to match a connected container to endpoints for routed links.</p>
+<p>Operations allowed: <code>CREATE</code>, <code>READ</code></p>
+<dl>
+<dt><em>prefix</em> (string, required, <code>CREATE</code>)</dt>
+<dd><p>The AMQP address prefix for nodes on the container.</p>
+</dd>
+<dt><em>connector</em> (string, required, <code>CREATE</code>)</dt>
+<dd><p>The name of the on-demand connector used to reach the waypoint's container.</p>
+</dd>
+</dl>
<h2 id="operational-entities"><span class="header-section-number">5.2</span> Operational Entities</h2>
<p>Operational entities provide statistics and other run-time attributes of the router. The <code>qdstat(8)</code> tool provides a convenient way to query run-time statistics. You can also use the general-purpose management tool <code>qdmanage(8)</code> to query operational attributes.</p>
-<h3 id="router.link"><span class="header-section-number">5.2.1</span> router.link</h3>
+<h3 id="org.amqp.management"><span class="header-section-number">5.2.1</span> org.amqp.management</h3>
+<p>The standard AMQP management node interface.</p>
+<p>Operations allowed: <code>QUERY</code>, <code>GET-TYPES</code>, <code>GET-ANNOTATIONS</code>, <code>GET-OPERATIONS</code>, <code>GET-ATTRIBUTES</code>, <code>GET-MGMT-NODES</code>, <code>READ</code></p>
+<h4 id="operation-get-types"><span class="header-section-number">5.2.1.1</span> Operation GET-TYPES</h4>
+<p>Get the set of entity types and their inheritance relationships</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>entityType</em> (string)</dt>
+<dd><p>If set, restrict query results to entities that extend (directly or indirectly) this type</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of the entity types (strings) that it extends.</p>
+<h4 id="operation-get-attributes"><span class="header-section-number">5.2.1.2</span> Operation GET-ATTRIBUTES</h4>
+<p>Get the set of entity types and the annotations they implement</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>entityType</em> (string)</dt>
+<dd><p>If set, restrict query results to entities that extend (directly or indirectly) this type</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is a list (of strings) of attributes on that entity type.</p>
+<h4 id="operation-get-operations"><span class="header-section-number">5.2.1.3</span> Operation GET-OPERATIONS</h4>
+<p>Get the set of entity types and the operations they support</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>entityType</em> (string)</dt>
+<dd><p>If set, restrict query results to entities that extend (directly or indirectly) this type</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of operation names (strings) that it supports.</p>
+<h4 id="operation-get-annotations"><span class="header-section-number">5.2.1.4</span> Operation GET-ANNOTATIONS</h4>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>entityType</em> (string)</dt>
+<dd><p>If set, restrict query results to entities that extend (directly or indirectly) this type</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of annotations (strings) that it implements.</p>
+<h4 id="operation-query"><span class="header-section-number">5.2.1.5</span> Operation QUERY</h4>
+<p>Query for attribute values of multiple entities.</p>
+<p><strong>Request body</strong> (map)A map containing the key <code>attributeNames</code> with value a list of (string) attribute names to return. If the list or the map is empty or the body is missing all attributes are returned.</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>count</em> (integer)</dt>
+<dd><p>If set, specifies the number of entries from the result set to return. If not set return all from <code>offset</code></p>
+</dd>
+<dt><em>entityType</em> (string)</dt>
+<dd><p>If set, restrict query results to entities that extend (directly or indirectly) this type</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+<dt><em>offset</em> (integer)</dt>
+<dd><p>If set, specifies the number of the first element of the result set to be returned.</p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map with two entries. <code>attributeNames</code> is a list of the attribute names returned. <code>results</code> is a list of lists each containing the attribute values for a single entity in the same order as the names in the <code>attributeNames</code> entry. If an attribute name is not applicable for an entity then the corresponding value is <code>null</code></p>
+<p><strong>Response properties:</strong></p>
+<dl>
+<dt><em>count</em> (integer)</dt>
+<dd><p>Number of results returned</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<h4 id="operation-get-mgmt-nodes"><span class="header-section-number">5.2.1.6</span> Operation GET-MGMT-NODES</h4>
+<p>Get the addresses of all management nodes known to this router</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <code>self</code>
+</dd>
+</dl>
+<p><strong>Response body</strong> (list)A list of addresses (strings) of management nodes known to this management node.</p>
+<h3 id="management"><span class="header-section-number">5.2.2</span> management</h3>
+<p>Qpid dispatch router extensions to the standard org.amqp.management interface.</p>
+<p>Operations allowed: <code>GET-SCHEMA</code>, <code>GET-JSON-SCHEMA</code>, <code>QUERY</code>, <code>GET-TYPES</code>, <code>GET-ANNOTATIONS</code>, <code>GET-OPERATIONS</code>, <code>GET-ATTRIBUTES</code>, <code>GET-MGMT-NODES</code>, <code>READ</code></p>
+<h4 id="operation-get-schema-json"><span class="header-section-number">5.2.2.1</span> Operation GET-SCHEMA-JSON</h4>
+<p>Get the qdrouterd schema for this router in JSON format</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>indent</em> (integer)</dt>
+<dd><p>Number of spaces to indent the formatted result. If not specified, the result is in minimal format, no unnecessary spaces or newlines.</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (string)The qdrouter schema as a JSON string.</p>
+<h4 id="operation-get-schema"><span class="header-section-number">5.2.2.2</span> Operation GET-SCHEMA</h4>
+<p>Get the qdrouterd schema for this router in AMQP map format</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <code>self</code>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)The qdrouter schema as a map.</p>
+<h3 id="router.link"><span class="header-section-number">5.2.3</span> router.link</h3>
<p>Link to another AMQP endpoint: router node, client or other AMQP process.</p>
-<p><em>linkName</em> (String)</p>
+<p>Operations allowed: <code>READ</code></p>
+<p><em>linkName</em> (string)</p>
<p><em>linkType</em> (One of ['endpoint', 'waypoint', 'inter-router', 'inter-area'])</p>
<p><em>linkDir</em> (One of ['in', 'out'])</p>
-<p><em>owningAddr</em> (String)</p>
-<p><em>eventFifoDepth</em> (Integer)</p>
-<p><em>msgFifoDepth</em> (Integer)</p>
-<p><em>remoteContainer</em> (String)</p>
-<p>Operations allowed: READ</p>
-<h3 id="router.address"><span class="header-section-number">5.2.2</span> router.address</h3>
+<p><em>owningAddr</em> (string)</p>
+<p><em>eventFifoDepth</em> (integer)</p>
+<p><em>msgFifoDepth</em> (integer)</p>
+<p><em>remoteContainer</em> (string)</p>
+<h3 id="router.address"><span class="header-section-number">5.2.4</span> router.address</h3>
<p>AMQP address managed by the router.</p>
-<p><em>inProcess</em> (Boolean)</p>
-<p><em>subscriberCount</em> (Integer)</p>
-<p><em>remoteCount</em> (Integer)</p>
-<p><em>deliveriesIngress</em> (Integer)</p>
-<p><em>deliveriesEgress</em> (Integer)</p>
-<p><em>deliveriesTransit</em> (Integer)</p>
-<p><em>deliveriesToContainer</em> (Integer)</p>
-<p><em>deliveriesFromContainer</em> (Integer)</p>
-<p>Operations allowed: READ</p>
-<h3 id="router.node"><span class="header-section-number">5.2.3</span> router.node</h3>
-<p>AMQP node managed by the router.</p>
-<p><em>addr</em> (String)</p>
-<p><em>nextHop</em> (Integer)</p>
-<p><em>routerLink</em> (Integer)</p>
-<p><em>validOrigins</em> (List)</p>
-<p>Operations allowed: READ</p>
-<h3 id="connection"><span class="header-section-number">5.2.4</span> connection</h3>
+<p>Operations allowed: <code>READ</code></p>
+<p><em>inProcess</em> (boolean)</p>
+<p><em>subscriberCount</em> (integer)</p>
+<p><em>remoteCount</em> (integer)</p>
+<p><em>deliveriesIngress</em> (integer)</p>
+<p><em>deliveriesEgress</em> (integer)</p>
+<p><em>deliveriesTransit</em> (integer)</p>
+<p><em>deliveriesToContainer</em> (integer)</p>
+<p><em>deliveriesFromContainer</em> (integer)</p>
+<dl>
+<dt><em>key</em> (string)</dt>
+<dd>Internal unique (to this router) key to identify the address
+</dd>
+</dl>
+<h3 id="router.node"><span class="header-section-number">5.2.5</span> router.node</h3>
+<p>Remote router node connected to this router.</p>
+<p>Operations allowed: <code>READ</code></p>
+<dl>
+<dt><em>routerId</em> (string)</dt>
+<dd><p>Remote node identifier.</p>
+</dd>
+<dt><em>instance</em> (integer)</dt>
+<dd><p>Remote node boot number.</p>
+</dd>
+<dt><em>linkState</em> (list)</dt>
+<dd><p>List of remote node's neighbours.</p>
+</dd>
+<dt><em>nextHop</em> (string)</dt>
+<dd><p>Neighbour ID of next hop to remote node from here.</p>
+</dd>
+<dt><em>validOrigins</em> (list)</dt>
+<dd><p>List of valid origin nodes for messages arriving via the remote node, used for duplicate elimination in redundant networks.</p>
+</dd>
+<dt><em>address</em> (string)</dt>
+<dd><p>Address of the remote node</p>
+</dd>
+<dt><em>routerLink</em> (entityId)</dt>
+<dd><p>Local link to remote node</p>
+</dd>
+</dl>
+<h3 id="connection"><span class="header-section-number">5.2.6</span> connection</h3>
<p>Connections to the router's container.</p>
-<p><em>container</em> (String)</p>
+<p>Operations allowed: <code>READ</code></p>
+<dl>
+<dt><em>container</em> (string)</dt>
+<dd>The container for this connection
+</dd>
+</dl>
<p><em>state</em> (One of ['connecting', 'opening', 'operational', 'failed', 'user'])</p>
-<p><em>host</em> (String)</p>
-<p><em>dir</em> (One of ['in', 'out'])</p>
-<p><em>role</em> (String)</p>
-<p><em>sasl</em> (String)</p>
-<p>Operations allowed: READ</p>
-<h3 id="allocator"><span class="header-section-number">5.2.5</span> allocator</h3>
+<dl>
+<dt><em>host</em> (string)</dt>
+<dd><p>IP address and port number in the form addr:port.</p>
+</dd>
+<dt><em>dir</em> (One of ['in', 'out'])</dt>
+<dd><p>Direction of connection establishment in or out of the router.</p>
+</dd>
+</dl>
+<p><em>role</em> (string)</p>
+<dl>
+<dt><em>sasl</em> (string)</dt>
+<dd>SASL mechanism used for authentication.
+</dd>
+</dl>
+<h3 id="allocator"><span class="header-section-number">5.2.7</span> allocator</h3>
<p>Memory allocation pool.</p>
-<p><em>typeSize</em> (Integer)</p>
-<p><em>transferBatchSize</em> (Integer)</p>
-<p><em>localFreeListMax</em> (Integer)</p>
-<p><em>globalFreeListMax</em> (Integer)</p>
-<p><em>totalAllocFromHeap</em> (Integer)</p>
-<p><em>totalFreeToHeap</em> (Integer)</p>
-<p><em>heldByThreads</em> (Integer)</p>
-<p><em>batchesRebalancedToThreads</em> (Integer)</p>
-<p><em>batchesRebalancedToGlobal</em> (Integer)</p>
-<p>Operations allowed: READ</p>
+<p>Operations allowed: <code>READ</code></p>
+<p><em>typeName</em> (string)</p>
+<p><em>typeSize</em> (integer)</p>
+<p><em>transferBatchSize</em> (integer)</p>
+<p><em>localFreeListMax</em> (integer)</p>
+<p><em>globalFreeListMax</em> (integer)</p>
+<p><em>totalAllocFromHeap</em> (integer)</p>
+<p><em>totalFreeToHeap</em> (integer)</p>
+<p><em>heldByThreads</em> (integer)</p>
+<p><em>batchesRebalancedToThreads</em> (integer)</p>
+<p><em>batchesRebalancedToGlobal</em> (integer)</p>
+<h2 id="management-operations"><span class="header-section-number">5.3</span> Management Operations</h2>
+<p>The <code>qdstat(8)</code> and <code>qdmanage(8)</code> tools allow you to view or modify management entity attributes. They work by invoking <em>management operations</em>. You can invoke these operations from any AMQP client by sending a message with the appropriate properties and body to the <code>$management</code> address. The message should have a <code>reply-to</code> address indicating where the response should be sent.</p>
+<h3 id="operations-for-all-entity-types"><span class="header-section-number">5.3.1</span> Operations for all entity types</h3>
+<h4 id="operation-read"><span class="header-section-number">5.3.1.1</span> Operation READ</h4>
+<p>Read attributes of an entity</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>type</em> (string)</dt>
+<dd><p>Type of desired entity.</p>
+</dd>
+<dt><em>name</em> (string)</dt>
+<dd><p>Name of desired entity. Must supply name or identity.</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Identity of desired entity. Must supply name or identity.</p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)Attributes of the entity</p>
+<h4 id="operation-create"><span class="header-section-number">5.3.1.2</span> Operation CREATE</h4>
+<p>Create a new entity.</p>
+<p><strong>Request body</strong> (map, required)Attributes for the new entity. Can include name and/or type.</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>type</em> (string, required)</dt>
+<dd><p>Type of new entity.</p>
+</dd>
+<dt><em>name</em> (string)</dt>
+<dd><p>Name of new entity. Optional, defaults to identity.</p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)Attributes of the entity</p>
+<h4 id="operation-update"><span class="header-section-number">5.3.1.3</span> Operation UPDATE</h4>
+<p>Update attributes of an entity</p>
+<p><strong>Request body</strong> (map)Attributes to update for the entity. Can include name or identity.</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>type</em> (string)</dt>
+<dd><p>Type of desired entity.</p>
+</dd>
+<dt><em>name</em> (string)</dt>
+<dd><p>Name of desired entity. Must supply name or identity.</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Identity of desired entity. Must supply name or identity.</p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)Updated attributes of the entity</p>
+<h4 id="operation-delete"><span class="header-section-number">5.3.1.4</span> Operation DELETE</h4>
+<p>Delete an entity</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>type</em> (string)</dt>
+<dd><p>Type of desired entity.</p>
+</dd>
+<dt><em>name</em> (string)</dt>
+<dd><p>Name of desired entity. Must supply name or identity.</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Identity of desired entity. Must supply name or identity.</p>
+</dd>
+</dl>
+<h3 id="operations-for-org.amqp.management-entity-type"><span class="header-section-number">5.3.2</span> Operations for <code>org.amqp.management</code> entity type</h3>
+<h4 id="operation-get-types-1"><span class="header-section-number">5.3.2.1</span> Operation GET-TYPES</h4>
+<p>Get the set of entity types and their inheritance relationships</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>entityType</em> (string)</dt>
+<dd><p>If set, restrict query results to entities that extend (directly or indirectly) this type</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of the entity types (strings) that it extends.</p>
+<h4 id="operation-get-attributes-1"><span class="header-section-number">5.3.2.2</span> Operation GET-ATTRIBUTES</h4>
+<p>Get the set of entity types and the annotations they implement</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>entityType</em> (string)</dt>
+<dd><p>If set, restrict query results to entities that extend (directly or indirectly) this type</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is a list (of strings) of attributes on that entity type.</p>
+<h4 id="operation-get-operations-1"><span class="header-section-number">5.3.2.3</span> Operation GET-OPERATIONS</h4>
+<p>Get the set of entity types and the operations they support</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>entityType</em> (string)</dt>
+<dd><p>If set, restrict query results to entities that extend (directly or indirectly) this type</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of operation names (strings) that it supports.</p>
+<h4 id="operation-get-annotations-1"><span class="header-section-number">5.3.2.4</span> Operation GET-ANNOTATIONS</h4>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>entityType</em> (string)</dt>
+<dd><p>If set, restrict query results to entities that extend (directly or indirectly) this type</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of annotations (strings) that it implements.</p>
+<h4 id="operation-query-1"><span class="header-section-number">5.3.2.5</span> Operation QUERY</h4>
+<p>Query for attribute values of multiple entities.</p>
+<p><strong>Request body</strong> (map)A map containing the key <code>attributeNames</code> with value a list of (string) attribute names to return. If the list or the map is empty or the body is missing all attributes are returned.</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>count</em> (integer)</dt>
+<dd><p>If set, specifies the number of entries from the result set to return. If not set return all from <code>offset</code></p>
+</dd>
+<dt><em>entityType</em> (string)</dt>
+<dd><p>If set, restrict query results to entities that extend (directly or indirectly) this type</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+<dt><em>offset</em> (integer)</dt>
+<dd><p>If set, specifies the number of the first element of the result set to be returned.</p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map with two entries. <code>attributeNames</code> is a list of the attribute names returned. <code>results</code> is a list of lists each containing the attribute values for a single entity in the same order as the names in the <code>attributeNames</code> entry. If an attribute name is not applicable for an entity then the corresponding value is <code>null</code></p>
+<p><strong>Response properties:</strong></p>
+<dl>
+<dt><em>count</em> (integer)</dt>
+<dd><p>Number of results returned</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<h4 id="operation-get-mgmt-nodes-1"><span class="header-section-number">5.3.2.6</span> Operation GET-MGMT-NODES</h4>
+<p>Get the addresses of all management nodes known to this router</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <code>self</code>
+</dd>
+</dl>
+<p><strong>Response body</strong> (list)A list of addresses (strings) of management nodes known to this management node.</p>
+<h3 id="operations-for-management-entity-type"><span class="header-section-number">5.3.3</span> Operations for <code>management</code> entity type</h3>
+<h4 id="operation-get-schema-json-1"><span class="header-section-number">5.3.3.1</span> Operation GET-SCHEMA-JSON</h4>
+<p>Get the qdrouterd schema for this router in JSON format</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>indent</em> (integer)</dt>
+<dd><p>Number of spaces to indent the formatted result. If not specified, the result is in minimal format, no unnecessary spaces or newlines.</p>
+</dd>
+<dt><em>identity</em> (string)</dt>
+<dd><p>Set to the value <code>self</code></p>
+</dd>
+</dl>
+<p><strong>Response body</strong> (string)The qdrouter schema as a JSON string.</p>
+<h4 id="operation-get-schema-1"><span class="header-section-number">5.3.3.2</span> Operation GET-SCHEMA</h4>
+<p>Get the qdrouterd schema for this router in AMQP map format</p>
+<p><strong>Request properties:</strong></p>
+<dl>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <code>self</code>
+</dd>
+</dl>
+<p><strong>Response body</strong> (map)The qdrouter schema as a map.</p>
Modified: qpid/site/input/releases/qpid-dispatch-trunk/book.pdf
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-trunk/book.pdf?rev=1658800&r1=1658799&r2=1658800&view=diff
==============================================================================
Binary files - no diff available.
Modified: qpid/site/input/releases/qpid-dispatch-trunk/index.md
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-trunk/index.md?rev=1658800&r1=1658799&r2=1658800&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-trunk/index.md (original)
+++ qpid/site/input/releases/qpid-dispatch-trunk/index.md Tue Feb 10 20:33:25 2015
@@ -27,7 +27,7 @@ Code and documentation found here may be
incomplete. For a smoother experience, see the
[current stable release](@current-dispatch-release-url@/index.html).
-This content was generated at 16:14 on Wednesday, 21 January 2015.
+This content was generated at 15:28 on Tuesday, 10 February 2015.
</div>
@@ -38,13 +38,13 @@ This content was generated at 16:14 on
<div class="column" markdown="1">
- [Installing Qpid Dispatch](http://svn.apache.org/repos/asf/qpid/dispatch/trunk/README)
- [Dispatch router book](book.html) ([PDF](book.pdf))
-- [Dispatch Library API](api/index.html)
+- [Dispatch library API](api/index.html)
</div>
<div class="column" markdown="1">
-- [qdrouterd](qdrouterd.8.html) The router daemon
-- [qdrouterd.conf](qdrouterd.conf.5.html) Router daemon configuration
-- [qdstat](qdstat.8.html) Check statistics for a running router
-- [qdmanage](qdmanage.8.html) Check statistics for a running router
+- [qdrouterd](qdrouterd.8.html) - The router daemon
+- [qdrouterd.conf](qdrouterd.conf.5.html) - Router daemon configuration
+- [qdstat](qdstat.8.html) - Check statistics for a running router
+- [qdmanage](qdmanage.8.html) - Check statistics for a running router
</div>
</div>
Modified: qpid/site/input/releases/qpid-dispatch-trunk/qdmanage.8.html
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-trunk/qdmanage.8.html?rev=1658800&r1=1658799&r2=1658800&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-trunk/qdmanage.8.html (original)
+++ qpid/site/input/releases/qpid-dispatch-trunk/qdmanage.8.html Tue Feb 10 20:33:25 2015
@@ -44,7 +44,10 @@
<dd><p>List entity types with their annotations. With no arguments list all types.</p>
</dd>
<dt><code>get-mgmt-nodes</code></dt>
-<dd>List all other known management nodes connected to this one.
+<dd><p>List all other known management nodes connected to this one.</p>
+</dd>
+<dt><code>get-json-schema</code> [<em>INDENT</em>]</dt>
+<dd>Get the router schema in JSON format. Optional integer indent for formatted output.
</dd>
</dl>
<h1 id="options">OPTIONS</h1>
@@ -70,6 +73,12 @@
<dt>--stdin</dt>
<dd><p>Read attributes as JSON map or list of maps from stdin.</p>
</dd>
+<dt>--body=BODY</dt>
+<dd><p>JSON value to use as body of a non-standard operation call.</p>
+</dd>
+<dt>--properties=PROPERTIES</dt>
+<dd><p>JSON map to use as properties for a non-standard operation call.</p>
+</dd>
</dl>
<h2 id="connection-options">CONNECTION OPTIONS</h2>
<dl>
Modified: qpid/site/input/releases/qpid-dispatch-trunk/qdrouterd.conf.5.html
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-trunk/qdrouterd.conf.5.html?rev=1658800&r1=1658799&r2=1658800&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-trunk/qdrouterd.conf.5.html (original)
+++ qpid/site/input/releases/qpid-dispatch-trunk/qdrouterd.conf.5.html Tue Feb 10 20:33:25 2015
@@ -34,230 +34,237 @@ listener {
port: 20102
sasl-mechanisms: ANONYMOUS
}</code></pre>
-<h1 id="annotation-sections">Annotation Sections</h1>
-<h2 id="addrport">addrPort</h2>
+<h2 id="annotation-sections">Annotation Sections</h2>
+<h3 id="addrport">addrPort</h3>
<p>Attributes for internet address and port.</p>
+<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p>
<dl>
-<dt>addr (String, default=0.0.0.0)</dt>
-<dd><p>Host address: ipv4 or ipv6 literal or a host name.</p>
+<dt><em>addr</em> (string, default='0.0.0.0')</dt>
+<dd><p>IP address: ipv4 or ipv6 literal or a host name.</p>
</dd>
-<dt>port (String, default=amqp)</dt>
+<dt><em>port</em> (string, default='amqp')</dt>
<dd><p>Port number or symbolic service name.</p>
</dd>
</dl>
-<p>Used by listener, connector.</p>
-<h2 id="saslmechanisms">saslMechanisms</h2>
+<h3 id="saslmechanisms">saslMechanisms</h3>
<p>Attribute for a list of SASL mechanisms.</p>
+<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p>
<dl>
-<dt>saslMechanisms (String, required)</dt>
+<dt><em>saslMechanisms</em> (string, required)</dt>
<dd>Comma separated list of accepted SASL authentication mechanisms.
</dd>
</dl>
-<p>Used by listener, connector.</p>
-<h2 id="connectionrole">connectionRole</h2>
+<h3 id="connectionrole">connectionRole</h3>
<p>Attribute for the role of a connection.</p>
+<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p>
<dl>
-<dt>role (One of ['normal', 'inter-router', 'on-demand'], default=normal)</dt>
-<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over interRouter connections.
+<dt><em>role</em> (One of ['normal', 'inter-router', 'on-demand'], default='normal')</dt>
+<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.
</dd>
</dl>
-<p>Used by listener, connector.</p>
-<h2 id="sslprofile">sslProfile</h2>
+<h3 id="sslprofile">sslProfile</h3>
<p>Attributes for setting TLS/SSL configuration for connections.</p>
+<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p>
<dl>
-<dt>certDb (String)</dt>
-<dd><p>The path to the database that contains the public certificates of trusted certificate authorities (CAs).</p>
+<dt><em>certDb</em> (string)</dt>
+<dd><p>The path to the database that contains the public certificates of trusted certificate authorities (CA).</p>
</dd>
-<dt>certFile (String)</dt>
+<dt><em>certFile</em> (string)</dt>
<dd><p>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</p>
</dd>
-<dt>keyFile (String)</dt>
+<dt><em>keyFile</em> (string)</dt>
<dd><p>The path to the file containing the PEM-formatted private key for the above certificate.</p>
</dd>
-<dt>passwordFile (String)</dt>
+<dt><em>passwordFile</em> (string)</dt>
<dd><p>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</p>
</dd>
-<dt>password (String)</dt>
+<dt><em>password</em> (string)</dt>
<dd><p>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the 'password' option. Don't use both password and passwordFile in the same profile.</p>
</dd>
</dl>
-<p>Used by listener, connector.</p>
-<h1 id="configuration-sections">Configuration Sections</h1>
-<h2 id="container">container</h2>
+<h2 id="configuration-sections">Configuration Sections</h2>
+<h3 id="container">container</h3>
<p>Attributes related to the AMQP container.</p>
<dl>
-<dt>containerName (String)</dt>
+<dt><em>containerName</em> (string)</dt>
<dd><p>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.</p>
</dd>
-<dt>workerThreads (Integer, default=1)</dt>
+<dt><em>workerThreads</em> (integer, default=1)</dt>
<dd><p>The number of threads that will be created to process message traffic and other application work (timers, non-amqp file descriptors, etc.) .</p>
</dd>
-<dt>debugDump (String)</dt>
+<dt><em>debugDump</em> (string)</dt>
<dd><p>A file to dump debugging information that can't be logged normally.</p>
</dd>
-<dt>name (String, unique)</dt>
-<dd><p>Unique name, can be changed.</p>
-</dd>
-<dt>identity (String, unique)</dt>
-<dd><p>Unique identity, will not change.</p>
-</dd>
</dl>
-<h2 id="router">router</h2>
+<h3 id="router">router</h3>
<p>Tracks peer routers and computes routes to destinations.</p>
<dl>
-<dt>routerId (String)</dt>
+<dt><em>routerId</em> (string)</dt>
<dd><p>Router's unique identity.</p>
</dd>
-<dt>mode (One of ['standalone', 'interior', 'edge', 'endpoint'], default=standalone)</dt>
-<dd><p>In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not coorperate with other routers. In interior mode, the router operates in cooreration with other interior routers in an interconnected network. In edge mode, the router operates with an uplink into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.</p>
-</dd>
-<dt>area (String)</dt>
-<dd><p>Unused placeholder.</p>
+<dt><em>mode</em> (One of ['standalone', 'interior', 'edge', 'endpoint'], default='standalone')</dt>
+<dd><p>In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not cooperate with other routers. In interior mode, the router operates in cooperation with other interior routers in an interconnected network. In edge mode, the router operates with an up link into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.</p>
</dd>
-<dt>helloInterval (Integer, default=1)</dt>
+<dt><em>helloInterval</em> (integer, default=1)</dt>
<dd><p>Interval in seconds between HELLO messages sent to neighbor routers.</p>
</dd>
-<dt>helloMaxAge (Integer, default=3)</dt>
+<dt><em>helloMaxAge</em> (integer, default=3)</dt>
<dd><p>Time in seconds after which a neighbor is declared lost if no HELLO is received.</p>
</dd>
-<dt>raInterval (Integer, default=30)</dt>
+<dt><em>raInterval</em> (integer, default=30)</dt>
<dd><p>Interval in seconds between Router-Advertisements sent to all routers in a stable network.</p>
</dd>
-<dt>raIntervalFlux (Integer, default=4)</dt>
+<dt><em>raIntervalFlux</em> (integer, default=4)</dt>
<dd><p>Interval in seconds between Router-Advertisements sent to all routers during topology fluctuations.</p>
</dd>
-<dt>remoteLsMaxAge (Integer, default=60)</dt>
+<dt><em>remoteLsMaxAge</em> (integer, default=60)</dt>
<dd><p>Time in seconds after which link state is declared stale if no RA is received.</p>
</dd>
-<dt>mobileAddrMaxAge (Integer, default=60)</dt>
+<dt><em>mobileAddrMaxAge</em> (integer, default=60)</dt>
<dd><p>Deprecated - This value is no longer used in the router.</p>
</dd>
-<dt>addrCount (Integer)</dt>
-<dd><p>Number of addresses known to the router.</p>
+</dl>
+<h3 id="listener">listener</h3>
+<p>Listens for incoming connections to the router.</p>
+<p>Annotations: <strong>addrPort</strong>, <strong>connectionRole</strong>, <strong>sslProfile</strong>, <strong>saslMechanisms</strong>.</p>
+<dl>
+<dt><em>addr</em> (string, default='0.0.0.0')</dt>
+<dd><p>IP address: ipv4 or ipv6 literal or a host name.</p>
</dd>
-<dt>linkCount (Integer)</dt>
-<dd><p>Number of links attached to the router node.</p>
+<dt><em>port</em> (string, default='amqp')</dt>
+<dd><p>Port number or symbolic service name.</p>
</dd>
-<dt>nodeCount (Integer)</dt>
-<dd><p>Number of known peer router nodes.</p>
+<dt><em>role</em> (One of ['normal', 'inter-router', 'on-demand'], default='normal')</dt>
+<dd><p>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.</p>
</dd>
-<dt>name (String, unique)</dt>
-<dd><p>Unique name, can be changed.</p>
+<dt><em>certDb</em> (string)</dt>
+<dd><p>The path to the database that contains the public certificates of trusted certificate authorities (CA).</p>
</dd>
-<dt>identity (String, unique)</dt>
-<dd><p>Unique identity, will not change.</p>
+<dt><em>certFile</em> (string)</dt>
+<dd><p>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</p>
</dd>
-</dl>
-<h2 id="listener">listener</h2>
-<p>Listens for incoming connections to the router.</p>
-<dl>
-<dt>requirePeerAuth (Boolean, default=True)</dt>
+<dt><em>keyFile</em> (string)</dt>
+<dd><p>The path to the file containing the PEM-formatted private key for the above certificate.</p>
+</dd>
+<dt><em>passwordFile</em> (string)</dt>
+<dd><p>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</p>
+</dd>
+<dt><em>password</em> (string)</dt>
+<dd><p>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the 'password' option. Don't use both password and passwordFile in the same profile.</p>
+</dd>
+<dt><em>saslMechanisms</em> (string, required)</dt>
+<dd><p>Comma separated list of accepted SASL authentication mechanisms.</p>
+</dd>
+<dt><em>requirePeerAuth</em> (boolean, default=True)</dt>
<dd><p>Only for listeners using SSL. If set to 'yes', attached clients will be required to supply a certificate. If the certificate is not traceable to a CA in the ssl profile's cert-db, authentication fails for the connection.</p>
</dd>
-<dt>trustedCerts (String)</dt>
+<dt><em>trustedCerts</em> (string)</dt>
<dd><p>This optional setting can be used to reduce the set of available CAs for client authentication. If used, this setting must provide a path to a PEM file that contains the trusted certificates.</p>
</dd>
-<dt>allowUnsecured (Boolean)</dt>
-<dd><p>For listeners using SSL only. If set to 'yes', this option causes the listener to watch the initial network traffic to determine if the client is using SSL or is running in-the-clear. The listener will enable SSL only if the client uis using SSL.</p>
+<dt><em>allowUnsecured</em> (boolean)</dt>
+<dd><p>For listeners using SSL only. If set to 'yes', this option causes the listener to watch the initial network traffic to determine if the client is using SSL or is running in-the-clear. The listener will enable SSL only if the client is using SSL.</p>
</dd>
-<dt>allowNoSasl (Boolean)</dt>
+<dt><em>allowNoSasl</em> (boolean)</dt>
<dd><p>If set to 'yes', this option causes the listener to allow clients to connect even if they skip the SASL authentication protocol.</p>
</dd>
-<dt>maxFrameSize (Integer, default=65536)</dt>
-<dd><p>Defaults to 65536. If specified, it is the maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uniterruptible data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.</p>
-</dd>
-<dt>name (String, unique)</dt>
-<dd><p>Unique name, can be changed.</p>
-</dd>
-<dt>identity (String, unique)</dt>
-<dd><p>Unique identity, will not change.</p>
+<dt><em>maxFrameSize</em> (integer, default=65536)</dt>
+<dd><p>Defaults to 65536. If specified, it is the maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.</p>
</dd>
</dl>
-<p>Annotations addrPort, connectionRole, sslProfile, saslMechanisms.</p>
-<h2 id="connector">connector</h2>
+<h3 id="connector">connector</h3>
<p>Establishes an outgoing connections from the router.</p>
+<p>Annotations: <strong>addrPort</strong>, <strong>connectionRole</strong>, <strong>sslProfile</strong>, <strong>saslMechanisms</strong>.</p>
<dl>
-<dt>allowRedirect (Boolean, default=True)</dt>
-<dd><p>Allow the peer to redirect this connection to another address.</p>
+<dt><em>addr</em> (string, default='0.0.0.0')</dt>
+<dd><p>IP address: ipv4 or ipv6 literal or a host name.</p>
</dd>
-<dt>maxFrameSize (Integer, default=65536)</dt>
-<dd><p>Maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uniterruptible data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.</p>
+<dt><em>port</em> (string, default='amqp')</dt>
+<dd><p>Port number or symbolic service name.</p>
+</dd>
+<dt><em>role</em> (One of ['normal', 'inter-router', 'on-demand'], default='normal')</dt>
+<dd><p>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.</p>
+</dd>
+<dt><em>certDb</em> (string)</dt>
+<dd><p>The path to the database that contains the public certificates of trusted certificate authorities (CA).</p>
</dd>
-<dt>name (String, unique)</dt>
-<dd><p>Unique name, can be changed.</p>
+<dt><em>certFile</em> (string)</dt>
+<dd><p>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</p>
</dd>
-<dt>identity (String, unique)</dt>
-<dd><p>Unique identity, will not change.</p>
+<dt><em>keyFile</em> (string)</dt>
+<dd><p>The path to the file containing the PEM-formatted private key for the above certificate.</p>
+</dd>
+<dt><em>passwordFile</em> (string)</dt>
+<dd><p>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</p>
+</dd>
+<dt><em>password</em> (string)</dt>
+<dd><p>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the 'password' option. Don't use both password and passwordFile in the same profile.</p>
+</dd>
+<dt><em>saslMechanisms</em> (string, required)</dt>
+<dd><p>Comma separated list of accepted SASL authentication mechanisms.</p>
+</dd>
+<dt><em>allowRedirect</em> (boolean, default=True)</dt>
+<dd><p>Allow the peer to redirect this connection to another address.</p>
+</dd>
+<dt><em>maxFrameSize</em> (integer, default=65536)</dt>
+<dd><p>Maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.</p>
</dd>
</dl>
-<p>Annotations addrPort, connectionRole, sslProfile, saslMechanisms.</p>
-<h2 id="log">log</h2>
-<p>Configure logging for a particular module.</p>
+<h3 id="log">log</h3>
+<p>Configure logging for a particular module. You can use the <code>UPDATE</code> operation to change log settings while the router is running.</p>
<dl>
-<dt>module (One of ['ROUTER', 'ROUTER_HELLO', 'ROUTER_LS', 'ROUTER_MA', 'MESSAGE', 'SERVER', 'AGENT', 'CONTAINER', 'CONFIG', 'ERROR', 'DISPATCH', 'DEFAULT'], required)</dt>
-<dd><p>Module to configure. The special module 'DEFAULT' specifies defaults for all modules.</p>
-</dd>
-<dt>enable (String, required, default=default)</dt>
+<dt><em>enable</em> (string, default='default', required)</dt>
<dd><p>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.</p>
</dd>
-<dt>timestamp (Boolean)</dt>
+<dt><em>timestamp</em> (boolean)</dt>
<dd><p>Include timestamp in log messages.</p>
</dd>
-<dt>source (Boolean)</dt>
+<dt><em>source</em> (boolean)</dt>
<dd><p>Include source file and line number in log messages.</p>
</dd>
-<dt>output (String)</dt>
+<dt><em>output</em> (string)</dt>
<dd><p>Where to send log messages. Can be 'stderr', 'syslog' or a file name.</p>
</dd>
-<dt>name (String, unique)</dt>
-<dd><p>Unique name, can be changed.</p>
-</dd>
-<dt>identity (String, unique)</dt>
-<dd><p>Unique identity, will not change.</p>
-</dd>
</dl>
-<h2 id="fixedaddress">fixedAddress</h2>
+<h3 id="fixedaddress">fixedAddress</h3>
<p>Establishes semantics for addresses starting with a prefix.</p>
<dl>
-<dt>prefix (String, required)</dt>
+<dt><em>prefix</em> (string, required)</dt>
<dd><p>The address prefix (always starting with '/').</p>
</dd>
-<dt>phase (Integer)</dt>
+<dt><em>phase</em> (integer)</dt>
<dd><p>The phase of a multi-hop address passing through one or more waypoints.</p>
</dd>
-<dt>fanout (One of ['multiple', 'single'], default=multiple)</dt>
+<dt><em>fanout</em> (One of ['multiple', 'single'], default='multiple')</dt>
<dd><p>One of 'multiple' or 'single'. Multiple fanout is a non-competing pattern. If there are multiple consumers using the same address, each consumer will receive its own copy of every message sent to the address. Single fanout is a competing pattern where each message is sent to only one consumer.</p>
</dd>
-<dt>bias (One of ['closest', 'spread'], default=closest)</dt>
+<dt><em>bias</em> (One of ['closest', 'spread'], default='closest')</dt>
<dd><p>Only if fanout is single. One of 'closest' or 'spread'. Closest bias means that messages to an address will always be delivered to the closest (lowest cost) subscribed consumer. Spread bias will distribute the messages across subscribers in an approximately even manner.</p>
</dd>
-<dt>name (String, unique)</dt>
-<dd><p>Unique name, can be changed.</p>
-</dd>
-<dt>identity (String, unique)</dt>
-<dd><p>Unique identity, will not change.</p>
-</dd>
</dl>
-<h2 id="waypoint">waypoint</h2>
+<h3 id="waypoint">waypoint</h3>
<p>A remote node that messages for an address pass through.</p>
<dl>
-<dt>address (String, required)</dt>
+<dt><em>address</em> (string, required)</dt>
<dd><p>The AMQP address of the waypoint.</p>
</dd>
-<dt>connector (String, required)</dt>
+<dt><em>connector</em> (string, required)</dt>
<dd><p>The name of the on-demand connector used to reach the waypoint's container.</p>
</dd>
-<dt>inPhase (Integer, default=-1)</dt>
+<dt><em>inPhase</em> (integer, default=-1)</dt>
<dd><p>The phase of the address as it is routed <em>to</em> the waypoint.</p>
</dd>
-<dt>outPhase (Integer, default=-1)</dt>
+<dt><em>outPhase</em> (integer, default=-1)</dt>
<dd><p>The phase of the address as it is routed <em>from</em> the waypoint.</p>
</dd>
-<dt>name (String, unique)</dt>
-<dd><p>Unique name, can be changed.</p>
+</dl>
+<h3 id="linkroutepattern">linkRoutePattern</h3>
+<p>A pattern to match a connected container to endpoints for routed links.</p>
+<dl>
+<dt><em>prefix</em> (string, required)</dt>
+<dd><p>The AMQP address prefix for nodes on the container.</p>
</dd>
-<dt>identity (String, unique)</dt>
-<dd><p>Unique identity, will not change.</p>
+<dt><em>connector</em> (string, required)</dt>
+<dd><p>The name of the on-demand connector used to reach the waypoint's container.</p>
</dd>
</dl>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org