Return-Path: X-Original-To: apmail-qpid-commits-archive@www.apache.org Delivered-To: apmail-qpid-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 850591791E for ; Mon, 13 Apr 2015 21:05:46 +0000 (UTC) Received: (qmail 42174 invoked by uid 500); 13 Apr 2015 21:05:46 -0000 Delivered-To: apmail-qpid-commits-archive@qpid.apache.org Received: (qmail 42096 invoked by uid 500); 13 Apr 2015 21:05:46 -0000 Mailing-List: contact commits-help@qpid.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@qpid.apache.org Delivered-To: mailing list commits@qpid.apache.org Received: (qmail 41898 invoked by uid 99); 13 Apr 2015 21:05:46 -0000 Received: from eris.apache.org (HELO hades.apache.org) (140.211.11.105) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 13 Apr 2015 21:05:46 +0000 Received: from hades.apache.org (localhost [127.0.0.1]) by hades.apache.org (ASF Mail Server at hades.apache.org) with ESMTP id 2F2D6AC0AE6 for ; Mon, 13 Apr 2015 21:05:46 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: svn commit: r1673280 [6/7] - in /qpid/site: docs/ docs/components/dispatch-router/ docs/releases/ docs/releases/qpid-dispatch-0.1/ docs/releases/qpid-dispatch-0.2/ docs/releases/qpid-dispatch-0.3/ docs/releases/qpid-dispatch-0.4/ docs/releases/qpid-dis... Date: Mon, 13 Apr 2015 21:05:45 -0000 To: commits@qpid.apache.org From: aconway@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20150413210546.2F2D6AC0AE6@hades.apache.org> Added: qpid/site/input/releases/qpid-dispatch-0.4/book/schema.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-0.4/book/schema.html.in?rev=1673280&view=auto ============================================================================== --- qpid/site/input/releases/qpid-dispatch-0.4/book/schema.html.in (added) +++ qpid/site/input/releases/qpid-dispatch-0.4/book/schema.html.in Mon Apr 13 21:05:44 2015 @@ -0,0 +1,715 @@ + + + + + + + + 3.4. Management Schema — Qpid Dispatch 0.4 documentation + + + + + + + + + + + + + +
+
+
+
+ +
+

3.4. Management Schema¶

+

This chapter documents the set of management entity types that define +configuration and management of a Dispatch Router. A management entity type has +a set of attributes that can be read, some attributes can also be +updated. Some entity types also support operations that can be called.

+

All management entity types have the following standard attributes:

+
+
type
+
The fully qualified type of the entity, +e.g. org.apache.qpid.dispatch.router. This document uses the short name +without the org.apache.qpid.dispatch prefix e.g. router. The dispatch +tools will accept the short or long name.
+
name
+
A user-generated identity for the entity. This can be used in other entities +that need to refer to the named entity.
+
identity
+
A system-generated identity of the entity. It includes +the short type name and some identifying information. E.g. log/AGENT or +listener/localhost:amqp
+
+

There are two main categories of management entity type.

+
+
Configuration Entities
+
Parameters that can be set in the configuration file +(see qdrouterd.conf(5) man page) or set at run-time with the qdmanage(8) +tool.
+
Operational Entities
+
Run-time status values that can be queried using qdstat(8) or qdmanage(8) tools.
+
+
+

3.4.1. Configuration Entities¶

+

Configuration entities define the attributes allowed in the configuration file +(see qdrouterd.conf(5)) but you can also create entities once the router is +running using the qdrouterd(8) tool’s create operation. Some entities can also +be modified using the update operation, see the entity descriptions below.

+
+

3.4.1.1. container¶

+

Attributes related to the AMQP container.

+

Operations allowed: READ

+
+
containerName (string, CREATE)
+
The name of the AMQP container. If not specified, the container name will be set to a value of the container’s choosing. The automatically assigned container name is not guaranteed to be persistent across restarts of the container.
+
workerThreads (integer, default=1, CREATE)
+
The number of threads that will be created to process message traffic and other application work (timers, non-amqp file descriptors, etc.) .
+
debugDump (path, CREATE)
+
A file to dump debugging information that can’t be logged normally.
+
+
+
+

3.4.1.2. router¶

+

Tracks peer routers and computes routes to destinations.

+

Operations allowed: READ

