http://git-wip-us.apache.org/repos/asf/qpid-site/blob/18828d3b/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 75de632..08aeede 100644 --- a/input/releases/qpid-dispatch-master/qdrouterd.conf.5.html.in +++ b/input/releases/qpid-dispatch-master/qdrouterd.conf.5.html.in @@ -1,788 +1,38 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" - "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> -<head> -<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> -<title>qdrouterd.conf(5)</title> -<style type="text/css"> -/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ - -/* Default font. */ -body { - font-family: Georgia,serif; -} - -/* Title font. */ -h1, h2, h3, h4, h5, h6, -div.title, caption.title, -thead, p.table.header, -#toctitle, -#author, #revnumber, #revdate, #revremark, -#footer { - font-family: Arial,Helvetica,sans-serif; -} - -body { - margin: 1em 5% 1em 5%; -} - -a { - color: blue; - text-decoration: underline; -} -a:visited { - color: fuchsia; -} - -em { - font-style: italic; - color: navy; -} - -strong { - font-weight: bold; - color: #083194; -} - -h1, h2, h3, h4, h5, h6 { - color: #527bbd; - margin-top: 1.2em; - margin-bottom: 0.5em; - line-height: 1.3; -} - -h1, h2, h3 { - border-bottom: 2px solid silver; -} -h2 { - padding-top: 0.5em; -} -h3 { - float: left; -} -h3 + * { - clear: left; -} -h5 { - font-size: 1.0em; -} - -div.sectionbody { - margin-left: 0; -} - -hr { - border: 1px solid silver; -} - -p { - margin-top: 0.5em; - margin-bottom: 0.5em; -} - -ul, ol, li > p { - margin-top: 0; -} -ul > li { color: #aaa; } -ul > li > * { color: black; } - -.monospaced, code, pre { - font-family: "Courier New", Courier, monospace; - font-size: inherit; - color: navy; - padding: 0; - margin: 0; -} - - -#author { - color: #527bbd; - font-weight: bold; - font-size: 1.1em; -} -#email { -} -#revnumber, #revdate, #revremark { -} - -#footer { - font-size: small; - border-top: 2px solid silver; - padding-top: 0.5em; - margin-top: 4.0em; -} -#footer-text { - float: left; - padding-bottom: 0.5em; -} -#footer-badges { - float: right; - padding-bottom: 0.5em; -} - -#preamble { - margin-top: 1.5em; - margin-bottom: 1.5em; -} -div.imageblock, div.exampleblock, div.verseblock, -div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, -div.admonitionblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -div.admonitionblock { - margin-top: 2.0em; - margin-bottom: 2.0em; - margin-right: 10%; - color: #606060; -} - -div.content { /* Block element content. */ - padding: 0; -} - -/* Block element titles. */ -div.title, caption.title { - color: #527bbd; - font-weight: bold; - text-align: left; - margin-top: 1.0em; - margin-bottom: 0.5em; -} -div.title + * { - margin-top: 0; -} - -td div.title:first-child { - margin-top: 0.0em; -} -div.content div.title:first-child { - margin-top: 0.0em; -} -div.content + div.title { - margin-top: 0.0em; -} - -div.sidebarblock > div.content { - background: #ffffee; - border: 1px solid #dddddd; - border-left: 4px solid #f0f0f0; - padding: 0.5em; -} - -div.listingblock > div.content { - border: 1px solid #dddddd; - border-left: 5px solid #f0f0f0; - background: #f8f8f8; - padding: 0.5em; -} - -div.quoteblock, div.verseblock { - padding-left: 1.0em; - margin-left: 1.0em; - margin-right: 10%; - border-left: 5px solid #f0f0f0; - color: #888; -} - -div.quoteblock > div.attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock > pre.content { - font-family: inherit; - font-size: inherit; -} -div.verseblock > div.attribution { - padding-top: 0.75em; - text-align: left; -} -/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ -div.verseblock + div.attribution { - text-align: left; -} - -div.admonitionblock .icon { - vertical-align: top; - font-size: 1.1em; - font-weight: bold; - text-decoration: underline; - color: #527bbd; - padding-right: 0.5em; -} -div.admonitionblock td.content { - padding-left: 0.5em; - border-left: 3px solid #dddddd; -} - -div.exampleblock > div.content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } -a.image:visited { color: white; } - -dl { - margin-top: 0.8em; - margin-bottom: 0.8em; -} -dt { - margin-top: 0.5em; - margin-bottom: 0; - font-style: normal; - color: navy; -} -dd > *:first-child { - margin-top: 0.1em; -} - -ul, ol { - list-style-position: outside; -} -ol.arabic { - list-style-type: decimal; -} -ol.loweralpha { - list-style-type: lower-alpha; -} -ol.upperalpha { - list-style-type: upper-alpha; -} -ol.lowerroman { - list-style-type: lower-roman; -} -ol.upperroman { - list-style-type: upper-roman; -} - -div.compact ul, div.compact ol, -div.compact p, div.compact p, -div.compact div, div.compact div { - margin-top: 0.1em; - margin-bottom: 0.1em; -} - -tfoot { - font-weight: bold; -} -td > div.verse { - white-space: pre; -} - -div.hdlist { - margin-top: 0.8em; - margin-bottom: 0.8em; -} -div.hdlist tr { - padding-bottom: 15px; -} -dt.hdlist1.strong, td.hdlist1.strong { - font-weight: bold; -} -td.hdlist1 { - vertical-align: top; - font-style: normal; - padding-right: 0.8em; - color: navy; -} -td.hdlist2 { - vertical-align: top; -} -div.hdlist.compact tr { - margin: 0; - padding-bottom: 0; -} - -.comment { - background: yellow; -} - -.footnote, .footnoteref { - font-size: 0.8em; -} - -span.footnote, span.footnoteref { - vertical-align: super; -} - -#footnotes { - margin: 20px 0 20px 0; - padding: 7px 0 0 0; -} - -#footnotes div.footnote { - margin: 0 0 5px 0; -} - -#footnotes hr { - border: none; - border-top: 1px solid silver; - height: 1px; - text-align: left; - margin-left: 0; - width: 20%; - min-width: 100px; -} - -div.colist td { - padding-right: 0.5em; - padding-bottom: 0.3em; - vertical-align: top; -} -div.colist td img { - margin-top: 0.3em; -} - -@media print { - #footer-badges { display: none; } -} - -#toc { - margin-bottom: 2.5em; -} - -#toctitle { - color: #527bbd; - font-size: 1.1em; - font-weight: bold; - margin-top: 1.0em; - margin-bottom: 0.1em; -} - -div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { - margin-top: 0; - margin-bottom: 0; -} -div.toclevel2 { - margin-left: 2em; - font-size: 0.9em; -} -div.toclevel3 { - margin-left: 4em; - font-size: 0.9em; -} -div.toclevel4 { - margin-left: 6em; - font-size: 0.9em; -} - -span.aqua { color: aqua; } -span.black { color: black; } -span.blue { color: blue; } -span.fuchsia { color: fuchsia; } -span.gray { color: gray; } -span.green { color: green; } -span.lime { color: lime; } -span.maroon { color: maroon; } -span.navy { color: navy; } -span.olive { color: olive; } -span.purple { color: purple; } -span.red { color: red; } -span.silver { color: silver; } -span.teal { color: teal; } -span.white { color: white; } -span.yellow { color: yellow; } - -span.aqua-background { background: aqua; } -span.black-background { background: black; } -span.blue-background { background: blue; } -span.fuchsia-background { background: fuchsia; } -span.gray-background { background: gray; } -span.green-background { background: green; } -span.lime-background { background: lime; } -span.maroon-background { background: maroon; } -span.navy-background { background: navy; } -span.olive-background { background: olive; } -span.purple-background { background: purple; } -span.red-background { background: red; } -span.silver-background { background: silver; } -span.teal-background { background: teal; } -span.white-background { background: white; } -span.yellow-background { background: yellow; } - -span.big { font-size: 2em; } -span.small { font-size: 0.6em; } - -span.underline { text-decoration: underline; } -span.overline { text-decoration: overline; } -span.line-through { text-decoration: line-through; } - -div.unbreakable { page-break-inside: avoid; } - - -/* - * xhtml11 specific - * - * */ - -div.tableblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-weight: bold; - color: #527bbd; -} -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - - -/* - * html5 specific - * - * */ - -table.tableblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -thead, p.tableblock.header { - font-weight: bold; - color: #527bbd; -} -p.tableblock { - margin-top: 0; -} -table.tableblock { - border-width: 3px; - border-spacing: 0px; - border-style: solid; - border-color: #527bbd; - border-collapse: collapse; -} -th.tableblock, td.tableblock { - border-width: 1px; - padding: 4px; - border-style: solid; - border-color: #527bbd; -} - -table.tableblock.frame-topbot { - border-left-style: hidden; - border-right-style: hidden; -} -table.tableblock.frame-sides { - border-top-style: hidden; - border-bottom-style: hidden; -} -table.tableblock.frame-none { - border-style: hidden; -} - -th.tableblock.halign-left, td.tableblock.halign-left { - text-align: left; -} -th.tableblock.halign-center, td.tableblock.halign-center { - text-align: center; -} -th.tableblock.halign-right, td.tableblock.halign-right { - text-align: right; -} - -th.tableblock.valign-top, td.tableblock.valign-top { - vertical-align: top; -} -th.tableblock.valign-middle, td.tableblock.valign-middle { - vertical-align: middle; -} -th.tableblock.valign-bottom, td.tableblock.valign-bottom { - vertical-align: bottom; -} - - -/* - * manpage specific - * - * */ - -body.manpage h1 { - padding-top: 0.5em; - padding-bottom: 0.5em; - border-top: 2px solid silver; - border-bottom: 2px solid silver; -} -body.manpage h2 { - border-style: none; -} -body.manpage div.sectionbody { - margin-left: 3em; -} - -@media print { - body.manpage div#toc { display: none; } -} - - -</style> -<script type="text/javascript"> -/*<+'])'); - // Function that scans the DOM tree for header elements (the DOM2 - // nodeIterator API would be a better technique but not supported by all - // browsers). - var iterate = function (el) { - for (var i = el.firstChild; i != null; i = i.nextSibling) { - if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { - var mo = re.exec(i.tagName); - if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { - result[result.length] = new TocEntry(i, getText(i), mo[1]-1); - } - iterate(i); - } - } - } - iterate(el); - return result; - } - - var toc = document.getElementById("toc"); - if (!toc) { - return; - } - - // Delete existing TOC entries in case we're reloading the TOC. - var tocEntriesToRemove = []; - var i; - for (i = 0; i < toc.childNodes.length; i++) { - var entry = toc.childNodes[i]; - if (entry.nodeName.toLowerCase() == 'div' - && entry.getAttribute("class") - && entry.getAttribute("class").match(/^toclevel/)) - tocEntriesToRemove.push(entry); - } - for (i = 0; i < tocEntriesToRemove.length; i++) { - toc.removeChild(tocEntriesToRemove[i]); - } - - // Rebuild TOC entries. - var entries = tocEntries(document.getElementById("content"), toclevels); - for (var i = 0; i < entries.length; ++i) { - var entry = entries[i]; - if (entry.element.id == "") - entry.element.id = "_toc_" + i; - var a = document.createElement("a"); - a.href = "#" + entry.element.id; - a.appendChild(document.createTextNode(entry.text)); - var div = document.createElement("div"); - div.appendChild(a); - div.className = "toclevel" + entry.toclevel; - toc.appendChild(div); - } - if (entries.length == 0) - toc.parentNode.removeChild(toc); -}, - - -///////////////////////////////////////////////////////////////////// -// Footnotes generator -///////////////////////////////////////////////////////////////////// - -/* Based on footnote generation code from: - * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html - */ - -footnotes: function () { - // Delete existing footnote entries in case we're reloading the footnodes. - var i; - var noteholder = document.getElementById("footnotes"); - if (!noteholder) { - return; - } - var entriesToRemove = []; - for (i = 0; i < noteholder.childNodes.length; i++) { - var entry = noteholder.childNodes[i]; - if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") - entriesToRemove.push(entry); - } - for (i = 0; i < entriesToRemove.length; i++) { - noteholder.removeChild(entriesToRemove[i]); - } - - // Rebuild footnote entries. - var cont = document.getElementById("content"); - var spans = cont.getElementsByTagName("span"); - var refs = {}; - var n = 0; - for (i=0; i<spans.length; i++) { - if (spans[i].className == "footnote") { - n++; - var note = spans[i].getAttribute("data-note"); - if (!note) { - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; - spans[i].setAttribute("data-note", note); - } - noteholder.innerHTML += - "<div class='footnote' id='_footnote_" + n + "'>" + - "<a href='#_footnoteref_" + n + "' title='Return to text'>" + - n + "</a>. " + note + "</div>"; - var id =spans[i].getAttribute("id"); - if (id != null) refs["#"+id] = n; - } - } - if (n == 0) - noteholder.parentNode.removeChild(noteholder); - else { - // Process footnoterefs. - for (i=0; i<spans.length; i++) { - if (spans[i].className == "footnoteref") { - var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); - href = href.match(/#.*/)[0]; // Because IE return full URL. - n = refs[href]; - spans[i].innerHTML = - "[<a href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; - } - } - } -}, - -install: function(toclevels) { - var timerId; - - function reinstall() { - asciidoc.footnotes(); - if (toclevels) { - asciidoc.toc(toclevels); - } - } - - function reinstallAndRemoveTimer() { - clearInterval(timerId); - reinstall(); - } - - timerId = setInterval(reinstall, 500); - if (document.addEventListener) - document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); - else - window.onload = reinstallAndRemoveTimer; -} - -} -asciidoc.install(); -/*]]>*/ -</script> -</head> -<body class="manpage"> -<div id="header"> -<h1> -qdrouterd.conf(5) Manual Page -</h1> <h2>NAME</h2> -<div class="sectionbody"> <p>qdrouterd.conf - configuration file for the dispatch router. </p> -</div> -</div> -<div id="content"> -<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"> +<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> <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"> +</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> <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"> +</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> <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"> +</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> <pre><code>connector { role: inter-router host: 0.0.0.0 @@ -790,12 +40,11 @@ of a running router can be modified using <em>qdmanage(8)</em>.</p></div> 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"> +</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> <pre><code>sslProfile { name: my-ssl certDb: ca-certificate-1.pem @@ -809,998 +58,949 @@ listener { 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="_sslprofile">sslProfile</h3> -<div class="paragraph"><p>Attributes for setting TLS/SSL configuration for connections.</p></div> -<div class="paragraph"><p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p></div> -<div class="dlist"><dl> -<dt class="hdlist1"> -<em>certDb</em> (path) +</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) </dt> <dd> <p> - The absolute path to the database that contains the public certificates of trusted certificate authorities (CA). + name of the sslProfile </p> </dd> -<dt class="hdlist1"> -<em>certFile</em> (path) +<dt> +<b>certDb</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. + The absolute path to the database that contains the public certificates of trusted certificate authorities (CA). </p> </dd> -<dt class="hdlist1"> -<em>keyFile</em> (path) +<dt> +<b>certFile</b> (path) </dt> <dd> <p> - The absolute path to the file containing the PEM-formatted private key for the above certificate. + 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>passwordFile</em> (path) +<dt> +<b>keyFile</b> (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. + The absolute path to the file containing the PEM-formatted private key for the above certificate. </p> </dd> -<dt class="hdlist1"> -<em>password</em> (string) +<dt> +<b>passwordFile</b> (path) </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 <em>password</em> option. Don’t use both password and passwordFile in the same profile. + 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>uidFormat</em> (string) +<dt> +<b>password</b> (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). + 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. </p> </dd> -<dt class="hdlist1"> -<em>displayNameFile</em> (string) +<dt> +<b>uidFormat</b> (string) </dt> <dd> <p> - The absolute path to the file containing the unique id to dispay name mapping + 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). </p> </dd> -<dt class="hdlist1"> -<em>name</em> (string) +<dt> +<b>displayNameFile</b> (string) </dt> <dd> <p> - name of the sslProfile + The absolute path to the file containing the unique id to dispay name mapping </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) +</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> <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> +<b>workerThreads</b> (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> +<b>debugDump</b> (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> +<b>saslConfigPath</b> (path) </dt> <dd> <p> Absolute path to the SASL configuration file. </p> </dd> -<dt class="hdlist1"> -<em>saslConfigName</em> (string) +<dt> +<b>saslConfigName</b> (string) </dt> <dd> <p> - Name of the SASL configuration. This string + <em>.conf</em> is the name of the configuration file. + Name of the SASL configuration. This string + <b>.conf</b> is the name of the configuration file. </p> </dd> -</dl></div> -</div> -<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>routerId</em> (string) +</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> <dd> <p> (DEPRECATED) Router’s unique identity. This attribute has been deprecated. Use id instead </p> </dd> -<dt class="hdlist1"> -<em>id</em> (string) +<dt> +<b>id</b> (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> +<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 class="hdlist1"> -<em>helloInterval</em> (integer, default=1) +<dt> +<b>helloInterval</b> (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> +<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 class="hdlist1"> -<em>raInterval</em> (integer, default=30) +<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 class="hdlist1"> -<em>raIntervalFlux</em> (integer, default=4) +<dt> +<b>raIntervalFlux</b> (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> +<b>remoteLsMaxAge</b> (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>mobileAddrMaxAge</em> (integer, default=60) +<dt> +<b>mobileAddrMaxAge</b> (integer, default=60) </dt> <dd> <p> (DEPRECATED) This value is no longer used in the router. </p> </dd> -<dt class="hdlist1"> -<em>workerThreads</em> (integer, default=4) +<dt> +<b>workerThreads</b> (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> +<b>debugDump</b> (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> +<b>saslConfigPath</b> (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> +<b>saslConfigName</b> (string, default=<b>qdrouterd</b>) </dt> <dd> <p> - Name of the SASL configuration. This string + <em>.conf</em> is the name of the configuration file. + Name of the SASL configuration. This string + <b>.conf</b> is the name of the configuration file. </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>saslMechanisms</em> (string) +</dl> +<h3><a name="_listener"></a>listener</h3> +<p>Listens for incoming connections to the router.</p> +<dl> +<dt> +<b>name</b> (string) </dt> <dd> <p> - Space separated list of accepted SASL authentication mechanisms. + Unique name optionally assigned by user. Can be changed. </p> </dd> -<dt class="hdlist1"> -<em>authenticatePeer</em> (boolean) +<dt> +<b>host</b> (string) </dt> <dd> <p> - yes: Require the peer’s identity to be authenticated; no: Do not require any authentication. + IP address: ipv4 or ipv6 literal or a host name </p> </dd> -<dt class="hdlist1"> -<em>requireEncryption</em> (boolean) +<dt> +<b>port</b> (string) </dt> <dd> <p> - yes: Require the connection to the peer to be encrypted; no: Permit non-encrypted communication with the peer + Port number or symbolic service name. </p> </dd> -<dt class="hdlist1"> -<em>requireSsl</em> (boolean) +<dt> +<b>protocolFamily</b> (One of [<b>IPv4</b>, <b>IPv6</b>]) </dt> <dd> <p> - yes: Require the use of SSL or TLS on the connection; no: Allow clients to connect without SSL or TLS. + [<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. </p> </dd> -<dt class="hdlist1"> -<em>trustedCerts</em> (path) +<dt> +<b>role</b> (One of [<b>normal</b>, <b>inter-router</b>, <b>route-container</b>, <b>on-demand</b>]) </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. + 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>maxFrameSize</em> (integer, default=16384) +<dt> +<b>cost</b> (integer) </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. + 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. </p> </dd> -<dt class="hdlist1"> -<em>idleTimeoutSeconds</em> (integer, default=16) +<dt> +<b>sslProfile</b> (string) </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. + name of the sslProfile </p> </dd> -<dt class="hdlist1"> -<em>requirePeerAuth</em> (boolean) +<dt> +<b>saslMechanisms</b> (string) </dt> <dd> <p> - (DEPRECATED) This attribute is now controlled by the authenticatePeer attribute. + Space separated list of accepted SASL authentication mechanisms. </p> </dd> -<dt class="hdlist1"> -<em>allowUnsecured</em> (boolean) +<dt> +<b>authenticatePeer</b> (boolean) </dt> <dd> <p> - (DEPRECATED) This attribute is now controlled by the requireEncryption attribute. + yes: Require the peer’s identity to be authenticated; no: Do not require any authentication. </p> </dd> -<dt class="hdlist1"> -<em>allowNoSasl</em> (boolean) +<dt> +<b>requireEncryption</b> (boolean) </dt> <dd> <p> - (DEPRECATED) This attribute is now controlled by the authenticatePeer attribute. + yes: Require the connection to the peer to be encrypted; no: Permit non-encrypted communication with the peer </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> +<b>requireSsl</b> (boolean) </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 + 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>linkCapacity</em> (integer) +<dt> +<b>trustedCerts</b> (path) </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. + 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>name</em> (string, unique) +<dt> +<b>maxFrameSize</b> (integer, default=16384) </dt> <dd> <p> - Unique name optionally assigned by user. Can be changed. + 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 class="hdlist1"> -<em>host</em> (string) +<dt> +<b>idleTimeoutSeconds</b> (integer, default=16) </dt> <dd> <p> - IP address: ipv4 or ipv6 literal or a host name + 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>port</em> (string) +<dt> +<b>requirePeerAuth</b> (boolean) </dt> <dd> <p> - Port number or symbolic service name. + (DEPRECATED) This attribute is now controlled by the authenticatePeer attribute. </p> </dd> -<dt class="hdlist1"> -<em>protocolFamily</em> (One of [<em>IPv4</em>, <em>IPv6</em>]) +<dt> +<b>allowUnsecured</b> (boolean) </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. + (DEPRECATED) This attribute is now controlled by the requireEncryption attribute. </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>]) +<dt> +<b>allowNoSasl</b> (boolean) </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. + (DEPRECATED) This attribute is now controlled by the authenticatePeer attribute. </p> </dd> -<dt class="hdlist1"> -<em>cost</em> (integer) +<dt> +<b>stripAnnotations</b> (One of [<b>in</b>, <b>out</b>, <b>both</b>, <b>no</b>], default=<b>both</b>) </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. + [<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 </p> </dd> -<dt class="hdlist1"> -<em>sslProfile</em> (string) +<dt> +<b>linkCapacity</b> (integer) </dt> <dd> <p> - name of the sslProfile + 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> -</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>saslMechanisms</em> (string) +</dl> +<h3><a name="_connector"></a>connector</h3> +<p>Establishes an outgoing connection from the router.</p> +<dl> +<dt> +<b>name</b> (string) </dt> <dd> <p> - Space separated list of accepted SASL authentication mechanisms. + Unique name optionally assigned by user. Can be changed. </p> </dd> -<dt class="hdlist1"> -<em>allowRedirect</em> (boolean, default=True) +<dt> +<b>host</b> (string) </dt> <dd> <p> - Allow the peer to redirect this connection to another address. + IP address: ipv4 or ipv6 literal or a host name </p> </dd> -<dt class="hdlist1"> -<em>maxFrameSize</em> (integer, default=65536) +<dt> +<b>port</b> (string) </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. + Port number or symbolic service name. </p> </dd> -<dt class="hdlist1"> -<em>idleTimeoutSeconds</em> (integer, default=16) +<dt> +<b>protocolFamily</b> (One of [<b>IPv4</b>, <b>IPv6</b>]) </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. + [<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. </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> +<b>role</b> (One of [<b>normal</b>, <b>inter-router</b>, <b>route-container</b>, <b>on-demand</b>]) </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 + 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>linkCapacity</em> (integer) +<dt> +<b>cost</b> (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. + 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. </p> </dd> -<dt class="hdlist1"> -<em>verifyHostName</em> (boolean, default=True) +<dt> +<b>sslProfile</b> (string) </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 + name of the sslProfile </p> </dd> -<dt class="hdlist1"> -<em>saslUsername</em> (string) +<dt> +<b>saslMechanisms</b> (string) </dt> <dd> <p> - The user name that the connector is using to connect to a peer. + Space separated list of accepted SASL authentication mechanisms. </p> </dd> -<dt class="hdlist1"> -<em>saslPassword</em> (string) +<dt> +<b>allowRedirect</b> (boolean, default=True) </dt> <dd> <p> - The password that the connector is using to connect to a peer. + Allow the peer to redirect this connection to another address. </p> </dd> -<dt class="hdlist1"> -<em>name</em> (string, unique) +<dt> +<b>maxFrameSize</b> (integer, default=65536) </dt> <dd> <p> - Unique name optionally assigned by user. Can be changed. + 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 class="hdlist1"> -<em>host</em> (string) +<dt> +<b>idleTimeoutSeconds</b> (integer, default=16) </dt> <dd> <p> - IP address: ipv4 or ipv6 literal or a host name + 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>port</em> (string) +<dt> +<b>stripAnnotations</b> (One of [<b>in</b>, <b>out</b>, <b>both</b>, <b>no</b>], default=<b>both</b>) </dt> <dd> <p> - Port number or symbolic service name. + [<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 </p> </dd> -<dt class="hdlist1"> -<em>protocolFamily</em> (One of [<em>IPv4</em>, <em>IPv6</em>]) +<dt> +<b>linkCapacity</b> (integer) </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. + 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>role</em> (One of [<em>normal</em>, <em>inter-router</em>, <em>route-container</em>, <em>on-demand</em>]) +<dt> +<b>verifyHostName</b> (boolean, default=True) </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. + 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>cost</em> (integer) +<dt> +<b>saslUsername</b> (string) </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. + The user name that the connector is using to connect to a peer. </p> </dd> -<dt class="hdlist1"> -<em>sslProfile</em> (string) +<dt> +<b>saslPassword</b> (string) </dt> <dd> <p> - name of the sslProfile + The password that the connector is using to connect to a peer. </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>DEFAULT</em>], required) +</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> <dd> <p> - Module to configure. The special module <em>DEFAULT</em> specifies defaults for all modules. + Module to configure. The special module <b>DEFAULT</b> specifies defaults for all modules. </p> </dd> -<dt class="hdlist1"> -<em>enable</em> (string, default=<em>default</em>, required) +<dt> +<b>enable</b> (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. The value <em>default</em> means use the value from the DEFAULT module. + 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. </p> </dd> -<dt class="hdlist1"> -<em>timestamp</em> (boolean) +<dt> +<b>timestamp</b> (boolean) </dt> <dd> <p> Include timestamp in log messages. </p> </dd> -<dt class="hdlist1"> -<em>source</em> (boolean) +<dt> +<b>source</b> (boolean) </dt> <dd> <p> Include source file and line number in log messages. </p> </dd> -<dt class="hdlist1"> -<em>output</em> (string) +<dt> +<b>output</b> (string) </dt> <dd> <p> - Where to send log messages. Can be <em>stderr</em>, <em>syslog</em> or a file name. + Where to send log messages. Can be <b>stderr</b>, <b>stdout</b>, <b>syslog</b> or a file name. </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) +</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) </dt> <dd> <p> - The address prefix (always starting with <em>/</em>). + The address prefix (always starting with <b>/</b>). </p> </dd> -<dt class="hdlist1"> -<em>phase</em> (integer) +<dt> +<b>phase</b> (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> +<b>fanout</b> (One of [<b>multiple</b>, <b>single</b>], default=<b>multiple</b>) </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. + 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. </p> </dd> -<dt class="hdlist1"> -<em>bias</em> (One of [<em>closest</em>, <em>spread</em>], default=<em>closest</em>) +<dt> +<b>bias</b> (One of [<b>closest</b>, <b>spread</b>], default=<b>closest</b>) </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. + 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. </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) +</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> <dd> <p> The AMQP address of the waypoint. </p> </dd> -<dt class="hdlist1"> -<em>connector</em> (string, required) +<dt> +<b>connector</b> (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> +<b>inPhase</b> (integer, default=-1) </dt> <dd> <p> - The phase of the address as it is routed <em>to</em> the waypoint. + The phase of the address as it is routed <b>to</b> the waypoint. </p> </dd> -<dt class="hdlist1"> -<em>outPhase</em> (integer, default=-1) +<dt> +<b>outPhase</b> (integer, default=-1) </dt> <dd> <p> - The phase of the address as it is routed <em>from</em> the waypoint. + The phase of the address as it is routed <b>from</b> the waypoint. </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) +</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> <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 + 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 </p> </dd> -<dt class="hdlist1"> -<em>dir</em> (One of [<em>in</em>, <em>out</em>, <em>both</em>], default=<em>both</em>) +<dt> +<b>dir</b> (One of [<b>in</b>, <b>out</b>, <b>both</b>], default=<b>both</b>) </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. + 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. </p> </dd> -<dt class="hdlist1"> -<em>connector</em> (string) +<dt> +<b>connector</b> (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 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) +</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> <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> +<b>distribution</b> (One of [<b>multicast</b>, <b>closest</b>, <b>balanced</b>], default=<b>balanced</b>) </dt> <dd> <p> Treatment of traffic associated with the address </p> </dd> -<dt class="hdlist1"> -<em>waypoint</em> (boolean) +<dt> +<b>waypoint</b> (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> +<b>ingressPhase</b> (integer) </dt> <dd> <p> Advanced - Override the ingress phase for this address </p> </dd> -<dt class="hdlist1"> -<em>egressPhase</em> (integer) +<dt> +<b>egressPhase</b> (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) +</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> <dd> <p> The address prefix for the configured settings </p> </dd> -<dt class="hdlist1"> -<em>containerId</em> (string) +<dt> +<b>containerId</b> (string) </dt> <dd> <p> ContainerID for the target container </p> </dd> -<dt class="hdlist1"> -<em>connection</em> (string) +<dt> +<b>connection</b> (string) </dt> <dd> <p> The name from a connector or listener </p> </dd> -<dt class="hdlist1"> -<em>distribution</em> (One of [<em>linkBalanced</em>], default=<em>linkBalanced</em>) +<dt> +<b>distribution</b> (One of [<b>linkBalanced</b>], default=<b>linkBalanced</b>) </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> +<b>dir</b> (One of [<b>in</b>, <b>out</b>], required) </dt> <dd> <p> - The permitted direction of links: <em>in</em> means client senders; <em>out</em> means client receivers + The permitted direction of links: <b>in</b> means client senders; <b>out</b> 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) +</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> <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> +<b>dir</b> (One of [<b>in</b>, <b>out</b>], 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> +<b>phase</b> (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. + 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. </p> </dd> -<dt class="hdlist1"> -<em>containerId</em> (string) +<dt> +<b>containerId</b> (string) </dt> <dd> <p> ContainerID for the target container </p> </dd> -<dt class="hdlist1"> -<em>connection</em> (string) +<dt> +<b>connection</b> (string) </dt> <dd> <p> The name from a connector or listener </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) +</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> <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> +<b>wsport</b> (integer, default=5673) </dt> <dd> <p> port on which to listen for websocket traffic </p> </dd> -<dt class="hdlist1"> -<em>proxy</em> (string) +<dt> +<b>proxy</b> (string) </dt> <dd> <p> The full path to the proxy program to run. </p> </dd> -<dt class="hdlist1"> -<em>home</em> (string) +<dt> +<b>home</b> (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> +<b>args</b> (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>maximumConnections</em> (integer) +</dl> +<h3><a name="_policy"></a>policy</h3> +<p>Defines global connection limit</p> +<dl> +<dt> +<b>maximumConnections</b> (integer) </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. </p> </dd> -<dt class="hdlist1"> -<em>enableAccessRules</em> (boolean) +<dt> +<b>enableAccessRules</b> (boolean) </dt> <dd> <p> Enable user rule set processing and connection denial. </p> </dd> -<dt class="hdlist1"> -<em>policyFolder</em> (path) +<dt> +<b>policyFolder</b> (path) </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. </p> </dd> -<dt class="hdlist1"> -<em>defaultApplication</em> (string) +<dt> +<b>defaultApplication</b> (string) </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. </p> </dd> -<dt class="hdlist1"> -<em>defaultApplicationEnabled</em> (boolean) +<dt> +<b>defaultApplicationEnabled</b> (boolean) </dt> <dd> <p> Enable defaultApplication policy fallback logic. </p> </dd> -</dl></div> -</div> -<div class="sect2"> -<h3 id="_policyruleset">policyRuleset</h3> -<div class="paragraph"><p>Per application definition of the locations from which users may connect and the groups to which users belong.</p></div> -<div class="dlist"><dl> -<dt class="hdlist1"> -<em>maxConnections</em> (integer) +</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> <dd> <p> Maximum number of concurrent client connections allowed. Zero implies no limit. </p> </dd> -<dt class="hdlist1"> -<em>maxConnPerUser</em> (integer) +<dt> +<b>maxConnPerUser</b> (integer) </dt> <dd> <p> Maximum number of concurrent client connections allowed for any single user. Zero implies no limit. </p> </dd> -<dt class="hdlist1"> -<em>maxConnPerHost</em> (integer) +<dt> +<b>maxConnPerHost</b> (integer) </dt> <dd> <p> Maximum number of concurrent client connections allowed for any remote host. Zero implies no limit. </p> </dd> -<dt class="hdlist1"> -<em>userGroups</em> (map) +<dt> +<b>userGroups</b> (map) </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 <em>restricted</em>. 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. + 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. </p> </dd> -<dt class="hdlist1"> -<em>ingressHostGroups</em> (map) +<dt> +<b>ingressHostGroups</b> (map) </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 <em>*</em> represents any host address. + 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. </p> </dd> -<dt class="hdlist1"> -<em>ingressPolicies</em> (map) +<dt> +<b>ingressPolicies</b> (map) </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. </p> </dd> -<dt class="hdlist1"> -<em>connectionAllowDefault</em> (boolean) +<dt> +<b>connectionAllowDefault</b> (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. + 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. </p> </dd> -<dt class="hdlist1"> -<em>settings</em> (map) +<dt> +<b>settings</b> (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> -</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> -</div> -<div id="footnotes"><hr /></div> -<div id="footer"> -<div id="footer-text"> -Last updated 2016-06-23 12:42:34 EDT -</div> -</div> -</body> -</html> +</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>
--------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
