You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by gm...@apache.org on 2016/06/15 17:46:43 UTC
qpid-site git commit: DISPATCH-363 - Removed all annotation sections
in doc except sslProfile. Removed sslProfile attributes from connector and
listener. All changes only in qdrouter.json man doc page
Repository: qpid-site
Updated Branches:
refs/heads/asf-site d22e4fe34 -> a5b385d86
DISPATCH-363 - Removed all annotation sections in doc except sslProfile. Removed sslProfile attributes from connector and listener. All changes only in qdrouter.json man doc page
Project: http://git-wip-us.apache.org/repos/asf/qpid-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-site/commit/a5b385d8
Tree: http://git-wip-us.apache.org/repos/asf/qpid-site/tree/a5b385d8
Diff: http://git-wip-us.apache.org/repos/asf/qpid-site/diff/a5b385d8
Branch: refs/heads/asf-site
Commit: a5b385d86a111de38d1ca5217842d586015c64b4
Parents: d22e4fe
Author: Ganesh Murthy <gm...@redhat.com>
Authored: Wed Jun 15 13:46:23 2016 -0400
Committer: Ganesh Murthy <gm...@redhat.com>
Committed: Wed Jun 15 13:46:23 2016 -0400
----------------------------------------------------------------------
.../qpid-dispatch-master/book/schema.html | 34 +++---
.../releases/qpid-dispatch-master/index.html | 2 +-
.../man/qdrouterd.conf.html | 115 +++----------------
.../qpid-dispatch-master/book/schema.html.in | 34 +++---
input/releases/qpid-dispatch-master/index.md | 2 +-
.../man/qdrouterd.conf.html.in | 115 +++----------------
6 files changed, 74 insertions(+), 228 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/a5b385d8/content/releases/qpid-dispatch-master/book/schema.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-dispatch-master/book/schema.html b/content/releases/qpid-dispatch-master/book/schema.html
index 20fa905..831319a 100644
--- a/content/releases/qpid-dispatch-master/book/schema.html
+++ b/content/releases/qpid-dispatch-master/book/schema.html
@@ -228,23 +228,23 @@ be modified using the <cite>update</cite> operation, see the entity descriptions
<dt><em>cost</em> (integer, default=‘1’, <cite>CREATE</cite>)</dt>
<dd>For the ‘inter-router’ 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.</dd>
<dt><em>certDb</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
+<dd>The absolute path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
<dt><em>certFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
+<dd>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.</dd>
<dt><em>keyFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
+<dd>The absolute path to the file containing the PEM-formatted private key for the above certificate.</dd>
<dt><em>passwordFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
+<dd>If the above private key is password protected, this is the absolute path to a file containing the password that unlocks the certificate key.</dd>
<dt><em>password</em> (string, <cite>CREATE</cite>)</dt>
<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
<dt><em>uidFormat</em> (string, <cite>CREATE</cite>)</dt>
-<dd>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 ‘cou’ 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 ‘o2’ 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 comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
+<dd>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 ‘cou’ 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 ‘o2’ 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 ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate with say a web bro
wser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
<dt><em>displayNameFile</em> (string, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the unique id to dispay name mapping</dd>
+<dd>The absolute path to the file containing the unique id to dispay name mapping</dd>
<dt><em>sslProfileName</em> (string)</dt>
<dd>The name of the ssl profile. This is for internal use only. Use the ‘name’ attribute to assign a name to an sslProfile section</dd>
<dt><em>saslMechanisms</em> (string, <cite>CREATE</cite>)</dt>
-<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
+<dd>Space separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>authenticatePeer</em> (boolean, <cite>CREATE</cite>)</dt>
<dd>yes: Require the peer’s identity to be authenticated; no: Do not require any authentication.</dd>
<dt><em>requireEncryption</em> (boolean, <cite>CREATE</cite>)</dt>
@@ -252,7 +252,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions
<dt><em>requireSsl</em> (boolean, <cite>CREATE</cite>)</dt>
<dd>yes: Require the use of SSL or TLS on the connection; no: Allow clients to connect without SSL or TLS.</dd>
<dt><em>trustedCerts</em> (path, <cite>CREATE</cite>)</dt>
-<dd>This optional setting can be used to reduce the set of available CAs for client authentication. If used, this setting must provide a path to a PEM file that contains the trusted certificates.</dd>
+<dd>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.</dd>
<dt><em>maxFrameSize</em> (integer, default=16384, <cite>CREATE</cite>)</dt>
<dd>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.</dd>
<dt><em>idleTimeoutSeconds</em> (integer, default=16, <cite>CREATE</cite>)</dt>
@@ -287,23 +287,23 @@ be modified using the <cite>update</cite> operation, see the entity descriptions
<dt><em>cost</em> (integer, default=‘1’, <cite>CREATE</cite>)</dt>
<dd>For the ‘inter-router’ 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.</dd>
<dt><em>certDb</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
+<dd>The absolute path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
<dt><em>certFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
+<dd>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.</dd>
<dt><em>keyFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
+<dd>The absolute path to the file containing the PEM-formatted private key for the above certificate.</dd>
<dt><em>passwordFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
+<dd>If the above private key is password protected, this is the absolute path to a file containing the password that unlocks the certificate key.</dd>
<dt><em>password</em> (string, <cite>CREATE</cite>)</dt>
<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
<dt><em>uidFormat</em> (string, <cite>CREATE</cite>)</dt>
-<dd>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 ‘cou’ 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 ‘o2’ 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 comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
+<dd>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 ‘cou’ 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 ‘o2’ 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 ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate with say a web bro
wser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
<dt><em>displayNameFile</em> (string, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the unique id to dispay name mapping</dd>
+<dd>The absolute path to the file containing the unique id to dispay name mapping</dd>
<dt><em>sslProfileName</em> (string)</dt>
<dd>The name of the ssl profile. This is for internal use only. Use the ‘name’ attribute to assign a name to an sslProfile section</dd>
<dt><em>saslMechanisms</em> (string, <cite>CREATE</cite>)</dt>
-<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
+<dd>Space separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>allowRedirect</em> (boolean, default=True, <cite>CREATE</cite>)</dt>
<dd>Allow the peer to redirect this connection to another address.</dd>
<dt><em>maxFrameSize</em> (integer, default=65536, <cite>CREATE</cite>)</dt>
@@ -327,7 +327,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions
<p>Configure logging for a particular module. You can use the <cite>UPDATE</cite> operation to change log settings while the router is running.</p>
<p>Operations allowed: <cite>UPDATE</cite>, <cite>READ</cite></p>
<dl class="docutils">
-<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required, <cite>UPDATE</cite>)</dt>
+<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘ERROR’, ‘POLICY’, ‘DEFAULT’], required, <cite>UPDATE</cite>)</dt>
<dd>Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.</dd>
<dt><em>enable</em> (string, default=’default’, required, <cite>UPDATE</cite>)</dt>
<dd>Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.</dd>
@@ -468,7 +468,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions
<dt><em>enableAccessRules</em> (boolean, <cite>CREATE</cite>)</dt>
<dd>Enable user rule set processing and connection denial.</dd>
<dt><em>policyFolder</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The 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.</dd>
+<dd>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.</dd>
<dt><em>defaultApplication</em> (string, <cite>CREATE</cite>)</dt>
<dd>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.</dd>
<dt><em>defaultApplicationEnabled</em> (boolean, <cite>CREATE</cite>)</dt>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/a5b385d8/content/releases/qpid-dispatch-master/index.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-dispatch-master/index.html b/content/releases/qpid-dispatch-master/index.html
index bc5e96e..7cb668e 100644
--- a/content/releases/qpid-dispatch-master/index.html
+++ b/content/releases/qpid-dispatch-master/index.html
@@ -124,7 +124,7 @@ https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/>
incomplete. For a smoother experience, see the <a href="/releases/qpid-dispatch-0.6.0/index.html">current stable
release</a>.</p>
-<p>This content was generated at 10:40 on Wednesday, 08 June 2016.</p>
+<p>This content was generated at 13:37 on Wednesday, 15 June 2016.</p>
</div>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/a5b385d8/content/releases/qpid-dispatch-master/man/qdrouterd.conf.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-dispatch-master/man/qdrouterd.conf.html b/content/releases/qpid-dispatch-master/man/qdrouterd.conf.html
index 687f555..500b484 100644
--- a/content/releases/qpid-dispatch-master/man/qdrouterd.conf.html
+++ b/content/releases/qpid-dispatch-master/man/qdrouterd.conf.html
@@ -157,58 +157,31 @@ listener {
</pre></div>
</div>
</div>
-<div class="section" id="annotation-sections">
-<h2>Annotation Sections<a class="headerlink" href="#annotation-sections" title="Permalink to this headline">.</a></h2>
-<div class="section" id="addrport">
-<h3>addrPort<a class="headerlink" href="#addrport" title="Permalink to this headline">.</a></h3>
-<p>Attributes for internet address and port.</p>
-<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p>
-<dl class="docutils">
-<dt><em>addr</em> (string, default=‘127.0.0.1’)</dt>
-<dd>(DEPRECATED)IP address: ipv4 or ipv6 literal or a host name. This attribute has been deprecated. Use host instead</dd>
-<dt><em>host</em> (string, default=‘127.0.0.1’)</dt>
-<dd>IP address: ipv4 or ipv6 literal or a host name</dd>
-<dt><em>port</em> (string, default=’amqp’)</dt>
-<dd>Port number or symbolic service name.</dd>
-<dt><em>protocolFamily</em> (One of [‘IPv4’, ‘IPv6’])</dt>
-<dd>[‘IPv4’, ‘IPv6’] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address.</dd>
-</dl>
-</div>
-<div class="section" id="connectionrole">
-<h3>connectionRole<a class="headerlink" href="#connectionrole" title="Permalink to this headline">.</a></h3>
-<p>Attribute for the role of a connection.</p>
-<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p>
-<dl class="docutils">
-<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘route-container’, ‘on-demand’], default=’normal’)</dt>
-<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections. route-container role can be used for router-container connections, for example, a router-broker connection. on-demand role has been deprecated.</dd>
-<dt><em>cost</em> (integer, default=‘1’)</dt>
-<dd>For the ‘inter-router’ 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.</dd>
-</dl>
-</div>
+<div class="section" id="configuration-sections">
+<h2>Configuration Sections<a class="headerlink" href="#configuration-sections" title="Permalink to this headline">.</a></h2>
<div class="section" id="sslprofile">
<h3>sslProfile<a class="headerlink" href="#sslprofile" title="Permalink to this headline">.</a></h3>
<p>Attributes for setting TLS/SSL configuration for connections.</p>
<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p>
<dl class="docutils">
<dt><em>certDb</em> (path)</dt>
-<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
+<dd>The absolute path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
<dt><em>certFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
+<dd>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.</dd>
<dt><em>keyFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
+<dd>The absolute path to the file containing the PEM-formatted private key for the above certificate.</dd>
<dt><em>passwordFile</em> (path)</dt>
-<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
+<dd>If the above private key is password protected, this is the absolute path to a file containing the password that unlocks the certificate key.</dd>
<dt><em>password</em> (string)</dt>
<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
<dt><em>uidFormat</em> (string)</dt>
-<dd>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 ‘cou’ 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 ‘o2’ 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 comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
+<dd>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 ‘cou’ 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 ‘o2’ 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 ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate with say a web bro
wser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
<dt><em>displayNameFile</em> (string)</dt>
-<dd>The path to the file containing the unique id to dispay name mapping</dd>
+<dd>The absolute path to the file containing the unique id to dispay name mapping</dd>
+<dt><em>name</em> (string)</dt>
+<dd>name of the sslProfile</dd>
</dl>
</div>
-</div>
-<div class="section" id="configuration-sections">
-<h2>Configuration Sections<a class="headerlink" href="#configuration-sections" title="Permalink to this headline">.</a></h2>
<div class="section" id="container">
<h3>container<a class="headerlink" href="#container" title="Permalink to this headline">.</a></h3>
<p>(DEPRECATED)Attributes related to the AMQP container. This entity has been deprecated. Use the router entity instead.</p>
@@ -260,36 +233,9 @@ listener {
<div class="section" id="listener">
<h3>listener<a class="headerlink" href="#listener" title="Permalink to this headline">.</a></h3>
<p>Listens for incoming connections to the router.</p>
-<p>Annotations: <strong>addrPort</strong>, <strong>connectionRole</strong>, <strong>sslProfile</strong>.</p>
<dl class="docutils">
-<dt><em>addr</em> (string, default=‘127.0.0.1’)</dt>
-<dd>(DEPRECATED)IP address: ipv4 or ipv6 literal or a host name. This attribute has been deprecated. Use host instead</dd>
-<dt><em>host</em> (string, default=‘127.0.0.1’)</dt>
-<dd>IP address: ipv4 or ipv6 literal or a host name</dd>
-<dt><em>port</em> (string, default=’amqp’)</dt>
-<dd>Port number or symbolic service name.</dd>
-<dt><em>protocolFamily</em> (One of [‘IPv4’, ‘IPv6’])</dt>
-<dd>[‘IPv4’, ‘IPv6’] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address.</dd>
-<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘route-container’, ‘on-demand’], default=’normal’)</dt>
-<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections. route-container role can be used for router-container connections, for example, a router-broker connection. on-demand role has been deprecated.</dd>
-<dt><em>cost</em> (integer, default=‘1’)</dt>
-<dd>For the ‘inter-router’ 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.</dd>
-<dt><em>certDb</em> (path)</dt>
-<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
-<dt><em>certFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
-<dt><em>keyFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
-<dt><em>passwordFile</em> (path)</dt>
-<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
-<dt><em>password</em> (string)</dt>
-<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
-<dt><em>uidFormat</em> (string)</dt>
-<dd>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 ‘cou’ 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 ‘o2’ 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 comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
-<dt><em>displayNameFile</em> (string)</dt>
-<dd>The path to the file containing the unique id to dispay name mapping</dd>
<dt><em>saslMechanisms</em> (string)</dt>
-<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
+<dd>Space separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>authenticatePeer</em> (boolean)</dt>
<dd>yes: Require the peer’s identity to be authenticated; no: Do not require any authentication.</dd>
<dt><em>requireEncryption</em> (boolean)</dt>
@@ -297,7 +243,7 @@ listener {
<dt><em>requireSsl</em> (boolean)</dt>
<dd>yes: Require the use of SSL or TLS on the connection; no: Allow clients to connect without SSL or TLS.</dd>
<dt><em>trustedCerts</em> (path)</dt>
-<dd>This optional setting can be used to reduce the set of available CAs for client authentication. If used, this setting must provide a path to a PEM file that contains the trusted certificates.</dd>
+<dd>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.</dd>
<dt><em>maxFrameSize</em> (integer, default=16384)</dt>
<dd>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.</dd>
<dt><em>idleTimeoutSeconds</em> (integer, default=16)</dt>
@@ -312,41 +258,16 @@ listener {
<dd>[‘in’, ‘out’, ‘both’, ‘no’] 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</dd>
<dt><em>linkCapacity</em> (integer)</dt>
<dd>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.</dd>
+<dt><em>sslProfile</em> (string)</dt>
+<dd>name of the sslProfile</dd>
</dl>
</div>
<div class="section" id="connector">
<h3>connector<a class="headerlink" href="#connector" title="Permalink to this headline">.</a></h3>
<p>Establishes an outgoing connection from the router.</p>
-<p>Annotations: <strong>addrPort</strong>, <strong>connectionRole</strong>, <strong>sslProfile</strong>.</p>
<dl class="docutils">
-<dt><em>addr</em> (string, default=‘127.0.0.1’)</dt>
-<dd>(DEPRECATED)IP address: ipv4 or ipv6 literal or a host name. This attribute has been deprecated. Use host instead</dd>
-<dt><em>host</em> (string, default=‘127.0.0.1’)</dt>
-<dd>IP address: ipv4 or ipv6 literal or a host name</dd>
-<dt><em>port</em> (string, default=’amqp’)</dt>
-<dd>Port number or symbolic service name.</dd>
-<dt><em>protocolFamily</em> (One of [‘IPv4’, ‘IPv6’])</dt>
-<dd>[‘IPv4’, ‘IPv6’] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address.</dd>
-<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘route-container’, ‘on-demand’], default=’normal’)</dt>
-<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections. route-container role can be used for router-container connections, for example, a router-broker connection. on-demand role has been deprecated.</dd>
-<dt><em>cost</em> (integer, default=‘1’)</dt>
-<dd>For the ‘inter-router’ 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.</dd>
-<dt><em>certDb</em> (path)</dt>
-<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
-<dt><em>certFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
-<dt><em>keyFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
-<dt><em>passwordFile</em> (path)</dt>
-<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
-<dt><em>password</em> (string)</dt>
-<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
-<dt><em>uidFormat</em> (string)</dt>
-<dd>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 ‘cou’ 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 ‘o2’ 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 comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
-<dt><em>displayNameFile</em> (string)</dt>
-<dd>The path to the file containing the unique id to dispay name mapping</dd>
<dt><em>saslMechanisms</em> (string)</dt>
-<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
+<dd>Space separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>allowRedirect</em> (boolean, default=True)</dt>
<dd>Allow the peer to redirect this connection to another address.</dd>
<dt><em>maxFrameSize</em> (integer, default=65536)</dt>
@@ -363,13 +284,15 @@ listener {
<dd>The user name that the connector is using to connect to a peer.</dd>
<dt><em>saslPassword</em> (string)</dt>
<dd>The password that the connector is using to connect to a peer.</dd>
+<dt><em>sslProfile</em> (string)</dt>
+<dd>name of the sslProfile</dd>
</dl>
</div>
<div class="section" id="log">
<h3>log<a class="headerlink" href="#log" title="Permalink to this headline">.</a></h3>
<p>Configure logging for a particular module. You can use the <cite>UPDATE</cite> operation to change log settings while the router is running.</p>
<dl class="docutils">
-<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required)</dt>
+<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘ERROR’, ‘POLICY’, ‘DEFAULT’], required)</dt>
<dd>Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.</dd>
<dt><em>enable</em> (string, default=’default’, required)</dt>
<dd>Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.</dd>
@@ -482,7 +405,7 @@ listener {
<dt><em>enableAccessRules</em> (boolean)</dt>
<dd>Enable user rule set processing and connection denial.</dd>
<dt><em>policyFolder</em> (path)</dt>
-<dd>The 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.</dd>
+<dd>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.</dd>
<dt><em>defaultApplication</em> (string)</dt>
<dd>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.</dd>
<dt><em>defaultApplicationEnabled</em> (boolean)</dt>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/a5b385d8/input/releases/qpid-dispatch-master/book/schema.html.in
----------------------------------------------------------------------
diff --git a/input/releases/qpid-dispatch-master/book/schema.html.in b/input/releases/qpid-dispatch-master/book/schema.html.in
index 4d26bd8..3e38874 100644
--- a/input/releases/qpid-dispatch-master/book/schema.html.in
+++ b/input/releases/qpid-dispatch-master/book/schema.html.in
@@ -112,23 +112,23 @@ be modified using the <cite>update</cite> operation, see the entity descriptions
<dt><em>cost</em> (integer, default=‘1’, <cite>CREATE</cite>)</dt>
<dd>For the ‘inter-router’ 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.</dd>
<dt><em>certDb</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
+<dd>The absolute path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
<dt><em>certFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
+<dd>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.</dd>
<dt><em>keyFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
+<dd>The absolute path to the file containing the PEM-formatted private key for the above certificate.</dd>
<dt><em>passwordFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
+<dd>If the above private key is password protected, this is the absolute path to a file containing the password that unlocks the certificate key.</dd>
<dt><em>password</em> (string, <cite>CREATE</cite>)</dt>
<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
<dt><em>uidFormat</em> (string, <cite>CREATE</cite>)</dt>
-<dd>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 ‘cou’ 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 ‘o2’ 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 comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
+<dd>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 ‘cou’ 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 ‘o2’ 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 ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate with say a web bro
wser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
<dt><em>displayNameFile</em> (string, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the unique id to dispay name mapping</dd>
+<dd>The absolute path to the file containing the unique id to dispay name mapping</dd>
<dt><em>sslProfileName</em> (string)</dt>
<dd>The name of the ssl profile. This is for internal use only. Use the ‘name’ attribute to assign a name to an sslProfile section</dd>
<dt><em>saslMechanisms</em> (string, <cite>CREATE</cite>)</dt>
-<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
+<dd>Space separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>authenticatePeer</em> (boolean, <cite>CREATE</cite>)</dt>
<dd>yes: Require the peer’s identity to be authenticated; no: Do not require any authentication.</dd>
<dt><em>requireEncryption</em> (boolean, <cite>CREATE</cite>)</dt>
@@ -136,7 +136,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions
<dt><em>requireSsl</em> (boolean, <cite>CREATE</cite>)</dt>
<dd>yes: Require the use of SSL or TLS on the connection; no: Allow clients to connect without SSL or TLS.</dd>
<dt><em>trustedCerts</em> (path, <cite>CREATE</cite>)</dt>
-<dd>This optional setting can be used to reduce the set of available CAs for client authentication. If used, this setting must provide a path to a PEM file that contains the trusted certificates.</dd>
+<dd>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.</dd>
<dt><em>maxFrameSize</em> (integer, default=16384, <cite>CREATE</cite>)</dt>
<dd>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.</dd>
<dt><em>idleTimeoutSeconds</em> (integer, default=16, <cite>CREATE</cite>)</dt>
@@ -171,23 +171,23 @@ be modified using the <cite>update</cite> operation, see the entity descriptions
<dt><em>cost</em> (integer, default=‘1’, <cite>CREATE</cite>)</dt>
<dd>For the ‘inter-router’ 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.</dd>
<dt><em>certDb</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
+<dd>The absolute path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
<dt><em>certFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
+<dd>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.</dd>
<dt><em>keyFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
+<dd>The absolute path to the file containing the PEM-formatted private key for the above certificate.</dd>
<dt><em>passwordFile</em> (path, <cite>CREATE</cite>)</dt>
-<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
+<dd>If the above private key is password protected, this is the absolute path to a file containing the password that unlocks the certificate key.</dd>
<dt><em>password</em> (string, <cite>CREATE</cite>)</dt>
<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
<dt><em>uidFormat</em> (string, <cite>CREATE</cite>)</dt>
-<dd>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 ‘cou’ 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 ‘o2’ 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 comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
+<dd>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 ‘cou’ 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 ‘o2’ 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 ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate with say a web bro
wser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
<dt><em>displayNameFile</em> (string, <cite>CREATE</cite>)</dt>
-<dd>The path to the file containing the unique id to dispay name mapping</dd>
+<dd>The absolute path to the file containing the unique id to dispay name mapping</dd>
<dt><em>sslProfileName</em> (string)</dt>
<dd>The name of the ssl profile. This is for internal use only. Use the ‘name’ attribute to assign a name to an sslProfile section</dd>
<dt><em>saslMechanisms</em> (string, <cite>CREATE</cite>)</dt>
-<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
+<dd>Space separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>allowRedirect</em> (boolean, default=True, <cite>CREATE</cite>)</dt>
<dd>Allow the peer to redirect this connection to another address.</dd>
<dt><em>maxFrameSize</em> (integer, default=65536, <cite>CREATE</cite>)</dt>
@@ -211,7 +211,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions
<p>Configure logging for a particular module. You can use the <cite>UPDATE</cite> operation to change log settings while the router is running.</p>
<p>Operations allowed: <cite>UPDATE</cite>, <cite>READ</cite></p>
<dl class="docutils">
-<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required, <cite>UPDATE</cite>)</dt>
+<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘ERROR’, ‘POLICY’, ‘DEFAULT’], required, <cite>UPDATE</cite>)</dt>
<dd>Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.</dd>
<dt><em>enable</em> (string, default=’default’, required, <cite>UPDATE</cite>)</dt>
<dd>Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.</dd>
@@ -352,7 +352,7 @@ be modified using the <cite>update</cite> operation, see the entity descriptions
<dt><em>enableAccessRules</em> (boolean, <cite>CREATE</cite>)</dt>
<dd>Enable user rule set processing and connection denial.</dd>
<dt><em>policyFolder</em> (path, <cite>CREATE</cite>)</dt>
-<dd>The 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.</dd>
+<dd>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.</dd>
<dt><em>defaultApplication</em> (string, <cite>CREATE</cite>)</dt>
<dd>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.</dd>
<dt><em>defaultApplicationEnabled</em> (boolean, <cite>CREATE</cite>)</dt>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/a5b385d8/input/releases/qpid-dispatch-master/index.md
----------------------------------------------------------------------
diff --git a/input/releases/qpid-dispatch-master/index.md b/input/releases/qpid-dispatch-master/index.md
index c8322bb..233f2e7 100644
--- a/input/releases/qpid-dispatch-master/index.md
+++ b/input/releases/qpid-dispatch-master/index.md
@@ -27,7 +27,7 @@ Code and documentation found here may be unstable, incorrect, or
incomplete. For a smoother experience, see the [current stable
release]({{current_dispatch_release_url}}/index.html).
-This content was generated at 10:40 on Wednesday, 08 June 2016.
+This content was generated at 13:37 on Wednesday, 15 June 2016.
</div>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/a5b385d8/input/releases/qpid-dispatch-master/man/qdrouterd.conf.html.in
----------------------------------------------------------------------
diff --git a/input/releases/qpid-dispatch-master/man/qdrouterd.conf.html.in b/input/releases/qpid-dispatch-master/man/qdrouterd.conf.html.in
index 0021070..9632d1a 100644
--- a/input/releases/qpid-dispatch-master/man/qdrouterd.conf.html.in
+++ b/input/releases/qpid-dispatch-master/man/qdrouterd.conf.html.in
@@ -41,58 +41,31 @@ listener {
</pre></div>
</div>
</div>
-<div class="section" id="annotation-sections">
-<h2>Annotation Sections<a class="headerlink" href="#annotation-sections" title="Permalink to this headline">.</a></h2>
-<div class="section" id="addrport">
-<h3>addrPort<a class="headerlink" href="#addrport" title="Permalink to this headline">.</a></h3>
-<p>Attributes for internet address and port.</p>
-<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p>
-<dl class="docutils">
-<dt><em>addr</em> (string, default=‘127.0.0.1’)</dt>
-<dd>(DEPRECATED)IP address: ipv4 or ipv6 literal or a host name. This attribute has been deprecated. Use host instead</dd>
-<dt><em>host</em> (string, default=‘127.0.0.1’)</dt>
-<dd>IP address: ipv4 or ipv6 literal or a host name</dd>
-<dt><em>port</em> (string, default=’amqp’)</dt>
-<dd>Port number or symbolic service name.</dd>
-<dt><em>protocolFamily</em> (One of [‘IPv4’, ‘IPv6’])</dt>
-<dd>[‘IPv4’, ‘IPv6’] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address.</dd>
-</dl>
-</div>
-<div class="section" id="connectionrole">
-<h3>connectionRole<a class="headerlink" href="#connectionrole" title="Permalink to this headline">.</a></h3>
-<p>Attribute for the role of a connection.</p>
-<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p>
-<dl class="docutils">
-<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘route-container’, ‘on-demand’], default=’normal’)</dt>
-<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections. route-container role can be used for router-container connections, for example, a router-broker connection. on-demand role has been deprecated.</dd>
-<dt><em>cost</em> (integer, default=‘1’)</dt>
-<dd>For the ‘inter-router’ 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.</dd>
-</dl>
-</div>
+<div class="section" id="configuration-sections">
+<h2>Configuration Sections<a class="headerlink" href="#configuration-sections" title="Permalink to this headline">.</a></h2>
<div class="section" id="sslprofile">
<h3>sslProfile<a class="headerlink" href="#sslprofile" title="Permalink to this headline">.</a></h3>
<p>Attributes for setting TLS/SSL configuration for connections.</p>
<p>Used by: <strong>listener</strong>, <strong>connector</strong>.</p>
<dl class="docutils">
<dt><em>certDb</em> (path)</dt>
-<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
+<dd>The absolute path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
<dt><em>certFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
+<dd>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.</dd>
<dt><em>keyFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
+<dd>The absolute path to the file containing the PEM-formatted private key for the above certificate.</dd>
<dt><em>passwordFile</em> (path)</dt>
-<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
+<dd>If the above private key is password protected, this is the absolute path to a file containing the password that unlocks the certificate key.</dd>
<dt><em>password</em> (string)</dt>
<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
<dt><em>uidFormat</em> (string)</dt>
-<dd>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 ‘cou’ 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 ‘o2’ 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 comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
+<dd>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 ‘cou’ 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 ‘o2’ 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 ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate with say a web bro
wser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
<dt><em>displayNameFile</em> (string)</dt>
-<dd>The path to the file containing the unique id to dispay name mapping</dd>
+<dd>The absolute path to the file containing the unique id to dispay name mapping</dd>
+<dt><em>name</em> (string)</dt>
+<dd>name of the sslProfile</dd>
</dl>
</div>
-</div>
-<div class="section" id="configuration-sections">
-<h2>Configuration Sections<a class="headerlink" href="#configuration-sections" title="Permalink to this headline">.</a></h2>
<div class="section" id="container">
<h3>container<a class="headerlink" href="#container" title="Permalink to this headline">.</a></h3>
<p>(DEPRECATED)Attributes related to the AMQP container. This entity has been deprecated. Use the router entity instead.</p>
@@ -144,36 +117,9 @@ listener {
<div class="section" id="listener">
<h3>listener<a class="headerlink" href="#listener" title="Permalink to this headline">.</a></h3>
<p>Listens for incoming connections to the router.</p>
-<p>Annotations: <strong>addrPort</strong>, <strong>connectionRole</strong>, <strong>sslProfile</strong>.</p>
<dl class="docutils">
-<dt><em>addr</em> (string, default=‘127.0.0.1’)</dt>
-<dd>(DEPRECATED)IP address: ipv4 or ipv6 literal or a host name. This attribute has been deprecated. Use host instead</dd>
-<dt><em>host</em> (string, default=‘127.0.0.1’)</dt>
-<dd>IP address: ipv4 or ipv6 literal or a host name</dd>
-<dt><em>port</em> (string, default=’amqp’)</dt>
-<dd>Port number or symbolic service name.</dd>
-<dt><em>protocolFamily</em> (One of [‘IPv4’, ‘IPv6’])</dt>
-<dd>[‘IPv4’, ‘IPv6’] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address.</dd>
-<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘route-container’, ‘on-demand’], default=’normal’)</dt>
-<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections. route-container role can be used for router-container connections, for example, a router-broker connection. on-demand role has been deprecated.</dd>
-<dt><em>cost</em> (integer, default=‘1’)</dt>
-<dd>For the ‘inter-router’ 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.</dd>
-<dt><em>certDb</em> (path)</dt>
-<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
-<dt><em>certFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
-<dt><em>keyFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
-<dt><em>passwordFile</em> (path)</dt>
-<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
-<dt><em>password</em> (string)</dt>
-<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
-<dt><em>uidFormat</em> (string)</dt>
-<dd>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 ‘cou’ 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 ‘o2’ 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 comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
-<dt><em>displayNameFile</em> (string)</dt>
-<dd>The path to the file containing the unique id to dispay name mapping</dd>
<dt><em>saslMechanisms</em> (string)</dt>
-<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
+<dd>Space separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>authenticatePeer</em> (boolean)</dt>
<dd>yes: Require the peer’s identity to be authenticated; no: Do not require any authentication.</dd>
<dt><em>requireEncryption</em> (boolean)</dt>
@@ -181,7 +127,7 @@ listener {
<dt><em>requireSsl</em> (boolean)</dt>
<dd>yes: Require the use of SSL or TLS on the connection; no: Allow clients to connect without SSL or TLS.</dd>
<dt><em>trustedCerts</em> (path)</dt>
-<dd>This optional setting can be used to reduce the set of available CAs for client authentication. If used, this setting must provide a path to a PEM file that contains the trusted certificates.</dd>
+<dd>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.</dd>
<dt><em>maxFrameSize</em> (integer, default=16384)</dt>
<dd>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.</dd>
<dt><em>idleTimeoutSeconds</em> (integer, default=16)</dt>
@@ -196,41 +142,16 @@ listener {
<dd>[‘in’, ‘out’, ‘both’, ‘no’] 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</dd>
<dt><em>linkCapacity</em> (integer)</dt>
<dd>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.</dd>
+<dt><em>sslProfile</em> (string)</dt>
+<dd>name of the sslProfile</dd>
</dl>
</div>
<div class="section" id="connector">
<h3>connector<a class="headerlink" href="#connector" title="Permalink to this headline">.</a></h3>
<p>Establishes an outgoing connection from the router.</p>
-<p>Annotations: <strong>addrPort</strong>, <strong>connectionRole</strong>, <strong>sslProfile</strong>.</p>
<dl class="docutils">
-<dt><em>addr</em> (string, default=‘127.0.0.1’)</dt>
-<dd>(DEPRECATED)IP address: ipv4 or ipv6 literal or a host name. This attribute has been deprecated. Use host instead</dd>
-<dt><em>host</em> (string, default=‘127.0.0.1’)</dt>
-<dd>IP address: ipv4 or ipv6 literal or a host name</dd>
-<dt><em>port</em> (string, default=’amqp’)</dt>
-<dd>Port number or symbolic service name.</dd>
-<dt><em>protocolFamily</em> (One of [‘IPv4’, ‘IPv6’])</dt>
-<dd>[‘IPv4’, ‘IPv6’] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address.</dd>
-<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘route-container’, ‘on-demand’], default=’normal’)</dt>
-<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections. route-container role can be used for router-container connections, for example, a router-broker connection. on-demand role has been deprecated.</dd>
-<dt><em>cost</em> (integer, default=‘1’)</dt>
-<dd>For the ‘inter-router’ 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.</dd>
-<dt><em>certDb</em> (path)</dt>
-<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
-<dt><em>certFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
-<dt><em>keyFile</em> (path)</dt>
-<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
-<dt><em>passwordFile</em> (path)</dt>
-<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
-<dt><em>password</em> (string)</dt>
-<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
-<dt><em>uidFormat</em> (string)</dt>
-<dd>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 ‘cou’ 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 ‘o2’ 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 comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
-<dt><em>displayNameFile</em> (string)</dt>
-<dd>The path to the file containing the unique id to dispay name mapping</dd>
<dt><em>saslMechanisms</em> (string)</dt>
-<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
+<dd>Space separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>allowRedirect</em> (boolean, default=True)</dt>
<dd>Allow the peer to redirect this connection to another address.</dd>
<dt><em>maxFrameSize</em> (integer, default=65536)</dt>
@@ -247,13 +168,15 @@ listener {
<dd>The user name that the connector is using to connect to a peer.</dd>
<dt><em>saslPassword</em> (string)</dt>
<dd>The password that the connector is using to connect to a peer.</dd>
+<dt><em>sslProfile</em> (string)</dt>
+<dd>name of the sslProfile</dd>
</dl>
</div>
<div class="section" id="log">
<h3>log<a class="headerlink" href="#log" title="Permalink to this headline">.</a></h3>
<p>Configure logging for a particular module. You can use the <cite>UPDATE</cite> operation to change log settings while the router is running.</p>
<dl class="docutils">
-<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required)</dt>
+<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘ERROR’, ‘POLICY’, ‘DEFAULT’], required)</dt>
<dd>Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.</dd>
<dt><em>enable</em> (string, default=’default’, required)</dt>
<dd>Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.</dd>
@@ -366,7 +289,7 @@ listener {
<dt><em>enableAccessRules</em> (boolean)</dt>
<dd>Enable user rule set processing and connection denial.</dd>
<dt><em>policyFolder</em> (path)</dt>
-<dd>The 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.</dd>
+<dd>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.</dd>
<dt><em>defaultApplication</em> (string)</dt>
<dd>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.</dd>
<dt><em>defaultApplicationEnabled</em> (boolean)</dt>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org