+
+
routerId (string, CREATE)
+
Router’s unique identity.
+
mode (One of [‘standalone’, ‘interior’, ‘edge’, ‘endpoint’], default=’standalone’, CREATE)
+
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.
+
area (string)
+
Unused placeholder.
+
helloInterval (integer, default=1, CREATE)
+
Interval in seconds between HELLO messages sent to neighbor routers.
+
helloMaxAge (integer, default=3, CREATE)
+
Time in seconds after which a neighbor is declared lost if no HELLO is received.
+
raInterval (integer, default=30, CREATE)
+
Interval in seconds between Router-Advertisements sent to all routers in a stable network.
+
raIntervalFlux (integer, default=4, CREATE)
+
Interval in seconds between Router-Advertisements sent to all routers during topology fluctuations.
+
remoteLsMaxAge (integer, default=60, CREATE)
+
Time in seconds after which link state is declared stale if no RA is received.
+
mobileAddrMaxAge (integer, default=60, CREATE)
+
Deprecated - This value is no longer used in the router.
+
addrCount (integer)
+
Number of addresses known to the router.
+
linkCount (integer)
+
Number of links attached to the router node.
+
nodeCount (integer)
+
Number of known peer router nodes.
+
+
+
+

3.4.1.3. listener¶

+

Listens for incoming connections to the router.

+

Operations allowed: CREATE, READ

+
+
addr (string, default=‘0.0.0.0’, CREATE)
+
IP address: ipv4 or ipv6 literal or a host name.
+
port (string, default=’amqp’, CREATE)
+
Port number or symbolic service name.
+
role (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’, CREATE)
+
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.
+
certDb (path, CREATE)
+
The path to the database that contains the public certificates of trusted certificate authorities (CA).
+
certFile (path, CREATE)
+
The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.
+
keyFile (path, CREATE)
+
The path to the file containing the PEM-formatted private key for the above certificate.
+
passwordFile (path, CREATE)
+
If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.
+
password (string, CREATE)
+
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.
+
saslMechanisms (string, required, CREATE)
+
Comma separated list of accepted SASL authentication mechanisms.
+
requirePeerAuth (boolean, default=True, CREATE)
+
Only for listeners using SSL. If set to ‘yes’, attached clients will be required to supply a certificate. If the certificate is not traceable to a CA in the ssl profile’s cert-db, authentication fails for the connection.
+
trustedCerts (path, CREATE)
+
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.
+
allowUnsecured (boolean, CREATE)
+
For listeners using SSL only. If set to ‘yes’ the listener will allow both SSL-secured clients and non-SSL clients to connect.
+
allowNoSasl (boolean, CREATE)
+
If set to ‘yes’, this option causes the listener to allow clients to connect even if they skip the SASL authentication protocol.
+
maxFrameSize (integer, default=65536, CREATE)
+
Defaults to 65536. 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.
+
+
+
+

3.4.1.4. connector¶

+

Establishes an outgoing connections from the router.

+

Operations allowed: CREATE, READ

+
+
addr (string, default=‘0.0.0.0’, CREATE)
+
IP address: ipv4 or ipv6 literal or a host name.
+
port (string, default=’amqp’, CREATE)
+
Port number or symbolic service name.
+
role (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’, CREATE)
+
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.
+
certDb (path, CREATE)
+
The path to the database that contains the public certificates of trusted certificate authorities (CA).
+
certFile (path, CREATE)
+
The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.
+
keyFile (path, CREATE)
+
The path to the file containing the PEM-formatted private key for the above certificate.
+
passwordFile (path, CREATE)
+
If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.
+
password (string, CREATE)
+
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.
+
saslMechanisms (string, required, CREATE)
+
Comma separated list of accepted SASL authentication mechanisms.
+
allowRedirect (boolean, default=True, CREATE)
+
Allow the peer to redirect this connection to another address.
+
maxFrameSize (integer, default=65536, CREATE)
+
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.
+
+
+
+

3.4.1.5. log¶

+

Configure logging for a particular module. You can use the UPDATE operation to change log settings while the router is running.

+

Operations allowed: UPDATE, READ

