http://git-wip-us.apache.org/repos/asf/qpid-site/blob/3cbe9ebf/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 775e7a4..685fc17 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 15:45 on Thursday, 30 June 2016. +This content was generated at 09:51 on Monday, 08 August 2016. </div>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/3cbe9ebf/input/releases/qpid-dispatch-master/qdmanage.8.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-master/qdmanage.8.html.in b/input/releases/qpid-dispatch-master/qdmanage.8.html.in index 82a43f8..576260c 100644 --- a/input/releases/qpid-dispatch-master/qdmanage.8.html.in +++ b/input/releases/qpid-dispatch-master/qdmanage.8.html.in @@ -1,52 +1,76 @@ -<h2>NAME</h2> -<p>qdmanage - - management client to control or query qdrouterd(8) -</p> -<h2><a name="_synopsis"></a>SYNOPSIS</h2> -<p><strong>qdmanage</strong> [<b>OPTIONS</b>] <b>OPERATION</b> [<b>ARGUMENTS</b>]</p> -<h2><a name="_description"></a>DESCRIPTION</h2> -<p>An AMQP management client for use with qdrouterd. Sends AMQP management +<div class="sect1"> +<h2 id="_synopsis">SYNOPSIS</h2> +<div class="sectionbody"> +<div class="paragraph"><p><strong>qdmanage</strong> [<em>OPTIONS</em>] <em>OPERATION</em> [<em>ARGUMENTS</em>]</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"><p>An AMQP management client for use with qdrouterd. Sends AMQP management operations requests and prints the response in JSON format. This is a generic AMQP management tool and can be used with any standard AMQP -managed endpoint, not just with qdrouter.</p> -<h2><a name="_options"></a>OPTIONS</h2> -<p>-h, --help -: show this help message and exit</p> -<p>--version -: Print version and exit.</p> -<p>--type=TYPE -: Type of entity to operate on.</p> -<p>--name=NAME -: Name of entity to operate on.</p> -<p>--identity=ID -: Identity of entity to operate on.</p> -<p>--indent=INDENT -: Pretty-printing indent. -1 means don’t pretty-print (default 2)</p> -<p>--stdin -: Read attributes as JSON map or list of maps from stdin.</p> -<p>--body=BODY -: JSON value to use as body of a non-standard operation call.</p> -<p>--properties=PROPERTIES -: JSON map to use as properties for a non-standard operation call.</p> -<h3><a name="_connection_options"></a>Connection Options</h3> -<p>-b URL, --bus=URL -: URL of the messaging bus to connect to (default 0.0.0.0)</p> -<p>-r ROUTER-ID, --router=ROUTER-ID -: Router to be queried</p> -<p>-t SECS, --timeout=SECS -: Maximum time to wait for connection in seconds (default 5)</p> -<p>--ssl-certificate=CERT -: Client SSL certificate (PEM Format)</p> -<p>--ssl-key=KEY -: Client SSL private key (PEM Format)</p> -<p>--ssl-trustfile=TRUSTED-CA-DB -: Trusted Certificate Authority Database file (PEM Format)</p> -<p>--ssl-password=PASSWORD -: Certificate password, will be prompted if not specifed.</p> -<h2><a name="_operations"></a>OPERATIONS</h2> -<dl> -<dt> -<code>query</code> [<b>ATTR</b>…] +managed endpoint, not just with qdrouter.</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_options">OPTIONS</h2> +<div class="sectionbody"> +<div class="paragraph"><p>-h, --help +: show this help message and exit</p></div> +<div class="paragraph"><p>--version +: Print version and exit.</p></div> +<div class="paragraph"><p>--type=TYPE +: Type of entity to operate on.</p></div> +<div class="paragraph"><p>--name=NAME +: Name of entity to operate on.</p></div> +<div class="paragraph"><p>--identity=ID +: Identity of entity to operate on.</p></div> +<div class="paragraph"><p>--indent=INDENT +: Pretty-printing indent. -1 means don’t pretty-print</p></div> +<div class="paragraph"><p>--stdin +: Read attributes as JSON map or list of maps from</p></div> +<div class="paragraph"><p>--body=BODY +: JSON value to use as body of a non-standard operation</p></div> +<div class="paragraph"><p>--properties=PROPERTIES +: JSON map to use as properties for a non-standard operation call.</p></div> +<div class="sect2"> +<h3 id="_connection_options">Connection Options</h3> +<div class="paragraph"><p>-b URL, --bus=URL +: URL of the messaging bus to connect to (default 0.0.0.0)</p></div> +<div class="paragraph"><p>-r ROUTER-ID, --router=ROUTER-ID +: Router to be queried</p></div> +<div class="paragraph"><p>-t SECS, --timeout=SECS +: Maximum time to wait for connection in seconds (default 5)</p></div> +<div class="paragraph"><p>--ssl-certificate=CERT +: Client SSL certificate (PEM Format)</p></div> +<div class="paragraph"><p>--ssl-key=KEY +: Client SSL private key (PEM Format)</p></div> +<div class="paragraph"><p>--ssl-trustfile=TRUSTED-CA-DB +: Trusted Certificate Authority Database file (PEM Format)</p></div> +<div class="paragraph"><p>--ssl-password=PASSWORD +: Certificate password, will be prompted if not specifed.</p></div> +<div class="paragraph"><p>--ssl-password-file=SSL-PASSWORD-FILE +: Certificate password, will be prompted if not specifed.</p></div> +<div class="paragraph"><p>--sasl-mechanisms=SASL-MECHANISMS +: Allowed sasl mechanisms to be supplied during the sasl handshake.</p></div> +<div class="paragraph"><p>--sasl-username=SASL-USERNAME +: User name for SASL plain authentication</p></div> +<div class="paragraph"><p>--sasl-password=SASL-PASSWORD +: Password for SASL plain authentication</p></div> +<div class="paragraph"><p>--sasl-password-file=SASL-PASSWORD-FILE +: Password for SASL plain authentication</p></div> +<div class="paragraph"><p>--ssl-disable-peer-name-verify +: Disables SSL peer name verification. WARNING - This option is insecure and must not be used in production environments</p></div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_operations">OPERATIONS</h2> +<div class="sectionbody"> +<div class="dlist"><dl> +<dt class="hdlist1"> +<code>query</code> [<em>ATTR</em>…] </dt> <dd> <p> @@ -56,8 +80,8 @@ managed endpoint, not just with qdrouter.</p> listed. </p> </dd> -<dt> -<code>create</code> [<b>ATTR=VALUE</b>…] +<dt class="hdlist1"> +<code>create</code> [<em>ATTR=VALUE</em>…] </dt> <dd> <p> @@ -67,7 +91,7 @@ managed endpoint, not just with qdrouter.</p> multiple entities. </p> </dd> -<dt> +<dt class="hdlist1"> <code>read</code> </dt> <dd> @@ -76,8 +100,8 @@ managed endpoint, not just with qdrouter.</p> --identity options. </p> </dd> -<dt> -<code>update</code> [<b>ATTR=VALUE</b>…] +<dt class="hdlist1"> +<code>update</code> [<em>ATTR=VALUE</em>…] </dt> <dd> <p> @@ -87,7 +111,7 @@ managed endpoint, not just with qdrouter.</p> update a single entity, or a JSON list of maps to update multiple entities. </p> </dd> -<dt> +<dt class="hdlist1"> <code>delete</code> </dt> <dd> @@ -95,8 +119,8 @@ managed endpoint, not just with qdrouter.</p> Delete an entity specified by the --name or --identity options. </p> </dd> -<dt> -<code>get-types</code> [<b>TYPE</b>] +<dt class="hdlist1"> +<code>get-types</code> [<em>TYPE</em>] </dt> <dd> <p> @@ -104,8 +128,8 @@ managed endpoint, not just with qdrouter.</p> types. </p> </dd> -<dt> -<code>get-operations</code> [<b>TYPE</b>] +<dt class="hdlist1"> +<code>get-operations</code> [<em>TYPE</em>] </dt> <dd> <p> @@ -113,8 +137,8 @@ managed endpoint, not just with qdrouter.</p> types. </p> </dd> -<dt> -<code>get-attributes</code> [<b>TYPE</b>] +<dt class="hdlist1"> +<code>get-attributes</code> [<em>TYPE</em>] </dt> <dd> <p> @@ -122,8 +146,8 @@ managed endpoint, not just with qdrouter.</p> types. </p> </dd> -<dt> -<code>get-annotations</code> [<b>TYPE</b>] +<dt class="hdlist1"> +<code>get-annotations</code> [<em>TYPE</em>] </dt> <dd> <p> @@ -131,7 +155,7 @@ managed endpoint, not just with qdrouter.</p> types. </p> </dd> -<dt> +<dt class="hdlist1"> <code>get-mgmt-nodes</code> </dt> <dd> @@ -139,8 +163,8 @@ managed endpoint, not just with qdrouter.</p> List all other known management nodes connected to this one. </p> </dd> -<dt> -<code>get-json-schema</code> [<b>INDENT</b>] +<dt class="hdlist1"> +<code>get-json-schema</code> [<em>INDENT</em>] </dt> <dd> <p> @@ -148,18 +172,22 @@ managed endpoint, not just with qdrouter.</p> formatted output. </p> </dd> -<dt> -<code>get-log</code> [<b>INDENT</b>] +<dt class="hdlist1"> +<code>get-log</code> [<em>INDENT</em>] </dt> <dd> <p> Get recent log entries from the router. </p> </dd> -</dl> -<h2><a name="_files"></a>FILES</h2> -<dl> -<dt> +</dl></div> +</div> +</div> +<div class="sect1"> +<h2 id="_files">FILES</h2> +<div class="sectionbody"> +<div class="dlist"><dl> +<dt class="hdlist1"> /usr/local/share/doc/qpid-dispatch/qdrouter.json </dt> <dd> @@ -167,7 +195,7 @@ managed endpoint, not just with qdrouter.</p> Management schema for qdrouterd. </p> </dd> -<dt> +<dt class="hdlist1"> /usr/local/share/doc/qpid-dispatch/qdrouter.json.readme.txt </dt> <dd> @@ -175,28 +203,43 @@ managed endpoint, not just with qdrouter.</p> Explanation of the management schema. </p> </dd> -</dl> -<h2><a name="_examples"></a>EXAMPLES</h2> -<p><b>Show the logging configuration</b></p> -<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td> +</dl></div> +</div> +</div> +<div class="sect1"> +<h2 id="_examples">EXAMPLES</h2> +<div class="sectionbody"> +<div class="listingblock"> +<div class="title">Show the logging configuration</div> +<div class="content"> <pre><code>qdmanage query --type=log</code></pre> -</td></tr></table> -<p><b>Enable debug and higher log messages by default:</b></p> -<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td> +</div></div> +<div class="listingblock"> +<div class="title">Enable debug and higher log messages by default:</div> +<div class="content"> <pre><code>qdmanage update name=log/DEFAULT enable=debug+</code></pre> -</td></tr></table> -<p><b>Enable trace log messages only for the MESSAGE module and direct MESSAGE logs to the file "test.log"</b></p> -<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td> +</div></div> +<div class="listingblock"> +<div class="title">Enable trace log messages only for the MESSAGE module and direct MESSAGE logs to the file "test.log"</div> +<div class="content"> <pre><code>qdmanage update name=log/MESSAGE enable=trace output=test.log</code></pre> -</td></tr></table> -<p><b>Set MESSAGE logging back to the default</b></p> -<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td> +</div></div> +<div class="listingblock"> +<div class="title">Set MESSAGE logging back to the default</div> +<div class="content"> <pre><code>qdmanage update name=log/MESSAGE enable=default</code></pre> -</td></tr></table> -<p><b>Disable MESSAGE logging</b></p> -<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td> +</div></div> +<div class="listingblock"> +<div class="title">Disable MESSAGE logging</div> +<div class="content"> <pre><code>qdmanage update name=log/MESSAGE enable=none</code></pre> -</td></tr></table> -<h2><a name="_see_also"></a>SEE ALSO</h2> -<p><b>qdrouterd(8)</b>, <b>qdstat(8)</b>, <b>qdrouterd.conf(5)</b></p> -<p><a href="http://qpid.apache.org/components/dispatch-router";>http://qpid.apache.org/components/dispatch-router</a></p> +</div></div> +</div> +</div> +<div class="sect1"> +<h2 id="_see_also">SEE ALSO</h2> +<div class="sectionbody"> +<div class="paragraph"><p><em>qdrouterd(8)</em>, <em>qdstat(8)</em>, <em>qdrouterd.conf(5)</em></p></div> +<div class="paragraph"><p><a href="http://qpid.apache.org/components/dispatch-router";>http://qpid.apache.org/components/dispatch-router</a></p></div> +</div> +</div> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/3cbe9ebf/input/releases/qpid-dispatch-master/qdrouterd.8.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-master/qdrouterd.8.html.in b/input/releases/qpid-dispatch-master/qdrouterd.8.html.in index 23bb412..965f0cd 100644 --- a/input/releases/qpid-dispatch-master/qdrouterd.8.html.in +++ b/input/releases/qpid-dispatch-master/qdrouterd.8.html.in @@ -1,29 +1,39 @@ -<h2>NAME</h2> -<p>qdrouterd - - routes AMQP messages. -</p> -<h2><a name="_synopsis"></a>SYNOPSIS</h2> -<p><strong>qdrouterd</strong> [<b>OPTIONS</b>]</p> -<h2><a name="_description"></a>DESCRIPTION</h2> -<p>The Qpid Dispatch router (qdrouterd) is a network daemon that directs +<div class="sect1"> +<h2 id="_synopsis">SYNOPSIS</h2> +<div class="sectionbody"> +<div class="paragraph"><p><strong>qdrouterd</strong> [<em>OPTIONS</em>]</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"><p>The Qpid Dispatch router (qdrouterd) is a network daemon that directs AMQP 1.0 messages between endpoints, such as messaging clients and -servers.</p> -<h2><a name="_options"></a>OPTIONS</h2> -<p>-c, --config=PATH (/usr/local/etc/qpid-dispatch/qdrouterd.conf) -: Load configuration from file at PATH</p> -<p>-I, --include=PATH (/usr/local/lib/qpid-dispatch/python) -: Location of Dispatch’s Python library</p> -<p>-d, --daemon -: Run process as a SysV-style daemon</p> -<p>-P, --pidfile -: If daemon, the file for the stored daemon pid</p> -<p>-U, --user -: If daemon, the username to run as</p> -<p>-h, --help -: Print this help</p> -<h2><a name="_files"></a>FILES</h2> -<dl> -<dt> +servers.</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_options">OPTIONS</h2> +<div class="sectionbody"> +<div class="paragraph"><p>-c, --config=PATH (/usr/local/etc/qpid-dispatch/qdrouterd.conf) +: Load configuration from file at PATH</p></div> +<div class="paragraph"><p>-I, --include=PATH (/usr/local/lib/qpid-dispatch/python) +: Location of Dispatch’s Python library</p></div> +<div class="paragraph"><p>-d, --daemon +: Run process as a SysV-style daemon</p></div> +<div class="paragraph"><p>-P, --pidfile +: If daemon, the file for the stored daemon pid</p></div> +<div class="paragraph"><p>-U, --user +: If daemon, the username to run as</p></div> +<div class="paragraph"><p>-h, --help +: Print this help</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_files">FILES</h2> +<div class="sectionbody"> +<div class="dlist"><dl> +<dt class="hdlist1"> /usr/local/etc/qdrouterd.conf </dt> <dd> @@ -31,7 +41,13 @@ servers.</p> Configuration flie. </p> </dd> -</dl> -<h2><a name="_see_also"></a>SEE ALSO</h2> -<p><b>qdrouterd.conf(5)</b>, <b>qdstat(8)</b>, <b>qdmanage(8)</b></p> -<p><a href="http://qpid.apache.org/components/dispatch-router";>http://qpid.apache.org/components/dispatch-router</a></p> +</dl></div> +</div> +</div> +<div class="sect1"> +<h2 id="_see_also">SEE ALSO</h2> +<div class="sectionbody"> +<div class="paragraph"><p><em>qdrouterd.conf(5)</em>, <em>qdstat(8)</em>, <em>qdmanage(8)</em></p></div> +<div class="paragraph"><p><a href="http://qpid.apache.org/components/dispatch-router";>http://qpid.apache.org/components/dispatch-router</a></p></div> +</div> +</div> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/3cbe9ebf/input/releases/qpid-dispatch-master/qdrouterd.conf.5.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-master/qdrouterd.conf.5.html.in b/input/releases/qpid-dispatch-master/qdrouterd.conf.5.html.in index 08aeede..b21f67f 100644 --- a/input/releases/qpid-dispatch-master/qdrouterd.conf.5.html.in +++ b/input/releases/qpid-dispatch-master/qdrouterd.conf.5.html.in @@ -1,38 +1,44 @@ -<h2>NAME</h2> -<p>qdrouterd.conf - - configuration file for the dispatch router. -</p> -<h2><a name="_synopsis"></a>SYNOPSIS</h2> -<p>Provides the initial configuration when <b>qdrouterd(8)</b> starts. The configuration -of a running router can be modified using <b>qdmanage(8)</b>.</p> -<h2><a name="_description"></a>DESCRIPTION</h2> -<p>The configuration file is made up of sections with this syntax:</p> -<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td> +<div class="sect1"> +<h2 id="_synopsis">SYNOPSIS</h2> +<div class="sectionbody"> +<div class="paragraph"><p>Provides the initial configuration when <em>qdrouterd(8)</em> starts. The configuration +of a running router can be modified using <em>qdmanage(8)</em>.</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"><p>The configuration file is made up of sections with this syntax:</p></div> +<div class="listingblock"> +<div class="content"> <pre><code>sectionName { attributeName: attributeValue attributeName: attributeValue ... }</code></pre> -</td></tr></table> -<p>For example you can define a router using the <b>router</b> section</p> -<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td> +</div></div> +<div class="paragraph"><p>For example you can define a router using the <em>router</em> section</p></div> +<div class="listingblock"> +<div class="content"> <pre><code>router { mode: standalone id: Router.A ... }</code></pre> -</td></tr></table> -<p>or define a listener using the <b>listener</b> section</p> -<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td> +</div></div> +<div class="paragraph"><p>or define a listener using the <em>listener</em> section</p></div> +<div class="listingblock"> +<div class="content"> <pre><code>listener { host: 0.0.0.0 port: 20102 saslMechanisms: ANONYMOUS ... }</code></pre> -</td></tr></table> -<p>or define a connector using the <b>connector</b> section</p> -<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td> +</div></div> +<div class="paragraph"><p>or define a connector using the <em>connector</em> section</p></div> +<div class="listingblock"> +<div class="content"> <pre><code>connector { role: inter-router host: 0.0.0.0 @@ -40,11 +46,12 @@ of a running router can be modified using <b>qdmanage(8)</b>.</p> saslMechanisms: ANONYMOUS ... }</code></pre> -</td></tr></table> -<p>An <b>sslProfile</b> section with SSL credentials can be included in multiple <b>listener</b> or <b>connector</b> entities. Here’s an example, note -how the <b>sslProfile</b> attribute of <b>listener</b> sections references the <b>name</b> -attribute of <b>sslProfile</b> sections.</p> -<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td> +</div></div> +<div class="paragraph"><p>An <em>sslProfile</em> section with SSL credentials can be included in multiple <em>listener</em> or <em>connector</em> entities. Here’s an example, note +how the <em>sslProfile</em> attribute of <em>listener</em> sections references the <em>name</em> +attribute of <em>sslProfile</em> sections.</p></div> +<div class="listingblock"> +<div class="content"> <pre><code>sslProfile { name: my-ssl certDb: ca-certificate-1.pem @@ -58,949 +65,948 @@ listener { port: 20102 saslMechanisms: ANONYMOUS }</code></pre> -</td></tr></table> -<h2><a name="_configuration_sections"></a>Configuration Sections</h2> -<h3><a name="_sslprofile"></a>sslProfile</h3> -<p>Attributes for setting TLS/SSL configuration for connections.</p> -<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p> -<dl> -<dt> -<b>name</b> (string) +</div></div> +</div> +</div> +<div class="sect1"> +<h2 id="_configuration_sections">Configuration Sections</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_router">router</h3> +<div class="paragraph"><p>Tracks peer routers and computes routes to destinations.</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>id</em> (string) </dt> <dd> <p> - name of the sslProfile -</p> -</dd> -<dt> -<b>certDb</b> (path) -</dt> -<dd> -<p> - The absolute path to the database that contains the public certificates of trusted certificate authorities (CA). -</p> -</dd> -<dt> -<b>certFile</b> (path) -</dt> -<dd> -<p> - The absolute path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile. + Router’s unique identity. One of id or routerId is required. The router will fail to start without id or routerId </p> </dd> -<dt> -<b>keyFile</b> (path) +<dt class="hdlist1"> +<em>mode</em> (One of [<em>standalone</em>, <em>interior</em>], default=<em>standalone</em>) </dt> <dd> <p> - The absolute path to the file containing the PEM-formatted private key for the above certificate. + 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. </p> </dd> -<dt> -<b>passwordFile</b> (path) +<dt class="hdlist1"> +<em>helloInterval</em> (integer, default=1) </dt> <dd> <p> - If the above private key is password protected, this is the absolute path to a file containing the password that unlocks the certificate key. + Interval in seconds between HELLO messages sent to neighbor routers. </p> </dd> -<dt> -<b>password</b> (string) +<dt class="hdlist1"> +<em>helloMaxAge</em> (integer, default=3) </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 <b>password</b> option. Don’t use both password and passwordFile in the same profile. + Time in seconds after which a neighbor is declared lost if no HELLO is received. </p> </dd> -<dt> -<b>uidFormat</b> (string) +<dt class="hdlist1"> +<em>raInterval</em> (integer, default=30) </dt> <dd> <p> - A list of x509 client certificate fields that will be used to build a string that will uniquely identify the client certificate owner. For e.g. a value of <b>cou</b> indicates that the uid will consist of c - common name concatenated with o - organization-company name concatenated with u - organization unit; or a value of <b>o2</b> indicates that the uid will consist of o (organization name) concatenated with 2 (the sha256 fingerprint of the entire certificate) . Allowed values can be any combination of <b>c</b>( ISO3166 two character country code), <b>s</b>(state or province), <b>l</b>(Locality; generally - city), <b>o</b>(Organization - Company Name), <b>u</b>(Organization Unit - typically certificate type or brand), <b>n</b>(CommonName - typically a user name for client certificates) and <b>1</b>(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate with say a web browser is the hash of the entire certificate) and 2 (sha256 certifi cate fingerprint) and 5 (sha512 certificate fingerprint). + Interval in seconds between Router-Advertisements sent to all routers in a stable network. </p> </dd> -<dt> -<b>displayNameFile</b> (string) +<dt class="hdlist1"> +<em>raIntervalFlux</em> (integer, default=4) </dt> <dd> <p> - The absolute path to the file containing the unique id to dispay name mapping + Interval in seconds between Router-Advertisements sent to all routers during topology fluctuations. </p> </dd> -</dl> -<h3><a name="_container"></a>container</h3> -<p>(DEPRECATED)Attributes related to the AMQP container. This entity has been deprecated. Use the router entity instead.</p> -<dl> -<dt> -<b>containerName</b> (string) +<dt class="hdlist1"> +<em>remoteLsMaxAge</em> (integer, default=60) </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. + Time in seconds after which link state is declared stale if no RA is received. </p> </dd> -<dt> -<b>workerThreads</b> (integer, default=4) +<dt class="hdlist1"> +<em>workerThreads</em> (integer, default=4) </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> -<b>debugDump</b> (path) +<dt class="hdlist1"> +<em>debugDump</em> (path) </dt> <dd> <p> A file to dump debugging information that can’t be logged normally. </p> </dd> -<dt> -<b>saslConfigPath</b> (path) +<dt class="hdlist1"> +<em>saslConfigPath</em> (path) </dt> <dd> <p> Absolute path to the SASL configuration file. </p> </dd> -<dt> -<b>saslConfigName</b> (string) +<dt class="hdlist1"> +<em>saslConfigName</em> (string, default=<em>qdrouterd</em>) </dt> <dd> <p> - Name of the SASL configuration. This string + <b>.conf</b> is the name of the configuration file. + Name of the SASL configuration. This string + <em>.conf</em> is the name of the configuration file. </p> </dd> -</dl> -<h3><a name="_router"></a>router</h3> -<p>Tracks peer routers and computes routes to destinations.</p> -<dl> -<dt> -<b>routerId</b> (string) +<dt class="hdlist1"> +<em>routerId</em> (string) </dt> <dd> <p> (DEPRECATED) Router’s unique identity. This attribute has been deprecated. Use id instead </p> </dd> -<dt> -<b>id</b> (string) +<dt class="hdlist1"> +<em>mobileAddrMaxAge</em> (integer, default=60) </dt> <dd> <p> - Router’s unique identity. One of id or routerId is required. The router will fail to start without id or routerId -</p> -</dd> -<dt> -<b>mode</b> (One of [<b>standalone</b>, <b>interior</b>], default=<b>standalone</b>) -</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. -</p> -</dd> -<dt> -<b>helloInterval</b> (integer, default=1) -</dt> -<dd> -<p> - Interval in seconds between HELLO messages sent to neighbor routers. -</p> -</dd> -<dt> -<b>helloMaxAge</b> (integer, default=3) -</dt> -<dd> -<p> - Time in seconds after which a neighbor is declared lost if no HELLO is received. -</p> -</dd> -<dt> -<b>raInterval</b> (integer, default=30) -</dt> -<dd> -<p> - Interval in seconds between Router-Advertisements sent to all routers in a stable network. -</p> -</dd> -<dt> -<b>raIntervalFlux</b> (integer, default=4) -</dt> -<dd> -<p> - Interval in seconds between Router-Advertisements sent to all routers during topology fluctuations. + (DEPRECATED) This value is no longer used in the router. </p> </dd> -<dt> -<b>remoteLsMaxAge</b> (integer, default=60) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_sslprofile">sslProfile</h3> +<div class="paragraph"><p>Attributes for setting TLS/SSL configuration for connections.</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>certDb</em> (path) </dt> <dd> <p> - Time in seconds after which link state is declared stale if no RA is received. + The absolute path to the database that contains the public certificates of trusted certificate authorities (CA). </p> </dd> -<dt> -<b>mobileAddrMaxAge</b> (integer, default=60) +<dt class="hdlist1"> +<em>certFile</em> (path) </dt> <dd> <p> - (DEPRECATED) This value is no longer used in the router. + The absolute 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> -<b>workerThreads</b> (integer, default=4) +<dt class="hdlist1"> +<em>keyFile</em> (path) </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.) . + The absolute path to the file containing the PEM-formatted private key for the above certificate. </p> </dd> -<dt> -<b>debugDump</b> (path) +<dt class="hdlist1"> +<em>passwordFile</em> (path) </dt> <dd> <p> - A file to dump debugging information that can’t be logged normally. + If the above private key is password protected, this is the absolute path to a file containing the password that unlocks the certificate key. </p> </dd> -<dt> -<b>saslConfigPath</b> (path) +<dt class="hdlist1"> +<em>password</em> (string) </dt> <dd> <p> - Absolute path to the SASL configuration file. + 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 <em>password</em> option. Don’t use both password and passwordFile in the same profile. </p> </dd> -<dt> -<b>saslConfigName</b> (string, default=<b>qdrouterd</b>) +<dt class="hdlist1"> +<em>uidFormat</em> (string) </dt> <dd> <p> - Name of the SASL configuration. This string + <b>.conf</b> is the name of the configuration file. + A list of x509 client certificate fields that will be used to build a string that will uniquely identify the client certificate owner. For e.g. a value of <em>cou</em> indicates that the uid will consist of c - common name concatenated with o - organization-company name concatenated with u - organization unit; or a value of <em>o2</em> indicates that the uid will consist of o (organization name) concatenated with 2 (the sha256 fingerprint of the entire certificate) . Allowed values can be any combination of <em>c</em>( ISO3166 two character country code), <em>s</em>(state or province), <em>l</em>(Locality; generally - city), <em>o</em>(Organization - Company Name), <em>u</em>(Organization Unit - typically certificate type or brand), <em>n</em>(CommonName - typically a user name for client certificates) and <em>1</em>(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate with say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint). </p> </dd> -</dl> -<h3><a name="_listener"></a>listener</h3> -<p>Listens for incoming connections to the router.</p> -<dl> -<dt> -<b>name</b> (string) +<dt class="hdlist1"> +<em>displayNameFile</em> (string) </dt> <dd> <p> - Unique name optionally assigned by user. Can be changed. + The absolute path to the file containing the unique id to dispay name mapping </p> </dd> -<dt> -<b>host</b> (string) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_listener">listener</h3> +<div class="paragraph"><p>Listens for incoming connections to the router.</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>host</em> (string, default=<em>127.0.0.1</em>) </dt> <dd> <p> IP address: ipv4 or ipv6 literal or a host name </p> </dd> -<dt> -<b>port</b> (string) +<dt class="hdlist1"> +<em>port</em> (string, default=<em>amqp</em>) </dt> <dd> <p> Port number or symbolic service name. </p> </dd> -<dt> -<b>protocolFamily</b> (One of [<b>IPv4</b>, <b>IPv6</b>]) +<dt class="hdlist1"> +<em>protocolFamily</em> (One of [<em>IPv4</em>, <em>IPv6</em>]) </dt> <dd> <p> - [<b>IPv4</b>, <b>IPv6</b>] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address. + [<em>IPv4</em>, <em>IPv6</em>] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address. </p> </dd> -<dt> -<b>role</b> (One of [<b>normal</b>, <b>inter-router</b>, <b>route-container</b>, <b>on-demand</b>]) +<dt class="hdlist1"> +<em>role</em> (One of [<em>normal</em>, <em>inter-router</em>, <em>route-container</em>, <em>on-demand</em>], default=<em>normal</em>) </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. route-container role can be used for router-container connections, for example, a router-broker connection. on-demand role has been deprecated. </p> </dd> -<dt> -<b>cost</b> (integer) +<dt class="hdlist1"> +<em>cost</em> (integer, default=<em>1</em>) </dt> <dd> <p> - For the <b>inter-router</b> role only. This value assigns a cost metric to the inter-router connection. The default (and minimum) value is one. Higher values represent higher costs. The cost is used to influence the routing algorithm as it attempts to use the path with the lowest total cost from ingress to egress. + For the <em>inter-router</em> role only. This value assigns a cost metric to the inter-router connection. The default (and minimum) value is one. Higher values represent higher costs. The cost is used to influence the routing algorithm as it attempts to use the path with the lowest total cost from ingress to egress. </p> </dd> -<dt> -<b>sslProfile</b> (string) +<dt class="hdlist1"> +<em>sslProfile</em> (string) </dt> <dd> <p> - name of the sslProfile + Name of the sslProfile. </p> </dd> -<dt> -<b>saslMechanisms</b> (string) +<dt class="hdlist1"> +<em>saslMechanisms</em> (string) </dt> <dd> <p> Space separated list of accepted SASL authentication mechanisms. </p> </dd> -<dt> -<b>authenticatePeer</b> (boolean) +<dt class="hdlist1"> +<em>authenticatePeer</em> (boolean) </dt> <dd> <p> yes: Require the peer’s identity to be authenticated; no: Do not require any authentication. </p> </dd> -<dt> -<b>requireEncryption</b> (boolean) +<dt class="hdlist1"> +<em>requireEncryption</em> (boolean) </dt> <dd> <p> yes: Require the connection to the peer to be encrypted; no: Permit non-encrypted communication with the peer </p> </dd> -<dt> -<b>requireSsl</b> (boolean) +<dt class="hdlist1"> +<em>requireSsl</em> (boolean) </dt> <dd> <p> yes: Require the use of SSL or TLS on the connection; no: Allow clients to connect without SSL or TLS. </p> </dd> -<dt> -<b>trustedCerts</b> (path) +<dt class="hdlist1"> +<em>trustedCerts</em> (path) </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 the absolute path to a PEM file that contains the trusted certificates. </p> </dd> -<dt> -<b>maxFrameSize</b> (integer, default=16384) +<dt class="hdlist1"> +<em>maxFrameSize</em> (integer, default=16384) </dt> <dd> <p> Defaults to 16384. 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> -<dt> -<b>idleTimeoutSeconds</b> (integer, default=16) +<dt class="hdlist1"> +<em>idleTimeoutSeconds</em> (integer, default=16) </dt> <dd> <p> The idle timeout, in seconds, for connections through this listener. If no frames are received on the connection for this time interval, the connection shall be closed. </p> </dd> -<dt> -<b>requirePeerAuth</b> (boolean) +<dt class="hdlist1"> +<em>stripAnnotations</em> (One of [<em>in</em>, <em>out</em>, <em>both</em>, <em>no</em>], default=<em>both</em>) </dt> <dd> <p> - (DEPRECATED) This attribute is now controlled by the authenticatePeer attribute. + [<em>in</em>, <em>out</em>, <em>both</em>, <em>no</em>] in: Strip the dispatch router specific annotations only on ingress; out: Strip the dispatch router specific annotations only on egress; both: Strip the dispatch router specific annotations on both ingress and egress; no - do not strip dispatch router specific annotations </p> </dd> -<dt> -<b>allowUnsecured</b> (boolean) +<dt class="hdlist1"> +<em>linkCapacity</em> (integer) </dt> <dd> <p> - (DEPRECATED) This attribute is now controlled by the requireEncryption attribute. + The capacity of links within this connection, in terms of message deliveries. The capacity is the number of messages that can be in-flight concurrently for each link. </p> </dd> -<dt> -<b>allowNoSasl</b> (boolean) +<dt class="hdlist1"> +<em>addr</em> (string, default=<em>127.0.0.1</em>) </dt> <dd> <p> - (DEPRECATED) This attribute is now controlled by the authenticatePeer attribute. + (DEPRECATED)IP address: ipv4 or ipv6 literal or a host name. This attribute has been deprecated. Use host instead </p> </dd> -<dt> -<b>stripAnnotations</b> (One of [<b>in</b>, <b>out</b>, <b>both</b>, <b>no</b>], default=<b>both</b>) +<dt class="hdlist1"> +<em>allowNoSasl</em> (boolean) </dt> <dd> <p> - [<b>in</b>, <b>out</b>, <b>both</b>, <b>no</b>] in: Strip the dispatch router specific annotations only on ingress; out: Strip the dispatch router specific annotations only on egress; both: Strip the dispatch router specific annotations on both ingress and egress; no - do not strip dispatch router specific annotations + (DEPRECATED) This attribute is now controlled by the authenticatePeer attribute. </p> </dd> -<dt> -<b>linkCapacity</b> (integer) +<dt class="hdlist1"> +<em>requirePeerAuth</em> (boolean) </dt> <dd> <p> - The capacity of links within this connection, in terms of message deliveries. The capacity is the number of messages that can be in-flight concurrently for each link. + (DEPRECATED) This attribute is now controlled by the authenticatePeer attribute. </p> </dd> -</dl> -<h3><a name="_connector"></a>connector</h3> -<p>Establishes an outgoing connection from the router.</p> -<dl> -<dt> -<b>name</b> (string) +<dt class="hdlist1"> +<em>allowUnsecured</em> (boolean) </dt> <dd> <p> - Unique name optionally assigned by user. Can be changed. + (DEPRECATED) This attribute is now controlled by the requireEncryption attribute. </p> </dd> -<dt> -<b>host</b> (string) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_connector">connector</h3> +<div class="paragraph"><p>Establishes an outgoing connection from the router.</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>host</em> (string, default=<em>127.0.0.1</em>) </dt> <dd> <p> IP address: ipv4 or ipv6 literal or a host name </p> </dd> -<dt> -<b>port</b> (string) +<dt class="hdlist1"> +<em>port</em> (string, default=<em>amqp</em>) </dt> <dd> <p> Port number or symbolic service name. </p> </dd> -<dt> -<b>protocolFamily</b> (One of [<b>IPv4</b>, <b>IPv6</b>]) +<dt class="hdlist1"> +<em>protocolFamily</em> (One of [<em>IPv4</em>, <em>IPv6</em>]) </dt> <dd> <p> - [<b>IPv4</b>, <b>IPv6</b>] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address. + [<em>IPv4</em>, <em>IPv6</em>] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address. </p> </dd> -<dt> -<b>role</b> (One of [<b>normal</b>, <b>inter-router</b>, <b>route-container</b>, <b>on-demand</b>]) +<dt class="hdlist1"> +<em>role</em> (One of [<em>normal</em>, <em>inter-router</em>, <em>route-container</em>, <em>on-demand</em>], default=<em>normal</em>) </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. route-container role can be used for router-container connections, for example, a router-broker connection. on-demand role has been deprecated. </p> </dd> -<dt> -<b>cost</b> (integer) +<dt class="hdlist1"> +<em>cost</em> (integer, default=<em>1</em>) </dt> <dd> <p> - For the <b>inter-router</b> role only. This value assigns a cost metric to the inter-router connection. The default (and minimum) value is one. Higher values represent higher costs. The cost is used to influence the routing algorithm as it attempts to use the path with the lowest total cost from ingress to egress. + For the <em>inter-router</em> role only. This value assigns a cost metric to the inter-router connection. The default (and minimum) value is one. Higher values represent higher costs. The cost is used to influence the routing algorithm as it attempts to use the path with the lowest total cost from ingress to egress. </p> </dd> -<dt> -<b>sslProfile</b> (string) +<dt class="hdlist1"> +<em>sslProfile</em> (string) </dt> <dd> <p> - name of the sslProfile + Name of the sslProfile. </p> </dd> -<dt> -<b>saslMechanisms</b> (string) +<dt class="hdlist1"> +<em>saslMechanisms</em> (string) </dt> <dd> <p> Space separated list of accepted SASL authentication mechanisms. </p> </dd> -<dt> -<b>allowRedirect</b> (boolean, default=True) +<dt class="hdlist1"> +<em>allowRedirect</em> (boolean, default=True) </dt> <dd> <p> Allow the peer to redirect this connection to another address. </p> </dd> -<dt> -<b>maxFrameSize</b> (integer, default=65536) +<dt class="hdlist1"> +<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> -<dt> -<b>idleTimeoutSeconds</b> (integer, default=16) +<dt class="hdlist1"> +<em>idleTimeoutSeconds</em> (integer, default=16) </dt> <dd> <p> The idle timeout, in seconds, for connections through this connector. If no frames are received on the connection for this time interval, the connection shall be closed. </p> </dd> -<dt> -<b>stripAnnotations</b> (One of [<b>in</b>, <b>out</b>, <b>both</b>, <b>no</b>], default=<b>both</b>) +<dt class="hdlist1"> +<em>stripAnnotations</em> (One of [<em>in</em>, <em>out</em>, <em>both</em>, <em>no</em>], default=<em>both</em>) </dt> <dd> <p> - [<b>in</b>, <b>out</b>, <b>both</b>, <b>no</b>] in: Strip the dispatch router specific annotations only on ingress; out: Strip the dispatch router specific annotations only on egress; both: Strip the dispatch router specific annotations on both ingress and egress; no - do not strip dispatch router specific annotations + [<em>in</em>, <em>out</em>, <em>both</em>, <em>no</em>] in: Strip the dispatch router specific annotations only on ingress; out: Strip the dispatch router specific annotations only on egress; both: Strip the dispatch router specific annotations on both ingress and egress; no - do not strip dispatch router specific annotations </p> </dd> -<dt> -<b>linkCapacity</b> (integer) +<dt class="hdlist1"> +<em>linkCapacity</em> (integer) </dt> <dd> <p> The capacity of links within this connection, in terms of message deliveries. The capacity is the number of messages that can be in-flight concurrently for each link. </p> </dd> -<dt> -<b>verifyHostName</b> (boolean, default=True) +<dt class="hdlist1"> +<em>verifyHostName</em> (boolean, default=True) </dt> <dd> <p> yes: Ensures that when initiating a connection (as a client) the host name in the URL to which this connector connects to matches the host name in the digital certificate that the peer sends back as part of the SSL connection; no: Does not perform host name verification </p> </dd> -<dt> -<b>saslUsername</b> (string) +<dt class="hdlist1"> +<em>saslUsername</em> (string) </dt> <dd> <p> The user name that the connector is using to connect to a peer. </p> </dd> -<dt> -<b>saslPassword</b> (string) +<dt class="hdlist1"> +<em>saslPassword</em> (string) </dt> <dd> <p> The password that the connector is using to connect to a peer. </p> </dd> -</dl> -<h3><a name="_log"></a>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> -<b>module</b> (One of [<b>ROUTER</b>, <b>ROUTER_CORE</b>, <b>ROUTER_HELLO</b>, <b>ROUTER_LS</b>, <b>ROUTER_MA</b>, <b>MESSAGE</b>, <b>SERVER</b>, <b>AGENT</b>, <b>CONTAINER</b>, <b>ERROR</b>, <b>POLICY</b>, <b>DEFAULT</b>], required) +<dt class="hdlist1"> +<em>addr</em> (string, default=<em>127.0.0.1</em>) </dt> <dd> <p> - Module to configure. The special module <b>DEFAULT</b> specifies defaults for all modules. + (DEPRECATED)IP address: ipv4 or ipv6 literal or a host name. This attribute has been deprecated. Use host instead </p> </dd> -<dt> -<b>enable</b> (string) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_log">log</h3> +<div class="paragraph"><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></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>module</em> (One of [<em>ROUTER</em>, <em>ROUTER_CORE</em>, <em>ROUTER_HELLO</em>, <em>ROUTER_LS</em>, <em>ROUTER_MA</em>, <em>MESSAGE</em>, <em>SERVER</em>, <em>AGENT</em>, <em>CONTAINER</em>, <em>ERROR</em>, <em>POLICY</em>, <em>DEFAULT</em>], 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 <b>+</b> to enable that level and above. For example <b>trace,debug,warning+</b> means enable trace, debug, warning, error and critical. The value <b>none</b> means disable logging for the module. + Module to configure. The special module <em>DEFAULT</em> specifies defaults for all modules. </p> </dd> -<dt> -<b>timestamp</b> (boolean) +<dt class="hdlist1"> +<em>enable</em> (string) +</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 <em>+</em> to enable that level and above. For example <em>trace,debug,warning+</em> means enable trace, debug, warning, error and critical. The value <em>none</em> means disable logging for the module. +</p> +</dd> +<dt class="hdlist1"> +<em>timestamp</em> (boolean) </dt> <dd> <p> Include timestamp in log messages. </p> </dd> -<dt> -<b>source</b> (boolean) +<dt class="hdlist1"> +<em>source</em> (boolean) </dt> <dd> <p> Include source file and line number in log messages. </p> </dd> -<dt> -<b>output</b> (string) +<dt class="hdlist1"> +<em>output</em> (string) </dt> <dd> <p> - Where to send log messages. Can be <b>stderr</b>, <b>stdout</b>, <b>syslog</b> or a file name. + Where to send log messages. Can be <em>stderr</em>, <em>stdout</em>, <em>syslog</em> or a file name. </p> </dd> -</dl> -<h3><a name="_fixedaddress"></a>fixedAddress</h3> -<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix. This entity has been deprecated. Use address instead</p> -<dl> -<dt> -<b>prefix</b> (string, required) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_address">address</h3> +<div class="paragraph"><p>Entity type for address configuration. This is used to configure the treatment of message-routed deliveries within a particular address-space. The configuration controls distribution and address phasing.</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>prefix</em> (string, required) </dt> <dd> <p> - The address prefix (always starting with <b>/</b>). + The address prefix for the configured settings </p> </dd> -<dt> -<b>phase</b> (integer) +<dt class="hdlist1"> +<em>distribution</em> (One of [<em>multicast</em>, <em>closest</em>, <em>balanced</em>], default=<em>balanced</em>) </dt> <dd> <p> - The phase of a multi-hop address passing through one or more waypoints. + Treatment of traffic associated with the address </p> </dd> -<dt> -<b>fanout</b> (One of [<b>multiple</b>, <b>single</b>], default=<b>multiple</b>) +<dt class="hdlist1"> +<em>waypoint</em> (boolean) </dt> <dd> <p> - One of <b>multiple</b> or <b>single</b>. 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. + Designates this address space as being used for waypoints. This will cause the proper address-phasing to be used. </p> </dd> -<dt> -<b>bias</b> (One of [<b>closest</b>, <b>spread</b>], default=<b>closest</b>) +<dt class="hdlist1"> +<em>ingressPhase</em> (integer) </dt> <dd> <p> - Only if fanout is single. One of <b>closest</b> or <b>spread</b>. 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. + Advanced - Override the ingress phase for this address </p> </dd> -</dl> -<h3><a name="_waypoint"></a>waypoint</h3> -<p>(DEPRECATED) A remote node that messages for an address pass through. This entity has been deprecated. Use autoLink instead</p> -<dl> -<dt> -<b>address</b> (string, required) +<dt class="hdlist1"> +<em>egressPhase</em> (integer) </dt> <dd> <p> - The AMQP address of the waypoint. + Advanced - Override the egress phase for this address </p> </dd> -<dt> -<b>connector</b> (string, required) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_linkroute">linkRoute</h3> +<div class="paragraph"><p>Entity type for link-route configuration. This is used to identify remote containers that shall be destinations for routed link-attaches. The link-routing configuration applies to an addressing space defined by a prefix.</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>prefix</em> (string, required) </dt> <dd> <p> - The name of the on-demand connector used to reach the waypoint’s container. + The address prefix for the configured settings </p> </dd> -<dt> -<b>inPhase</b> (integer, default=-1) +<dt class="hdlist1"> +<em>containerId</em> (string) </dt> <dd> <p> - The phase of the address as it is routed <b>to</b> the waypoint. + ContainerID for the target container </p> </dd> -<dt> -<b>outPhase</b> (integer, default=-1) +<dt class="hdlist1"> +<em>connection</em> (string) </dt> <dd> <p> - The phase of the address as it is routed <b>from</b> the waypoint. + The name from a connector or listener </p> </dd> -</dl> -<h3><a name="_linkroutepattern"></a>linkRoutePattern</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. This entity has been deprecated. Use linkRoute instead</p> -<dl> -<dt> -<b>prefix</b> (string, required) +<dt class="hdlist1"> +<em>distribution</em> (One of [<em>linkBalanced</em>], default=<em>linkBalanced</em>) </dt> <dd> <p> - An address prefix to match against target and source addresses. This pattern must be of the form <b><text>.<text1>.<textN></b> or <b><text></b> or <b><text>.</b> 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 <b>org.apache</b> (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 + Treatment of traffic associated with the address </p> </dd> -<dt> -<b>dir</b> (One of [<b>in</b>, <b>out</b>, <b>both</b>], default=<b>both</b>) +<dt class="hdlist1"> +<em>dir</em> (One of [<em>in</em>, <em>out</em>], required) </dt> <dd> <p> - Link direction for match: <b>in</b> matches only links inbound to the client; <b>out</b> matches only links outbound from the client; <b>both</b> matches any link. + The permitted direction of links: <em>in</em> means client senders; <em>out</em> means client receivers </p> </dd> -<dt> -<b>connector</b> (string) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_autolink">autoLink</h3> +<div class="paragraph"><p>Entity type for configuring auto-links. Auto-links are links whose lifecycle is managed by the router. These are typically used to attach to waypoints on remote containers (brokers, etc.).</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>addr</em> (string, required) </dt> <dd> <p> - The name of the on-demand connector used to reach the target node’s container. If this value is not provided, it means that the target container is expected to be connected to a different router in the network. This prevents links to a link-routable address from being misinterpreted as message-routing links when there is no route to a valid destination available. + The address of the provisioned object </p> </dd> -</dl> -<h3><a name="_address"></a>address</h3> -<p>Entity type for address configuration. This is used to configure the treatment of message-routed deliveries within a particular address-space. The configuration controls distribution and address phasing.</p> -<dl> -<dt> -<b>prefix</b> (string, required) +<dt class="hdlist1"> +<em>dir</em> (One of [<em>in</em>, <em>out</em>], required) </dt> <dd> <p> - The address prefix for the configured settings + The direction of the link to be created. In means into the router, out means out of the router. </p> </dd> -<dt> -<b>distribution</b> (One of [<b>multicast</b>, <b>closest</b>, <b>balanced</b>], default=<b>balanced</b>) +<dt class="hdlist1"> +<em>phase</em> (integer) </dt> <dd> <p> - Treatment of traffic associated with the address + The address phase for this link. Defaults to <em>0</em> for <em>out</em> links and <em>1</em> for <em>in</em> links. </p> </dd> -<dt> -<b>waypoint</b> (boolean) +<dt class="hdlist1"> +<em>containerId</em> (string) </dt> <dd> <p> - Designates this address space as being used for waypoints. This will cause the proper address-phasing to be used. + ContainerID for the target container </p> </dd> -<dt> -<b>ingressPhase</b> (integer) +<dt class="hdlist1"> +<em>connection</em> (string) </dt> <dd> <p> - Advanced - Override the ingress phase for this address + The name from a connector or listener </p> </dd> -<dt> -<b>egressPhase</b> (integer) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_console">console</h3> +<div class="paragraph"><p>Start a websocket/tcp proxy and http file server to serve the web console</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>listener</em> (string) </dt> <dd> <p> - Advanced - Override the egress phase for this address + The name of the listener to send the proxied tcp traffic to. </p> </dd> -</dl> -<h3><a name="_linkroute"></a>linkRoute</h3> -<p>Entity type for link-route configuration. This is used to identify remote containers that shall be destinations for routed link-attaches. The link-routing configuration applies to an addressing space defined by a prefix.</p> -<dl> -<dt> -<b>prefix</b> (string, required) +<dt class="hdlist1"> +<em>wsport</em> (integer, default=5673) </dt> <dd> <p> - The address prefix for the configured settings + port on which to listen for websocket traffic </p> </dd> -<dt> -<b>containerId</b> (string) +<dt class="hdlist1"> +<em>proxy</em> (string) </dt> <dd> <p> - ContainerID for the target container + The full path to the proxy program to run. </p> </dd> -<dt> -<b>connection</b> (string) +<dt class="hdlist1"> +<em>home</em> (string) </dt> <dd> <p> - The name from a connector or listener + The full path to the html/css/js files for the console. </p> </dd> -<dt> -<b>distribution</b> (One of [<b>linkBalanced</b>], default=<b>linkBalanced</b>) +<dt class="hdlist1"> +<em>args</em> (string) </dt> <dd> <p> - Treatment of traffic associated with the address + Optional args to pass the proxy program for logging, authentication, etc. </p> </dd> -<dt> -<b>dir</b> (One of [<b>in</b>, <b>out</b>], required) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_policy">policy</h3> +<div class="paragraph"><p>Defines global connection limit</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>maxConnections</em> (integer, default=65535) </dt> <dd> <p> - The permitted direction of links: <b>in</b> means client senders; <b>out</b> means client receivers + Global maximum number of concurrent client connections allowed. This limit is always enforced even if no other policy settings have been defined. </p> </dd> -</dl> -<h3><a name="_autolink"></a>autoLink</h3> -<p>Entity type for configuring auto-links. Auto-links are links whose lifecycle is managed by the router. These are typically used to attach to waypoints on remote containers (brokers, etc.).</p> -<dl> -<dt> -<b>addr</b> (string, required) +<dt class="hdlist1"> +<em>enableVhostPolicy</em> (boolean) </dt> <dd> <p> - The address of the provisioned object + Enable vhost policy user groups, connection denial, and resource limit enforcement </p> </dd> -<dt> -<b>dir</b> (One of [<b>in</b>, <b>out</b>], required) +<dt class="hdlist1"> +<em>policyDir</em> (path) </dt> <dd> <p> - The direction of the link to be created. In means into the router, out means out of the router. + Absolute path to a directory that holds vhost definition .json files. All vhost definitions in all .json files in this directory are processed. </p> </dd> -<dt> -<b>phase</b> (integer) +<dt class="hdlist1"> +<em>defaultVhost</em> (string) </dt> <dd> <p> - The address phase for this link. Defaults to <b>0</b> for <b>out</b> links and <b>1</b> for <b>in</b> links. + Vhost rule set name to use for connections with a vhost that is otherwise not defined. Default vhost processing may be disabled either by erasing the definition of defaultVhost or by not defining a vhost object named <em>$default</em>. </p> </dd> -<dt> -<b>containerId</b> (string) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_vhost">vhost</h3> +<div class="paragraph"><p>AMQP virtual host policy definition of users, user groups, allowed remote hosts, and AMQP restrictions.</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>maxConnections</em> (integer, default=65535) </dt> <dd> <p> - ContainerID for the target container + Maximum number of concurrent client connections allowed. </p> </dd> -<dt> -<b>connection</b> (string) +<dt class="hdlist1"> +<em>maxConnectionsPerUser</em> (integer, default=65535) </dt> <dd> <p> - The name from a connector or listener + Maximum number of concurrent client connections allowed for any single user. </p> </dd> -</dl> -<h3><a name="_console"></a>console</h3> -<p>Start a websocket/tcp proxy and http file server to serve the web console</p> -<dl> -<dt> -<b>listener</b> (string) +<dt class="hdlist1"> +<em>maxConnectionsPerHost</em> (integer, default=65535) </dt> <dd> <p> - The name of the listener to send the proxied tcp traffic to. + Maximum number of concurrent client connections allowed for any remote host. </p> </dd> -<dt> -<b>wsport</b> (integer, default=5673) +<dt class="hdlist1"> +<em>allowUnknownUser</em> (boolean) </dt> <dd> <p> - port on which to listen for websocket traffic + Unrestricted users, those who are not members of a defined user group, are allowed to connect to this application. Unrestricted users are assigned to the <em>default</em> user group and receive <em>default</em> settings. </p> </dd> -<dt> -<b>proxy</b> (string) +<dt class="hdlist1"> +<em>groups</em> (map) </dt> <dd> <p> - The full path to the proxy program to run. + A map where each key is a user group name and the value is a map of the corresponding settings for that group. </p> </dd> -<dt> -<b>home</b> (string) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_container">container</h3> +<div class="paragraph"><p>(DEPRECATED)Attributes related to the AMQP container. This entity has been deprecated. Use the router entity instead.</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>containerName</em> (string) </dt> <dd> <p> - The full path to the html/css/js files for the console. + 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> -<b>args</b> (string) +<dt class="hdlist1"> +<em>workerThreads</em> (integer, default=4) </dt> <dd> <p> - Optional args to pass the proxy program for logging, authentication, etc. + 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 class="hdlist1"> +<em>debugDump</em> (path) +</dt> +<dd> +<p> + A file to dump debugging information that can’t be logged normally. </p> </dd> -</dl> -<h3><a name="_policy"></a>policy</h3> -<p>Defines global connection limit</p> -<dl> -<dt> -<b>maximumConnections</b> (integer) +<dt class="hdlist1"> +<em>saslConfigPath</em> (path) </dt> <dd> <p> - Global maximum number of concurrent client connections allowed. Zero implies no limit. This limit is always enforced even if no other policy settings have been defined. + Absolute path to the SASL configuration file. </p> </dd> -<dt> -<b>enableAccessRules</b> (boolean) +<dt class="hdlist1"> +<em>saslConfigName</em> (string) </dt> <dd> <p> - Enable user rule set processing and connection denial. + Name of the SASL configuration. This string + <em>.conf</em> is the name of the configuration file. </p> </dd> -<dt> -<b>policyFolder</b> (path) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_waypoint">waypoint</h3> +<div class="paragraph"><p>(DEPRECATED) A remote node that messages for an address pass through. This entity has been deprecated. Use autoLink instead</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>address</em> (string, required) </dt> <dd> <p> - The absolute path to a folder that holds policyRuleset definition .json files. For a small system the rulesets may all be defined in this file. At a larger scale it is better to have the policy files in their own folder and to have none of the rulesets defined here. All rulesets in all .json files in this folder are processed. + The AMQP address of the waypoint. </p> </dd> -<dt> -<b>defaultApplication</b> (string) +<dt class="hdlist1"> +<em>connector</em> (string, required) </dt> <dd> <p> - Application policyRuleset to use for connections with no open.hostname or a hostname that does not match any existing policy. For users that don’t wish to use open.hostname or any multi-tennancy feature, this default policy can be the only policy in effect for the network. + The name of the on-demand connector used to reach the waypoint’s container. </p> </dd> -<dt> -<b>defaultApplicationEnabled</b> (boolean) +<dt class="hdlist1"> +<em>inPhase</em> (integer, default=-1) </dt> <dd> <p> - Enable defaultApplication policy fallback logic. + The phase of the address as it is routed <em>to</em> the waypoint. </p> </dd> -</dl> -<h3><a name="_policyruleset"></a>policyRuleset</h3> -<p>Per application definition of the locations from which users may connect and the groups to which users belong.</p> -<dl> -<dt> -<b>maxConnections</b> (integer) +<dt class="hdlist1"> +<em>outPhase</em> (integer, default=-1) </dt> <dd> <p> - Maximum number of concurrent client connections allowed. Zero implies no limit. + The phase of the address as it is routed <em>from</em> the waypoint. </p> </dd> -<dt> -<b>maxConnPerUser</b> (integer) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_fixedaddress">fixedAddress</h3> +<div class="paragraph"><p>(DEPRECATED) Establishes treatment for addresses starting with a prefix. This entity has been deprecated. Use address instead</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>prefix</em> (string, required) </dt> <dd> <p> - Maximum number of concurrent client connections allowed for any single user. Zero implies no limit. + The address prefix (always starting with <em>/</em>). </p> </dd> -<dt> -<b>maxConnPerHost</b> (integer) +<dt class="hdlist1"> +<em>phase</em> (integer) </dt> <dd> <p> - Maximum number of concurrent client connections allowed for any remote host. Zero implies no limit. + The phase of a multi-hop address passing through one or more waypoints. </p> </dd> -<dt> -<b>userGroups</b> (map) +<dt class="hdlist1"> +<em>fanout</em> (One of [<em>multiple</em>, <em>single</em>], default=<em>multiple</em>) </dt> <dd> <p> - A map where each key is a user group name and the corresponding value is a CSV string naming the users in that group. Users who are assigned to one or more groups are deemed <b>restricted</b>. Restricted users are subject to connection ingress policy and are assigned policy settings based on the assigned user groups. Unrestricted users may be allowed or denied. If unrestricted users are allowed to connect then they are assigned to user group default. + One of <em>multiple</em> or <em>single</em>. 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> -<b>ingressHostGroups</b> (map) +<dt class="hdlist1"> +<em>bias</em> (One of [<em>closest</em>, <em>spread</em>], default=<em>closest</em>) </dt> <dd> <p> - A map where each key is an ingress host group name and the corresponding value is a CSV string naming the IP addresses or address ranges in that group. IP addresses may be FQDN strings or numeric IPv4 or IPv6 host addresses. A host range is two host addresses of the same address family separated with a hyphen. The wildcard host address <b>*</b> represents any host address. + Only if fanout is single. One of <em>closest</em> or <em>spread</em>. 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> -<b>ingressPolicies</b> (map) +</dl></div> +</div> +<div class="sect2"> +<h3 id="_linkroutepattern">linkRoutePattern</h3> +<div class="paragraph"><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 linkRoute instead</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>prefix</em> (string, required) </dt> <dd> <p> - A map where each key is a user group name and the corresponding value is a CSV string naming the ingress host group names that restrict the ingress host for the user group. Users who are members of the user group are allowed to connect only from a host in one of the named ingress host groups. + An address prefix to match against target and source addresses. This pattern must be of the form <em><text>.<text1>.<textN></em> or <em><text></em> or <em><text>.</em> 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 <em>org.apache</em> (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 </p> </dd> -<dt> -<b>connectionAllowDefault</b> (boolean) +<dt class="hdlist1"> +<em>dir</em> (One of [<em>in</em>, <em>out</em>, <em>both</em>], default=<em>both</em>) </dt> <dd> <p> - Unrestricted users, those who are not members of a defined user group, are allowed to connect to this application. Unrestricted users are assigned to the <b>default</b> user group and receive <b>default</b> settings. + Link direction for match: <em>in</em> matches only links inbound to the client; <em>out</em> matches only links outbound from the client; <em>both</em> matches any link. </p> </dd> -<dt> -<b>settings</b> (map) +<dt class="hdlist1"> +<em>connector</em> (string) </dt> <dd> <p> - A map where each key is a user group name and the value is a map of the corresponding settings for that group. + The name of the on-demand connector used to reach the target node’s container. If this value is not provided, it means that the target container is expected to be connected to a different router in the network. This prevents links to a link-routable address from being misinterpreted as message-routing links when there is no route to a valid destination available. </p> </dd> -</dl> -<h2><a name="_see_also"></a>SEE ALSO</h2> -<p><strong>qdrouterd(8)</strong>, <strong>qdmanage(8)</strong></p> -<p><a href="http://qpid.apache.org/components/dispatch-router";>http://qpid.apache.org/components/dispatch-router</a></p> +</dl></div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_see_also">SEE ALSO</h2> +<div class="sectionbody"> +<div class="paragraph"><p><strong>qdrouterd(8)</strong>, <strong>qdmanage(8)</strong></p></div> +<div class="paragraph"><p><a href="http://qpid.apache.org/components/dispatch-router";>http://qpid.apache.org/components/dispatch-router</a></p></div> +</div> +</div> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
