http://git-wip-us.apache.org/repos/asf/qpid-site/blob/e2639aac/input/releases/qpid-dispatch-0.8.0/book/console_charts.png ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/book/console_charts.png b/input/releases/qpid-dispatch-0.8.0/book/console_charts.png new file mode 100644 index 0000000..169c2ca Binary files /dev/null and b/input/releases/qpid-dispatch-0.8.0/book/console_charts.png differ
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/e2639aac/input/releases/qpid-dispatch-0.8.0/book/console_entity.png ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/book/console_entity.png b/input/releases/qpid-dispatch-0.8.0/book/console_entity.png new file mode 100644 index 0000000..130c7e7 Binary files /dev/null and b/input/releases/qpid-dispatch-0.8.0/book/console_entity.png differ http://git-wip-us.apache.org/repos/asf/qpid-site/blob/e2639aac/input/releases/qpid-dispatch-0.8.0/book/console_login.png ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/book/console_login.png b/input/releases/qpid-dispatch-0.8.0/book/console_login.png new file mode 100644 index 0000000..63e22c6 Binary files /dev/null and b/input/releases/qpid-dispatch-0.8.0/book/console_login.png differ http://git-wip-us.apache.org/repos/asf/qpid-site/blob/e2639aac/input/releases/qpid-dispatch-0.8.0/book/console_overview.png ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/book/console_overview.png b/input/releases/qpid-dispatch-0.8.0/book/console_overview.png new file mode 100644 index 0000000..af25f36 Binary files /dev/null and b/input/releases/qpid-dispatch-0.8.0/book/console_overview.png differ http://git-wip-us.apache.org/repos/asf/qpid-site/blob/e2639aac/input/releases/qpid-dispatch-0.8.0/book/console_schema.png ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/book/console_schema.png b/input/releases/qpid-dispatch-0.8.0/book/console_schema.png new file mode 100644 index 0000000..ba56c7b Binary files /dev/null and b/input/releases/qpid-dispatch-0.8.0/book/console_schema.png differ http://git-wip-us.apache.org/repos/asf/qpid-site/blob/e2639aac/input/releases/qpid-dispatch-0.8.0/book/console_topology.png ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/book/console_topology.png b/input/releases/qpid-dispatch-0.8.0/book/console_topology.png new file mode 100644 index 0000000..ae4b22a Binary files /dev/null and b/input/releases/qpid-dispatch-0.8.0/book/console_topology.png differ http://git-wip-us.apache.org/repos/asf/qpid-site/blob/e2639aac/input/releases/qpid-dispatch-0.8.0/index.md ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/index.md b/input/releases/qpid-dispatch-0.8.0/index.md new file mode 100644 index 0000000..081e84f --- /dev/null +++ b/input/releases/qpid-dispatch-0.8.0/index.md @@ -0,0 +1,66 @@ +;; +;; Licensed to the Apache Software Foundation (ASF) under one +;; or more contributor license agreements. See the NOTICE file +;; distributed with this work for additional information +;; regarding copyright ownership. The ASF licenses this file +;; to you under the Apache License, Version 2.0 (the +;; "License"); you may not use this file except in compliance +;; with the License. You may obtain a copy of the License at +;; +;; http://www.apache.org/licenses/LICENSE-2.0 +;; +;; Unless required by applicable law or agreed to in writing, +;; software distributed under the License is distributed on an +;; "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +;; KIND, either express or implied. See the License for the +;; specific language governing permissions and limitations +;; under the License. +;; + +# Qpid Dispatch 0.8.0 + +Dispatch is a lightweight AMQP message router library. More about +[Qpid +Dispatch]({{site_url}}/components/dispatch-router/index.html). + +For a detailed list of the changes in this release, see the [release +notes](release-notes.html). + +## Downloads + +It's important to [verify the +integrity]({{site_url}}/download.html#verify-what-you-download) of +the files you download. + +| Content | Download | Verify | +|---------|----------|--------| +| Dispatch router | [qpid-dispatch-0.8.0.tar.gz](http://archive.apache.org/dist/qpid/dispatch/0.8.0/qpid-dispatch-0.8.0.tar.gz) | [PGP](http://archive.apache.org/dist/qpid/dispatch/0.8.0/qpid-dispatch-0.8.0.tar.gz.asc) | + +## Documentation + + +<div class="two-column" markdown="1"> + + - [Installing Qpid Dispatch](https://git-wip-us.apache.org/repos/asf?p=qpid-dispatch.git;a=blob_plain;f=README;hb=0.8.x) + - [Dispatch Router User Guide](book/book.html) + - [qdrouterd](man/qdrouterd.html) - Router daemon + - [qdrouterd.conf](man/qdrouterd.conf.html) - Daemon configuration + - [qdstat](man/qdstat.html) - Get router statistics + - [qdmanage](man/qdmanage.html) - Manage the router + +</div> + + +## More information + + - [All release artefacts](http://archive.apache.org/dist/qpid/dispatch/0.8.0) + - [Resolved issues in JIRA](https://issues.apache.org/jira/issues/?jql=project+%3D+DISPATCH+AND+fixVersion+%3D+%270.8.0%27+AND+resolution+%3D+%27fixed%27+ORDER+BY+priority+DESC) + - [Source repository tag](https://git-wip-us.apache.org/repos/asf/qpid-dispatch.git/tree/refs/tags/0.8.0) + +<script type="text/javascript"> + _deferredFunctions.push(function() { + if ("0.8.0" === "{{current_dispatch_release}}") { + _modifyCurrentReleaseLinks(); + } + }); +</script> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/e2639aac/input/releases/qpid-dispatch-0.8.0/man/qdmanage.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/man/qdmanage.html.in b/input/releases/qpid-dispatch-0.8.0/man/qdmanage.html.in new file mode 100644 index 0000000..384c8f7 --- /dev/null +++ b/input/releases/qpid-dispatch-0.8.0/man/qdmanage.html.in @@ -0,0 +1,245 @@ +<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></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</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> + Print attributes for multiple entities. Prints all entities by default, use + --type, --name or --identity options to restrict which entities are printed. + Prints the attributes named in the ATTR list, or all attributes if none are + listed. +</p> +</dd> +<dt class="hdlist1"> +<code>create</code> [<em>ATTR=VALUE</em>…] +</dt> +<dd> +<p> + Create a new entity with the specified attributes. With the --stdin + option, read attributes from stdin. This can be a JSON map of + attributes to create a single entity, or a JSON list of maps to create + multiple entities. +</p> +</dd> +<dt class="hdlist1"> +<code>read</code> +</dt> +<dd> +<p> + Print all the attributes of a single entity, specified by the --name or + --identity options. +</p> +</dd> +<dt class="hdlist1"> +<code>update</code> [<em>ATTR=VALUE</em>…] +</dt> +<dd> +<p> + Update the attributes of an existing entity. If an ATTR name is listed with + no =VALUE, that attribute will be deleted from the entity. With the --stdin + option, read attributes from stdin. This can be a JSON map of attributes to + update a single entity, or a JSON list of maps to update multiple entities. +</p> +</dd> +<dt class="hdlist1"> +<code>delete</code> +</dt> +<dd> +<p> + Delete an entity specified by the --name or --identity options. +</p> +</dd> +<dt class="hdlist1"> +<code>get-types</code> [<em>TYPE</em>] +</dt> +<dd> +<p> + List entity types with their base types. With no arguments list all + types. +</p> +</dd> +<dt class="hdlist1"> +<code>get-operations</code> [<em>TYPE</em>] +</dt> +<dd> +<p> + List entity types with their operations. With no arguments list all + types. +</p> +</dd> +<dt class="hdlist1"> +<code>get-attributes</code> [<em>TYPE</em>] +</dt> +<dd> +<p> + List entity types with their attributes. With no arguments list all + types. +</p> +</dd> +<dt class="hdlist1"> +<code>get-annotations</code> [<em>TYPE</em>] +</dt> +<dd> +<p> + List entity types with their annotations. With no arguments list all + types. +</p> +</dd> +<dt class="hdlist1"> +<code>get-mgmt-nodes</code> +</dt> +<dd> +<p> + List all other known management nodes connected to this one. +</p> +</dd> +<dt class="hdlist1"> +<code>get-json-schema</code> [<em>INDENT</em>] +</dt> +<dd> +<p> + Get the router schema in JSON format. Optional integer indent for + formatted output. +</p> +</dd> +<dt class="hdlist1"> +<code>get-log</code> [<em>INDENT</em>] +</dt> +<dd> +<p> + Get recent log entries from the router. +</p> +</dd> +</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> +<p> + Management schema for qdrouterd. +</p> +</dd> +<dt class="hdlist1"> +/usr/local/share/doc/qpid-dispatch/qdrouter.json.readme.txt +</dt> +<dd> +<p> + Explanation of the management schema. +</p> +</dd> +</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> +</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> +</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> +</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> +</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> +</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/e2639aac/input/releases/qpid-dispatch-0.8.0/man/qdrouterd.conf.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/man/qdrouterd.conf.html.in b/input/releases/qpid-dispatch-0.8.0/man/qdrouterd.conf.html.in new file mode 100644 index 0000000..7194e81 --- /dev/null +++ b/input/releases/qpid-dispatch-0.8.0/man/qdrouterd.conf.html.in @@ -0,0 +1,1108 @@ +<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> +</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> +</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> +</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 + port: 20003 + saslMechanisms: ANONYMOUS + ... +}</code></pre> +</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 + certFile: server-certificate-1.pem + keyFile: server-private-key.pem +} + +listener { + sslProfile: my-ssl + host: 0.0.0.0 + port: 20102 + saslMechanisms: ANONYMOUS +}</code></pre> +</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. This entity is mandatory. The router will not start without this entity.</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +<em>id</em> (string) +</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 class="hdlist1"> +<em>mode</em> (One of [<em>standalone</em>, <em>interior</em>], default=<em>standalone</em>) +</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 class="hdlist1"> +<em>helloInterval</em> (integer, default=1) +</dt> +<dd> +<p> + Interval in seconds between HELLO messages sent to neighbor routers. +</p> +</dd> +<dt class="hdlist1"> +<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 class="hdlist1"> +<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 class="hdlist1"> +<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 class="hdlist1"> +<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 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 class="hdlist1"> +<em>debugDump</em> (path) +</dt> +<dd> +<p> + A file to dump debugging information that can’t be logged normally. +</p> +</dd> +<dt class="hdlist1"> +<em>saslConfigPath</em> (path) +</dt> +<dd> +<p> + Absolute path to the SASL configuration file. +</p> +</dd> +<dt class="hdlist1"> +<em>saslConfigName</em> (string, default=<em>qdrouterd</em>) +</dt> +<dd> +<p> + Name of the SASL configuration. This string + <em>.conf</em> is the name of the configuration file. +</p> +</dd> +<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 class="hdlist1"> +<em>mobileAddrMaxAge</em> (integer, default=60) +</dt> +<dd> +<p> + (DEPRECATED) This value is no longer used in the router. +</p> +</dd> +</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> + The absolute path to the database that contains the public certificates of trusted certificate authorities (CA). +</p> +</dd> +<dt class="hdlist1"> +<em>certFile</em> (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. +</p> +</dd> +<dt class="hdlist1"> +<em>keyFile</em> (path) +</dt> +<dd> +<p> + The absolute path to the file containing the PEM-formatted private key for the above certificate. +</p> +</dd> +<dt class="hdlist1"> +<em>passwordFile</em> (path) +</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. +</p> +</dd> +<dt class="hdlist1"> +<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 takes precedence over the passwordFile if both are specified. +</p> +</dd> +<dt class="hdlist1"> +<em>uidFormat</em> (string) +</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 <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). The user identifier (uid) that is generated based on the uidFormat is a string which has a semi-colon as a separator between the components +</p> +</dd> +<dt class="hdlist1"> +<em>displayNameFile</em> (string) +</dt> +<dd> +<p> + The absolute path to the file containing the unique id to display name mapping +</p> +</dd> +</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 class="hdlist1"> +<em>port</em> (string, default=<em>amqp</em>) +</dt> +<dd> +<p> + Port number or symbolic service name. +</p> +</dd> +<dt class="hdlist1"> +<em>protocolFamily</em> (One of [<em>IPv4</em>, <em>IPv6</em>]) +</dt> +<dd> +<p> + [<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 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 class="hdlist1"> +<em>cost</em> (integer, default=<em>1</em>) +</dt> +<dd> +<p> + 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 class="hdlist1"> +<em>sslProfile</em> (string) +</dt> +<dd> +<p> + Name of the sslProfile. +</p> +</dd> +<dt class="hdlist1"> +<em>saslMechanisms</em> (string) +</dt> +<dd> +<p> + Space separated list of accepted SASL authentication mechanisms. +</p> +</dd> +<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 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 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 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 class="hdlist1"> +<em>maxFrameSize</em> (integer, default=16384) +</dt> +<dd> +<p> + 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. Policy settings, if specified, will overwrite this value. Defaults to 16384. +</p> +</dd> +<dt class="hdlist1"> +<em>maxSessions</em> (integer, default=32768) +</dt> +<dd> +<p> + The maximum number of sessions that can be simultaneously active on the connection. Setting this value to zero selects the default number of sessions. Policy settings, if specified, will overwrite this value. Defaults to 32768. +</p> +</dd> +<dt class="hdlist1"> +<em>maxSessionFrames</em> (integer) +</dt> +<dd> +<p> + Session incoming window measured in transfer frames for sessions created on this connection. This is the number of transfer frames that may simultaneously be in flight for all links in the session. Setting this value to zero selects the default session window size. Policy settings, if specified, will overwrite this value. The numerical product of maxFrameSize and maxSessionFrames may not exceed 2<sup>31-1. If (maxFrameSize x maxSessionFrames) exceeds 2</sup>31-1 then maxSessionFrames is reduced to (2^31-1 / maxFrameSize). maxSessionFrames has a minimum value of 1. Defaults to 0 (unlimited window). +</p> +</dd> +<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 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> + [<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 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 class="hdlist1"> +<em>multiTenant</em> (boolean) +</dt> +<dd> +<p> + If true, apply multi-tenancy to endpoints connected at this listener. The address space is defined by the virtual host (hostname field in the Open). +</p> +</dd> +<dt class="hdlist1"> +<em>failoverList</em> (string) +</dt> +<dd> +<p> + A comma-separated list of failover urls to be supplied to connected clients. Form: [(amqp|amqps|ws|wss)://]host_or_ip[:port] +</p> +</dd> +<dt class="hdlist1"> +<em>addr</em> (string, default=<em>127.0.0.1</em>) +</dt> +<dd> +<p> + (DEPRECATED)IP address: ipv4 or ipv6 literal or a host name. This attribute has been deprecated. Use host instead +</p> +</dd> +<dt class="hdlist1"> +<em>allowNoSasl</em> (boolean) +</dt> +<dd> +<p> + (DEPRECATED) This attribute is now controlled by the authenticatePeer attribute. +</p> +</dd> +<dt class="hdlist1"> +<em>requirePeerAuth</em> (boolean) +</dt> +<dd> +<p> + (DEPRECATED) This attribute is now controlled by the authenticatePeer attribute. +</p> +</dd> +<dt class="hdlist1"> +<em>allowUnsecured</em> (boolean) +</dt> +<dd> +<p> + (DEPRECATED) This attribute is now controlled by the requireEncryption attribute. +</p> +</dd> +<dt class="hdlist1"> +<em>http</em> (boolean) +</dt> +<dd> +<p> + Accept HTTP connections that can upgrade to AMQP over WebSocket +</p> +</dd> +<dt class="hdlist1"> +<em>httpRoot</em> (path) +</dt> +<dd> +<p> + Serve HTTP files from this directory, defaults to the installed stand-alone console directory +</p> +</dd> +<dt class="hdlist1"> +<em>logMessage</em> (string, default=<em>none</em>) +</dt> +<dd> +<p> + A comma separated list that indicates which components of the message should be logged. Defaults to <em>none</em> (log nothing). If you want all properties and application properties of the message logged use <em>all</em>. Specific components of the message can be logged by indicating the components via a comma separated list. The components are message-id, user-id, to, subject, reply-to, correlation-id, content-type, content-encoding, absolute-expiry-time, creation-time, group-id, group-sequence, reply-to-group-id, app-properties. The application-data part of the bare message will not be logged. No spaces are allowed +</p> +</dd> +</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 class="hdlist1"> +<em>port</em> (string, default=<em>amqp</em>) +</dt> +<dd> +<p> + Port number or symbolic service name. +</p> +</dd> +<dt class="hdlist1"> +<em>protocolFamily</em> (One of [<em>IPv4</em>, <em>IPv6</em>]) +</dt> +<dd> +<p> + [<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 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 class="hdlist1"> +<em>cost</em> (integer, default=<em>1</em>) +</dt> +<dd> +<p> + 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 class="hdlist1"> +<em>sslProfile</em> (string) +</dt> +<dd> +<p> + Name of the sslProfile. +</p> +</dd> +<dt class="hdlist1"> +<em>saslMechanisms</em> (string) +</dt> +<dd> +<p> + Space separated list of accepted SASL authentication mechanisms. +</p> +</dd> +<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 class="hdlist1"> +<em>maxFrameSize</em> (integer, default=16384) +</dt> +<dd> +<p> + 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. Policy settings will not overwrite this value. Defaults to 16384. +</p> +</dd> +<dt class="hdlist1"> +<em>maxSessions</em> (integer, default=32768) +</dt> +<dd> +<p> + The maximum number of sessions that can be simultaneously active on the connection. Setting this value to zero selects the default number of sessions. Policy settings will not overwrite this value. Defaults to 32768. +</p> +</dd> +<dt class="hdlist1"> +<em>maxSessionFrames</em> (integer) +</dt> +<dd> +<p> + Session incoming window measured in transfer frames for sessions created on this connection. This is the number of transfer frames that may simultaneously be in flight for all links in the session. Setting this value to zero selects the default session window size. Policy settings will not overwrite this value. The numerical product of maxFrameSize and maxSessionFrames may not exceed 2<sup>31-1. If (maxFrameSize x maxSessionFrames) exceeds 2</sup>31-1 then maxSessionFrames is reduced to (2^31-1 / maxFrameSize). maxSessionFrames has a minimum value of 1. Defaults to 0 (unlimited window). +</p> +</dd> +<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 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> + [<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 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 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 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 class="hdlist1"> +<em>saslPassword</em> (string) +</dt> +<dd> +<p> + The password that the connector is using to connect to a peer. +</p> +</dd> +<dt class="hdlist1"> +<em>addr</em> (string, default=<em>127.0.0.1</em>) +</dt> +<dd> +<p> + (DEPRECATED)IP address: ipv4 or ipv6 literal or a host name. This attribute has been deprecated. Use host instead +</p> +</dd> +<dt class="hdlist1"> +<em>logMessage</em> (string, default=<em>none</em>) +</dt> +<dd> +<p> + A comma separated list that indicates which components of the message should be logged. Defaults to <em>none</em> (log nothing). If you want all properties and application properties of the message logged use <em>all</em>. Specific components of the message can be logged by indicating the components via a comma separated list. The components are message-id, user-id, to, subject, reply-to, correlation-id, content-type, content-encoding, absolute-expiry-time, creation-time, group-id, group-sequence, reply-to-group-id, app-properties. The application-data part of the bare message will not be logged. No spaces are allowed +</p> +</dd> +</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>HTTP</em>, <em>CONN_MGR</em>, <em>PYTHON</em>, <em>DEFAULT</em>], required) +</dt> +<dd> +<p> + Module to configure. The special module <em>DEFAULT</em> specifies defaults for all modules. +</p> +</dd> +<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 class="hdlist1"> +<em>source</em> (boolean) +</dt> +<dd> +<p> + Include source file and line number in log messages. +</p> +</dd> +<dt class="hdlist1"> +<em>output</em> (string) +</dt> +<dd> +<p> + Where to send log messages. Can be <em>stderr</em>, <em>stdout</em>, <em>syslog</em> or a file name. +</p> +</dd> +</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 for the configured settings +</p> +</dd> +<dt class="hdlist1"> +<em>distribution</em> (One of [<em>multicast</em>, <em>closest</em>, <em>balanced</em>], default=<em>balanced</em>) +</dt> +<dd> +<p> + Treatment of traffic associated with the address +</p> +</dd> +<dt class="hdlist1"> +<em>waypoint</em> (boolean) +</dt> +<dd> +<p> + Designates this address space as being used for waypoints. This will cause the proper address-phasing to be used. +</p> +</dd> +<dt class="hdlist1"> +<em>ingressPhase</em> (integer) +</dt> +<dd> +<p> + Advanced - Override the ingress phase for this address +</p> +</dd> +<dt class="hdlist1"> +<em>egressPhase</em> (integer) +</dt> +<dd> +<p> + Advanced - Override the egress phase for this address +</p> +</dd> +</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 address prefix for the configured settings +</p> +</dd> +<dt class="hdlist1"> +<em>containerId</em> (string) +</dt> +<dd> +<p> + ContainerID for the target container. Only one of containerId or connection should be specified for a linkRoute. Specifying both will result in the linkRoute not being created. +</p> +</dd> +<dt class="hdlist1"> +<em>connection</em> (string) +</dt> +<dd> +<p> + The name from a connector or listener. Only one of containerId or connection should be specified for a linkRoute. Specifying both will result in the linkRoute not being created. +</p> +</dd> +<dt class="hdlist1"> +<em>distribution</em> (One of [<em>linkBalanced</em>], default=<em>linkBalanced</em>) +</dt> +<dd> +<p> + Treatment of traffic associated with the address +</p> +</dd> +<dt class="hdlist1"> +<em>dir</em> (One of [<em>in</em>, <em>out</em>], required) +</dt> +<dd> +<p> + The permitted direction of links: <em>in</em> means client senders; <em>out</em> means client receivers +</p> +</dd> +</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 address of the provisioned object +</p> +</dd> +<dt class="hdlist1"> +<em>dir</em> (One of [<em>in</em>, <em>out</em>], required) +</dt> +<dd> +<p> + The direction of the link to be created. In means into the router, out means out of the router. +</p> +</dd> +<dt class="hdlist1"> +<em>phase</em> (integer) +</dt> +<dd> +<p> + 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 class="hdlist1"> +<em>containerId</em> (string) +</dt> +<dd> +<p> + ContainerID for the target container. Only one of containerId or connection should be specified for an autoLink. Specifying both will result in the autoLink not being created +</p> +</dd> +<dt class="hdlist1"> +<em>connection</em> (string) +</dt> +<dd> +<p> + The name from a connector or listener. Only one of containerId or connection should be specified for an autoLink. Specifying both will result in the autoLink not being created +</p> +</dd> +<dt class="hdlist1"> +<em>externalAddr</em> (string) +</dt> +<dd> +<p> + If present, an alternate address of the node on the remote container. This is used if the node has a different address than the address used internally by the router to route deliveries. +</p> +</dd> +</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> + The name of the listener to send the proxied tcp traffic to. +</p> +</dd> +<dt class="hdlist1"> +<em>wsport</em> (integer, default=5673) +</dt> +<dd> +<p> + port on which to listen for websocket traffic +</p> +</dd> +<dt class="hdlist1"> +<em>proxy</em> (string) +</dt> +<dd> +<p> + The full path to the proxy program to run. +</p> +</dd> +<dt class="hdlist1"> +<em>home</em> (string) +</dt> +<dd> +<p> + The full path to the html/css/js files for the console. +</p> +</dd> +<dt class="hdlist1"> +<em>args</em> (string) +</dt> +<dd> +<p> + Optional args to pass the proxy program for logging, authentication, etc. +</p> +</dd> +</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> + Global maximum number of concurrent client connections allowed. This limit is always enforced even if no other policy settings have been defined. +</p> +</dd> +<dt class="hdlist1"> +<em>enableVhostPolicy</em> (boolean) +</dt> +<dd> +<p> + Enable vhost policy user groups, connection denial, and resource limit enforcement +</p> +</dd> +<dt class="hdlist1"> +<em>policyDir</em> (path) +</dt> +<dd> +<p> + 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 class="hdlist1"> +<em>defaultVhost</em> (string) +</dt> +<dd> +<p> + 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> +</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>id</em> (string, required) +</dt> +<dd> +<p> + The vhost name. +</p> +</dd> +<dt class="hdlist1"> +<em>maxConnections</em> (integer, default=65535) +</dt> +<dd> +<p> + Maximum number of concurrent client connections allowed. +</p> +</dd> +<dt class="hdlist1"> +<em>maxConnectionsPerUser</em> (integer, default=65535) +</dt> +<dd> +<p> + Maximum number of concurrent client connections allowed for any single user. +</p> +</dd> +<dt class="hdlist1"> +<em>maxConnectionsPerHost</em> (integer, default=65535) +</dt> +<dd> +<p> + Maximum number of concurrent client connections allowed for any remote host. +</p> +</dd> +<dt class="hdlist1"> +<em>allowUnknownUser</em> (boolean) +</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 <em>default</em> user group and receive <em>default</em> settings. +</p> +</dd> +<dt class="hdlist1"> +<em>groups</em> (map) +</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. +</p> +</dd> +</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 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 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 class="hdlist1"> +<em>debugDump</em> (path) +</dt> +<dd> +<p> + A file to dump debugging information that can’t be logged normally. +</p> +</dd> +<dt class="hdlist1"> +<em>saslConfigPath</em> (path) +</dt> +<dd> +<p> + Absolute path to the SASL configuration file. +</p> +</dd> +<dt class="hdlist1"> +<em>saslConfigName</em> (string) +</dt> +<dd> +<p> + Name of the SASL configuration. This string + <em>.conf</em> is the name of the configuration file. +</p> +</dd> +</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 AMQP address of the waypoint. +</p> +</dd> +<dt class="hdlist1"> +<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 class="hdlist1"> +<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 class="hdlist1"> +<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> +</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> + The address prefix (always starting with <em>/</em>). +</p> +</dd> +<dt class="hdlist1"> +<em>phase</em> (integer) +</dt> +<dd> +<p> + The phase of a multi-hop address passing through one or more waypoints. +</p> +</dd> +<dt class="hdlist1"> +<em>fanout</em> (One of [<em>multiple</em>, <em>single</em>], default=<em>multiple</em>) +</dt> +<dd> +<p> + 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 class="hdlist1"> +<em>bias</em> (One of [<em>closest</em>, <em>spread</em>], default=<em>closest</em>) +</dt> +<dd> +<p> + 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> +</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> + 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 class="hdlist1"> +<em>dir</em> (One of [<em>in</em>, <em>out</em>, <em>both</em>], default=<em>both</em>) +</dt> +<dd> +<p> + 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 class="hdlist1"> +<em>connector</em> (string) +</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. +</p> +</dd> +</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> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/e2639aac/input/releases/qpid-dispatch-0.8.0/man/qdrouterd.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/man/qdrouterd.html.in b/input/releases/qpid-dispatch-0.8.0/man/qdrouterd.html.in new file mode 100644 index 0000000..0b85b2e --- /dev/null +++ b/input/releases/qpid-dispatch-0.8.0/man/qdrouterd.html.in @@ -0,0 +1,55 @@ +<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></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>-v, --version +: Print the version of Qpid Dispatch Router</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> +<p> + Configuration flie. +</p> +</dd> +</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/e2639aac/input/releases/qpid-dispatch-0.8.0/man/qdstat.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-0.8.0/man/qdstat.html.in b/input/releases/qpid-dispatch-0.8.0/man/qdstat.html.in new file mode 100644 index 0000000..81f209e --- /dev/null +++ b/input/releases/qpid-dispatch-0.8.0/man/qdstat.html.in @@ -0,0 +1,738 @@ +<div class="sect1"> +<h2 id="_synopsis">SYNOPSIS</h2> +<div class="sectionbody"> +<div class="paragraph"><p><strong>qdstat</strong> [<em>OPTIONS</em>]</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"><p>Shows status information about networks of Dispatch routers. It can display +connections, network nodes and links, and router stats such as memory use.</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_options">OPTIONS</h2> +<div class="sectionbody"> +<div class="paragraph"><p>-h, --help +: show this help message and exit</p></div> +<div class="paragraph"><p>--version +: Print version and exit.</p></div> +<div class="paragraph"><p>-g, --general +: Show General Router Stats</p></div> +<div class="paragraph"><p>-c, --connections +: Show Connections</p></div> +<div class="paragraph"><p>-l, --links +: Show Router Links</p></div> +<div class="paragraph"><p>-n, --nodes +: Show Router Nodes</p></div> +<div class="paragraph"><p>-a, --address +: Show Router Addresses</p></div> +<div class="paragraph"><p>-m, --memory +: Show Router Memory Stats</p></div> +<div class="paragraph"><p>--autolinks +: Show Auto Links</p></div> +<div class="paragraph"><p>--linkroutes +: Show Link Routes</p></div> +<div class="paragraph"><p>-v, --verbose +: Show maximum detail</p></div> +<div class="paragraph"><p>--log +: Show recent log entries</p></div> +<div class="paragraph"><p>--limit=LIMIT +: Limit number of output rows</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</p></div> +<div class="paragraph"><p>-r ROUTER-ID, --router=ROUTER-ID +: Router to be queried</p></div> +<div class="paragraph"><p>-t SECS, --timeout=SECS +: Maximum time to wait for connection in seconds (default 5)</p></div> +<div class="paragraph"><p>--ssl-certificate=CERT +: Client SSL certificate (PEM Format)</p></div> +<div class="paragraph"><p>--ssl-key=KEY +: Client SSL private key (PEM Format)</p></div> +<div class="paragraph"><p>--ssl-trustfile=TRUSTED-CA-DB +: Trusted Certificate Authority Database file (PEM Format)</p></div> +<div class="paragraph"><p>--ssl-password=PASSWORD +: Certificate password, will be prompted if not specifed.</p></div> +<div class="paragraph"><p>--ssl-password-file=SSL-PASSWORD-FILE +: Certificate password, will be prompted if not specifed.</p></div> +<div class="paragraph"><p>--sasl-mechanisms=SASL-MECHANISMS +: Allowed sasl mechanisms to be supplied during the sasl handshake.</p></div> +<div class="paragraph"><p>--sasl-username=SASL-USERNAME +: User name for SASL plain authentication</p></div> +<div class="paragraph"><p>--sasl-password=SASL-PASSWORD +: Password for SASL plain authentication</p></div> +<div class="paragraph"><p>--sasl-password-file=SASL-PASSWORD-FILE +: Password for SASL plain authentication</p></div> +<div class="paragraph"><p>--ssl-disable-peer-name-verify +: Disables SSL peer name verification. WARNING - This option is insecure and must not be used in production environments</p></div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_output_columns">OUTPUT COLUMNS</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_qdstat_c">qdstat -c</h3> +<div class="dlist"><dl> +<dt class="hdlist1"> +id +</dt> +<dd> +<p> +Unique connection identifier +</p> +</dd> +<dt class="hdlist1"> +host +</dt> +<dd> +<p> +The hostname or internet address of the remotely connected AMQP container +</p> +</dd> +<dt class="hdlist1"> +container +</dt> +<dd> +<p> +The container-name of the remotely connected AMQP container +</p> +</dd> +<dt class="hdlist1"> +role +</dt> +<dd> +<p> +The configured role of the connection +</p> +<div class="ulist"><ul> +<li> +<p> +normal - Normal connections from client to router +</p> +</li> +<li> +<p> +inter-router - Connection between routers to form a network +</p> +</li> +<li> +<p> +route-container - Connection to/from a Broker or other host to receive link-routes and waypoints +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +dir +</dt> +<dd> +<p> +The direction of connection establishment +</p> +<div class="ulist"><ul> +<li> +<p> +in - The connection was initiated by the remote container +</p> +</li> +<li> +<p> +out - The connection was initiated by this router +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +security +</dt> +<dd> +<p> +A description of the security/encryption in effect for this +connection +</p> +</dd> +<dt class="hdlist1"> +authentication +</dt> +<dd> +<p> +The method and user-id of the authenticated user for +this connection +</p> +</dd> +</dl></div> +</div> +<div class="sect2"> +<h3 id="_qdstat_l">qdstat -l</h3> +<div class="dlist"><dl> +<dt class="hdlist1"> +type +</dt> +<dd> +<p> +Type of link +</p> +<div class="ulist"><ul> +<li> +<p> +router-control - An inter-router link that is reserved for control messages exchanged between routers +</p> +</li> +<li> +<p> +inter-router - An inter-router link that is used for normal message-routed deliveries +</p> +</li> +<li> +<p> +endpoint - A normal link to an external endpoint container +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +dir +</dt> +<dd> +<p> +The direction of message flow on the link +</p> +<div class="ulist"><ul> +<li> +<p> +in - Deliveries flow inbound to the router +</p> +</li> +<li> +<p> +out - Deliveries flow outbound from the router +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +conn id +</dt> +<dd> +<p> +Unique identifier of the connection over which this link is +attached +</p> +</dd> +<dt class="hdlist1"> +id +</dt> +<dd> +<p> +Unique identifier of this link +</p> +</dd> +<dt class="hdlist1"> +peer +</dt> +<dd> +<p> +For link-routed links, the unique identifier of the peer link. In +link routing, an inbound link is paired with an outbound link +</p> +</dd> +<dt class="hdlist1"> +class +</dt> +<dd> +<p> +Class of the address bound to the link +</p> +</dd> +<dt class="hdlist1"> +addr +</dt> +<dd> +<p> +The address bound to the link +</p> +</dd> +<dt class="hdlist1"> +phs +</dt> +<dd> +<p> +The phase of the address bound to the link +</p> +</dd> +<dt class="hdlist1"> +cap +</dt> +<dd> +<p> +The capacity, in deliveries, of the link +</p> +</dd> +<dt class="hdlist1"> +undel +</dt> +<dd> +<p> +The number of undelivered messages stored on the link’s FIFO +</p> +</dd> +<dt class="hdlist1"> +unsett +</dt> +<dd> +<p> +The number of unsettled deliveries being tracked by the link +</p> +</dd> +<dt class="hdlist1"> +del +</dt> +<dd> +<p> +The total number of deliveries that have transited this link +</p> +</dd> +</dl></div> +<div class="paragraph"><p>presett: +The number of pre-settled deliveries that transited this link</p></div> +<div class="paragraph"><p>acc: +The number of deliveries on this link that were accepted</p></div> +<div class="paragraph"><p>rej: +The number of deliveries on this link that were rejected</p></div> +<div class="paragraph"><p>rel: +The number of deliveries on this link that were released</p></div> +<div class="paragraph"><p>mod: +The number of deliveries on this link that were modified</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> +admin +</dt> +<dd> +<p> +The administrative status of the link +</p> +<div class="ulist"><ul> +<li> +<p> +enabled - The link is enabled for normal operation +</p> +</li> +<li> +<p> +disabled - The link is disabled and should be quiescing or stopped (not yet supported) +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +oper +</dt> +<dd> +<p> +The operational status of the link +</p> +<div class="ulist"><ul> +<li> +<p> +up - The link is operational +</p> +</li> +<li> +<p> +down - The link is not attached +</p> +</li> +<li> +<p> +quiescing - The link is in the process of quiescing (not yet supported) +</p> +</li> +<li> +<p> +idle - The link has completed quiescing and is idle (not yet supported) +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +name +</dt> +<dd> +<p> +The link name (only shown if the -v option is provided) +</p> +</dd> +</dl></div> +<div class="sect3"> +<h4 id="_qdstat_n">qdstat -n</h4> +<div class="dlist"><dl> +<dt class="hdlist1"> +router-id +</dt> +<dd> +<p> +Identifier of the router +</p> +</dd> +<dt class="hdlist1"> +next-hop +</dt> +<dd> +<p> +If this router is not a neighbor, identifies the next-hop neighbor used to reach this router +</p> +</dd> +<dt class="hdlist1"> +link +</dt> +<dd> +<p> +Unique identifier of the link to the neighbor router +</p> +</dd> +<dt class="hdlist1"> +cost +</dt> +<dd> +<p> +The topology cost to this remote router (with -v option only) +</p> +</dd> +<dt class="hdlist1"> +neighbors +</dt> +<dd> +<p> +The list of neighbor routers (the router’s link-state) (with -v option only) +</p> +</dd> +<dt class="hdlist1"> +valid-origins +</dt> +<dd> +<p> +The list of origin routers for which the best path to the listed router passes through this router (with -v option only) +</p> +</dd> +</dl></div> +</div> +</div> +<div class="sect2"> +<h3 id="_qdstat_a">qdstat -a</h3> +<div class="dlist"><dl> +<dt class="hdlist1"> +class +</dt> +<dd> +<p> +The class of the listed address +</p> +<div class="ulist"><ul> +<li> +<p> +local - Address that is local to this router +</p> +</li> +<li> +<p> +topo - Topological address used for router control messages +</p> +</li> +<li> +<p> +router - A summary router address used to route messages to a remote router’s local addresses +</p> +</li> +<li> +<p> +mobile - A mobile address for an attached consumer or producer +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +addr +</dt> +<dd> +<p> +The address text +</p> +</dd> +<dt class="hdlist1"> +phs +</dt> +<dd> +<p> +For mobile addresses only, the phase of the address. Direct addresses have only a phase 0. Waypoint addresses have multiple phases, normally 0 and 1. +</p> +</dd> +<dt class="hdlist1"> +distrib +</dt> +<dd> +<p> +Distribution method used for this address +</p> +<div class="ulist"><ul> +<li> +<p> +multicast - A copy of each message is delivered once to each consumer for the address +</p> +</li> +<li> +<p> +closest - Each message is delivered to only one consumer for the address. The closest (lowest cost) consumer will be chosen. If there are multiple lowest-cost consumers, deliveries will be spread across those consumers. +</p> +</li> +<li> +<p> +balanced - Each message is delivered to only one consumer for the address. The consumer with the fewest outstanding (unsettled) deliveries will be chosen. The cost of the route to the consumer is a threshold for delivery (i.e. higher cost consumers will only receive deliveries if closer consumers are backed up). +</p> +</li> +<li> +<p> +flood - Used only for router-control traffic. This is multicast without prevention of duplicate deliveries. +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +in-proc +</dt> +<dd> +<p> +The number of in-process consumers for this address +</p> +</dd> +<dt class="hdlist1"> +local +</dt> +<dd> +<p> +The number of local (on this router) consumers for this address +</p> +</dd> +<dt class="hdlist1"> +remote +</dt> +<dd> +<p> +The number of remote routers that have at least one consumer for this address +</p> +</dd> +<dt class="hdlist1"> +cntnr +</dt> +<dd> +<p> +The number of locally attached containers that are destinations for link-routes on this address +</p> +</dd> +<dt class="hdlist1"> +in +</dt> +<dd> +<p> +The number of deliveries for this address that entered the network on this router +</p> +</dd> +<dt class="hdlist1"> +out +</dt> +<dd> +<p> +The number of deliveries for this address that exited the network on this router +</p> +</dd> +<dt class="hdlist1"> +thru +</dt> +<dd> +<p> +The number of deliveries for this address that were forwarded to other routers +</p> +</dd> +<dt class="hdlist1"> +to-proc +</dt> +<dd> +<p> +The number of deliveries for this address that were delivered to an in-process consumer +</p> +</dd> +<dt class="hdlist1"> +from-proc +</dt> +<dd> +<p> +The number of deliveries for this address that were received from an in-process producer +</p> +</dd> +</dl></div> +</div> +<div class="sect2"> +<h3 id="_qdstat_linkroutes">qdstat --linkroutes</h3> +<div class="dlist"><dl> +<dt class="hdlist1"> +prefix +</dt> +<dd> +<p> +The prefix for matching addresses of routed links +</p> +</dd> +<dt class="hdlist1"> +dir +</dt> +<dd> +<p> +The direction (from the router’s perspective) of matching links +</p> +</dd> +<dt class="hdlist1"> +distrib +</dt> +<dd> +<p> +The distribution method used for routed links +</p> +<div class="ulist"><ul> +<li> +<p> +linkBalanced - the only supported distribution for routed links +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +status +</dt> +<dd> +<p> +Operational status of the link route +</p> +<div class="ulist"><ul> +<li> +<p> +active - Route is actively routing attaches (i.e. ready for use) +</p> +</li> +<li> +<p> +inactive - Route is inactive because there is no local destination connected +</p> +</li> +</ul></div> +</dd> +</dl></div> +</div> +<div class="sect2"> +<h3 id="_qstat_autolinks">qstat --autolinks</h3> +<div class="dlist"><dl> +<dt class="hdlist1"> +addr +</dt> +<dd> +<p> +The address of the auto link +</p> +</dd> +<dt class="hdlist1"> +dir +</dt> +<dd> +<p> +The direction of message flow for the auto link +</p> +<div class="ulist"><ul> +<li> +<p> +in - Messages flow in from the route-container to the router network +</p> +</li> +<li> +<p> +out - Messages flow out to the route-container from the router network +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +phs +</dt> +<dd> +<p> +Phase of the address for this auto link +</p> +</dd> +<dt class="hdlist1"> +link +</dt> +<dd> +<p> +Unique identifier of the link managed by this auto link +</p> +</dd> +<dt class="hdlist1"> +status +</dt> +<dd> +<p> +The operational status of this auto link +</p> +<div class="ulist"><ul> +<li> +<p> +inactive - There is no connected container for this auto link +</p> +</li> +<li> +<p> +attaching - The link is attaching to the container +</p> +</li> +<li> +<p> +failed - The link-attach failed +</p> +</li> +<li> +<p> +active - The link is operational +</p> +</li> +<li> +<p> +quiescing - The link is quiescing (not yet supported) +</p> +</li> +<li> +<p> +idle - The link is idle (not yet supported) +</p> +</li> +</ul></div> +</dd> +<dt class="hdlist1"> +lastErr +</dt> +<dd> +<p> +The description of the last attach failure that occurred on this auto link +</p> +</dd> +</dl></div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_see_also">SEE ALSO</h2> +<div class="sectionbody"> +<div class="paragraph"><p><em>qdrouterd(8)</em>, <em>qdmanage(8)</em>, <em>qdrouterd.conf(5)</em></p></div> +<div class="paragraph"><p><a href="http://qpid.apache.org/components/dispatch-router";>http://qpid.apache.org/components/dispatch-router</a></p></div> +</div> +</div> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