+
+
module (One of [‘ROUTER’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘DEFAULT’], required)
+
Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.
+
enable (string, default=’default’, required, UPDATE)
+
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.
+
timestamp (boolean, UPDATE)
+
Include timestamp in log messages.
+
source (boolean, UPDATE)
+
Include source file and line number in log messages.
+
output (string, UPDATE)
+
Where to send log messages. Can be ‘stderr’, ‘syslog’ or a file name.
+
+
+
+

3.4.1.6. fixedAddress¶

+

Establishes semantics for addresses starting with a prefix.

+

Operations allowed: CREATE, READ

+
+
prefix (string, required, CREATE)
+
The address prefix (always starting with ‘/’).
+
phase (integer, CREATE)
+
The phase of a multi-hop address passing through one or more waypoints.
+
fanout (One of [‘multiple’, ‘single’], default=’multiple’, CREATE)
+
One of ‘multiple’ or ‘single’. Multiple fanout is a non-competing pattern. If there are multiple consumers using the same address, each consumer will receive its own copy of every message sent to the address. Single fanout is a competing pattern where each message is sent to only one consumer.
+
bias (One of [‘closest’, ‘spread’], default=’closest’, CREATE)
+
Only if fanout is single. One of ‘closest’ or ‘spread’. Closest bias means that messages to an address will always be delivered to the closest (lowest cost) subscribed consumer. Spread bias will distribute the messages across subscribers in an approximately even manner.
+
+
+
+

3.4.1.7. waypoint¶

+

A remote node that messages for an address pass through.

+

Operations allowed: CREATE, READ

+
+
address (string, required, CREATE)
+
The AMQP address of the waypoint.
+
connector (string, required, CREATE)
+
The name of the on-demand connector used to reach the waypoint’s container.
+
inPhase (integer, default=-1, CREATE)
+
The phase of the address as it is routed _to_ the waypoint.
+
outPhase (integer, default=-1, CREATE)
+
The phase of the address as it is routed _from_ the waypoint.
+
+
+
+

3.4.1.8. linkRoutePattern¶

+

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.

+

Operations allowed: CREATE, READ

+
+
prefix (string, required, CREATE)
+
An address prefix to match against target and source addresses. For Dispatch 0.4, this pattern must be of the form ‘<text>.’ and matches any address that contains that prefix. Note that the prefix must end with a period (.) and must not contain any other periods.
+
connector (string, CREATE)
+
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.
+
+
+
+
+

3.4.2. Operational Entities¶

+

Operational entities provide statistics and other run-time attributes of the router. +The qdstat(8) tool provides a convenient way to query run-time statistics. +You can also use the general-purpose management tool qdmanage(8) to query +operational attributes.

+
+

3.4.2.1. org.amqp.management¶

+

The standard AMQP management node interface.

+

Operations allowed: QUERY, GET-TYPES, GET-ANNOTATIONS, GET-OPERATIONS, GET-ATTRIBUTES, GET-MGMT-NODES, READ

+
+

3.4.2.1.1. Operation GET-TYPES¶

+

Get the set of entity types and their inheritance relationships

+

Request properties:

+
+
entityType (string)
+
If set, restrict query results to entities that extend (directly or indirectly) this type
+
identity (string)
+
Set to the value self
+
+

Response body (map)A map where each key is an entity type name (string) and the corresponding value is the list of the entity types (strings) that it extends.

+
+
+

3.4.2.1.2. Operation GET-ATTRIBUTES¶

+

Get the set of entity types and the annotations they implement

+

Request properties:

+
+
entityType (string)
+
If set, restrict query results to entities that extend (directly or indirectly) this type
+
identity (string)
+
Set to the value self
+
+

Response body (map)A map where each key is an entity type name (string) and the corresponding value is a list (of strings) of attributes on that entity type.

+
+
+

3.4.2.1.3. Operation GET-OPERATIONS¶

+

Get the set of entity types and the operations they support

+

Request properties:

+
+
entityType (string)
+
If set, restrict query results to entities that extend (directly or indirectly) this type
+
identity (string)
+
Set to the value self
+
+

Response body (map)A map where each key is an entity type name (string) and the corresponding value is the list of operation names (strings) that it supports.

+
+
+

3.4.2.1.4. Operation GET-ANNOTATIONS¶

+

Request properties:

+
+
entityType (string)
+
If set, restrict query results to entities that extend (directly or indirectly) this type
+
identity (string)
+
Set to the value self
+
+

