You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by tr...@apache.org on 2016/04/05 19:01:11 UTC
svn commit: r1737854 [2/4] - in /qpid/site:
docs/releases/qpid-dispatch-master/ docs/releases/qpid-dispatch-master/book/
docs/releases/qpid-dispatch-master/man/ input/releases/qpid-dispatch-master/
input/releases/qpid-dispatch-master/book/ input/releas...
Modified: qpid/site/docs/releases/qpid-dispatch-master/book/schema.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-master/book/schema.html?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-dispatch-master/book/schema.html (original)
+++ qpid/site/docs/releases/qpid-dispatch-master/book/schema.html Tue Apr 5 17:01:10 2016
@@ -115,6 +115,7 @@ https://github.com/apache/qpid-proton/bl
<div id="-middle-content">
+
<div class="section" id="management-schema">
<h1>3.4. Management Schema<a class="headerlink" href="#management-schema" title="Permalink to this headline">.</a></h1>
@@ -176,8 +177,8 @@ be modified using the <cite>update</cite
<dl class="docutils">
<dt><em>routerId</em> (string, <cite>CREATE</cite>)</dt>
<dd>Router’s unique identity.</dd>
-<dt><em>mode</em> (One of [‘standalone’, ‘interior’, ‘edge’, ‘endpoint’], default=’standalone’, <cite>CREATE</cite>)</dt>
-<dd>In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not cooperate with other routers. In interior mode, the router operates in cooperation with other interior routers in an interconnected network. In edge mode, the router operates with an up link into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.</dd>
+<dt><em>mode</em> (One of [‘standalone’, ‘interior’], default=’standalone’, <cite>CREATE</cite>)</dt>
+<dd>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.</dd>
<dt><em>area</em> (string)</dt>
<dd>Unused placeholder.</dd>
<dt><em>helloInterval</em> (integer, default=1, <cite>CREATE</cite>)</dt>
@@ -191,7 +192,7 @@ be modified using the <cite>update</cite
<dt><em>remoteLsMaxAge</em> (integer, default=60, <cite>CREATE</cite>)</dt>
<dd>Time in seconds after which link state is declared stale if no RA is received.</dd>
<dt><em>mobileAddrMaxAge</em> (integer, default=60, <cite>CREATE</cite>)</dt>
-<dd>Deprecated - This value is no longer used in the router.</dd>
+<dd>(DEPRECATED) This value is no longer used in the router.</dd>
<dt><em>addrCount</em> (integer)</dt>
<dd>Number of addresses known to the router.</dd>
<dt><em>linkCount</em> (integer)</dt>
@@ -203,13 +204,15 @@ be modified using the <cite>update</cite
<div class="section" id="listener">
<h3>3.4.1.3. listener<a class="headerlink" href="#listener" title="Permalink to this headline">.</a></h3>
<p>Listens for incoming connections to the router.</p>
-<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
<dl class="docutils">
<dt><em>addr</em> (string, default=‘127.0.0.1’, <cite>CREATE</cite>)</dt>
<dd>IP address: ipv4 or ipv6 literal or a host name.</dd>
<dt><em>port</em> (string, default=’amqp’, <cite>CREATE</cite>)</dt>
<dd>Port number or symbolic service name.</dd>
-<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’, <cite>CREATE</cite>)</dt>
+<dt><em>protocolFamily</em> (One of [‘IPv4’, ‘IPv6’], <cite>CREATE</cite>)</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’, <cite>CREATE</cite>)</dt>
<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.</dd>
<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>
@@ -221,6 +224,12 @@ be modified using the <cite>update</cite
<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, <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 ‘oF’ indicates that the uid will consist of o (organization name) concatenated with F (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, <cite>CREATE</cite>)</dt>
+<dd>The 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</dd>
<dt><em>saslMechanisms</em> (string, <cite>CREATE</cite>)</dt>
<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>authenticatePeer</em> (boolean, <cite>CREATE</cite>)</dt>
@@ -236,25 +245,29 @@ be modified using the <cite>update</cite
<dt><em>idleTimeoutSeconds</em> (integer, default=16, <cite>CREATE</cite>)</dt>
<dd>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.</dd>
<dt><em>requirePeerAuth</em> (boolean, <cite>CREATE</cite>)</dt>
-<dd>Deprecated - This attribute is now controlled by the authenticatePeer attribute.</dd>
+<dd>(DEPRECATED) This attribute is now controlled by the authenticatePeer attribute.</dd>
<dt><em>allowUnsecured</em> (boolean, <cite>CREATE</cite>)</dt>
-<dd>Deprecated - This attribute is now controlled by the requireEncryption attribute.</dd>
+<dd>(DEPRECATED) This attribute is now controlled by the requireEncryption attribute.</dd>
<dt><em>allowNoSasl</em> (boolean, <cite>CREATE</cite>)</dt>
-<dd>Deprecated - This attribute is now controlled by the authenticatePeer attribute.</dd>
+<dd>(DEPRECATED) This attribute is now controlled by the authenticatePeer attribute.</dd>
<dt><em>stripAnnotations</em> (One of [‘in’, ‘out’, ‘both’, ‘no’], default=’both’, <cite>CREATE</cite>)</dt>
<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, <cite>CREATE</cite>)</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>
</dl>
</div>
<div class="section" id="connector">
<h3>3.4.1.4. connector<a class="headerlink" href="#connector" title="Permalink to this headline">.</a></h3>
-<p>Establishes an outgoing connections from the router.</p>
-<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<p>Establishes an outgoing connection from the router.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
<dl class="docutils">
<dt><em>addr</em> (string, default=‘127.0.0.1’, <cite>CREATE</cite>)</dt>
<dd>IP address: ipv4 or ipv6 literal or a host name.</dd>
<dt><em>port</em> (string, default=’amqp’, <cite>CREATE</cite>)</dt>
<dd>Port number or symbolic service name.</dd>
-<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’, <cite>CREATE</cite>)</dt>
+<dt><em>protocolFamily</em> (One of [‘IPv4’, ‘IPv6’], <cite>CREATE</cite>)</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’, <cite>CREATE</cite>)</dt>
<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.</dd>
<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>
@@ -266,6 +279,12 @@ be modified using the <cite>update</cite
<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, <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 ‘oF’ indicates that the uid will consist of o (organization name) concatenated with F (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, <cite>CREATE</cite>)</dt>
+<dd>The 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</dd>
<dt><em>saslMechanisms</em> (string, <cite>CREATE</cite>)</dt>
<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>allowRedirect</em> (boolean, default=True, <cite>CREATE</cite>)</dt>
@@ -276,6 +295,12 @@ be modified using the <cite>update</cite
<dd>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.</dd>
<dt><em>stripAnnotations</em> (One of [‘in’, ‘out’, ‘both’, ‘no’], default=’both’, <cite>CREATE</cite>)</dt>
<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, <cite>CREATE</cite>)</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>saslUsername</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The user name that the connector is using to connect to a peer.</dd>
+<dt><em>saslPassword</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The password that the connector is using to connect to a peer.</dd>
</dl>
</div>
<div class="section" id="log">
@@ -283,7 +308,7 @@ be modified using the <cite>update</cite
<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_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘DEFAULT’], required)</dt>
+<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>
<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>
@@ -297,7 +322,7 @@ be modified using the <cite>update</cite
</div>
<div class="section" id="fixedaddress">
<h3>3.4.1.6. fixedAddress<a class="headerlink" href="#fixedaddress" title="Permalink to this headline">.</a></h3>
-<p>Establishes semantics for addresses starting with a prefix.</p>
+<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix.</p>
<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
<dl class="docutils">
<dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt>
@@ -312,8 +337,8 @@ be modified using the <cite>update</cite
</div>
<div class="section" id="waypoint">
<h3>3.4.1.7. waypoint<a class="headerlink" href="#waypoint" title="Permalink to this headline">.</a></h3>
-<p>A remote node that messages for an address pass through.</p>
-<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<p>(DEPRECATED) A remote node that messages for an address pass through.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
<dl class="docutils">
<dt><em>address</em> (string, required, <cite>CREATE</cite>)</dt>
<dd>The AMQP address of the waypoint.</dd>
@@ -327,19 +352,76 @@ be modified using the <cite>update</cite
</div>
<div class="section" id="linkroutepattern">
<h3>3.4.1.8. linkRoutePattern<a class="headerlink" href="#linkroutepattern" title="Permalink to this headline">.</a></h3>
-<p>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.</p>
+<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.</p>
<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
<dl class="docutils">
<dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt>
-<dd>An address prefix to match against target and source addresses. From Dispatch 0.6 onwards, this pattern must be of the form ‘<text>/<text1>/...’ or just ‘<text>’ and matches any address that contains that prefix. For example, if the prefix is set to org/apache any address that has the prefix ‘org/apache’ like org/apache/dev will match. Note that a prefix must not start or end with a slash (/) and can contain zero or more slashes (/). Any characters between the slashes are simply treated as part of the address</dd>
+<dd>An address prefix to match against target and source addresses. This pattern must be of the form ‘<text>.<text1>.<textN>’ or ‘<text>’ or ‘<text>.’ 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 ‘org.apache’ (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</dd>
<dt><em>dir</em> (One of [‘in’, ‘out’, ‘both’], default=’both’, <cite>CREATE</cite>)</dt>
<dd>Link direction for match: ‘in’ matches only links inbound to the client; ‘out’ matches only links outbound from the client; ‘both’ matches any link.</dd>
<dt><em>connector</em> (string, <cite>CREATE</cite>)</dt>
<dd>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.</dd>
</dl>
</div>
+<div class="section" id="router-config-address">
+<h3>3.4.1.9. router.config.address<a class="headerlink" href="#router-config-address" title="Permalink to this headline">.</a></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>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>The address prefix for the configured settings</dd>
+<dt><em>distribution</em> (One of [‘multicast’, ‘closest’, ‘balanced’], default=’balanced’, <cite>CREATE</cite>)</dt>
+<dd>Treatment of traffic associated with the address</dd>
+<dt><em>waypoint</em> (boolean, <cite>CREATE</cite>)</dt>
+<dd>Designates this address space as being used for waypoints. This will cause the proper address-phasing to be used.</dd>
+<dt><em>ingressPhase</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Advanced - Override the ingress phase for this address</dd>
+<dt><em>egressPhase</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Advanced - Override the egress phase for this address</dd>
+</dl>
+</div>
+<div class="section" id="router-config-linkroute">
+<h3>3.4.1.10. router.config.linkRoute<a class="headerlink" href="#router-config-linkroute" title="Permalink to this headline">.</a></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>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>The address prefix for the configured settings</dd>
+<dt><em>containerId</em> (string, <cite>CREATE</cite>)</dt>
+<dd>ContainerID for the target container</dd>
+<dt><em>connection</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The name from a connector or listener</dd>
+<dt><em>distribution</em> (One of [‘linkBalanced’], default=’linkBalanced’, <cite>CREATE</cite>)</dt>
+<dd>Treatment of traffic associated with the address</dd>
+<dt><em>dir</em> (One of [‘in’, ‘out’], required, <cite>CREATE</cite>)</dt>
+<dd>The permitted direction of links: ‘in’ means client senders; ‘out’ means client receivers</dd>
+</dl>
+</div>
+<div class="section" id="router-config-autolink">
+<h3>3.4.1.11. router.config.autoLink<a class="headerlink" href="#router-config-autolink" title="Permalink to this headline">.</a></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>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>addr</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>The address of the provisioned object</dd>
+<dt><em>dir</em> (One of [‘in’, ‘out’], required, <cite>CREATE</cite>)</dt>
+<dd>The direction of the link to be created. In means into the router, out means out of the router.</dd>
+<dt><em>phase</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>The address phase for this link. Defaults to ‘0’ for ‘out’ links and ‘1’ for ‘in’ links.</dd>
+<dt><em>containerId</em> (string, <cite>CREATE</cite>)</dt>
+<dd>ContainerID for the target container</dd>
+<dt><em>connection</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The name from a connector or listener</dd>
+<dt><em>linkRef</em> (string)</dt>
+<dd>Reference to the org.apache.qpid.dispatch.router.link if the link exists</dd>
+<dt><em>operStatus</em> (One of [‘inactive’, ‘attaching’, ‘failed’, ‘active’, ‘quiescing’, ‘idle’])</dt>
+<dd>The operational status of this autoLink: inactive - The remote container is not connected; attaching - the link is attaching to the remote node; failed - the link attach failed; active - the link is attached and operational; quiescing - the link is transitioning to idle state; idle - the link is attached but there are no deliveries flowing and no unsettled deliveries.</dd>
+<dt><em>lastError</em> (string)</dt>
+<dd>The error description from the last attach failure</dd>
+</dl>
+</div>
<div class="section" id="console">
-<h3>3.4.1.9. console<a class="headerlink" href="#console" title="Permalink to this headline">.</a></h3>
+<h3>3.4.1.12. console<a class="headerlink" href="#console" title="Permalink to this headline">.</a></h3>
<p>Start a websocket/tcp proxy and http file server to serve the web console</p>
<p>Operations allowed: <cite>READ</cite></p>
<dl class="docutils">
@@ -355,6 +437,47 @@ be modified using the <cite>update</cite
<dd>Optional args to pass the proxy program for logging, authentication, etc.</dd>
</dl>
</div>
+<div class="section" id="policy">
+<h3>3.4.1.13. policy<a class="headerlink" href="#policy" title="Permalink to this headline">.</a></h3>
+<p>Defines global connection limit</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>maximumConnections</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>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.</dd>
+<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>
+</dl>
+<p><em>connectionsProcessed</em> (integer)</p>
+<p><em>connectionsDenied</em> (integer)</p>
+<p><em>connectionsCurrent</em> (integer)</p>
+</div>
+<div class="section" id="policyruleset">
+<h3>3.4.1.14. policyRuleset<a class="headerlink" href="#policyruleset" title="Permalink to this headline">.</a></h3>
+<p>Per application definition of the locations from which users may connect and the groups to which users belong.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>applicationName</em> (string, required)</dt>
+<dd>The application name.</dd>
+<dt><em>maxConnections</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Maximum number of concurrent client connections allowed. Zero implies no limit.</dd>
+<dt><em>maxConnPerUser</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Maximum number of concurrent client connections allowed for any single user. Zero implies no limit.</dd>
+<dt><em>maxConnPerHost</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Maximum number of concurrent client connections allowed for any remote host. Zero implies no limit.</dd>
+<dt><em>userGroups</em> (map, <cite>CREATE</cite>)</dt>
+<dd>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 ‘restricted’. 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.</dd>
+<dt><em>ingressHostGroups</em> (map, <cite>CREATE</cite>)</dt>
+<dd>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 ‘*’ represents any host address.</dd>
+<dt><em>ingressPolicies</em> (map, <cite>CREATE</cite>)</dt>
+<dd>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.</dd>
+<dt><em>connectionAllowDefault</em> (boolean, <cite>CREATE</cite>)</dt>
+<dd>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 ‘default’ user group and receive ‘default’ settings.</dd>
+<dt><em>settings</em> (map, <cite>CREATE</cite>)</dt>
+<dd>A map where each key is a user group name and the value is a map of the corresponding settings for that group.</dd>
+</dl>
+</div>
</div>
<div class="section" id="operational-entities">
<h2>3.4.2. Operational Entities<a class="headerlink" href="#operational-entities" title="Permalink to this headline">.</a></h2>
@@ -490,30 +613,59 @@ operational attributes.</p>
<div class="section" id="router-link">
<h3>3.4.2.3. router.link<a class="headerlink" href="#router-link" title="Permalink to this headline">.</a></h3>
<p>Link to another AMQP endpoint: router node, client or other AMQP process.</p>
-<p>Operations allowed: <cite>READ</cite></p>
-<p><em>linkName</em> (string)</p>
-<p><em>linkType</em> (One of [‘endpoint’, ‘waypoint’, ‘inter-router’, ‘inter-area’])</p>
-<p><em>linkDir</em> (One of [‘in’, ‘out’])</p>
-<p><em>owningAddr</em> (string)</p>
-<p><em>eventFifoDepth</em> (integer)</p>
-<p><em>msgFifoDepth</em> (integer)</p>
-<p><em>remoteContainer</em> (string)</p>
+<p>Operations allowed: <cite>UPDATE</cite>, <cite>READ</cite></p>
+<p><em>adminStatus</em> (One of [‘enabled’, ‘disabled’], default=’enabled’, <cite>UPDATE</cite>)</p>
+<p><em>operStatus</em> (One of [‘up’, ‘down’, ‘quiescing’, ‘idle’])</p>
+<dl class="docutils">
+<dt><em>linkName</em> (string)</dt>
+<dd>Name assigned to the link in the Attach.</dd>
+<dt><em>linkType</em> (One of [‘endpoint’, ‘router-control’, ‘inter-router’])</dt>
+<dd>Type of link: endpoint: a link to a normally connected endpoint; inter-router: a link to another router in the network.</dd>
+<dt><em>linkDir</em> (One of [‘in’, ‘out’])</dt>
+<dd>Direction of delivery flow over the link, inbound or outbound to or from the router.</dd>
+<dt><em>owningAddr</em> (string)</dt>
+<dd>Address assigned to this link during attach: The target for inbound links or the source for outbound links.</dd>
+<dt><em>capacity</em> (integer)</dt>
+<dd>The capacity, in deliveries, for the link. The number of undelivered plus unsettled deliveries shall not exceed the capacity. This is enforced by link flow control.</dd>
+<dt><em>peer</em> (string)</dt>
+<dd>Identifier of the paired link if this is an attach-routed link.</dd>
+<dt><em>undeliveredCount</em> (integer)</dt>
+<dd>The number of undelivered messages pending for the link.</dd>
+<dt><em>unsettledCount</em> (integer)</dt>
+<dd>The number of unsettled deliveries awaiting settlement on the link</dd>
+<dt><em>deliveryCount</em> (integer)</dt>
+<dd>The total number of deliveries that have traversed this link.</dd>
+</dl>
</div>
<div class="section" id="router-address">
<h3>3.4.2.4. router.address<a class="headerlink" href="#router-address" title="Permalink to this headline">.</a></h3>
<p>AMQP address managed by the router.</p>
<p>Operations allowed: <cite>READ</cite></p>
-<p><em>inProcess</em> (boolean)</p>
-<p><em>subscriberCount</em> (integer)</p>
-<p><em>remoteCount</em> (integer)</p>
-<p><em>deliveriesIngress</em> (integer)</p>
-<p><em>deliveriesEgress</em> (integer)</p>
-<p><em>deliveriesTransit</em> (integer)</p>
-<p><em>deliveriesToContainer</em> (integer)</p>
-<p><em>deliveriesFromContainer</em> (integer)</p>
<dl class="docutils">
+<dt><em>distribution</em> (One of [‘flood’, ‘multicast’, ‘closest’, ‘balanced’, ‘linkBalanced’])</dt>
+<dd>Forwarding treatment for the address: flood - messages delivered to all subscribers along all available paths (this will cause duplicate deliveries if there are redundant paths); multi - one copy of each message delivered to all subscribers; anyClosest - messages delivered to only the closest subscriber; anyBalanced - messages delivered to one subscriber with load balanced across subscribers; linkBalanced - for link-routing, link attaches balanced across destinations.</dd>
+<dt><em>inProcess</em> (integer)</dt>
+<dd>The number of in-process subscribers for this address</dd>
+<dt><em>subscriberCount</em> (integer)</dt>
+<dd>The number of local subscribers for this address (i.e. attached to this router)</dd>
+<dt><em>remoteCount</em> (integer)</dt>
+<dd>The number of remote routers that have at least one subscriber to this address</dd>
+<dt><em>containerCount</em> (integer)</dt>
+<dd>The number of attached containers that serve this route address</dd>
+<dt><em>deliveriesIngress</em> (integer)</dt>
+<dd>The number of deliveries to this address that entered the router network on this router</dd>
+<dt><em>deliveriesEgress</em> (integer)</dt>
+<dd>The number of deliveries to this address that exited the router network on this router</dd>
+<dt><em>deliveriesTransit</em> (integer)</dt>
+<dd>The number of deliveries to this address that transited this router to another router</dd>
+<dt><em>deliveriesToContainer</em> (integer)</dt>
+<dd>The number of deliveries to this address that were given to an in-process subscriber</dd>
+<dt><em>deliveriesFromContainer</em> (integer)</dt>
+<dd>The number of deliveries to this address that were originated from an in-process entity</dd>
<dt><em>key</em> (string)</dt>
<dd>Internal unique (to this router) key to identify the address</dd>
+<dt><em>hostRouters</em> (list)</dt>
+<dd>List of remote routers on which there is a destination for this address.</dd>
</dl>
</div>
<div class="section" id="router-node">
@@ -588,6 +740,31 @@ operational attributes.</p>
<p><em>batchesRebalancedToThreads</em> (integer)</p>
<p><em>batchesRebalancedToGlobal</em> (integer)</p>
</div>
+<div class="section" id="policystats">
+<h3>3.4.2.8. policyStats<a class="headerlink" href="#policystats" title="Permalink to this headline">.</a></h3>
+<p>Per application connection and access statistics.</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>applicationName</em> (string)</dt>
+<dd>The application name.</dd>
+</dl>
+<p><em>connectionsApproved</em> (integer)</p>
+<p><em>connectionsDenied</em> (integer)</p>
+<p><em>connectionsCurrent</em> (integer)</p>
+<dl class="docutils">
+<dt><em>perUserState</em> (map)</dt>
+<dd>A map where the key is the authenticated user name and the value is a list of the user’s connections.</dd>
+<dt><em>perHostState</em> (map)</dt>
+<dd>A map where the key is the host name and the value is a list of the host’s connections.</dd>
+</dl>
+<p><em>sessionDenied</em> (integer)</p>
+<p><em>senderDenied</em> (integer)</p>
+<p><em>receiverDenied</em> (integer)</p>
+<p><em>dynamicSrcDenied</em> (integer)</p>
+<p><em>anonymousSenderDenied</em> (integer)</p>
+<p><em>linkSourceDenied</em> (integer)</p>
+<p><em>linkTargetDenied</em> (integer)</p>
+</div>
</div>
<div class="section" id="management-operations">
<h2>3.4.3. Management Operations<a class="headerlink" href="#management-operations" title="Permalink to this headline">.</a></h2>
Modified: qpid/site/docs/releases/qpid-dispatch-master/book/technical_details.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-master/book/technical_details.html?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-dispatch-master/book/technical_details.html (original)
+++ qpid/site/docs/releases/qpid-dispatch-master/book/technical_details.html Tue Apr 5 17:01:10 2016
@@ -115,6 +115,7 @@ https://github.com/apache/qpid-proton/bl
<div id="-middle-content">
+
<div class="section" id="technical-details-and-specifications">
<h1>3. Technical Details and Specifications<a class="headerlink" href="#technical-details-and-specifications" title="Permalink to this headline">.</a></h1>
@@ -151,7 +152,12 @@ https://github.com/apache/qpid-proton/bl
<li class="toctree-l3"><a class="reference internal" href="schema.html#fixedaddress">3.4.1.6. fixedAddress</a></li>
<li class="toctree-l3"><a class="reference internal" href="schema.html#waypoint">3.4.1.7. waypoint</a></li>
<li class="toctree-l3"><a class="reference internal" href="schema.html#linkroutepattern">3.4.1.8. linkRoutePattern</a></li>
-<li class="toctree-l3"><a class="reference internal" href="schema.html#console">3.4.1.9. console</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#router-config-address">3.4.1.9. router.config.address</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#router-config-linkroute">3.4.1.10. router.config.linkRoute</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#router-config-autolink">3.4.1.11. router.config.autoLink</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#console">3.4.1.12. console</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#policy">3.4.1.13. policy</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#policyruleset">3.4.1.14. policyRuleset</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="schema.html#operational-entities">3.4.2. Operational Entities</a><ul>
@@ -162,6 +168,7 @@ https://github.com/apache/qpid-proton/bl
<li class="toctree-l3"><a class="reference internal" href="schema.html#router-node">3.4.2.5. router.node</a></li>
<li class="toctree-l3"><a class="reference internal" href="schema.html#connection">3.4.2.6. connection</a></li>
<li class="toctree-l3"><a class="reference internal" href="schema.html#allocator">3.4.2.7. allocator</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#policystats">3.4.2.8. policyStats</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="schema.html#management-operations">3.4.3. Management Operations</a><ul>
Modified: qpid/site/docs/releases/qpid-dispatch-master/book/tools.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-master/book/tools.html?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-dispatch-master/book/tools.html (original)
+++ qpid/site/docs/releases/qpid-dispatch-master/book/tools.html Tue Apr 5 17:01:10 2016
@@ -115,18 +115,19 @@ https://github.com/apache/qpid-proton/bl
<div id="-middle-content">
+
<div class="section" id="tools">
<h1>2.2. Tools<a class="headerlink" href="#tools" title="Permalink to this headline">.</a></h1>
<div class="section" id="qdstat">
<h2>2.2.1. qdstat<a class="headerlink" href="#qdstat" title="Permalink to this headline">.</a></h2>
<p><em>qdstat</em> is a command line tool that lets you view the status of a
-Dispatch Router. The following options are useful for seeing that the
+Dispatch Router. The following options are useful for seeing what the
router is doing:</p>
<table border="1" class="docutils">
<colgroup>
-<col width="11%" />
-<col width="89%" />
+<col width="15%" />
+<col width="85%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head"><em>Option</em></th>
@@ -150,6 +151,12 @@ are attached to other routers in a netwo
<tr class="row-odd"><td>-c</td>
<td>Print a list of connections to the router.</td>
</tr>
+<tr class="row-even"><td>–autolinks</td>
+<td>Print a list of configured auto-links.</td>
+</tr>
+<tr class="row-odd"><td>–linkroutes</td>
+<td>Print a list of configures link-routes.</td>
+</tr>
</tbody>
</table>
<p>For complete details see the <cite>qdstat(8)</cite> man page and the output of
@@ -161,22 +168,18 @@ are attached to other routers in a netwo
to not only view but modify the configuration of a running dispatch
router.</p>
<p>For example you can query all the connection entities in the router:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdmanage query --type connection
-</pre></div>
+<div class="highlight-python"><pre>$ qdmanage query --type connection</pre>
</div>
<p>To enable logging debug and higher level messages by default:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdmanage update log/DEFAULT enable=debug+
-</pre></div>
+<div class="highlight-python"><pre>$ qdmanage update log/DEFAULT enable=debug+</pre>
</div>
<p>In fact, everything that can be configured in the configuration file can
also be created in a running router via management. For example to
create a new listener in a running router:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdmanage create type=listener port=5555
-</pre></div>
+<div class="highlight-python"><pre>$ qdmanage create type=listener port=5555</pre>
</div>
<p>Now you can connect to port 5555, for exampple:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdmanage query -b localhost:5555 --type listener
-</pre></div>
+<div class="highlight-python"><pre>$ qdmanage query -b localhost:5555 --type listener</pre>
</div>
<p>For complete details see the <cite>qdmanage(8)</cite> man page and the output of
<cite>qdmanage –help</cite>. Also for details of what can be configured see the
Modified: qpid/site/docs/releases/qpid-dispatch-master/book/using.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-master/book/using.html?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-dispatch-master/book/using.html (original)
+++ qpid/site/docs/releases/qpid-dispatch-master/book/using.html Tue Apr 5 17:01:10 2016
@@ -115,6 +115,7 @@ https://github.com/apache/qpid-proton/bl
<div id="-middle-content">
+
<div class="section" id="using-qpid-dispatch">
<h1>2. Using Qpid Dispatch<a class="headerlink" href="#using-qpid-dispatch" title="Permalink to this headline">.</a></h1>
@@ -136,6 +137,12 @@ https://github.com/apache/qpid-proton/bl
<li class="toctree-l2"><a class="reference internal" href="link_routing.html#configuration">2.4.1. Configuration</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="auto_links.html">2.5. Indirect Waypoints and Auto-Links</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="auto_links.html#queue-waypoint-example">2.5.1. Queue Waypoint Example</a></li>
+<li class="toctree-l2"><a class="reference internal" href="auto_links.html#sharded-queue-example">2.5.2. Sharded Queue Example</a></li>
+<li class="toctree-l2"><a class="reference internal" href="auto_links.html#dynamically-adding-shards">2.5.3. Dynamically Adding Shards</a></li>
+</ul>
+</li>
</ul>
</div>
</div>
Modified: qpid/site/docs/releases/qpid-dispatch-master/index.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-master/index.html?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-dispatch-master/index.html (original)
+++ qpid/site/docs/releases/qpid-dispatch-master/index.html Tue Apr 5 17:01:10 2016
@@ -124,7 +124,7 @@ https://github.com/apache/qpid-proton/bl
incomplete. For a smoother experience, see the <a href="/releases/qpid-dispatch-0.5/index.html">current stable
release</a>.</p>
-<p>This content was generated at 16:25 on Tuesday, 29 September 2015.</p>
+<p>This content was generated at 12:49 on Tuesday, 05 April 2016.</p>
</div>
Modified: qpid/site/docs/releases/qpid-dispatch-master/man/qdmanage.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-master/man/qdmanage.html?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-dispatch-master/man/qdmanage.html (original)
+++ qpid/site/docs/releases/qpid-dispatch-master/man/qdmanage.html Tue Apr 5 17:01:10 2016
@@ -115,6 +115,7 @@ https://github.com/apache/qpid-proton/bl
<div id="-middle-content">
+
<div class="section" id="qdmanage-manual-page">
<h1>qdmanage manual page<a class="headerlink" href="#qdmanage-manual-page" title="Permalink to this headline">.</a></h1>
@@ -177,41 +178,19 @@ formatted output.</dd>
</div>
<div class="section" id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">.</a></h2>
-<p>-h, –help
-: show this help message and exit</p>
-<p>–version
-: Print version and exit.</p>
-<p>–type=TYPE
-: Type of entity to operate on.</p>
-<p>–name=NAME
-: Name of entity to operate on.</p>
-<p>–identity=ID
-: Identity of entity to operate on.</p>
-<p>–indent=INDENT
-: Pretty-printing indent. -1 means don’t pretty-print (default 2)</p>
-<p>–stdin
-: Read attributes as JSON map or list of maps from stdin.</p>
-<p>–body=BODY
-: JSON value to use as body of a non-standard operation call.</p>
-<p>–properties=PROPERTIES
-: JSON map to use as properties for a non-standard operation call.</p>
-<div class="section" id="connection-options">
-<h3>Connection Options<a class="headerlink" href="#connection-options" title="Permalink to this headline">.</a></h3>
-<p>-b URL, –bus=URL
-: URL of the messaging bus to connect to (default 0.0.0.0)</p>
-<p>-r ROUTER-ID, –router=ROUTER-ID
-: Router to be queried</p>
-<p>-t SECS, –timeout=SECS
-: Maximum time to wait for connection in seconds (default 5)</p>
-<p>–ssl-certificate=CERT
-: Client SSL certificate (PEM Format)</p>
-<p>–ssl-key=KEY
-: Client SSL private key (PEM Format)</p>
-<p>–ssl-trustfile=TRUSTED-CA-DB
-: Trusted Certificate Authority Database file (PEM Format)</p>
-<p>–ssl-password=PASSWORD
-: Certificate password, will be prompted if not specifed.</p>
-</div>
+<p>Command ‘[‘/tmp/ross/transom/qpid-dispatch-master/tools/qdmanage’, ‘–help’]’ returned non-zero exit status 1</p>
+<dl class="docutils">
+<dt>Traceback (most recent call last):</dt>
+<dd><dl class="first last docutils">
+<dt>File “/tmp/ross/transom/qpid-dispatch-master/tools/qdmanage”, line 24, in <module></dt>
+<dd>from qpid_dispatch.management.client import Node, Url</dd>
+<dt>File “/tmp/ross/transom/qpid-dispatch-master/python/qpid_dispatch/management/client.py”, line 25, in <module></dt>
+<dd>import proton</dd>
+</dl>
+</dd>
+</dl>
+<p>ImportError: No module named proton</p>
+<p>Run python script ‘/tmp/ross/transom/qpid-dispatch-master/doc/man/help2rst.py’:CalledProcessError: Command ‘[‘/tmp/ross/transom/qpid-dispatch-master/tools/qdmanage’, ‘–help’]’ returned non-zero exit status 1</p>
</div>
<div class="section" id="files">
<h2>Files<a class="headerlink" href="#files" title="Permalink to this headline">.</a></h2>
@@ -225,25 +204,20 @@ formatted output.</dd>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">.</a></h2>
<p>Show the logging configuration</p>
-<div class="highlight-python"><div class="highlight"><pre>qdmanage query --type=log
-</pre></div>
+<div class="highlight-python"><pre>qdmanage query --type=log</pre>
</div>
<p>Enable debug and higher log messages by default:</p>
-<div class="highlight-python"><div class="highlight"><pre>qdmanage udpdate name=log/DEFAULT enable=debug+
-</pre></div>
+<div class="highlight-python"><pre>qdmanage udpdate name=log/DEFAULT enable=debug+</pre>
</div>
<p>Enable trace log messages only for the MESSAGE moudle and direct MESSAGE
logs to the file “test.log”</p>
-<div class="highlight-python"><div class="highlight"><pre>qdmanage udpdate name=log/MESSAGE enable=trace output=test.log
-</pre></div>
+<div class="highlight-python"><pre>qdmanage udpdate name=log/MESSAGE enable=trace output=test.log</pre>
</div>
<p>Set MESSAGE logging back to the default:</p>
-<div class="highlight-python"><div class="highlight"><pre>qdmanage udpdate name=log/MESSAGE enable=default
-</pre></div>
+<div class="highlight-python"><pre>qdmanage udpdate name=log/MESSAGE enable=default</pre>
</div>
<p>Disable MESSAGE logging:</p>
-<div class="highlight-python"><div class="highlight"><pre>qdmanage udpdate name=log/MESSAGE enable=none
-</pre></div>
+<div class="highlight-python"><pre>qdmanage udpdate name=log/MESSAGE enable=none</pre>
</div>
</div>
<div class="section" id="see-also">
Modified: qpid/site/docs/releases/qpid-dispatch-master/man/qdrouterd.conf.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-master/man/qdrouterd.conf.html?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-dispatch-master/man/qdrouterd.conf.html (original)
+++ qpid/site/docs/releases/qpid-dispatch-master/man/qdrouterd.conf.html Tue Apr 5 17:01:10 2016
@@ -115,6 +115,7 @@ https://github.com/apache/qpid-proton/bl
<div id="-middle-content">
+
<div class="section" id="qdrouterd-conf-manual-page">
<h1>qdrouterd.conf manual page<a class="headerlink" href="#qdrouterd-conf-manual-page" title="Permalink to this headline">.</a></h1>
@@ -125,12 +126,11 @@ https://github.com/apache/qpid-proton/bl
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">.</a></h2>
<p>The configuration file is made up of sections with this syntax:</p>
-<div class="highlight-python"><div class="highlight"><pre>SECTION-NAME {
+<div class="highlight-python"><pre>SECTION-NAME {
ATTRIBUTE-NAME: ATTRIBUTE-VALUE
ATTRIBUTE-NAME: ATTRIBUTE-VALUE
...
-}
-</pre></div>
+}</pre>
</div>
<p>There are two types of sections:</p>
<p><em>Configuration sections</em> correspond to configuration entities. They can be queried and
@@ -141,7 +141,7 @@ one or more entity sections.</p>
that can be included in multiple “listener” entities. Here’s an example, note
how the ‘ssl-profile’ attribute of ‘listener’ sections references the ‘name’
attribute of ‘ssl-profile’ sections.</p>
-<div class="highlight-python"><div class="highlight"><pre>ssl-profile {
+<div class="highlight-python"><pre>ssl-profile {
name: ssl-profile-one
cert-db: ca-certificate-1.pem
cert-file: server-certificate-1.pem
@@ -153,8 +153,7 @@ listener {
addr: 0.0.0.0
port: 20102
sasl-mechanisms: ANONYMOUS
-}
-</pre></div>
+}</pre>
</div>
</div>
<div class="section" id="annotation-sections">
@@ -168,6 +167,8 @@ listener {
<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">
@@ -175,7 +176,7 @@ listener {
<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’, ‘on-demand’], default=’normal’)</dt>
+<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.</dd>
</dl>
</div>
@@ -194,6 +195,10 @@ listener {
<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 ‘oF’ indicates that the uid will consist of o (organization name) concatenated with F (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>
</dl>
</div>
</div>
@@ -221,8 +226,8 @@ listener {
<dl class="docutils">
<dt><em>routerId</em> (string)</dt>
<dd>Router’s unique identity.</dd>
-<dt><em>mode</em> (One of [‘standalone’, ‘interior’, ‘edge’, ‘endpoint’], default=’standalone’)</dt>
-<dd>In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not cooperate with other routers. In interior mode, the router operates in cooperation with other interior routers in an interconnected network. In edge mode, the router operates with an up link into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.</dd>
+<dt><em>mode</em> (One of [‘standalone’, ‘interior’], default=’standalone’)</dt>
+<dd>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.</dd>
<dt><em>helloInterval</em> (integer, default=1)</dt>
<dd>Interval in seconds between HELLO messages sent to neighbor routers.</dd>
<dt><em>helloMaxAge</em> (integer, default=3)</dt>
@@ -234,7 +239,7 @@ listener {
<dt><em>remoteLsMaxAge</em> (integer, default=60)</dt>
<dd>Time in seconds after which link state is declared stale if no RA is received.</dd>
<dt><em>mobileAddrMaxAge</em> (integer, default=60)</dt>
-<dd>Deprecated - This value is no longer used in the router.</dd>
+<dd>(DEPRECATED) This value is no longer used in the router.</dd>
</dl>
</div>
<div class="section" id="listener">
@@ -246,7 +251,9 @@ listener {
<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>role</em> (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’)</dt>
+<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.</dd>
<dt><em>certDb</em> (path)</dt>
<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
@@ -258,6 +265,10 @@ listener {
<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 ‘oF’ indicates that the uid will consist of o (organization name) concatenated with F (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>
<dt><em>authenticatePeer</em> (boolean)</dt>
@@ -273,25 +284,29 @@ listener {
<dt><em>idleTimeoutSeconds</em> (integer, default=16)</dt>
<dd>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.</dd>
<dt><em>requirePeerAuth</em> (boolean)</dt>
-<dd>Deprecated - This attribute is now controlled by the authenticatePeer attribute.</dd>
+<dd>(DEPRECATED) This attribute is now controlled by the authenticatePeer attribute.</dd>
<dt><em>allowUnsecured</em> (boolean)</dt>
-<dd>Deprecated - This attribute is now controlled by the requireEncryption attribute.</dd>
+<dd>(DEPRECATED) This attribute is now controlled by the requireEncryption attribute.</dd>
<dt><em>allowNoSasl</em> (boolean)</dt>
-<dd>Deprecated - This attribute is now controlled by the authenticatePeer attribute.</dd>
+<dd>(DEPRECATED) This attribute is now controlled by the authenticatePeer attribute.</dd>
<dt><em>stripAnnotations</em> (One of [‘in’, ‘out’, ‘both’, ‘no’], default=’both’)</dt>
<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>
</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 connections from the router.</p>
+<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>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>role</em> (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’)</dt>
+<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.</dd>
<dt><em>certDb</em> (path)</dt>
<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
@@ -303,6 +318,10 @@ listener {
<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 ‘oF’ indicates that the uid will consist of o (organization name) concatenated with F (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>
<dt><em>allowRedirect</em> (boolean, default=True)</dt>
@@ -313,6 +332,12 @@ listener {
<dd>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.</dd>
<dt><em>stripAnnotations</em> (One of [‘in’, ‘out’, ‘both’, ‘no’], default=’both’)</dt>
<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>saslUsername</em> (string)</dt>
+<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>
</dl>
</div>
<div class="section" id="log">
@@ -331,7 +356,7 @@ listener {
</div>
<div class="section" id="fixedaddress">
<h3>fixedAddress<a class="headerlink" href="#fixedaddress" title="Permalink to this headline">.</a></h3>
-<p>Establishes semantics for addresses starting with a prefix.</p>
+<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix.</p>
<dl class="docutils">
<dt><em>prefix</em> (string, required)</dt>
<dd>The address prefix (always starting with ‘/’).</dd>
@@ -345,7 +370,7 @@ listener {
</div>
<div class="section" id="waypoint">
<h3>waypoint<a class="headerlink" href="#waypoint" title="Permalink to this headline">.</a></h3>
-<p>A remote node that messages for an address pass through.</p>
+<p>(DEPRECATED) A remote node that messages for an address pass through.</p>
<dl class="docutils">
<dt><em>address</em> (string, required)</dt>
<dd>The AMQP address of the waypoint.</dd>
@@ -359,20 +384,102 @@ listener {
</div>
<div class="section" id="linkroutepattern">
<h3>linkRoutePattern<a class="headerlink" href="#linkroutepattern" title="Permalink to this headline">.</a></h3>
-<p>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.</p>
+<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.</p>
<dl class="docutils">
<dt><em>prefix</em> (string, required)</dt>
-<dd>An address prefix to match against target and source addresses. From Dispatch 0.6 onwards, this pattern must be of the form ‘<text>/<text1>/...’ or just ‘<text>’ and matches any address that contains that prefix. For example, if the prefix is set to org/apache any address that has the prefix ‘org/apache’ like org/apache/dev will match. Note that a prefix must not start or end with a slash (/) and can contain zero or more slashes (/). Any characters between the slashes are simply treated as part of the address</dd>
+<dd>An address prefix to match against target and source addresses. This pattern must be of the form ‘<text>.<text1>.<textN>’ or ‘<text>’ or ‘<text>.’ 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 ‘org.apache’ (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</dd>
<dt><em>dir</em> (One of [‘in’, ‘out’, ‘both’], default=’both’)</dt>
<dd>Link direction for match: ‘in’ matches only links inbound to the client; ‘out’ matches only links outbound from the client; ‘both’ matches any link.</dd>
<dt><em>connector</em> (string)</dt>
<dd>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.</dd>
</dl>
</div>
+<div class="section" id="router-config-address">
+<h3>router.config.address<a class="headerlink" href="#router-config-address" title="Permalink to this headline">.</a></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 class="docutils">
+<dt><em>prefix</em> (string, required)</dt>
+<dd>The address prefix for the configured settings</dd>
+<dt><em>distribution</em> (One of [‘multicast’, ‘closest’, ‘balanced’], default=’balanced’)</dt>
+<dd>Treatment of traffic associated with the address</dd>
+<dt><em>waypoint</em> (boolean)</dt>
+<dd>Designates this address space as being used for waypoints. This will cause the proper address-phasing to be used.</dd>
+<dt><em>ingressPhase</em> (integer)</dt>
+<dd>Advanced - Override the ingress phase for this address</dd>
+<dt><em>egressPhase</em> (integer)</dt>
+<dd>Advanced - Override the egress phase for this address</dd>
+</dl>
+</div>
+<div class="section" id="router-config-linkroute">
+<h3>router.config.linkRoute<a class="headerlink" href="#router-config-linkroute" title="Permalink to this headline">.</a></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 class="docutils">
+<dt><em>prefix</em> (string, required)</dt>
+<dd>The address prefix for the configured settings</dd>
+<dt><em>containerId</em> (string)</dt>
+<dd>ContainerID for the target container</dd>
+<dt><em>connection</em> (string)</dt>
+<dd>The name from a connector or listener</dd>
+<dt><em>distribution</em> (One of [‘linkBalanced’], default=’linkBalanced’)</dt>
+<dd>Treatment of traffic associated with the address</dd>
+<dt><em>dir</em> (One of [‘in’, ‘out’], required)</dt>
+<dd>The permitted direction of links: ‘in’ means client senders; ‘out’ means client receivers</dd>
+</dl>
+</div>
+<div class="section" id="router-config-autolink">
+<h3>router.config.autoLink<a class="headerlink" href="#router-config-autolink" title="Permalink to this headline">.</a></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 class="docutils">
+<dt><em>addr</em> (string, required)</dt>
+<dd>The address of the provisioned object</dd>
+<dt><em>dir</em> (One of [‘in’, ‘out’], required)</dt>
+<dd>The direction of the link to be created. In means into the router, out means out of the router.</dd>
+<dt><em>phase</em> (integer)</dt>
+<dd>The address phase for this link. Defaults to ‘0’ for ‘out’ links and ‘1’ for ‘in’ links.</dd>
+<dt><em>containerId</em> (string)</dt>
+<dd>ContainerID for the target container</dd>
+<dt><em>connection</em> (string)</dt>
+<dd>The name from a connector or listener</dd>
+</dl>
+</div>
<div class="section" id="console">
<h3>console<a class="headerlink" href="#console" title="Permalink to this headline">.</a></h3>
<p>Start a websocket/tcp proxy and http file server to serve the web console</p>
</div>
+<div class="section" id="policy">
+<h3>policy<a class="headerlink" href="#policy" title="Permalink to this headline">.</a></h3>
+<p>Defines global connection limit</p>
+<dl class="docutils">
+<dt><em>maximumConnections</em> (integer)</dt>
+<dd>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.</dd>
+<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>
+</dl>
+</div>
+<div class="section" id="policyruleset">
+<h3>policyRuleset<a class="headerlink" href="#policyruleset" title="Permalink to this headline">.</a></h3>
+<p>Per application definition of the locations from which users may connect and the groups to which users belong.</p>
+<dl class="docutils">
+<dt><em>maxConnections</em> (integer)</dt>
+<dd>Maximum number of concurrent client connections allowed. Zero implies no limit.</dd>
+<dt><em>maxConnPerUser</em> (integer)</dt>
+<dd>Maximum number of concurrent client connections allowed for any single user. Zero implies no limit.</dd>
+<dt><em>maxConnPerHost</em> (integer)</dt>
+<dd>Maximum number of concurrent client connections allowed for any remote host. Zero implies no limit.</dd>
+<dt><em>userGroups</em> (map)</dt>
+<dd>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 ‘restricted’. 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.</dd>
+<dt><em>ingressHostGroups</em> (map)</dt>
+<dd>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 ‘*’ represents any host address.</dd>
+<dt><em>ingressPolicies</em> (map)</dt>
+<dd>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.</dd>
+<dt><em>connectionAllowDefault</em> (boolean)</dt>
+<dd>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 ‘default’ user group and receive ‘default’ settings.</dd>
+<dt><em>settings</em> (map)</dt>
+<dd>A map where each key is a user group name and the value is a map of the corresponding settings for that group.</dd>
+</dl>
+</div>
</div>
<div class="section" id="see-also">
<h2>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">.</a></h2>
Modified: qpid/site/docs/releases/qpid-dispatch-master/man/qdrouterd.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-master/man/qdrouterd.html?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-dispatch-master/man/qdrouterd.html (original)
+++ qpid/site/docs/releases/qpid-dispatch-master/man/qdrouterd.html Tue Apr 5 17:01:10 2016
@@ -115,6 +115,7 @@ https://github.com/apache/qpid-proton/bl
<div id="-middle-content">
+
<div class="section" id="qdrouterd-manual-page">
<h1>qdrouterd manual page<a class="headerlink" href="#qdrouterd-manual-page" title="Permalink to this headline">.</a></h1>
Modified: qpid/site/docs/releases/qpid-dispatch-master/man/qdstat.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-master/man/qdstat.html?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-dispatch-master/man/qdstat.html (original)
+++ qpid/site/docs/releases/qpid-dispatch-master/man/qdstat.html Tue Apr 5 17:01:10 2016
@@ -115,6 +115,7 @@ https://github.com/apache/qpid-proton/bl
<div id="-middle-content">
+
<div class="section" id="qdstat-manual-page">
<h1>qdstat manual page<a class="headerlink" href="#qdstat-manual-page" title="Permalink to this headline">.</a></h1>
@@ -130,45 +131,19 @@ as memory use.</p>
</div>
<div class="section" id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">.</a></h2>
-<p>-h, –help
-: show this help message and exit</p>
-<p>–version
-: Print version and exit.</p>
-<p>-g, –general
-: Show General Router Stats</p>
-<p>-c, –connections
-: Show Connections</p>
-<p>-l, –links
-: Show Router Links</p>
-<p>-n, –nodes
-: Show Router Nodes</p>
-<p>-a, –address
-: Show Router Addresses</p>
-<p>-m, –memory
-: Show Broker Memory Stats</p>
-<p>-v, –verbose
-: Show maximum detail</p>
-<p>–log
-: Show recent log entries</p>
-<p>–limit=LIMIT
-: Limit number of log entries</p>
-<div class="section" id="connection-options">
-<h3>Connection Options<a class="headerlink" href="#connection-options" title="Permalink to this headline">.</a></h3>
-<p>-b URL, –bus=URL
-: URL of the messaging bus to connect to (default 0.0.0.0)</p>
-<p>-r ROUTER-ID, –router=ROUTER-ID
-: Router to be queried</p>
-<p>-t SECS, –timeout=SECS
-: Maximum time to wait for connection in seconds (default 5)</p>
-<p>–ssl-certificate=CERT
-: Client SSL certificate (PEM Format)</p>
-<p>–ssl-key=KEY
-: Client SSL private key (PEM Format)</p>
-<p>–ssl-trustfile=TRUSTED-CA-DB
-: Trusted Certificate Authority Database file (PEM Format)</p>
-<p>–ssl-password=PASSWORD
-: Certificate password, will be prompted if not specifed.</p>
-</div>
+<p>Command ‘[‘/tmp/ross/transom/qpid-dispatch-master/tools/qdstat’, ‘–help’]’ returned non-zero exit status 1</p>
+<dl class="docutils">
+<dt>Traceback (most recent call last):</dt>
+<dd><dl class="first last docutils">
+<dt>File “/tmp/ross/transom/qpid-dispatch-master/tools/qdstat”, line 30, in <module></dt>
+<dd>from qpid_dispatch.management.client import Url, Node, Entity</dd>
+<dt>File “/tmp/ross/transom/qpid-dispatch-master/python/qpid_dispatch/management/client.py”, line 25, in <module></dt>
+<dd>import proton</dd>
+</dl>
+</dd>
+</dl>
+<p>ImportError: No module named proton</p>
+<p>Run python script ‘/tmp/ross/transom/qpid-dispatch-master/doc/man/help2rst.py’:CalledProcessError: Command ‘[‘/tmp/ross/transom/qpid-dispatch-master/tools/qdstat’, ‘–help’]’ returned non-zero exit status 1</p>
</div>
<div class="section" id="see-also">
<h2>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">.</a></h2>
Modified: qpid/site/input/releases/qpid-dispatch-master/book/addressing.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/addressing.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/addressing.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/addressing.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="addressing">
<h1>3.2. Addressing<a class="headerlink" href="#addressing" title="Permalink to this headline">.</a></h1>
Modified: qpid/site/input/releases/qpid-dispatch-master/book/amqp-mapping.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/amqp-mapping.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/amqp-mapping.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/amqp-mapping.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="amqp-mapping">
<h1>3.3. AMQP Mapping<a class="headerlink" href="#amqp-mapping" title="Permalink to this headline">.</a></h1>
@@ -47,11 +48,10 @@ properties. A router may append, remove,
annotation field depending on the policy in place for
routing the message.</td>
</tr>
-<tr class="row-odd"><td>x-opt-qd.class</td>
-<td>string</td>
-<td>Message class. This is used to allow the router to
-provide separate paths for different classes of
-traffic.</td>
+<tr class="row-odd"><td>x-opt-qd.phase</td>
+<td>integer</td>
+<td>The address-phase, if not zero, for messages flowing
+between routers.</td>
</tr>
</tbody>
</table>
@@ -72,7 +72,13 @@ traffic.</td>
<tbody valign="top">
<tr class="row-even"><td>qd.router</td>
<td>This capability is added to sources and targets that are used for
-inter-router message exchange.</td>
+inter-router message exchange. This capability denotes a link used for
+router-control messages flowing between routers.</td>
+</tr>
+<tr class="row-odd"><td>qd.router-data</td>
+<td>This capability is added to sources and targets that are used for
+inter-router message exchange. This capability denotes a link used for
+user messages being message-routed across an inter-router connection.</td>
</tr>
</tbody>
</table>
@@ -122,14 +128,18 @@ Dispatch Router.</p>
endpoint. Messages using this address pattern shall not
be routed over more than one link.</td>
</tr>
-<tr class="row-odd"><td><cite>_topo/<area>/<router>/<addr></cite></td>
-<td>An address that references an endpoint attached to a
+<tr class="row-odd"><td><cite>_topo/0/<router>/<addr></cite></td>
+<td><p class="first">An address that references an endpoint attached to a
specific router node in the network topology. Messages
with addresses that follow this pattern shall be routed
along the shortest path to the specified router. Note
that addresses of this form are a-priori routable in
that the address itself contains enough information to
-route the message to its destination.</td>
+route the message to its destination.</p>
+<p class="last">The ‘0’ component immediately preceding the router-id
+is a placeholder for an _area_ which may be used in
+the future if area routing is implemented.</p>
+</td>
</tr>
<tr class="row-even"><td><cite><addr></cite></td>
<td>A mobile address. An address of this format represents
@@ -146,8 +156,8 @@ addresses.</td>
<h3>3.3.4.2. Supported Addresses<a class="headerlink" href="#supported-addresses" title="Permalink to this headline">.</a></h3>
<table border="1" class="docutils">
<colgroup>
-<col width="33%" />
-<col width="67%" />
+<col width="35%" />
+<col width="65%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head"><em>Address</em></th>
@@ -161,7 +171,7 @@ address would be used by an endpoint tha
client/console/tool wishing to access management data from
the attached container.</td>
</tr>
-<tr class="row-odd"><td><cite>_topo/0/Router.E/agent</cite></td>
+<tr class="row-odd"><td><cite>_topo/0/Router.E/$management</cite></td>
<td>The management agent at Router.E in area 0. This address
would be used by a management client wishing to access
management data from a specific container that is reachable
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org