Response body (map)A map where each key is an entity type name (string) and the corresponding value is the list of annotations (strings) that it implements.

+
+
+

3.4.2.1.5. Operation QUERY¶

+

Query for attribute values of multiple entities.

+

Request body (map)A map containing the key attributeNames with value a list of (string) attribute names to return. If the list or the map is empty or the body is missing all attributes are returned.

+

Request properties:

+
+
count (integer)
+
If set, specifies the number of entries from the result set to return. If not set return all from offset
+
entityType (string)
+
If set, restrict query results to entities that extend (directly or indirectly) this type
+
identity (string)
+
Set to the value self
+
offset (integer)
+
If set, specifies the number of the first element of the result set to be returned.
+
+

Response body (map)A map with two entries. attributeNames is a list of the attribute names returned. results is a list of lists each containing the attribute values for a single entity in the same order as the names in the attributeNames entry. If an attribute name is not applicable for an entity then the corresponding value is null

+

Response properties:

+
+
count (integer)
+
Number of results returned
+
identity (string)
+
Set to the value self
+
+
+
+

3.4.2.1.6. Operation GET-MGMT-NODES¶

+

Get the addresses of all management nodes known to this router

+

Request properties:

+
+
identity (string)
+
Set to the value self
+
+

Response body (list)A list of addresses (strings) of management nodes known to this management node.

+
+
+
+

3.4.2.2. management¶

+

Qpid dispatch router extensions to the standard org.amqp.management interface.

+

Operations allowed: GET-SCHEMA, GET-JSON-SCHEMA, QUERY, GET-TYPES, GET-ANNOTATIONS, GET-OPERATIONS, GET-ATTRIBUTES, GET-MGMT-NODES, READ

+
+

3.4.2.2.1. Operation GET-SCHEMA-JSON¶

+

Get the qdrouterd schema for this router in JSON format

+

Request properties:

+
+
indent (integer)
+
Number of spaces to indent the formatted result. If not specified, the result is in minimal format, no unnecessary spaces or newlines.
+
identity (string)
+
Set to the value self
+
+

Response body (string)The qdrouter schema as a JSON string.

+
+
+

3.4.2.2.2. Operation GET-SCHEMA¶

+

Get the qdrouterd schema for this router in AMQP map format

+

Request properties:

+
+
identity (string)
+
Set to the value self
+
+

Response body (map)The qdrouter schema as a map.

+
+
+ +
+

3.4.2.4. router.address¶

+

AMQP address managed by the router.

+

Operations allowed: READ

+

inProcess (boolean)

+

subscriberCount (integer)

+

remoteCount (integer)

+

deliveriesIngress (integer)

+

deliveriesEgress (integer)

+

deliveriesTransit (integer)

+

deliveriesToContainer (integer)

+

deliveriesFromContainer (integer)

+
+
key (string)
+
Internal unique (to this router) key to identify the address
+
+
+
+

3.4.2.5. router.node¶

+

Remote router node connected to this router.

+

Operations allowed: READ

+
+
routerId (string)
+
Remote node identifier.
+
instance (integer)
+
Remote node boot number.
+
linkState (list)
+
List of remote node’s neighbours.
+
nextHop (string)
+
Neighbour ID of next hop to remote node from here.
+
validOrigins (list)
+
List of valid origin nodes for messages arriving via the remote node, used for duplicate elimination in redundant networks.
+
address (string)
+
Address of the remote node
+
routerLink (entityId)
+
Local link to remote node
+
+
+
+

3.4.2.6. connection¶

+

Connections to the router’s container.

+

Operations allowed: READ

+
+
container (string)
+
The container for this connection
+
+

state (One of [‘connecting’, ‘opening’, ‘operational’, ‘failed’, ‘user’])

+
+
host (string)
+
IP address and port number in the form addr:port.
+
dir (One of [‘in’, ‘out’])
+
Direction of connection establishment in or out of the router.
+
+

role (string)

+
+
sasl (string)
+
SASL mechanism used for authentication.
+
+
+
+

3.4.2.7. allocator¶

+

Memory allocation pool.

+

Operations allowed: READ

+

typeName (string)

+

typeSize (integer)

+

transferBatchSize (integer)

+

localFreeListMax (integer)

+

globalFreeListMax (integer)

+

totalAllocFromHeap (integer)

+

totalFreeToHeap (integer)

+

heldByThreads (integer)

+

batchesRebalancedToThreads (integer)

+

batchesRebalancedToGlobal (integer)

+
+
+
+

3.4.3. Management Operations¶

+

The qdstat(8) and qdmanage(8) tools allow you to view or modify management entity +attributes. They work by invoking management operations. You can invoke these operations +from any AMQP client by sending a message with the appropriate properties and body to the +$management address. The message should have a reply-to address indicating where the +response should be sent.

+
+

3.4.3.1. Operations for all entity types¶

+
+

3.4.3.1.1. Operation READ¶

+

Read attributes of an entity

+

Request properties:

+
+
type (string)
+
Type of desired entity.
+
name (string)
+
Name of desired entity. Must supply name or identity.
+
identity (string)
+
Identity of desired entity. Must supply name or identity.
+
+

Response body (map)Attributes of the entity

+
+
+

3.4.3.1.2. Operation CREATE¶

+

Create a new entity.

+

Request body (map, required)Attributes for the new entity. Can include name and/or type.

+

Request properties:

+
+
type (string, required)
+
Type of new entity.
+
name (string)
+
Name of new entity. Optional, defaults to identity.
+
+

Response body (map)Attributes of the entity

+
+
+

3.4.3.1.3. Operation UPDATE¶

+

Update attributes of an entity

+

Request body (map)Attributes to update for the entity. Can include name or identity.

+

Request properties:

+
+
type (string)
+
Type of desired entity.
+
name (string)
+
Name of desired entity. Must supply name or identity.
+
identity (string)
+
Identity of desired entity. Must supply name or identity.
+
+

Response body (map)Updated attributes of the entity

+
+
+

3.4.3.1.4. Operation DELETE¶

+

Delete an entity

+

Request properties:

+
+
type (string)
+
Type of desired entity.
+
name (string)
+
Name of desired entity. Must supply name or identity.
+
identity (string)
+
Identity of desired entity. Must supply name or identity.
+
+
+
+
+

3.4.3.2. Operations for org.amqp.management entity type¶

+
+

3.4.3.2.1. Operation GET-TYPES¶

+

Get the set of entity types and their inheritance relationships

+

Request properties:

+
+
entityType (string)
+
If set, restrict query results to entities that extend (directly or indirectly) this type
+
identity (string)
+
Set to the value self
+
+

Response body (map)A map where each key is an entity type name (string) and the corresponding value is the list of the entity types (strings) that it extends.

+
+
+

3.4.3.2.2. Operation GET-ATTRIBUTES¶

+

Get the set of entity types and the annotations they implement

+

Request properties:

+
+
entityType (string)
+
If set, restrict query results to entities that extend (directly or indirectly) this type
+
identity (string)
+
Set to the value self
+
+

Response body (map)A map where each key is an entity type name (string) and the corresponding value is a list (of strings) of attributes on that entity type.

+
+
+

3.4.3.2.3. Operation GET-OPERATIONS¶

+

Get the set of entity types and the operations they support

+

Request properties:

+
+
entityType (string)
+
If set, restrict query results to entities that extend (directly or indirectly) this type
+
identity (string)
+
Set to the value self
+
+

Response body (map)A map where each key is an entity type name (string) and the corresponding value is the list of operation names (strings) that it supports.

+
+
+

3.4.3.2.4. Operation GET-ANNOTATIONS¶

+

Request properties:

+
+
entityType (string)
+
If set, restrict query results to entities that extend (directly or indirectly) this type
+
identity (string)
+
Set to the value self
+
+

Response body (map)A map where each key is an entity type name (string) and the corresponding value is the list of annotations (strings) that it implements.

+
+
+

3.4.3.2.5. Operation QUERY¶

+

Query for attribute values of multiple entities.

+

Request body (map)A map containing the key attributeNames with value a list of (string) attribute names to return. If the list or the map is empty or the body is missing all attributes are returned.

+

Request properties:

+
+
count (integer)
+
If set, specifies the number of entries from the result set to return. If not set return all from offset
+
entityType (string)
+
If set, restrict query results to entities that extend (directly or indirectly) this type
+
identity (string)
+
Set to the value self
+
offset (integer)
+
If set, specifies the number of the first element of the result set to be returned.
+
+

Response body (map)A map with two entries. attributeNames is a list of the attribute names returned. results is a list of lists each containing the attribute values for a single entity in the same order as the names in the attributeNames entry. If an attribute name is not applicable for an entity then the corresponding value is null

+

Response properties:

+
+
count (integer)
+
Number of results returned
+
identity (string)
+
Set to the value self
+
+
+
+

3.4.3.2.6. Operation GET-MGMT-NODES¶

+

Get the addresses of all management nodes known to this router

+

Request properties:

+
+
identity (string)
+
Set to the value self
+
+

Response body (list)A list of addresses (strings) of management nodes known to this management node.

+
+
+
+

3.4.3.3. Operations for management entity type¶

+
+

3.4.3.3.1. Operation GET-SCHEMA-JSON¶

+

Get the qdrouterd schema for this router in JSON format

+

Request properties:

+
+
indent (integer)
+
Number of spaces to indent the formatted result. If not specified, the result is in minimal format, no unnecessary spaces or newlines.
+
identity (string)
+
Set to the value self
+
+

Response body (string)The qdrouter schema as a JSON string.

+
+
+

3.4.3.3.2. Operation GET-SCHEMA¶

+

Get the qdrouterd schema for this router in AMQP map format

+

Request properties:

+
+
identity (string)
+
Set to the value self
+
+

Response body (map)The qdrouter schema as a map.

+
+
+
+
+ + +
+
+
+ +
+
+ + + + \ No newline at end of file Added: qpid/site/input/releases/qpid-dispatch-0.4/book/technical_details.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-0.4/book/technical_details.html.in?rev=1673280&view=auto ============================================================================== --- qpid/site/input/releases/qpid-dispatch-0.4/book/technical_details.html.in (added) +++ qpid/site/input/releases/qpid-dispatch-0.4/book/technical_details.html.in Mon Apr 13 21:05:44 2015 @@ -0,0 +1,124 @@ + + + + + + + + 3. Technical Details and Specifications — Qpid Dispatch 0.4 documentation + + + + + + + + + + + + + + + + + + \ No newline at end of file Added: qpid/site/input/releases/qpid-dispatch-0.4/book/tools.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-0.4/book/tools.html.in?rev=1673280&view=auto ============================================================================== --- qpid/site/input/releases/qpid-dispatch-0.4/book/tools.html.in (added) +++ qpid/site/input/releases/qpid-dispatch-0.4/book/tools.html.in Mon Apr 13 21:05:44 2015 @@ -0,0 +1,142 @@ + + + + + + + + 2.2. Tools — Qpid Dispatch 0.4 documentation + + + + + + + + + + + + + +
+
+
+
+ +
+

2.2. Tools¶

+
+

2.2.1. qdstat¶

+

qdstat is a command line tool that lets you view the status of a +Dispatch Router. The following options are useful for seeing that the +router is doing:

+ ++++ + + + + + + + + + + + + + + + + + + + +
OptionDescription
-lPrint a list of AMQP links attached to the router. Links are +unidirectional. Outgoing links are usually associated with a subscription +address. The tool distinguishes between endpoint links and router +links. Endpoint links are attached to clients using the router. Router links +are attached to other routers in a network of routbers.
-aPrint a list of addresses known to the router.
-nPrint a list of known routers in the network.
-cPrint a list of connections to the router.
+

For complete details see the qdstat(8) man page and the output of +qdstat –help.

+
+
+

2.2.2. qdmanage¶

+

qdmanage is a general-purpose AMQP management client that allows you +to not only view but modify the configuration of a running dispatch +router.

+

For example you can query all the connection entities in the router:

+
$ qdrouterd query --type connection
+
+
+

To enable logging debug and higher level messages by default:

+
$ qdrouter update log/DEFAULT enable=debug+
+
+
+

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:

+
$ qdrouter create type=listener port=5555
+
+
+

Now you can connect to port 5555, for exampple:

+
$ qdrouterd query -b localhost:5555 --type listener
+
+
+

For complete details see the qdmanage(8) man page and the output of +qdmanage –help. Also for details of what can be configured see the +qdrouterd.conf(5) man page.

+
+
+ + +
+
+
+
+
+

Table Of Contents

+ + + + +
+
+
+
+ + + + \ No newline at end of file Added: qpid/site/input/releases/qpid-dispatch-0.4/book/using.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-0.4/book/using.html.in?rev=1673280&view=auto ============================================================================== --- qpid/site/input/releases/qpid-dispatch-0.4/book/using.html.in (added) +++ qpid/site/input/releases/qpid-dispatch-0.4/book/using.html.in Mon Apr 13 21:05:44 2015 @@ -0,0 +1,89 @@ + + + + + + + + 2. Using Qpid Dispatch — Qpid Dispatch 0.4 documentation + + + + + + + + + + + + + +
+ +
+
+ + +
+
+
+
+ + + + \ No newline at end of file Added: qpid/site/input/releases/qpid-dispatch-0.4/index.md URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-0.4/index.md?rev=1673280&view=auto ============================================================================== --- qpid/site/input/releases/qpid-dispatch-0.4/index.md (added) +++ qpid/site/input/releases/qpid-dispatch-0.4/index.md Mon Apr 13 21:05:44 2015 @@ -0,0 +1,68 @@ +;; +;; Licensed to the Apache Software Foundation (ASF) under one +;; or more contributor license agreements. See the NOTICE file +;; distributed with this work for additional information +;; regarding copyright ownership. The ASF licenses this file +;; to you under the Apache License, Version 2.0 (the +;; "License"); you may not use this file except in compliance +;; with the License. You may obtain a copy of the License at +;; +;; http://www.apache.org/licenses/LICENSE-2.0 +;; +;; Unless required by applicable law or agreed to in writing, +;; software distributed under the License is distributed on an +;; "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +;; KIND, either express or implied. See the License for the +;; specific language governing permissions and limitations +;; under the License. +;; + + + +# Qpid Dispatch 0.4 + +Dispatch is a lightweight AMQP message router library. More about +[Qpid Dispatch](@site-url@/components/dispatch-router/index.html). + +For a detailed list of the changes in this release, see the [release +notes](release-notes.html). + +## Downloads + +It's important to [verify the +integrity](@site-url@/download.html#verify-what-you-download) of the +files you download. + + || *Content* || *Download* || *Signature* || + || Dispatch router || [qpid-dispatch-0.4.tar.gz](http://archive.apache.org/dist/qpid/dispatch/0.4/qpid-dispatch-0.4.tar.gz) || [PGP](http://archive.apache.org/dist/qpid/dispatch/0.4/qpid-dispatch-0.4.tar.gz.asc) || + + +## Documentation + +
+
+- [Installing Qpid Dispatch](http://svn.apache.org/repos/asf/qpid/dispatch/trunk/README) +- [Dispatch router book](book/book.html) +
+
+- [qdrouterd](man/qdrouterd.html) - Router daemon +- [qdrouterd.conf](man/qdrouterd.conf.html) - Daemon configuration +- [qdstat](man/qdstat.html) - Get router statistics +- [qdmanage](man/qdmanage.html) - Manage the router +
+
+ + + +## More information + + - [All release artefacts](http://archive.apache.org/dist/qpid/dispatch/0.4) + - [Resolved issues in JIRA](https://issues.apache.org/jira/issues/?jql=project+%3D+DISPATCH+AND+fixVersion+%3D+%270.4%27+ORDER+BY+priority+DESC) + - [Source repository branch](http://svn.apache.org/repos/asf/qpid/dispatch/branches/0.4) + - [Source repository tag](http://svn.apache.org/repos/asf/qpid/dispatch/tags/0.4) \ No newline at end of file Added: qpid/site/input/releases/qpid-dispatch-0.4/man/qdmanage.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-0.4/man/qdmanage.html.in?rev=1673280&view=auto ============================================================================== --- qpid/site/input/releases/qpid-dispatch-0.4/man/qdmanage.html.in (added) +++ qpid/site/input/releases/qpid-dispatch-0.4/man/qdmanage.html.in Mon Apr 13 21:05:44 2015 @@ -0,0 +1,219 @@ + + + + + + + + qdmanage manual page — Qpid Dispatch 0.4 documentation + + + + + + + + + + + + + +
+
+
+
+ +
+

qdmanage manual page¶

+
+

Synopsis¶

+

qdmanage operation [options...] [arguments...]

+
+
+

Description¶

+

An AMQP management client for use with qdrouterd. Sends AMQP management +operations requests and prints the response in JSON format. This is a +generic AMQP management tool and can be used with any standard AMQP +managed endpoint, not just with qdrouter.

+
+
+

Operations¶

+
+
query [ATTR...]
+
Print the attributes named in the ATTR list or all attributes if +none are listed. Print attributes for all entities by default, use +–type, –name and –identity options to restrict what is printed.
+
create [ATTR=VALUE...]
+
Create a new entity with the specified attributes. With the –stdin +option, read attributes from stdin. This can be a JSON map of +attributes to create a single entity, or a JSON list of maps to +create multiple entitiees.
+
read
+
Print the attributes of an entity specified by the –name or +–identity options. With the –stdin option, create entities based +on data from stdin. This can be a JSON map of attributes to create a +single entity, or a JSON list of maps to create multiple entitiees.
+
update [ATTR=VALUE...]
+
Update the attributes of an existing entity. With the –stdin +option, read attributes from stdin. This can be a JSON map of +attributes to update a single entity, or a JSON list of maps to +update multiple entitiees. If an ATTR name is listed with no =VALUE, +that attribute will be deleted from the entity.
+
delete
+
Delete an entity specified by the –name or –identity options.
+
get-types [TYPE]
+
List entity types with their base types. With no arguments list all +types.
+
get-operations [TYPE]
+
List entity types with their operations. With no arguments list all +types.
+
get-attributes [TYPE]
+
List entity types with their attributes. With no arguments list all +types.
+
get-annotations [TYPE]
+
List entity types with their annotations. With no arguments list all +types.
+
get-mgmt-nodes
+
List all other known management nodes connected to this one.
+
get-json-schema [INDENT]
+
Get the router schema in JSON format. Optional integer indent for +formatted output.
+
get-log [INDENT]
+
Get recent log entries from the router.
+
+
+
+

Options¶

+

-h, –help +: show this help message and exit

+

–version +: Print version and exit.

+

–type=TYPE +: Type of entity to operate on.

+

–name=NAME +: Name of entity to operate on.

+

–identity=ID +: Identity of entity to operate on.

+

–indent=INDENT +: Pretty-printing indent. -1 means don’t pretty-print (default 2)

+

–stdin +: Read attributes as JSON map or list of maps from stdin.

+

–body=BODY +: JSON value to use as body of a non-standard operation call.

+

–properties=PROPERTIES +: JSON map to use as properties for a non-standard operation call.

+
+

Connection Options¶

+

-b URL, –bus=URL +: URL of the messaging bus to connect to (default 0.0.0.0)

+

-r ROUTER-ID, –router=ROUTER-ID +: Router to be queried

+

-t SECS, –timeout=SECS +: Maximum time to wait for connection in seconds (default 5)

+

–ssl-certificate=CERT +: Client SSL certificate (PEM Format)

+

–ssl-key=KEY +: Client SSL private key (PEM Format)

+

–ssl-trustfile=TRUSTED-CA-DB +: Trusted Certificate Authority Database file (PEM Format)

+

–ssl-password=PASSWORD +: Certificate password, will be prompted if not specifed.

+
+
+
+

Files¶

+
+
/usr/local/share/doc/qpid-dispatch/qdrouter.json
+
Management schema for qdrouterd.
+
/usr/local/share/doc/qpid-dispatch/qdrouter.json.readme.txt
+
Explanation of the management schema.
+
+
+
+

Examples¶

+

Show the logging configuration

+
qdmanage query --type=log
+
+
+

Enable debug and higher log messages by default:

+
qdmanage udpdate name=log/DEFAULT enable=debug+
+
+
+

Enable trace log messages only for the MESSAGE moudle and direct MESSAGE +logs to the file “test.log”

+
qdmanage udpdate name=log/MESSAGE enable=trace output=test.log
+
+
+

Set MESSAGE logging back to the default:

+
qdmanage udpdate name=log/MESSAGE enable=default
+
+
+

Disable MESSAGE logging:

+
qdmanage udpdate name=log/MESSAGE enable=none
+
+
+
+
+

See also¶

+

qdrouterd(8), qdstat(8), qdrouterd.conf(5)

+

http://qpid.apache.org/components/dispatch-router

+
+
+ + +
+
+
+
+
+

Table Of Contents

+ + + + +
+
+
+
+ + + + \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org For additional commands, e-mail: commits-help@qpid.apache.org