Dynamic Routing Guide

Informatica

Ultra Messaging (Version 6.12.1)



Dynamic Routing Guide



Multi-page HTML ]  |  [ PDF ]

Introduction  <-

© Copyright Informatica LLC 2004-2019.

This document explains design concepts and product implementation for the Ultra Messaging Dynamic Routing Option (DRO).

This software and documentation are provided only under a separate license agreement containing restrictions on use and disclosure. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica LLC.

A current list of Informatica trademarks is available on the web at https://www.informatica.com/trademarks.html.

Portions of this software and/or documentation are subject to copyright held by third parties. Required third party notices are included with the product.

This software is protected by patents as detailed at https://www.informatica.com/legal/patents.html.

The information in this documentation is subject to change without notice. If you find any problems in this documentation, please report them to us in writing at Informatica LLC 2100 Seaport Blvd. Redwood City, CA 94063.

Informatica products are warranted according to the terms and conditions of the agreements under which they are provided.
INFORMATICA LLC PROVIDES THE INFORMATION IN THIS DOCUMENT "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OR CONDITION OF NON-INFRINGEMENT.

The Ultra Messaging Dynamic Routing Option (DRO) consists of a daemon called the "UM Router" (or just the DRO) that bridges disjoint Topic Resolution Domains (TRDs) by effectively forwarding control and user traffic between them. Thus, the UM Router facilitates WAN routing where multicast routing capability is absent, possibly due to technical obstacles or enterprise policies. (FYI: a historical name for the UM Router is "Twenty Nine West Gateway Daemon" or "tnwgd". In the documentation you will see various abbreviations that include "tnwg".)


DRO Features  <-

The UM Router includes the following features:

  • Full bidirectional forwarding
  • Multi-hop forwarding
  • Mesh, loop, or alternate path UM Router configurations
  • Automatic rerouting around faults
  • Support for wildcard receivers
  • Support of Request/Response messages
  • Traffic filtering on multiple criteria
  • UM Router resilience
  • UMP persistence support
  • UM transport monitoring statistics
  • Web Monitoring
  • MIM and UIM forwarding

The following features are not fully supported in this release of the UM Router:

  • Queuing, both ULB and Brokered (including brokered JMS)
  • Multitransport Threads (MTT)

If you desire any of these features or any configuration or topology not presented in this document, please contact Informatica Ultra Messaging Support for possible alternatives.

Note
The UM Router is not directly supported on the OpenVMS® platform. UM applications running on the OpenVMS® platform, however, can use a UM Router running on a different platform, such as Microsoft Windows or Linux.


DRO Architecture  <-


UM Router Portals  <-

The UM Router uses interfaces, called portals, through which to pass data. A UM Router consists of two or more bidirectional portals that may be one of two types:

  • An endpoint portal, which communicates directly to a UM topic resolution domain (TRD; see Topic Resolution Domains).
  • A peer portal, which communicates via TCP with another peer portal (of another UM Router), allowing tunneling between UM Routers. Two peer portals connected to each other are referred to as companion peers, and utilize TCP connections for all data and control traffic (UDP is not supported for this). Compression and encryption can be applied to peer links.

The figure below shows a simple UM Router use case, where two UM Routers bridge an ISP to connect two TRDs.

portals.png

You configure portals in the UM Router's XML configuration file, specifying the portal's name, cost, UM Configuration, Access Control Lists and other attributes. See XML Configuration Reference.


Topic Resolution Domains  <-

Since topic resolution uses UDP, sources and receivers must have UDP connectivity to each other. When they do, we consider them to be in the same topic resolution domain (TRD). More specifically, UM contexts must satisfy the following two requirements to belong to the same topic resolution domain.

  • The contexts must use the same topic resolution UM configuration (i.e., resolver_* options are the same).
  • Contexts can communicate using the protocols required for both message transport and topic resolution traffic.

For example, two contexts on separate machines in the same LAN are not in the same topic resolution domain if they use different resolver addresses. See Multicast Resolver Network Options. A topic resolution domain can span a WAN if the UM contexts on each side of a firewall use the same UM configuration and the firewall allows UDP traffic (multicast or unicast) to pass.

Each endpoint portal must identify its associated topic resolution domain with a domain-id the UM Router's XML configuration file, as in the example below. All portals in the same TRD must have the same domain-id, and different TRDs networked together via UM Routers must have domain-ids unique to each other.

<portals>
<endpoint>
<name>LAN100</name>
<domain-id>100</domain-id>
<lbm-config>lan100.cfg</lbm-config>
</endpoint>
<endpoint>
<name>LAN200</name>
<domain-id>200</domain-id>
<lbm-config>lan200.cfg</lbm-config>
</endpoint>
</portals>


Proxy Sources and Proxy Receivers  <-

To resolve a topic across a UM Router (described in Basic UM Router Operation), the UM Router creates, within portals, proxy sources and proxy receivers (shown in the figure below by their dashed lines). These proxies behave like their UM counterparts; they resolve topics on the TRDs like normal sources and receivers, and the UM Router internally passes data from one portal to the other. However unlike regular sources, proxy sources do not have retransmission retention buffers normally used for Late Join or OTR.

proxies.png

Portals exist while the UM Router is running, however, the UM Router creates proxy sources and receivers during topic resolution and deletes them when the topic is retired.

Note
The proxy sources created by the UM Router are unrelated to proxy sources created by the UMP persistent store.


Routing  <-

In multiple-UM Router environments where more than one UM Router can provide possible messaging pathways, the UM Routers are able to cooperatively determine and establish optimal routes. Also, the UM Router network is able to detect link or other UM Router outages and automatically reroute traffic as needed. See Routing Topologies for more information.


UM Router Concepts  <-


Basic UM Router Operation  <-

The diagram below shows a UM Router bridging topic resolution domains TRD1 and TRD2, for topic AAA, in a direct link configuration. Endpoint E1 contains a proxy receiver for topic AAA and endpoint E2 has a proxy source for topic AAA.

basic_routing.png

To establish topic resolution in an already-running UM Router, the following sequence typically occurs in an example like the above figure.

  1. A receiver in TRD2 issues a TQR (Topic Query Record) for topic AAA.
  2. Portal E2 receives the TQR and passes information about topic AAA to all other portals in the UM Router. (In this case, E1 is the only other portal.)
  3. E1 immediately responds with three actions: a) create a proxy receiver for topic AAA, b) the new proxy receiver sends a TQR for AAA into TRD1, and c) E1 issues a Topic Interest message into TRD1 for the benefit of any other UM Routers that may be connected to that domain.
  4. A source for topic AAA in TRD1 sees the TQR and issues a TIR (Topic Information Record).
  5. E2 creates proxy source AAA, which then issues a TIR to TRD2. The receiver in TRD2 joins the transport, thus completing topic resolution.
  6. E1's AAA proxy receiver sees the TIR and requests that E2 (and any other interested portals in the UM Router, if there were any) create a proxy source for AAA.


Interest and Use Queries  <-

When a UM Router starts, its endpoint portals issue a brief series of Topic Resolution Request messages to their respective topic resolution domains. This provokes quiescent receivers (and wildcard receivers) into sending Use Query Responses, indicating interest in various topics. Each portal then records this interest.

dro_tr_1.png

After a UM Router has been running, endpoint portals issue periodic Topic Use Queries and Pattern Use Queries (collectively referred to as simply Use Queries). Use Query Responses from UM contexts confirm that the receivers for these topics indeed still exist, thus maintaining these topics on the interest list. Autonomous TQRs also refresh interest and have the effect of suppressing the generation of Use Queries.

dro_tr_2.png

In the case of multi-hop UM Router configurations, UM Routers cannot detect interest for remote contexts via Use Queries or TQRs. They do this instead via Interest Messages. An endpoint portal generates periodic interest messages, which are picked up by adjacent UM Routers (i.e., the next hop over), at which time interest is refreshed.

dro_tr_3.png

You can adjust intervals, limits, and durations for these topic resolution and interest mechanisms via UM Router configuration options (see XML Configuration Reference).


UM Router Keepalive  <-

To maintain a reliable connection, peer portals exchange UM Router Keepalive signals. Keepalive intervals and connection timeouts are configurable on a per-portal basis. You can also set the UM Router to send keepalives only when traffic is idle, which is the default condition. When both traffic and keepalives go silent at a portal ingress, the portal considers the connection lost and disconnects the TCP link. After the disconnect, the portal tries to reconnect. See refeatewaykeepalive.


Final Advertisements  <-

UM Router proxy sources on endpoint portals, when deleted, send out a series of final advertisements. A final advertisement tells any receivers, including proxy receivers on other UM Routers, that the particular source has gone away. This triggers EOS and clean-up activities on the receiver relative to that specific source, which causes the receiver to begin querying according to its topic resolution configuration for the sustaining phase of querying.

In short, final advertisements announce earlier detection of a source that has gone away, instead of transport timeout. This causes a faster transition to an alternative proxy source on a different UM Router if there is a change in the routing path.


More About Proxy Sources and Receivers  <-

The domain-id is used by Interest Messages and other internal and UM Router-to-UM Router traffic to ensure forwarding of all messages (payload and topic resolution) to the correct recipients. This also has the effect of not creating proxy sources/receivers where they are not needed. Thus, UM Routers create proxy sources and receivers based solely on receiver interest.

If more than one source sends on a given topic, the receiving portal's single proxy receiver for that topic receives all messages sent on that topic. The sending portal, however creates a proxy source for every source sending on the topic. The UM Router maintains a table of proxy sources, each keyed by an Originating Transport ID (OTID), enabling the proxy receiver to forward each message to the correct proxy source. An OTID uniquely identifies a source's transport session, and is included in topic advertisements.


Protocol Conversion  <-

When an application creates a source, it is configured to use one of the UM transport types. When a DRO is deployed, the proxy sources are also configured to use one of the UM transport types. Although users often use the same transport type for sources and proxy sources, this is not necessary. When different transport types are configured for source and proxy source, the DRO is performing a protocol conversion.

When this is done, it is very important to configure the transports to use the same maximum datagram size. If you don't, the DRO can drop messages which cannot be recovered through normal means. For example, a source in TRD1 can be configured for TCP, which has a default maximum datagram size of 65536. If a DRO's remote portal is configured to create LBT-RU proxy sources, that has a default maximum datagram size of 8192. If the source sends a user message of 10K, the TCP source will send it as a single fragment. The DRO will receive it and will attempt to forward it on an LBT-RU proxy source, but the 10K fragment is too large for LBT-RU's maximum datagram size, so the message will be dropped.

The solution is to override the default maximum datagram sizes to be the same. Informatica generally does not recommend configuring UDP-based transports for datagram sizes above 8K, so it is advisable to set the maximum datagram sizes of all transport types to 8192, like this:

context transport_tcp_datagram_max_size 8192
context transport_lbtrm_datagram_max_size 8192
context transport_lbtru_datagram_max_size 8192
context transport_lbtipc_datagram_max_size 8192
source transport_lbtsmx_datagram_max_size 8192

See configuration options: transport_tcp_datagram_max_size (context), transport_lbtrm_datagram_max_size (context), transport_lbtru_datagram_max_size (context), transport_lbtipc_datagram_max_size (context), and transport_lbtsmx_datagram_max_size (source).

Also see Message Fragmentation and Reassembly.

Final note: the resolver_datagram_max_size (context) option also needs to be made the same in all instances of UM, including DROs.


Multi-Hop Forwarding  <-

UM can resolve topics across a span of multiple UM Routers. Consider a simple example UM Router deployment, as shown in the following figure.

multi_hop.png

In this diagram, UM Router A has two endpoint portals connected to topic resolution domains TRD1 and TRD2. UM Router B also has two endpoint portals, which bridge TRD2 and TRD3. Endpoint portal names reflect the topic resolution domain to which they connect. For example, UM Router A endpoint E2 interfaces TRD2.

TRD1 has a source for topic AAA, and TRD3, an AAA receiver. The following sequence of events enables the forwarding of topic messages from source AAA to receiver AAA.

  1. Receiver AAA queries (issues a TQR).
  2. UM Router B, endpoint E3 (B-E3) receives the TQR and passes information about topic AAA to all other portals in the UM Router. In this case, B-E2 is the only other portal.
  3. In response, B-E2 creates a proxy receiver for AAA and sends a Topic Interest message for AAA into TRD2. The proxy receiver also issues a TQR, which in this case is ignored.
  4. UM Router A, endpoint E2 (A-E2) receives this Topic Interest message and passes information about topic AAA to all other portals in the UM Router. In this case, A-E1 is the only other portal.
  5. In response, A-E1 creates a proxy receiver for AAA and sends a Topic Interest message and TQR for AAA into TRD1.
  6. Source AAA responds to the TQR by sending a TIR for topic AAA. In this case, the Topic Interest message is ignored.
  7. The AAA proxy receiver created by A-E1 receives this TIR and requests that all UM Router A portals with an interest in topic AAA create a proxy source for AAA.
  8. In response, A-E2 creates a proxy source, which sends a TIR for topic AAA via TRD2.
  9. The AAA proxy receiver at B-E2 receives this TIR and requests that all UM Router B portals with an interest in topic AAA create a proxy source for AAA.
  10. In response, B-E3 creates a proxy source, which sends a TIR for topic AAA via TRD3. The receiver in TRD3 joins the transport.
  11. Topic AAA has now been resolved across both UM Routers, which forward all topic messages sent by source AAA to receiver AAA.


Routing Wildcard Receivers  <-

The UM Router supports topic resolution for wildcard receivers in a manner very similar to non-wildcard receivers. Wildcard receivers in a TRD issuing a WC-TQR cause corresponding proxy wildcard receivers to be created in portals, as shown in the following figure. The UM Router creates a single proxy source for pattern match.

wildcard.png


Forwarding Costs  <-

Forwarding a message through a UM Router incurs a cost in terms of latency, network bandwidth, and CPU utilization on the UM Router machine (which may in turn affect the latency of other forwarded messages). Transiting multiple UM Routers adds even more cumulative latency to a message. Other UM Router-related factors such as portal buffering, network bandwidth, switches, etc., can also add latency.

Factors other than latency contribute to the cost of forwarding a message. Consider a message that can be sent from one domain to its destination domain over one of two paths. A three-hop path over 1Gbps links may be faster than a single-hop path over a 100Mbps link. Further, it may be the case that the 100Mbps link is more expensive or less reliable.

You assign forwarding cost values on a per-portal basis. When summed over a path, these values determine the cost of that entire path. A network of UM Routers uses forwarding cost as the criterion for determining the best path over which to resolve a topic.


UM Router Routing  <-

UM Routers have an awareness of other UM Routers in their network and how they are linked. Thus, they each maintain a topology map, which is periodically confirmed and updated. This map also includes forwarding cost information.

Using this information, the UM Routers can cooperate during topic resolution to determine the best (lowest cost) path over which to resolve a topic or to route control information. They do this by totaling the costs of all portals along each candidate route, then comparing the totals.

For example, the following figure shows two possible paths from TRD1 to TRD2: A-C (total route cost of 11) and B-D (total route cost of 7). In this case, the UM Routers select path B-D.

routing.png

If a UM Router or link along path B-D should fail, the UM Routers detect this and reroute over path A-C. Similarly, if an administrator revises cost values along path B-D to exceed a total of 12, the UM Routers reroute to A-C.

If the UM Routers find more than one path with the same lowest total cost value, i.e., a "tie", they select the path based on a node-ID selection algorithm. Since administrators do not have access to node IDs, this will appear to be a pseudo-random selection.

Note
You cannot configure parallel paths (such as for load balancing or Hot failover), as the UM Routers always select the lowest-cost path and only the lowest-cost path for all data between two points. However, you can devise an exception to this rule by configuring the destinations to be in different TRDs. For example, you can create an HFX Receiver bridging two receivers in different TRD contexts. The UM Routers route to both TRDs, and the HFX Receiver merges to a single stream for the application.


Routing Topologies  <-

You can configure multiple UM Routers in a variety of topologies. Following are several examples.


Direct Link  <-

The Direct Link configuration uses a single UM Router to directly connect two TRDs. For a configuration example, see Direct Link Configuration.

direct_link.png


Single Link  <-

A Single Link configuration connects two TRDs using a UM Router on each end of an intermediate link. The intermediate link can be a "peer" link, or a transit TRD. For configuration examples, see Peer Link Configuration and Transit TRD Link Configuration.

single_link.png


Parallel Links  <-

Parallel Links offer multiple complete paths between two TRDs. However, UM will not load-balance messages across both links. Rather, parallel links are used for failover purposes. You can set preference between the links by setting the primary path for the lowest cost and standby paths at higher costs. For a configuration example, see Parallel Links Configuration.

parallel_links.png


Loops  <-

Loops let you route packets back to the originating UM Router without reusing any paths. Also, if any peer-peer links are interrupted, the looped UM Routers are able to find an alternate route between any two TRDs.

loops.png


Loop and Spur  <-

The Loop and Spur has a one or more UM Routers tangential to the loop and accessible only through a single UM Router participating in the loop. For a configuration example, see Loop and Spur Configuration.

loop_and_spur.png


Loop with Centralized TRD  <-

Adding a TRD to the center of a loop enhances its rerouting capabilities.

loop_central_trd.png


with centralized TRD  <-

A Star with a centralized TRD does not offer rerouting capabilities but does provide an economical way to join multiple disparate TRDs.

star_central_trd.png


Star with Centralized UM Router  <-

The Star with a centralized UM Router is the simplest way to bridge multiple TRDs. For a configuration example, see Star Configuration.

star_central_dro.png


Mesh  <-

The Mesh topology provides peer portal interconnects between many UM Routers, approaching an all-connected-to-all configuration. This provides multiple possible paths between any two TRDs in the mesh. Note that this diagram is illustrative of the ways the UM Routers may be interconnected, and not necessarily a practical or recommended application. For a configuration example, see Mesh Configuration.

mesh.png


Palm Tree  <-

The Palm Tree has a set of series-connected TRDs fanning out to a more richly meshed set of TRDs. This topology tends to pass more concentrated traffic over common links for part of its transit while supporting a loop, star, or mesh near its terminus.

palm_tree.png


Dumbbell  <-

Similar to the Palm Tree, the Dumbbell has a funneled route with a loop, star, or mesh topology on each end.

dumbell.png


Unsupported Configurations  <-

When designing UM Router networks, do not use any of the following topology constructs.

Two peer-to-peer connections between the same two UM Routers:

two_peers.png

Two endpoint connections from the same UM Router to the same TRD:

two_endpoints.png

Assigning two different Domain ID values (from different UM Routers) to the same TRD:

two_domainids.png


UM Feature Compatibility  <-

You must install the UM Dynamic Routing Option with its companion Ultra Messaging UMS, UMP, or UMQ product, and versions must match. While most UM features are compatible with the UM Router, some are not. Following is a table of features and their compatibilities with the UM Router.

UM Feature UM Router Compatible? Notes
Transport Acceleration Yes
Hot Failover (HF) Yes The UM Router can pass messages sent by HF publishers to HF receivers, however the UM Router itself cannot be configured to originate or terminate HF data streams.
Hot Failover across contexts (HFX) Yes
Late Join Yes
Message Batching Yes
Monitoring/Statistics Yes
Multicast Immediate Messaging (MIM) Yes
Multi-Transport Threads No
Off-Transport Recovery (OTR) Yes
Ordered Delivery Yes
Pre-Defined Messaging (PDM) Yes
Request/Response Yes
Self-Describing Messaging (SDM) Yes
Source Side Filtering Yes The UM Router supports transport source side filtering. You can activate this either at the originating TRD source, or at a downstream proxy source.
Transport LBT-IPC Yes
Transport LBT-RDMA Yes
Transport LBT-RM Yes
Transport LBT-RU Yes
Transport LBT-SMX Partial The UM router does not support proxy sources sending data via LBT-SMX. Any proxy sources configured for LBT-SMX will be converted to TCP, with a log message warning of the transport change. The UM Router does accept LBT-SMX ingress traffic to proxy receivers.
Transport TCP Yes
Transport TCP-LB Yes
JMS, via UMQ broker No
UM Spectrum Yes The UM Router supports UM Spectrum traffic, but you cannot implement Spectrum channels in UM Router proxy sources or receivers.
UMP Implicit/Explicit Acknowledgements Yes
UMP Persistent Store Yes
UMP Proxy Sources Yes
UMP Quorum Consensus Yes
UMP Registration ID/Session Management Yes
UMP Receiver-Paced Persistence (RPP) Yes
UMP Store Failover Yes
UMQ Brokered Queuing No
UMQ Ultra Load Balancing (ULB) No
Ultra Messaging Desktop Services (UMDS) Not for client connectivity to the UMDS server
Ultra Messaging Manager (UMM) Yes Not for UM Router management
UM SNMP Agent No
UMCache No
Wildcard Receivers Yes
Zero Object Delivery (ZOD) Yes


UM Router Implementation  <-


UM Router Configuration Overview  <-

When the UM Router daemon launches, it uses configuration option settings to determine its behavior and expectations. You specify option values in an XML configuration file, and reference the file from a command line argument.

Typically, you have a separate XML configuration file for each UM Router, which contains structured configuration elements that describe aspects of the UM Router. Within this XML configuration file, each endpoint portal definition points to a UM configuration file, which allow the portal to properly connect to its TRD.


Creating Applications for UM Router Compatibility  <-

When developing messaging applications that use Ultra Messaging and, in particular, the UM Router, please observe the following guidelines.


Naming and Identification  <-

An important part to successfully implementing UM Routers is prudent and error-free naming of TRDs, UM Routers, portals, etc., as well as correct identification of IP addresses and ports. It is good practice to first design the UM Router network by defining all connections and uniquely naming all UM Routers, portals, and TRDs. This works well as a diagram similar to some examples presented in this document. Include the following names and parameters in your design diagram:

  • TRD names and IDs
  • UM Router names
  • Portal names
  • Portal costs

For example, a well-prepared UM Router design could look like the following figure.

design_diagram.png


Portal Costs  <-

A network of UM Routers uses forwarding cost as the criterion for determining the best (lowest cost) path over which to resolve a topic and route data. Forwarding cost is simply the sum of all portal costs along a multi-UM Router path. Thus, total cost for the single path in the above example is 34. (Note that this is a non-real-world example, since costs are pointless without alternate routes to compare to.) You assign portal costs via the <cost> configuration option.

After the UM Router network calculates its paths, if a new lower-cost source becomes available, receivers switch to that path.


Access Control Lists (ACL)  <-

You can apply Access Control Lists (ACL) to a UM Router's portals to filter traffic by certain topics, transports, topic patterns, multicast groups, etc. You configure ACLs in a UM Router's XML configuration file, as children of an <endpoint> or <peer> portal. As traffic arrives at the portal, the portal either forwards it or rejects it per ACL criteria.

Inbound ACLs determine what information to forward to other portals in the UM Router, while Outbound ACLs determine (by topic) what information from other portals that this portal can send out the UM Router. Each portal (endpoint or peer) can have up to one inbound ACL and one outbound ACL.

acl.png

An ACL can contain one or more Access Control Entries (ACEs). ACEs are the filters that let you match (and accept or reject based on), criteria elements. For example, to accept only messages for topic ABC:

<acl>
<inbound>
<ace match="accept">
<topic>ABC</topic>
</ace>
</inbound>
</acl>

Possible ACE condition elements are:

  • <multicast-group/> *
  • <pcre-pattern> (PCRE wildcard patterns)
  • <regex-pattern> (Regex wildcard patterns)
  • <source-ip/> *
  • <tcp-source-port/> *
  • <topic>
  • <transport/> *
  • <udp-destination-port/> *
  • <udp-source-port/> *
  • <xport-id/> * (for LBT-IPC traffic)

These items apply to only inbound ACLs, and are ignored if used with an outbound ACL.

The above elements are all children of the <ace> element. When an ACL has multiple ACE entries, the UM Router goes down the list until it finds a match. It then accepts (forwards) or rejects, and is done with that ACL. An implicit "reject all" is at the end of every ACL, so the UM Router rejects any topic not matched. If you place multiple conditions within an ACE, the UM Router performs an "and" operation with them.

Note that the portal ignores a condition element if a) it is inbound-only and used in an outbound ACL, or b) it simply does not apply (such as a <udp-source-port/> if the transport is TCP).

Also note that ACLs can affect topic resolution traffic as well as user messages. They can, for example, block a topic (which prevents the creation of proxy receivers) and, thus, protect remote TRDs from unwanted queries and advertisements. This effect does not apply to wildcard receivers, however, because ACLs match only on discrete topics. Thus, while ACLs can operate on specific topic traffic derived from wildcard topic resolution, they cannot prevent pattern interest from propagating throughout the network.

Consider the following example, where we configure a portal to forward on specific topics. This example also illustrates the parent/child hierarchy for ACLs, ACEs, and ACE conditions.

<endpoint>
<name>LAN1</name>
<lbm-config>lan1.cfg</lbm-config>
<domain-id>1</domain-id>
<acl>
<inbound>
<ace match="accept">
<topic>ABC</topic>
</ace>
<ace match="accept">
<topic>DEF</topic>
<transport value=lbt-rm comparison=eq/>
</ace>
<ace match="accept">
<topic>GHI</topic>
</ace>
</inbound>
</acl>
</endpoint>

The above example shows each topic match in a separate ACE. When topic "GHI" arrives, the portal finds a match in the third ACE and forwards the topic. (Placing all three <topic>s in a single ACE would never match anything.) Also note that "DEF" is forwarded only if it uses an LBT-RM transport.

Since the behavior for multiple ACEs is "first match, then done", list ACEs in a specific-to-general order. For the example below, to forward topic "ABC123" but reject similar topics such as "ABCD123" or "ABCE123", list the ACE for "ABC123" first (as done below). If the ACE to reject "ABC.*123" was listed first, it would also (undesirably) match and reject "ABC123".

<endpoint>
<name>LAN1</name>
<lbm-config>lan1.cfg</lbm-config>
<domain-id>1</domain-id>
<acl>
<inbound>
<ace match="accept">
<topic>ABC123</topic>
</ace>
<ace match="reject">
<pcre-pattern>ABC.*123</pcre-pattern>
</ace>
</inbound>
</acl>
</endpoint>

You can also filter on certain transport types to accept multicast traffic but reject tcp traffic, as shown below.

<endpoint>
<name>LAN1</name>
<lbm-config>lan1.cfg</lbm-config>
<domain-id>1</domain-id>
<acl>
<inbound>
<ace match="accept">
<transport comparison="equal" value="lbtrm"/>
</ace>
<ace match="reject">
<transport comparison="equal" value="tcp"/>
</ace>
</inbound>
</acl>
</endpoint>


Timers and Intervals  <-

The UM Router offers a wide choice of timer and interval options to fine tune its behavior and performance. There are interactions and dependencies between some of these, and if misconfigured, they may cause race or failure conditions.

This manual's description of configuration options (see XML Configuration Reference), includes identification of such relationships. Please heed them.


Multicast Immediate Messaging Considerations  <-

Multicast Immediate Messages (MIMs) may pass through the UM Router. You cannot filter MIMs with Access Control Lists (ACL)-MIMs are forwarded to all TRDs. Informatica does not recommend using MIM for messaging traffic across the UM Router. MIM is intended for short-lived topics and applications that cannot tolerate a delay between source creation and the sending of the first message. See also Multicast Immediate Messaging.


Persistence Over the UM Router  <-

The UM Router supports UMP persistence by routing all necessary control and retransmission channels along with transport and topic resolution traffic. A typical implementation places the UMP persistent store in the same TRD as its registered source, as shown in the following figure.

persist_1.png

The UM Router also supports UMP implementations with the store located in a receiver's TRD, as shown in the following figure.

persist_2.png

Note: For more reliable operation when using UMP with UM Routers, Informatica recommends enabling OTR.


Late Join and Off-Transport Recovery  <-

The UM Router supports sources and receivers configured for Late Join and/or Off-Transport Recovery (OTR). Retransmission requests and subsequent retransmissions are conducted across the entire path through the UM Router network. A UM Router's proxy sources do not have Late-Join/OTR retention buffers and hence, are not able to provide recovered messages.


Topic Resolution Reliability  <-

Topic resolution can sometimes remain in a quiescent phase due to link interruption, preventing needed re-subscription topic resolution activity. Two ways you can address this are:


BOS and EOS Behavior Over the UM Router  <-

Through a network of UM Routers, a topic traverses a separate session for each link along its path. Thus, the UM Router reports BOS/EOSs based on the activity between the proxy source transport and its associated receiver. There is no end-to-end, application-to-application reporting of the data path state. Also, in the case of multiple topics being assigned to multiple sessions, topics may find themselves with different session mates from hop to hop. Of course, this all influences when, and for which transport session, a topic's BOSs and EOSs are issued.


UM Router Reliable Loss  <-

The UM router can create a situation where a "reliable" transport (TCP or LBT-IPC) can experience out-of-order message delivery.

The UM router can perform a "protocol conversion" function. I.e. an originating source can use a UDP-based protocol (LBT-RM or LBT-RU), but the proxy source for a remote receiver can use a "reliable" protocol (TCP or LBT-IPC). With a UDP-based protocol, messages can arrive to the UM Router network out of order, usually due to packet loss and recovery. However, when those out-of-order messages are forwarded across a "reliable" protocol (TCP or LBT-IPC), the receiver does not expect the sequence number gap, and immediately declares the out-of-order messages as unrecoverable loss. This, in spite of the fact that the missing message arrives shortly thereafter.

Starting in UM version 6.12, there are two new configuration options: transport_tcp_dro_loss_recovery_timeout (receiver) and transport_lbtipc_dro_loss_recovery_timeout (receiver), which modify the receiver's behavior. Instead of declaring a gap immediately unrecoverable, a delay is introduced which is similar to what a UDP-based receiver uses to wait for lost and retransmitted datagrams. If the missing message arrives within the delay time, the messages are delivered to application without loss.

Be aware that this functionality is only used with "reliable" protocols published by a UM Router's proxy source. If this delay feature is enabled, it will not apply to a "reliable" protocol that is received directly from the originating source.

Note however that you can get genuine gaps in the "reliable" data stream without recovery. For example, an overloaded UM Router can drop messages. Or a UM Router's proxy receiver can experience unrecoverable loss. In that case, the delay will have to expire before the missing messages are declared unrecoverable and subsequent data is delivered.

Attention
The delay times default to 0, which retains the pre-6.12 behavior of immediately declaring sequence number gaps unrecoverable. If you want this new behavior, you must configure the appropriate option.


Topology Configuration Examples  <-

Following are example configurations for a variety of UM Router topologies. These are the topology examples presented Routing Topologies.

In a real-world situation, you would have UM Router XML configuration files with their portal interfaces referencing complete UM configuration files. However, for these examples, the referred domain configuration files are simplified to contain only information relevant to the applicable UM Router. As part of this simplification, domain configuration files show interfaces for only one or two transport types.

Also, IP addresses are provided in some cases and omitted in other cases. This is because initiator peer portals need to know the IP addresses (and port numbers) of their corresponding acceptor portals to establish connections, whereas endpoint portals communicate via topic resolution and thus, do not need to know IP addresses.

Note
Before designing any UM Router implementations based on configurations or examples other than the types presented in this document, please contact your technical support representative.


Direct Link Configuration  <-

This example uses a UM Router to connect two topic resolution domain LANs.

cfg_direct_link.png

TRD1 Configuration

This UM configuration file, trd1.cfg, describes TRD1 and is referenced in the UM Router configuration file.

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.1.37.85

G1 Configuration

This UM Router configuration file defines two endpoint portals. In the daemon section, we have turned on monitoring for the all endpoint portals in the UM Router. The configuration specifies that all statistics be collected every 5 seconds and uses the lbm transport module to send statistics to your monitoring application, which runs in TRD1. See also UM Concepts, Monitoring UMS. The Web Monitor has also been turned on (port 15304) to monitor the performance of the UM Router.

<?xml version="1.0" encoding="UTF-8" ?>
<!-- G1 xml file- 2 endpoint portals -->
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
<lbm-license-file>lic0014.txt</lbm-license-file>
<monitor interval="5">
<transport-module module="lbm" options="config=trd1.cfg"/>
</monitor>
<web-monitor>*:15304</web-monitor>
</daemon>
<portals>
<endpoint>
<name>G1-TRD1</name>
<domain-id>1</domain-id>
<lbm-config>trd1.cfg</lbm-config>
</endpoint>
<endpoint>
<name>G1-TRD2</name>
<domain-id>2</domain-id>
<lbm-config>trd2.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

TRD2 Configuration

The configuration file trd2.cfg could look something like this.

# Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.2.37.85


Peer Link Configuration  <-

In cases where the UM Router connection between two TRDs must tunnel through a WAN or TCP/IP network, you can implement a UM Router at each end, as shown in the example below.

cfg_single_link.png

TRD1 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.1.37.85

G1 Configuration

Following is an example of two companion peer portals (on different UM Routers) configured via UM Router XML configuration file for a single TCP setup. Note that one must be an initiator and the other, an acceptor.

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<endpoint>
<name>G1-TRD1</name>
<domain-id>1</domain-id>
<lbm-config>TRD1.cfg</lbm-config>
</endpoint>
<peer>
<name>G1-G2</name>
<single-tcp>
<interface>10.30.3.100</interface>
<initiator>
<address>10.30.3.102</address>
<port>26123</port>
</initiator>
</single-tcp>
</peer>
</portals>
</tnw-gateway>

G2 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G2-G1</name>
<single-tcp>
<interface>10.30.3.102</interface>
<acceptor>
<listen-port>26123</listen-port>
</acceptor>
</single-tcp>
</peer>
<endpoint>
<name>G2-TRD2</name>
<domain-id>2</domain-id>
<lbm-config>TRD2.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

TRD2 Configuration

## LAN2 Configuration Options ##
context request_tcp_interface 10.33.3.0/24
context resolver_multicast_port 13965


Transit TRD Link Configuration  <-

This example, like the previous one, configures two localized UM Routers tunneling a connection between two TRDs, however, the UM Routers in this example are tunneling through an intermediate TRD. This has the added effect of connecting three TRDs.

cfg_transit_trd.png

TRD1 Configuration

## TRD1 Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.2.37.85

G1 Configuration

Following is an example of two companion peer portals (on different UM Routers) configured via UM Router XML configuration file for a single TCP setup. Note that one must be an initiator and the other, an acceptor.

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<endpoint>
<name>G1-TRD1</name>
<domain-id>1</domain-id>
<lbm-config>TRD1.cfg</lbm-config>
</endpoint>
<endpoint>
<name>G1-TRD2</name>
<domain-id>2</domain-id>
<lbm-config>TRD2.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

TRD2 Configuration

## TRD2 Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.2.37.85

G2 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<endpoint>
<name>G2-TRD2</name>
<domain-id>2</domain-id>
<lbm-config>TRD2.cfg</lbm-config>
</endpoint>
<endpoint>
<name>G2-TRD3</name>
<domain-id>3</domain-id>
<lbm-config>TRD3.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

TRD3 Configuration

## TRD3 Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.3.37.85


Parallel Links Configuration  <-

This example is similar in purpose to the single link, peer-to-peer example, except that a second pair of UM Routers is added as a backup route. You can set one of these as a secondary route by assigning a higher cost to portals along the path. In this case we set G3 and G4's portal costs to 5, forcing the lower route to be selected only if the upper (G1, G2) route fails.

Also note that we have configured the peer portals for the leftmost or odd-numbered UM Routers as initiators, and the rightmost or even-numbered UM Router peers as acceptors.

cfg_parallel.png

TRD1 Configuration

## TRD1 Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.1.37.85

G1 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<endpoint>
<name>G1-TRD1</name>
<domain-id>1</domain-id>
<cost>2</cost>
<lbm-config>TRD1.cfg</lbm-config>
</endpoint>
<peer>
<name>G1-G2</name>
<cost>2</cost>
<single-tcp>
<interface>10.30.3.101</interface>
<initiator>
<address>10.30.3.102</address>
<port>23745</port>
</initiator>
</single-tcp>
</peer>
</portals>
</tnw-gateway>

G2 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G2-G1</name>
<cost>2</cost>
<single-tcp>
<interface>10.30.3.102</interface>
<acceptor>
<listen-port>23745</listen-port>
</acceptor>
</single-tcp>
</peer>
<endpoint>
<name>G2-TRD2</name>
<domain-id>2</domain-id>
<cost>2</cost>
<lbm-config>TRD2.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

G3 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<endpoint>
<name>G3-TRD1</name>
<domain-id>1</domain-id>
<cost>5</cost>
<lbm-config>TRD1.cfg</lbm-config>
</endpoint>
<peer>
<name>G3-G4</name>
<cost>5</cost>
<single-tcp>
<interface>10.30.3.103</interface>
<initiator>
<address>10.30.3.104</address>
<port>23746</port>
</initiator>
</single-tcp>
</peer>
</portals>
</tnw-gateway>

G4 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G4-G3</name>
<cost>5</cost>
<single-tcp>
<interface>10.30.3.104</interface>
<acceptor>
<listen-port>23746</listen-port>
</acceptor>
</single-tcp>
</peer>
<endpoint>
<name>G4-TRD2</name>
<domain-id>2</domain-id>
<cost>5</cost>
<lbm-config>TRD2.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

TRD2 Configuration

## TRD2 Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.2.37.85


Loop and Spur Configuration  <-

cfg_loop_spur.png

TRD1 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.1.37.85

G1 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G1_to_G3</name>
<single-tcp>
<initiator>
<address>55.55.10.27</address>
<port>23801</port>
</initiator>
</single-tcp>
</peer>
<peer>
<name>G1_to_G2</name>
<single-tcp>
<initiator>
<address>55.55.10.26</address>
<port>23745</port>
</initiator>
</single-tcp>
</peer>
<endpoint>
<name>G1_to_TRD1</name>
<domain-id>1</domain-id>
<lbm-config>TRD1.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

G2 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G2_to_G4</name>
<single-tcp>
<initiator>
<address>55.55.10.28</address>
<port>23632</port>
</initiator>
</single-tcp>
</peer>
<peer>
<name>G2_to_G1</name>
<single-tcp>
<acceptor>
<listen-port>23745</listen-port>
</acceptor>
</single-tcp>
</peer>
<endpoint>
<name>G2_to_TRD2</name>
<domain-id>2</domain-id>
<lbm-config>TRD2.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

TRD2 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.2.37.85

TRD3 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.3.37.85

G3 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G3_to_G4</name>
<single-tcp>
<initiator>
<address>55.55.10.28</address>
<port>23754</port>
</initiator>
</single-tcp>
</peer>
<peer>
<name>G3_to_G1</name>
<single-tcp>
<acceptor>
<listen-port>23801</listen-port>
</acceptor>
</single-tcp>
</peer>
<endpoint>
<name>G3_to_TRD3</name>
<domain-id>3</domain-id>
<lbm-config>TRD3.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

G4 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G4_to_G3</name>
<single-tcp>
<acceptor>
<listen-port>23754</listen-port>
</acceptor>
</single-tcp>
</peer>
<endpoint>
<name>G4_to_TRD4</name>
<domain-id>4</domain-id>
<lbm-config>TRD4.cfg</lbm-config>
</endpoint>
<peer>
<name>G4_to_G2</name>
<single-tcp>
<acceptor>
<listen-port>23632</listen-port>
</acceptor>
</single-tcp>
</peer>
<peer>
<name>G4_to_G5</name>
<single-tcp>
<initiator>
<address>55.55.10.29</address>
<port>23739</port>
</initiator>
</single-tcp>
</peer>
</portals>
</tnw-gateway>

TRD4 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.4.37.85

G5 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<endpoint>
<name>G5_to_TRD5</name>
<domain-id>5</domain-id>
<lbm-config>TRD5.cfg</lbm-config>
</endpoint>
<peer>
<name>G5_to_G4</name>
<single-tcp>
<acceptor>
<listen-port>23739</listen-port>
</acceptor>
</single-tcp>
</peer>
</portals>
</tnw-gateway>

TRD5 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.5.37.85


Star Configuration  <-

This network consists of four TRDs. Within each TRD, full multicast connectivity exists. However, no multicast connectivity exists between the four TRDs.

cfg_star.png

G1 Configuration

The configuration for this UM Router also has transport statistics monitoring and the WebMonitor turned on.

<?xml version="1.0" encoding="UTF-8" ?>
<!-- UM GW xml file- 3 endpoint portals -->
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
<lbm-license-file>lic0014.txt</lbm-license-file>
<monitor interval="5">
<transport-module module="lbm" options="config=trd1.cfg"/>
</monitor>
<web-monitor>*:15304</web-monitor>
</daemon>
<portals>
<endpoint>
<name>G1_to_TRD1</name>
<domain-id>1</domain-id>
<lbm-config>trd1.cfg</lbm-config>
</endpoint>
<endpoint>
<name>G1_to_TRD2</name>
<domain-id>2</domain-id>
<lbm-config>trd2.cfg</lbm-config>
</endpoint>
<endpoint>
<name>G1_to_TRD3</name>
<domain-id>3</domain-id>
<lbm-config>trd3.cfg</lbm-config>
</endpoint>
<endpoint>
<name>G1_to_TRD4</name>
<domain-id>4</domain-id>
<lbm-config>trd4.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

TRD1 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.1.37.85

TRD2 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.2.37.85

TRD3 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.3.37.85

TRD4 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.4.37.85


Mesh Configuration  <-

The mesh topology utilizes many connections between many nodes, to provide a variety of alternate routes. However, meshes are not the best solution in many cases, as unneeded complexity can increase the chance for configuration errors or make it more difficult to trace problems.

cfg_mesh.png

TRD1 Configuration

### Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.1.37.85

G1 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G1_to_G5</name>
<single-tcp>
<initiator>
<address>55.55.10.105</address>
<port>23880</port>
</initiator>
</single-tcp>
</peer>
<peer>
<name>G1_to_G4</name>
<single-tcp>
<initiator>
<address>55.55.10.104</address>
<port>23801</port>
</initiator>
</single-tcp>
</peer>
<endpoint>
<name>G1_to_TRD1</name>
<domain-id>1</domain-id>
<lbm-config>TRD1.cfg</lbm-config>
</endpoint>
<endpoint>
<name>G1_to_TRD2</name>
<domain-id>2</domain-id>
<lbm-config>TRD2.cfg</lbm-config>
</endpoint>
<peer>
<name>G1_to_G2</name>
<single-tcp>
<initiator>
<address>55.55.10.102</address>
<port>23745</port>
</initiator>
</single-tcp>
</peer>
</portals>
</tnw-gateway>

G2 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G2_to_G5</name>
<single-tcp>
<initiator>
<address>55.55.10.105</address>
<port>23608</port>
</initiator>
</single-tcp>
</peer>
<peer>
<name>G2_to_G4</name>
<single-tcp>
<acceptor>
<listen-port>23831</listen-port>
</acceptor>
</single-tcp>
</peer>
<peer>
<name>G2_to_G1</name>
<single-tcp>
<acceptor>
<listen-port>23745</listen-port>
</acceptor>
</single-tcp>
</peer>
<peer>
<name>G2_to_G3</name>
<single-tcp>
<initiator>
<address>55.55.10.103</address>
<port>23632</port>
</initiator>
</single-tcp>
</peer>
<endpoint>
<name>G2_to_TRD2</name>
<domain-id>2</domain-id>
<lbm-config>TRD2.cfg</lbm-config>
</endpoint>
</portals>
</tnw-gateway>

G3 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G3_to_G5</name>
<single-tcp>
<initiator>
<address>55.55.10.105</address>
<port>23739</port>
</initiator>
</single-tcp>
</peer>
<peer>
<name>G3_to_G4</name>
<single-tcp>
<acceptor>
<listen-port>23754</listen-port>
</acceptor>
</single-tcp>
</peer>
<peer>
<name>G3_to_G2</name>
<single-tcp>
<acceptor>
<listen-port>23632</listen-port>
</acceptor>
</single-tcp>
</peer>
</portals>
</tnw-gateway>

TRD2 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.2.37.85

TRD3 Configuration

## Global Configuration Options ##
context request_tcp_interface 10.29.3.0/24
context resolver_multicast_port 13965
context resolver_multicast_interface 10.29.3.0/24
context resolver_multicast_address 225.3.37.85

G4 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G4_to_G5</name>
<single-tcp>
<initiator>
<address>55.55.10.105</address>
<port>23580</port>
</initiator>
</single-tcp>
</peer>
<endpoint>
<name>G4_to_TRD1</name>
<domain-id>1</domain-id>
<lbm-config>TRD1.cfg</lbm-config>
</endpoint>
<endpoint>
<name>G4_to_TRD3</name>
<domain-id>3</domain-id>
<lbm-config>TRD3.cfg</lbm-config>
</endpoint>
<peer>
<name>G4_to_G1</name>
<single-tcp>
<acceptor>
<listen-port>23801</listen-port>
</acceptor>
</single-tcp>
</peer>
<peer>
<name>G4_to_G3</name>
<single-tcp>
<initiator>
<address>55.55.10.103</address>
<port>23754</port>
</initiator>
</single-tcp>
</peer>
<peer>
<name>G4_to_G2</name>
<single-tcp>
<initiator>
<address>55.55.10.102</address>
<port>23831</port>
</initiator>
</single-tcp>
</peer>
</portals>
</tnw-gateway>

G5 Configuration

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
</daemon>
<portals>
<peer>
<name>G5_to_G4</name>
<single-tcp>
<acceptor>
<listen-port>23580</listen-port>
</acceptor>
</single-tcp>
</peer>
<peer>
<name>G5_to_G1</name>
<single-tcp>
<acceptor>
<listen-port>23880</listen-port>
</acceptor>
</single-tcp>
</peer>
<peer>
<name>G5_to_G3</name>
<single-tcp>
<acceptor>
<listen-port>23739</listen-port>
</acceptor>
</single-tcp>
</peer>
<peer>
<name>G5_to_G2</name>
<single-tcp>
<acceptor>
<listen-port>23608</listen-port>
</acceptor>
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Using UM Configuration Files with the UM Router  <-

Within the UM Router configuration file, the endpoint portal's <lbm-config> element lets you import configurations from either a plain text or XML UM configuration file. However, using the XML type of UM configuration files provides the following advantages over plain text UM configuration files:

  • You can apply UM attributes per topic and/or per context.
  • You can apply attributes to all portals on a particular UM Router using a UM XML template (instead of individual portal settings).
  • Using UM XML templates to set options for individual portals lets the UM Router process these settings in the <daemon> element instead of within each portal's configuration.


Setting Individual Endpoint Options  <-

When setting endpoint options, first name the context of each endpoint in the UM Router's XML configuration file.

<portals>
<endpoint>
<name>Endpoint_1</name>
<domain-id>1</domain-id>
<source-context-name>G1_E1</source-context-name>
<lbm-attributes>
<option name="request_tcp_interface" scope="context" value="10.29.4.0/24"/>
</lbm-attributes>
</endpoint>
<endpoint>
<name>G1-TRD2</name>
<domain-id>2</domain-id>
<receiver-context-name>G1_E2</source-context-name>
<lbm-attributes>
<option name="request_tcp_interface" scope="context" value="10.29.5.0/24" />
</lbm-attributes>
</endpoint>
</portals>

Then assign configuration templates to those contexts in the UM XML configuration file.

<application name="dro1" template="global">
<contexts>
<context name="G1_E1" template="G1-E1-options">
<sources />
</context>
<context name="G1_E2" template="G1-E2-options">
<sources />
</context>
</contexts>
</application>

You specify the unique options for each of this UM Router's two endpoints in the UM XML configuration <templates> section used for G1-E1-options and G1-E2-options.


UM Router and UM XML Configuration Use Cases  <-

One advantage of using UM XML configuration files with the UM Router is the ability to assign unique UM attributes to the topics and contexts used for the proxy sources and receivers (which plain text UM configuration files cannot do). The following example shows how to assign a different LBTRM multicast address to a source based on its topic.

Create a new UM XML configuration template for the desired topic name.

<template name="AAA-template">
<options type="source">
<option name="transport_lbtrm_multicast_address"
default-value="225.2.37.88"/>
</options>
</template>

Then include this template in the <application> element associated with the UM Router.

<application name="dro1" template="global-options">
<contexts>
<context>
<sources template="source-options">
<topic topicname="AAA" template="AAA-template" />
</sources>
</context>
</contexts>
</application>

It is also possible to assign UM attributes directly in the <application> tag. For example, the following specifies that a particular topic should use an LBT-RU transport.

<application name="dro1" template="dro1-common">
<contexts>
<context>
<sources template="source-template">
<topic topicname="LBTRU_TOPIC">
<options type="source">
<option name="transport" default-value="lbtru" />
</options>
</topic>
</sources>
</context>
</contexts>
</application>


Sample Configuration  <-

The following sample configuration incorporates many of the examples mentioned above. The UM Router applies options to all UM objects created. The UM XML configuration file overwrites these options for two specific topics. The first topic, LBTRM_TOPIC, uses a different template to change its transport from TCP to LBTRM, and to set an additional property. The second topic, LBTRU_TOPIC, also changes its transport from TCP to a new value. However, its new attributes are applied directly in its associated topic tag, instead of referencing a template. In addition, this sample configuration assigns the rm-source template to all sources and receivers associated with the context endpt_1.


XML UM Configuration File  <-

<?xml version="1.0" encoding="UTF-8" ?>
<um-configuration version="1.0">
<templates>
<template name="dro1-common">
<options type="source">
<option name="transport" default-value="tcp" />
</options>
<options type="context">
<option name="request_tcp_interface" default-value="10.29.5.6" />
<option name="transport_tcp_port_low" default-value="4400" />
<option name="transport_tcp_port_high" default-value="4500" />
<option name="resolver_multicast_address" default-value="225.2.37.88"/>
</options>
</template>
<template name="rm-source">
<options type="source">
<option name="transport" default-value="lbtrm" />
<option name="transport_lbtrm_multicast_address" default-value="225.2.37.89"/>
</options>
</template>
</templates>
<applications>
<application name="dro1" template="dro1-common">
<contexts>
<context>
<sources>
<topic topicname="LBTRM_TOPIC" template="rm-source" />
<topic topicname="LBTRU_TOPIC">
<options type="source">
<option name="transport" default-value="lbtru" />
<option name="resolver_unicast_daemon" default-value="10.29.5.1:1234" />
</options>
</topic>
</sources>
</context>
<context name="endpt_1">
<sources template="rm-source"/>
</context>
</contexts>
</application>
</applications>
</um-configuration>


XML UM Router Configuration File  <-

This UM Router uses the above XML UM configuration file, sample-config.xml, to set its UM options. It has three endpoints, one of which has the context endpt_1.

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
<xml-config>sample-config.xml</xml-config>
</daemon>
<portals>
<endpoint>
<name>Endpoint_1</name>
<domain-id>1</domain-id>
<lbm-attributes>
<option name="context_name" scope="context" value="endpt_1" />
<option name="request_tcp_interface" scope="context"
value="10.29.4.0/24"/>
</lbm-attributes>
</endpoint>
<endpoint>
<name>Endpoint_2</name>
<domain-id>2</domain-id>
<lbm-attributes>
<option name="request_tcp_interface" scope="context"
value="10.29.5.0/24"/>
</lbm-attributes>
</endpoint>
<endpoint>
<name>Endpoint_3</name>
<domain-id>3</domain-id>
<lbm-attributes>
<option name="request_tcp_interface" scope="context"
value="10.29.6.0/24"/>
</lbm-attributes>
</endpoint>
</portals>
</tnw-gateway>


Running the UM Router Daemon  <-

To run the UM Router, ensure the following:

  • Library environment variable paths are set correctly (LD_LIBRARY_PATH)
  • The license environment variable LBM_LICENSE_FILENAME points to a valid UM Router license file.
  • The configuration file is error free.

Typically, you run the UM Router with one configuration file argument, for example:

tnwgd gw1-config.xml

(FYI: "tnwgd" stands for "Twenty Nine West Gateway Daemon", a historical name for the UM Router.)

The UM Router logs version information on startup. The following is an example of this information:

Version 6.0 Build: Sep 26 2012, 00:31:33 (UMS 6.0 [UMP-6.0] [UMQ-6.0] [64-bit] Build: Sep 26 2012, 00:27:17 ( DEBUG license LBT-RM LBT-RU LBT-IPC LBT-RDMA ) WC[PCRE 7.4 2007-09-21, regex, appcb] HRT[gettimeofday()])


Man Pages for UM Router  <-

Help for the UM Router command line can be obtained by entering "tnwgd -h". Brief help for the UM Router configuration file can be obtained by entering "tnwgd -d", which prints the DTD contents. (FYI: "tnwgd" stands for "Twenty Nine West Gateway Daemon", a historical name for the UM Router.)

There are two executables for the UM Router, each with it's own man page:


Tnwgd Man Page  <-

The tnwgd executable can be run interactively from a command prompt or from a script/batch file. For use as a Windows Service, see Tnwgds Man Page.

Purpose: UM Gateway daemon
Usage: tnwgd [options] configfile
Available options:
-d, --dump-dtd dump the configuration DTD to stdout
-h, --help display this help and exit
-v, --validate validate config-file then exit
-f, --detach detach from terminal
Description
UM Router services are provided by tnwgd. (FYI: "tnwgd" stands for "Twenty Nine West Gateway Daemon", a historical name for the UM Router.) A UM Router configuration file is required. The contents and format of the configuration file are documented separately.
The DTD used to validate a configuration file is dumped to standard output with -d or --dump-dtd. After dumping the DTD, tnwgd exits instead of providing UM Router services as usual. See UM Router Configuration DTD for the DTD with comments removed.
To validate the configuration file, use either the -v or --validate options. After attempting validation, tnwgd exits instead of providing UM Router services as usual. The exit status will be 0 for a configuration file successfully validated by the DTD, and non-zero otherwise.
Command line help is available with -h or --help.
Unix Only
Tnwgd normally remains attached to the controlling terminal and runs until interrupted. If the -f or --detach option is given on Unix, tnwgd instead forks and detaches the child process from the controlling terminal, and the parent exits immediately.
Exit Status
The exit status from tnwgd is 0 for success and some non-zero value for failure.


Tnwgds Man Page  <-

The tnwgds executable is for use as a Windows Service. The service can be installed as a service by the Windows package installer.

Alternatively, the tnwgds executable can be run interactively from a command prompt to install the service or to change certain configuration elements. See UM Daemons as Windows Services for more details.

Purpose: UM Gateway daemon
Usage: tnwgds [options] [configfile]
Available options:
-d, --dump-dtd dump the configuration DTD to stdout
-h, --help display this help and exit
-v, --validate validate config-file then exit
-s, --service=install install the service passing configfile
-s, --service=remove delete/remove the service
-s, --service=config update configfile info to use configfile passed
-e, --event-log-level Update/set service logging level. This is the minimum logging
level to send to the Windows event log. Valid values are:
NONE - Send no events
INFO
WARN - default
ERROR
Description
UM Router services are provided by tnwgds Windows Service. (FYI: "tnwgds" stands for "Twenty Nine West Gateway Daemon Service", a historical name for the UM Router.) A UM Router configuration file is required. The contents and format of the configuration file are documented separately.
The configfile parameter is used interactively to configure the UM Router's XML configuration file.
The DTD used to validate a configuration file is dumped to standard output with -d or --dump-dtd. After dumping the DTD, tnwgd exits instead of providing UM Router services as usual. See UM Router Configuration DTD for the DTD with comments removed.
To validate the configuration file, use either the -v or --validate options. After attempting validation, tnwgd exits instead of providing UM Router services as usual. The exit status will be 0 for a configuration file successfully validated by the DTD, and non-zero otherwise.
The -s is used interactively to control the installation of the Windows service. The -e is used interactively to configure the logging threshold for writing to the Windows Event Log. See UM Daemons as Windows Services for more details.
Command line help is available with -h or --help.
Exit Status
The exit status from tnwgd is 0 for success and some non-zero value for failure.


XML Configuration Reference  <-

For controlling/configuring each UM Router, you use a XML UM Router configuration file, which also contains references to UM configuration files to extract needed information about the TRDs interfaced by endpoint portals. This chapter includes a lookup reference for the XML UM Router configuration file's elements and DTD.

An XML UM Router configuration file follows standard XML conventions. Element declarations or a pointer to a DTD file are not needed, as these are handled by the UM Router.


File Structure  <-

An XML UM Router configuration file generally comprises two primary elements: <daemon> and <portals>. Organized and contained within these are option value assignments. <daemon> sub-containers let you set options global to the UM Router. <portals> sub-containers let you configure each portal in the UM Router individually.

In general, the order of the elements is important. Please refer to the examples and ensure proper element ordering.

XML UM Router configuration files use the high-level structure shown in the following example. This example includes only some container elements, and only some options.

<?xml version="1.0" encoding="UTF-8" ?>
<tnw-gateway version="1.0">
<daemon>
<log type="console"/>
<uid>0</uid>
<gid>0</gid>
<pidfile>/path/file.pid</pidfile>
<lbm-license-file>/path/file.lic</lbm-license-file>
<topicmap/>
<patternmap/>
<monitor>
<transport-module/>
<format-module/>
</monitor>
<web-monitor>*:21000</web-monitor>
<propagation-delay/>
<xml-config>sample-config.xml</xml-config>
</daemon>
<portals>
<endpoint>
<name>Endpoint_1</name>
<domain-id>1</domain-id>
<cost>1</cost>
<lbm-config>endpoint2.cfg</lbm-config>
<lbm-attributes>
<option name="context_name" scope="context" value="endpt_1" />
</lbm-attributes>
<acl>
<inbound>
<ace match="accept">
<topic>ABC123</topic>
<pcre-pattern >pattern</pcre-pattern >
<regex-pattern >pattern</regex-pattern >
<transport/>
<source-ip/>
<multicast-group/>
<udp-source-port/>
<udp-destination-port/>
<tcp-source-port/>
<xport-id/>
</ace>
</inbound>
<outbound>
<ace match="accept">
<topic>ABC123</topic>
<pcre-pattern >pattern</pcre-pattern >
<regex-pattern >pattern</regex-pattern >
<transport/>
<source-ip/>
<multicast-group/>
<udp-source-port/>
<udp-destination-port/>
<tcp-source-port/>
<xport-id/>
</ace>
</outbound>
</acl>
</endpoint>
<peer>
<name>Peer_1</name>
<cost>1</cost>
<single-tcp>
<interface>
<receive-buffer>
<send-buffer>
<keepalive>
<nodelay>
<initiator>
<address>
<port>
</initiator>
<acceptor>
<listen-port>
</acceptor>
</single-tcp>
<max-queue>
<max-datagram>
<batching>
<min-length>
<batch-interval>
</batching>
<lbm-config>peer1.cfg</lbm-config>
<lbm-attributes>
<option name="name" scope="scope" value="value" />
</lbm-attributes>
<acl> (see above)
<topic-purge>
<topic-interest-generate>
<topic-domain-activity>
<pattern-purge>
<pattern-interest-generate>
<pattern-domain-activity>
<topic-use-check/>
<pattern-use-check>
<source-context-name>
<receiver-context-name>
<sqn-window>
<context-query>
<gateway-keepalive>
</peer>
</portals>
</tnw-gateway>


Elements Reference  <-



Router Element "<tnw-gateway>"  <-

Container for all options residing in the XML UM Router configuration file. This is the top-level element.

XML Attributes:

Attribute Description Valid Values Default Value
version The version of the DTD, which is currently. (This is not the product version.) "1.0" - Current version of DTD. (no default; must be specified)

Example:

<tnw-gateway version="1.0">
<daemon>
...
</daemon>
<portals>
...
</portals>
</tnw-gateway>


Router Element "<portals>"  <-

Container for all endpoint and peer portal configuration information.

Example:

<tnw-gateway version="1.0">
<portals>
<daemon>
...
</daemon>
<endpoint>
...
</endpoint>
...
</portals>
</tnw-gateway>


Router Element "<peer>"  <-

Container element for all configuration options of a single peer portal.

Example:

<tnw-gateway version="1.0">
<portals>
<daemon>
...
</daemon>
<peer>
</peer>
...
</portals>
</tnw-gateway>


Router Element "<publishing-interval>"  <-

Configures the rate at which Daemon Statistics messages are published. See Daemon Statistics for general information on Daemon Statistics.

Example:

<tnw-gateway version="1.0">
<daemon>
<daemon-monitor topic="umrouter.1">
<lbm-config>/path/umrouter_monitor.cfg</lbm-config>
<publishing-interval>
<group name="default" ivl="5">
<group name="gateway-config" ivl="30">
<group name="portal-config" ivl="30">
</publishing-interval>
...
</daemon-monitor>
</daemon>
...
</tnw-gateway>


Router Element "<group>"  <-

Configures the rate at which one particular grouping of Daemon Statistics messages are published. See Daemon Statistics for general information on Daemon Statistics.

XML Attributes:

Attribute Description Valid Values Default Value
name Name of statistics group being configured. "default" - Sets a default interval for all message types.
"gateway-config" - Sets the interval for messages of type tnwg_dstat_gatewaycfg_msg_t.
"route-manager-topology" - Sets the interval for messages of types tnwg_rm_stat_grp_msg_t.
"malloc-info" - Sets the interval for messages of type tnwg_dstat_mallinfo_msg_t.
"portal-config" - Sets the interval for messages of type tnwg_pcfg_stat_grp_msg_t.
"portal-stats" - Sets the interval for messages of type tnwg_dstat_portalstats_msg_t
(no default; must be specified)
ivl Time, in seconds, between publishing the statistics group being configured. string (no default; must be specified)

Example:

<tnw-gateway version="1.0">
<daemon>
<daemon-monitor topic="umrouter.1">
<lbm-config>/path/umrouter_monitor.cfg</lbm-config>
<publishing-interval>
<group name="default" ivl="5">
<group name="gateway-config" ivl="30">
<group name="portal-config" ivl="30">
</publishing-interval>
...
</daemon-monitor>
</daemon>
...
</tnw-gateway>


Router Element "<gateway-keepalive>"  <-

Contains parameters for the keepalive signals sent from this peer portal. This is a UM Router-level keepalive, not to be confused with the TCP-level <keepalive> element.

  • Cardinality: 0 .. 1
  • Parent: <peer>

XML Attributes:

Attribute Description Valid Values Default Value
idle Determines if UM Router keepalives should be sent only if no traffic has been sent or received in the last interval. "yes" - Send only if no traffic has been exchanged.
"no" - Send always, even of traffic has been exchanged.
"yes"
interval Minimum interval, in milliseconds, between keepalive messages sent. Informatica recommends setting this to 2000 or greater. A value of 0 (zero) disables keepalives. string "5000"
timeout Maximum time, in milliseconds, a peer can receive nothing from the companion before determining the connection is dead and disconnecting. We recommend setting this to 3 times the interval value. string "15000"

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<gateway-keepalive idle="no" interval="1000"/>
</peer>
</portals>
</tnw-gateway>


Router Element "<context-query>"  <-

Determines timing characteristics for context name queries generated at this portal.

XML Attributes:

Attribute Description Valid Values Default Value
periodic-interval Interval (in milliseconds) at which context queries are generated. Before changing the value of this option, please contact Informatica Support. string "300000"
max-contexts Maximum number of contexts for which queries are generated at one time. Before changing the value of this option, please contact Informatica Support. string "20"
interval Interval (in milliseconds) between groups of context queries. Before changing the value of this option, please contact Informatica Support. string "200"
timeout Minimum time (in seconds) a context query must be unanswered before it is removed for the portal. Before changing the value of this option, please contact Informatica Support. string "900"

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<context-query periodic-interval="25000" max-contexts="15" interval="180" timeout="875"/>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<sqn-window>"  <-

Specifies the portal's awareness of received message sequence numbers, for the purpose of detecting duplicates.

XML Attributes:

Attribute Description Valid Values Default Value
size Determines the maximum number of topic (fragment) sequence numbers maintained in the window, for any given source. Must be a multiple of 8. Before changing the value of this option, please contact Informatica Support. string "16384"
increment Determines the minimum increment, in topic (fragment) sequence numbers, by which the sequence number window is moved when the window size (below) is exceeded. Must be a multiple of 8, an even divisor of the window size, and less the window size. Before changing the value of this option, please contact Informatica Support. string "2048"

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<sqn-window size="1024" increment="512"/>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<receiver-context-name>"  <-

Specifies the portal receiver context name.

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<receiver-context-name>RcvrContext01</source-context-name>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<source-context-name>"  <-

Specifies the portal source context name.

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<source-context-name>SourceContext01</source-context-name>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<pattern-use-check>"  <-

  • Cardinality: 0 .. 1
  • Parent: <peer>

XML Attributes:

Attribute Description Valid Values Default Value
periodic-interval The interval (in milliseconds) at which source pattern are checked to determine if there is no more interest. This element is deprecated and has no function. string "300000"

Checks for interest in patterns at periodic intervals. This element is deprecated and has no function.



Router Element "<topic-use-check>"  <-

Checks for interest in topics at periodic intervals. This element is deprecated and has no function.

  • Cardinality: 0 .. 1
  • Parent: <peer>

XML Attributes:

Attribute Description Valid Values Default Value
periodic-interval The interval (in milliseconds) at which source topics are checked to determine if there is no more interest. This element is deprecated and has no function. string "300000"


Router Element "<pattern-domain-activity>"  <-

Determines how long a domain remains quiescent until it is determined inactive. This element is deprecated and has no function.

XML Attributes:

Attribute Description Valid Values Default Value
timeout Minimum time (in seconds) domain interest for a pattern must be refreshed before interest is removed for that domain. This element is deprecated and has no function. string "900"


Router Element "<pattern-interest-generate>"  <-

Determines timing characteristics for interest message generation at this portal. This element is deprecated and has no function.

XML Attributes:

Attribute Description Valid Values Default Value
periodic-interval Interval (in milliseconds) at which pattern interest is generated. This element is deprecated and has no function. string "300000"
max-patterns Maximum patterns for which interest is generated at one time. This element is deprecated and has no function. string "300000"
interval Interval (in milliseconds) between groups of patterns. This element is deprecated and has no function. string "200"


Router Element "<pattern-purge>"  <-

Determines when this portal's proxy receivers can purge pattern. This element is deprecated and has no function.

XML Attributes:

Attribute Description Valid Values Default Value
periodic-interval Interval (in milliseconds) at which receiver patterns are checked to determine if they can be purged. This element is deprecated and has no function. string "6000"


Router Element "<topic-domain-activity>"  <-

Determines how long a domain remains quiescent until it is determined inactive. This element is deprecated and has no function.

XML Attributes:

Attribute Description Valid Values Default Value
timeout Minimum time (in seconds) domain interest for a topic must be refreshed before interest is removed for that domain. This element is deprecated and has no function. string "900"


Router Element "<topic-interest-generate>"  <-

Determines timing characteristics for interest message generation at this portal. This element is deprecated and has no function.

XML Attributes:

Attribute Description Valid Values Default Value
periodic-interval Interval (in milliseconds) at which topic interest is generated. This element is deprecated and has no function. string "300000"
max-topics Maximum topics for which interest is generated at one time. This element is deprecated and has no function. string "20"
interval Interval (in milliseconds) between groups of topics. This element is deprecated and has no function. string "200"


Router Element "<topic-purge>"  <-

Determines when this portal's proxy receivers can purge topics. This element is deprecated and has no function.

XML Attributes:

Attribute Description Valid Values Default Value
periodic-interval Interval (in milliseconds) at which receiver topics are checked to determine if they can be purged. This element is deprecated and has no function. string "6000"


Router Element "<acl>"  <-

Contains elements (inbound and outbound ACEs) that describe how an ACL (Access Control List) filters messages.

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<acl>
<inbound>
<ace>
<topic>AAA</topic>
</ace>
</inbound>
</acl>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<outbound>"  <-

Container for ACE elements, to separate outbound ACEs from inbound ACEs.

  • Cardinality: 0 .. 1
  • Parent: <acl>
  • Children: <ace>

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<acl>
<outbound>
<ace>
<pcre-pattern>A[AB]A</pcre-pattern>
</ace>
</outbound>
</acl>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<ace>"  <-

Within an inbound or outbound ACL, you can have one or more "<ace>" elements. Each ACE (Access Control Entry) lets you match and accept or reject messages based on access control condition elements, which are the elements contained within an "<ace>" element.

XML Attributes:

Attribute Description Valid Values Default Value
match This required attribute determines what to do with matched messages. "accept" - Pass the message.
"reject" - Block the message.
(no default; must be specified)

Example:

<tnw-gateway version="1.0">
<portals>
<endpoint>
<name>LAN1</name>
<lbm-config>lan1.cfg</lbm-config>
<domain-id>1</domain-id>
<acl>
<inbound>
<ace match="accept">
<topic>ABC</topic>
</ace>
<ace match="accept">
<topic>DEF</topic>
<transport value=lbt-rm comparison=eq/>
</ace>
<ace match="accept">
<topic>GHI</topic>
</ace>
</inbound>
</acl>
</endpoint>
...


Router Element "<xport-id>"  <-

Defines a condition used in an ACE. Specifically, this is a match pattern for the message's xport ID number. This applies only to LBT-IPC transports.

XML Attributes:

Attribute Description Valid Values Default Value
value The xport ID number to be compared. string (no default; must be specified)
comparison Defines a match condition. "eq" - Matches if equal.
"equal" - Matches if equal.
"ne" - Matches if not equal.
"notequal" - Matches if not equal.
"lt" - Matches if less than.
"lessthan" - Matches if less than.
"le" - Matches if less than or equal to.
"lessthanequal" - Matches if less than or equal to.
"gt" - Matches if greater than.
"greaterthan" - Matches if greater than.
"ge" - Matches if greater than or equal to.
"greaterthanequal" - Matches if greater than or equal to.
(no default; must be specified)

Example:

<ace match="accept">
<xport-id comparison="equal" value="1234"/>
</ace>


Router Element "<tcp-source-port>"  <-

Defines a condition used in an ACE. Specifically, this is a match pattern for the message's TCP source port number. This applies only to TCP transports.

XML Attributes:

Attribute Description Valid Values Default Value
value The xport ID number to be compared. string (no default; must be specified)
comparison Defines a match condition. "eq" - Matches if equal.
"equal" - Matches if equal.
"ne" - Matches if not equal.
"notequal" - Matches if not equal.
"lt" - Matches if less than.
"lessthan" - Matches if less than.
"le" - Matches if less than or equal to.
"lessthanequal" - Matches if less than or equal to.
"gt" - Matches if greater than.
"greaterthan" - Matches if greater than.
"ge" - Matches if greater than or equal to.
"greaterthanequal" - Matches if greater than or equal to.
(no default; must be specified)

Example:

<ace match="accept">
<tcp-source-port comparison="equal" value="1234"/>
</ace>


Router Element "<udp-destination-port>"  <-

Defines a condition used in an ACE. Specifically, this is a match pattern for the message's UDP destination port number. This applies only to LBT-RM transports.

XML Attributes:

Attribute Description Valid Values Default Value
value The xport ID number to be compared. string (no default; must be specified)
comparison Defines a match condition. "eq" - Matches if equal.
"equal" - Matches if equal.
"ne" - Matches if not equal.
"notequal" - Matches if not equal.
"lt" - Matches if less than.
"lessthan" - Matches if less than.
"le" - Matches if less than or equal to.
"lessthanequal" - Matches if less than or equal to.
"gt" - Matches if greater than.
"greaterthan" - Matches if greater than.
"ge" - Matches if greater than or equal to.
"greaterthanequal" - Matches if greater than or equal to.
(no default; must be specified)

Example:

<ace match="accept">
< udp-destination-port comparison="equal" value="1234"/>
</ace>


Router Element "<udp-source-port>"  <-

Defines a condition used in an ACE. Specifically, this is a match pattern for the message's UDP source port number. This applies only to LBT-RM and LBT-RU transports.

XML Attributes:

Attribute Description Valid Values Default Value
value The xport ID number to be compared. string (no default; must be specified)
comparison Defines a match condition. "eq" - Matches if equal.
"equal" - Matches if equal.
"ne" - Matches if not equal.
"notequal" - Matches if not equal.
"lt" - Matches if less than.
"lessthan" - Matches if less than.
"le" - Matches if less than or equal to.
"lessthanequal" - Matches if less than or equal to.
"gt" - Matches if greater than.
"greaterthan" - Matches if greater than.
"ge" - Matches if greater than or equal to.
"greaterthanequal" - Matches if greater than or equal to.
(no default; must be specified)

Example:

<ace match="accept">
< udp-source-port comparison="equal" value="1234"/>
</ace>


Router Element "<multicast-group>"  <-

Defines a condition used in an ACE. Specifically, this is a match pattern for the message's multicast group address. This applies only to LBT-RM transports.

XML Attributes:

Attribute Description Valid Values Default Value
value The xport ID number to be compared. string (no default; must be specified)
comparison Defines a match condition. "eq" - Matches if equal.
"equal" - Matches if equal.
"ne" - Matches if not equal.
"notequal" - Matches if not equal.
"lt" - Matches if less than.
"lessthan" - Matches if less than.
"le" - Matches if less than or equal to.
"lessthanequal" - Matches if less than or equal to.
"gt" - Matches if greater than.
"greaterthan" - Matches if greater than.
"ge" - Matches if greater than or equal to.
"greaterthanequal" - Matches if greater than or equal to.
(no default; must be specified)

Example:

<ace match="accept">
< multicast-group comparison="equal" value="1234"/>
</ace>


Router Element "<source-ip>"  <-

Defines a condition used in an ACE. Specifically, this is a match pattern for the message source IP address. This applies only to TCP, LBT-RM, and LBT-RU transports.

XML Attributes:

Attribute Description Valid Values Default Value
value The xport ID number to be compared. string (no default; must be specified)
comparison Defines a match condition. "eq" - Matches if equal.
"equal" - Matches if equal.
"ne" - Matches if not equal.
"notequal" - Matches if not equal.
"lt" - Matches if less than.
"lessthan" - Matches if less than.
"le" - Matches if less than or equal to.
"lessthanequal" - Matches if less than or equal to.
"gt" - Matches if greater than.
"greaterthan" - Matches if greater than.
"ge" - Matches if greater than or equal to.
"greaterthanequal" - Matches if greater than or equal to.
(no default; must be specified)

Example:

<ace match="accept">
< source-ip comparison="equal" value="1234"/>
</ace>


Router Element "<transport>"  <-

Defines a condition used in an ACE. Specifically, this is a match pattern for a UM transport type.

XML Attributes:

Attribute Description Valid Values Default Value
value The transport type to be matched. "tcp" - TCP transport.
"lbt-rm" - LBT-RM transport.
"lbtrm" - LBT-RM transport.
"lbt-ru" - LBT-RU transport.
"lbtru" - LBT-RU transport.
"lbt-ipc" - IPC transport.
"lbtipc" - IPC transport.
(no default; must be specified)
comparison Defines a match condition. "eq" - Matches if equal.
"equal" - Matches if equal.
"ne" - Matches if not equal.
"notequal" - Matches if not equal.
(no default; must be specified)

Example:

<ace match="accept">
<transport comparison="equal" value="lbtrm"/>
</ace>


Router Element "<regex-pattern>"  <-

Defines a condition used in an ACE. Specifically, this is a match pattern for a POSIX regular expression matched in the message. This element is deprecated. Please use <pcre-pattern> .

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default


Router Element "<pcre-pattern>"  <-

Defines a condition used in an ACE. Specifically, this is a match pattern for a Perl Compatible Regular Expression (PCRE) matched in the message.

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Example:

<ace match="accept">
<pcre-pattern>ABC.*</pcre-pattern>
</ace>


Router Element "<topic>"  <-

Defines a condition used in an ACE. Specifically, this is a match pattern for a topic name.

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Example:

<ace match="accept">
<topic>ABC</topic>
</ace>


Router Element "<inbound>"  <-

Container for ACE elements, to separate inbound ACEs from outbound ACEs.

  • Cardinality: 0 .. 1
  • Parent: <acl>
  • Children: <ace>

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<acl>
<inbound>
<ace>
<topic>AAA</topic>
</ace>
</inbound>
</acl>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<lbm-attributes>"  <-

Container for individual UM-option-setting elements. It lets you set individual UM attributes without referencing a UM configuration file. These values override any values set via files referenced by <lbm-config>.

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<name>E2</name>
<domain-id>1</domain-id>
<lbm-attributes>
<option scope="context" name="request_tcp_interface" value="10.28.5.5" />
<option scope="context" name="response_tcp_interface" value="127.0.0.1" />
</lbm-attributes>
...
</endpoint>
</portals>
</tnw-gateway>


Router Element "<option>"  <-

Lets you set an individual UM configuration option without referencing a UM configuration file. This value overrides any values set via files referenced by <lbm-config>.

Note
Some UM options specify interfaces, which can be done by supplying the device name of the interface. Special care must be taken when supplying device names. See Interface Device Names and XML for details.

XML Attributes:

Attribute Description Valid Values Default Value
scope The type of object to which an option can apply. "receiver" - Receiver option.
"context" - Context option.
"source" - Source option.
"wildcard_receiver" - Wildcard Receiver option.
"event_queue" - Event queue option.
(no default; must be specified)
name The name of the option. attr_name (no default; must be specified)
value The value for the option. string (no default; must be specified)

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<name>E2</name>
<domain-id>1</domain-id>
<lbm-attributes>
<option scope="context" name="request_tcp_interface" value="10.28.5.5" />
<option scope="context" name="response_tcp_interface" value="127.0.0.1" />
</lbm-attributes>
...
</endpoint>
</portals>
</tnw-gateway>


Router Element "<lbm-config>"  <-

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Specifies the UM configuration file that contains configuration options associated with this portal.

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<name>E2</name>
<domain-id>1</domain-id>
<lbm-config>/path/endpoint2.cfg</lbm-config>
...
</endpoint>
</portals>
</tnw-gateway>


Router Element "<batching>"  <-

Contains batching size and timing parameters for peer link implicit batching. This applies to data messages only: the UM Router sends control messages immediately (flushing any batched data messages). Note: worst-case latency can be dramatically reduced by combining batching with <smart-batch>.

Example:

<tnw-gateway version="1.0">
. . .
. . .
<portals>
<peer>
<batching>
<min-length>4096</min-length>
<batch-interval>500</batch-interval>
</batching>
</peer>
</portals>
</tnw-gateway>


Router Element "<batch-interval>"  <-

Specifies the maximum interval (in milliseconds) between when the first message of a batch is queued until the batch is sent. A message stays in the batch queue until this value or <min-length> is met or exceeded (whichever occurs first). If not specified, it defaults to 200 milliseconds. The minimum allowed value is 3 milliseconds.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<batching>
<min-length>4096</min-length>
<batch-interval>500</batch-interval>
</batching>
</peer>
</portals>
</tnw-gateway>


Router Element "<min-length>"  <-

Specifies the minimum length of a set of batched messages. When the total length of the batched messages reaches or exceeds this value, the batch is sent. If not specified, it defaults to 8192 bytes.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<batching>
<min-length>4096</min-length>
<batch-interval>500</batch-interval>
</batching>
</peer>
</portals>
</tnw-gateway>


Router Element "<max-datagram>"  <-

Specifies the maximum size a peer portal will allow an outgoing datagram to be before fragmenting it.

  • Cardinality: 0 .. 1
  • Parent: <peer>

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<max-datagram>50000</max-datagram>
</peer>
</portals>
</tnw-gateway>


Router Element "<smart-batch>"  <-

Enables the smart batching algorithm used by the UM Router when forwarding messages from one portal to another. Possible values are 0 (disable) and 1 (enable).

In general, batching algorithms are used to increase throughput, but many such algorithms can produce latency outliers. The Smart Batching algorithm is designed to ensure low latencies by flushing the batching buffer when no more messages are waiting to be sent out the portal.

Smart batching works with both endpoint and peer portals. For endpoint portals, a UM configuration file may be provided to set the implicit_batching_minimum_length (source) option to a large value. For peer portals, the <batching> element may be used to set the <min-length> to a large value. In either case, large values are recommended and will not produce significant latency outliers.

Example:

<tnw-gateway version="1.0">
. . .
. . .
<portals>
<peer>
<smart-batch>1</smart-batch>
<batching>
<min-length>4096</min-length>
</batching>
</peer>
</portals>
</tnw-gateway>


Router Element "<max-queue>"  <-

Sets the maximum buffer size for blocking messages. If not specified, this defaults to 1000000 bytes.

Example:

<tnw-gateway version="1.0">
<daemon>
...
</daemon>
<portals>
<endpoint>
<name>E1</name>
<domain-id>1</domain-id>
<max-queue>500000</max-queue>
...
</endpoint>
</portals>
</tnw-gateway>


Router Element "<source-deletion-delay>"  <-

Sets the time in milliseconds to wait after a route map change occurs before deleting a proxy source. Such a route map change could be due to failure of a UM Router or link within a network.

Example:

<tnw-gateway version="1.0">
<daemon>
...
</daemon>
<portals>
<endpoint>
<name>E1</name>
<domain-id>1</domain-id>
<source-deletion-delay>500</source-deletion-delay>
...
</endpoint>
</portals>
</tnw-gateway>


Router Element "<single-tcp>"  <-

Contains elements for a peer portal's tcp settings, when configuring the peer for single-tcp operation.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<interface>10.28.5.5/24</interface>
<acceptor>
<listen-port>23746</listen-port>
</acceptor>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<acceptor>"  <-

Contains the listen port address of the corresponding acceptor peer portal on another UM Router, to which this peer is connected. This element is used in single-tcp peer configurations.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<acceptor>
<listen-port>25000</port>
</acceptor>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<listen-port>"  <-

Contains port number on which an acceptor peer portal listens for connections from the initiating peer portal. The initiating peer portal configuration must specify this port as its initiator port.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<acceptor>
<listen-port>46000</listen-port>
</acceptor>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<initiator>"  <-

Contains the IP address and the port of the corresponding acceptor peer portal on another UM Router, to which this peer is connected. This element is used in single-tcp peer configurations.

XML Attributes:

Attribute Description Valid Values Default Value
reconnect-interval The time interval, in milliseconds, to wait before reconnecting to the companion portal if this connection is interrupted. string "5000"

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<initiator>
<address>10.28.3.91</address>
<port>25000</port>
</initiator>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<port>"  <-

Contains the IP port of the acceptor peer portal on another UM Router, to which this initiator peer is connected. (As of UM version 6.10, dual TCP (<tcp>) is no longer supported. Please use <single-tcp> instead.)

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<initiator>
<address>10.28.3.91</address>
<port>25000</port>
</initiator>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<address>"  <-

Contains the IP address of the acceptor peer portal on another UM Router, to which this initiator peer is connected via "single TCP". (As of UM version 6.10, dual TCP (<tcp>) is no longer supported. Please use <single-tcp> instead.)

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<initiator>
<address>10.28.3.91</address>
<port>25000</port>
</initiator>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<tls>"  <-

Contains elements to configure peer link encryption.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<tls>
<certificate>test.crt<certificate>
<certificate-key>test.key<certificate-key>
<certificate-key-password>
CorrectHorseBatteryStaple
</certificate-key-password>
<trusted-certificates>peers.crt<trusted-certificates>
</tls>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<cipher-suites>"  <-

Defines the list of one or more (comma separated) names of cipher suites that are acceptable to this context. The names are in OpenSSL format (the ones with dashes). If more than suite name one is supplied, they should be in descending order of preference. When a remote context negotiates encrypted TCP, the two sides must find a cipher suite in common, otherwise the connection will be canceled.

The default is highly secure and is recommended.

  • Cardinality: 0 .. 1
  • Parent: <tls>

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<tls>
<cipher-suites>TLS_DHE_RSA_WITH_AES_256_GCM_SHA384<cipher-suites>
...
</tls>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<trusted-certificates>"  <-

Specifies the path to a file containing one or more OpenSSL-compatible PEM-formatted TLS client certificates and certificate authorities. If this element is not supplied, the default behavior is to use the system-level trusted certificates and certificate authorities (operating-system dependent). The TLS server uses these trusted certificates to verify the identity of connecting clients. If a client connects and presents a certificate which is not in the server's trusted certificates file, the connection will be canceled.

  • Cardinality: 0 .. 1
  • Parent: <tls>

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<tls>
<trusted-certificates>peers.crt<trusted-certificates>
...
</tls>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<certificate-key-password>"  <-

Specifies the passphrase needed to decrypt the server private key file specified by <certificate-key>.

  • Cardinality: 0 .. 1
  • Parent: <tls>

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<tls>
<certificate-key-password>
CorrectHorseBatteryStaple
</certificate-key-password>
...
</tls>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<certificate-key>"  <-

Specifies the path to a file containing the private key associated with the "server" certificate specified by <certificate>. Note that this private key must be protected from intruders. For that reason, when the certificate and private key files are generated, the private key file is typically encrypted with a passphrase. The passphrase is supplied using <certificate-key-password>.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<tls>
<certificate-key>test.key<certificate-key>
...
</tls>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<certificate>"  <-

Specifies the path to a file containing an OpenSSL-compatible PEM-formatted certificate that will be presented as the TLS server certificate when a TLS connection is established by a client.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<tls>
<certificate>test.crt<certificate>
...
</tls>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<compression>"  <-

Enables compression and sets the desired data compression algorithm for the peer link. Currently, only LZ4 lossless data compression is supported.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<compression>LZ4</compression>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<nodelay>"  <-

Enables setting the TCP_NODELAY socket option on the peer link. Setting TCP_NODELAY disables Nagle's algorithm, which somewhat decreases the efficiency and throughput of TCP, but decreases the latency of individual messages.

By default, TCP_NODELAY is not set (maximizes efficiency).

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<nodelay/>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<keepalive>"  <-

When present, enables a TCP keepalive signal transmission, which is disabled by default.

Example:

<tnw-gateway version="1.0">
. . .
. . .
<portals>
<peer>
<single-tcp>
<keepalive/>
. . .
. . .
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<send-buffer>"  <-

Contains the size of the TCP send buffer. If not specified, the UM Router uses the system default size.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<send-buffer>128000</send-buffer>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<receive-buffer>"  <-

Contains the size of the TCP receive buffer. If not specified, the UM Router uses the system default size.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<receive-buffer>128000</receive-buffer>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<interface>"  <-

Contains the IP host or network address for this peer portal, specified in dotted-decimal or CIDR format.

Example:

<tnw-gateway version="1.0">
...
<portals>
<peer>
<single-tcp>
<interface>10.28.5.5/24</interface>
...
</single-tcp>
</peer>
</portals>
</tnw-gateway>


Router Element "<tcp>"  <-

DEPRECATED AND ELIMINATED AS OF UM 6.10. DO NOT USE. Contains elements for a peer portal's "dual TCP" settings. (As of UM version 6.10, dual TCP (<tcp>) is no longer supported. Please use <single-tcp> instead.)



Router Element "<companion>"  <-

DEPRECATED AND ELIMINATED AS OF UM 6.10. DO NOT USE. Contains the IP address and the port of the companion peer portal on another UM Router, to which this peer is connected via "dual TCP". (As of UM version 6.10, dual TCP (<tcp>) is no longer supported. Please use <single-tcp> instead.)

XML Attributes:

Attribute Description Valid Values Default Value
reconnect-interval string


Router Element "<sourcemap>"  <-

Sets the size of the peer portal's source map. This normally does not need to be modified, but if very large numbers of topics are being used, a larger value might improve efficiency.

  • Cardinality: 0 .. 1
  • Parent: <peer>

XML Attributes:

Attribute Description Valid Values Default Value
size Number of entries in the source map. Value must be a power of 2 (e.g., 1024, 2048, ...). string "131072"

Example:

<tnw-gateway version="1.0">
. . .
. . .
<portals>
<peer>
<sourcemap size="131072"/>
. . .
. . .
</peer>
</portals>
</tnw-gateway>


Router Element "<cost>"  <-

Assigns a positive non-zero integer cost to the portal. The default value is 1. See Forwarding Costs.

Example:

<tnw-gateway version="1.0">
<daemon>
...
</daemon>
<portals>
<endpoint>
<name>E1</name>
<domain-id>1</domain-id>
<cost>25</cost>
...
</endpoint>
</portals>
</tnw-gateway>


Router Element "<name>"  <-

Lets you set a name for this UM Router (do not duplicate for any other known UM Routers), or for the name of an endpoint or peer portal. Each portal name must be unique within the UM Router.

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Example:

<tnw-gateway version="1.0">
<daemon>
<name>UM Router1</name>
</daemon>
<portals>
<endpoint>
<name>endpoint1</name>
...
</endpoint>
</portals>
...
</tnw-gateway>


Router Element "<endpoint>"  <-

Container element for all configuration options of a single endpoint portal.

Example:

<tnw-gateway version="1.0">
<daemon>
...
</daemon>
<portals>
<endpoint>
<name>E1</name>
<domain-id>1</domain-id>
<cost>1</cost>
...
</endpoint>
</portals>
</tnw-gateway>


Router Element "<remote-pattern>"  <-

Determines timings and limits for determination of continued pattern interest at this portal.

XML Attributes:

Attribute Description Valid Values Default Value
check-interval Interval (in milliseconds) between checking individual patterns for continued interest. Before changing the value of this option, please contact Informatica Support. string "90000"
max-patterns Maximum number of patterns to check at a time. Before changing the value of this option, please contact Informatica Support. string "100"
timeout Minimum time (in milliseconds) remote interest for a pattern must be refreshed before interest is removed for that domain. Before changing the value of this option, please contact Informatica Support. string "300000"

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<remote-pattern check-interval="80000" max-topics="80" timeout="250000"/>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<remote-topic>"  <-

Determines timings and limits for determination of continued topic interest at this portal.

XML Attributes:

Attribute Description Valid Values Default Value
check-interval Interval (in milliseconds) between checking individual topics for continued interest. Before changing the value of this option, please contact Informatica Support. string "90000"
max-topics Maximum number of topics to check at a time. Before changing the value of this option, please contact Informatica Support. string "100"
timeout Minimum time (in milliseconds) remote interest for a topic must be refreshed before interest is removed for that domain. Before changing the value of this option, please contact Informatica Support. string "300000"

Example:

<tnw-gateway version="1.0">
. . .
. . .
<portals>
<endpoint>
<remote-topic check-interval="80000" max-topics="80" timeout="250000"/>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<late-join>"  <-

DEPRECATED AND ELIMINATED. DO NOT USE. Determines how Late Join is handled by this endpoint portal.

XML Attributes:

Attribute Description Valid Values Default Value
provide "source"
"always"
"never"
forward "yes"
"no"


Router Element "<topic-resolution>"  <-

Container for UM Router topic resolution behavior options.

Example:

<tnw-gateway version="1.0">
. . .
. . .
<portals>
<endpoint>
<topic-resolution>
<initial-request>
<rate-limit/>
</initial-request>
</topic-resolution>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<initial-request>"  <-

Sets interval and duration for initial topic resolution requests.

XML Attributes:

Attribute Description Valid Values Default Value
periodic-interval The interval at which the initial topic resolution requests are sent. Before changing the value of this option, please contact Informatica Support. string "1000"
duration The minimum duration for which the initial topic resolution requests are sent. Before changing the value of this option, please contact Informatica Support. string "10"

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<topic-resolution>
<initial-request duration="15" periodic-interval="800"/>
</topic-use-query>
</topic-resolution>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<domain-route>"  <-

Sets maximum and minimum limits for the interval between periodic domain route messages being sent for each remote domain that the portal is servicing.

XML Attributes:

Attribute Description Valid Values Default Value
min-interval The minimum interval, in milliseconds, between domain route messages being sent for each domain. string "100"
max-interval The maximum interval, in milliseconds, between domain route messages being sent for each domain. string "1000"

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<topic-resolution>
<domain-route min-interval="100" max-interval="1000">
<rate-limit bps="0" objects-per-second="50"/>
</domain-route>
</topic-resolution>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<rate-limit>"  <-

Sets rate limits for topic resolution data sent over the network.

You can set rate limits individually for each of the topic resolution message types (see children elements).

XML Attributes:

Attribute Description Valid Values Default Value
bps The limit in Bits per Second that data will be sent on the network. A value of 0 disables limiting by bits per second. Before changing the value of this option, please contact Informatica Support. string

"500000" (For use queries and interest messages)
"0" (For domain route messages)

objects-per-second The limit in Objects per Second that data will be sent on the network. A value of 0 disables limiting by objects per second. Before changing the value of this option, please contact Informatica Support. string

"500" (For use queries)
"0" (For interest messages)
"50" (For domain route messages)

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<topic-resolution>
<topic-use-query max="6" periodic-interval="250000" timeout="4000"/>
<rate-limit bps="550000" objects-per-second="0"/>
</topic-use-query>
</topic-resolution>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<remote-pattern-interest>"  <-

Sets parameters for when and how often this endpoint portal sends pattern interest messages

XML Attributes:

Attribute Description Valid Values Default Value
min-interval The minimum interval, in milliseconds, between pattern interest messages being sent for each pattern the portal has interest in. string "1000"
max-interval The maximum interval, in milliseconds, between pattern interest messages being sent for each pattern the portal has interest in. string "60000"

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<topic-resolution>
<remote-pattern-interest min-interval="1000" max-interval="90000">
<rate-limit/>
</remote-pattern-interest>
</topic-resolution>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<remote-topic-interest>"  <-

Sets parameters for when and how often this endpoint portal sends topic interest messages.

XML Attributes:

Attribute Description Valid Values Default Value
min-interval The minimum interval, in milliseconds, between topic interest messages being sent for each topic the portal has interest in. string "1000"
max-interval The maximum interval, in milliseconds, between topic interest messages being sent for each topic the portal has interest in. string "60000"

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<topic-resolution>
<remote-topic-interest min-interval="1000" max-interval="90000">
<rate-limit/>
</remote-topic-interest>
</topic-resolution>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<pattern-use-query>"  <-

Sets parameters for when and how often this endpoint portal sends pattern use queries.

XML Attributes:

Attribute Description Valid Values Default Value
timeout The maximum time, in milliseconds, to wait for a pattern use response. Before changing the value of this option, please contact Informatica Support. string "3000"
max Maximum number of pattern use queries to send for a given pattern, each separated by the timeout value before giving up and removing the topic from the topic list. Before changing the value of this option, please contact Informatica Support. string "5"
periodic-interval The interval, in milliseconds, between periodic pattern use queries being sent for each pattern the portal has interest in. Before changing the value of this option, please contact Informatica Support. string "300000"

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<topic-resolution>
<pattern-use-query max="6" periodic-interval="250000" timeout="4000">
<rate-limit/>
</topic-use-query>
</topic-resolution>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<topic-use-query>"  <-

Sets parameters for when and how often this endpoint portal sends topic use queries.

XML Attributes:

Attribute Description Valid Values Default Value
timeout The maximum time, in milliseconds, to wait for a topic use response. Before changing the value of this option, please contact Informatica Support. string "3000"
max Maximum number of topic use queries to send for a given topic, each separated by the timeout value before giving up and removing the topic from the topic list. Before changing the value of this option, please contact Informatica Support. string "5"
periodic-interval The interval, in milliseconds, between periodic topic use queries being sent for each topic the portal has interest in. Before changing the value of this option, please contact Informatica Support. string "300000"

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<topic-resolution>
<topic-use-query max="6" periodic-interval="250000" timeout="4000">
<rate-limit/>
</topic-use-query>
</topic-resolution>
</endpoint>
</portals>
</tnw-gateway>


Router Element "<domain-id>"  <-

Identifies the TRD for this endpoint portal. It must be unique within the UM Router (which means that for any TRD, you can assign only one endpoint portal per UM Router). Also, all endpoints interfacing a given TRD must have the same <domain-id> value.

Example:

<tnw-gateway version="1.0">
...
<portals>
<endpoint>
<name>E1</name>
<domain-id>1</domain-id>
<cost>1</cost>
...
</endpoint>
</portals>
</tnw-gateway>


Router Element "<daemon>"  <-

Container for options common to the entire UM Router process.

Example:

<tnw-gateway version="1.0">
<daemon>
...
</daemon>
...
</tnw-gateway>


Router Element "<route-recalculation>"  <-

Lets you set timing parameters for UM Router rerouting route calculation behavior.

XML Attributes:

Attribute Description Valid Values Default Value
backoff-interval How long, in milliseconds, the UM Router waits after the last detected change in topology before initiating a route recalculation. string "5000"
warning-interval How long, in milliseconds, the UM Router waits before warning that a route recalculation is being held up due to a non-converging topology. string "10000"

Example:

<tnw-gateway version="1.0">
<daemon>
...
<route-recalculation backoff-interval="5000" warning-interval="10000"/>
</daemon>
...
</tnw-gateway>


Router Element "<route-info>"  <-

Lets you set control parameters for UM Router initial route setup (or reroute) behavior.

XML Attributes:

Attribute Description Valid Values Default Value
propagation-interval The time interval between route information messages that the UM Router sends to other UM Router. string "1000"
check-interval How often the UM Router checks to see if a route information message needs to be sent, a UM Router has timed out, and/or the routes need to be recalculated. string "750"
timeout How long a UM Router waits after receiving no route information messages from another UM Router before determining that that UM Router is out of service or unreachable. string "4000"
max-hop-count The maximum number of UM Routers a route information message can traverse before being discarded. string "100"

Example:

<tnw-gateway version="1.0">
<daemon>
...
<route-info propagation-interval="1000" check-interval="750" timeout="4000" max-hop-count="100"/>
</daemon>
...
</tnw-gateway>


Router Element "<xml-config>"  <-

Specifies the UM XML configuration file.

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Example:

<tnw-gateway version="1.0">
<daemon>
...
<xml-config>configfile.xml</xml-config>
</daemon>
...
</tnw-gateway>


Router Element "<propagation-delay>"  <-

DEPRECATED AND ELIMINATED. DO NOT USE. Specifies the difference between the shortest and longest propagation delays in the network.

XML Attributes:

Attribute Description Valid Values Default Value
delta string


Router Element "<daemon-monitor>"  <-

Configures the Daemon Statistics feature. See Daemon Statistics for general information on Daemon Statistics.

XML Attributes:

Attribute Description Valid Values Default Value
topic Topic name to use for publishing Daemon Statistics. string "tnwgd.monitor"

Example:

<tnw-gateway version="1.0">
<daemon>
...
<daemon-monitor topic="umrouter.1">
<lbm-config>/path/umrouter_monitor.cfg</lbm-config>
<publishing-interval>
...
</publishing-interval>
<remote-snapshot-request allow="1"/>
<remote-config-changes-request allow="0"/>
</daemon-monitor>
</daemon>
...
</tnw-gateway>


Router Element "<remote-config-changes-request>"  <-

Configures whether the UM Router will respond to monitoring apps requests to change the rate at which Daemon Statistics messages are published. See Daemon Statistics for general information on Daemon Statistics.

XML Attributes:

Attribute Description Valid Values Default Value
allow Enable or disable change requests. "0" - Ignore change requests.
"1" - Respond to change requests.
"0"

Example:

<tnw-gateway version="1.0">
<daemon>
...
<daemon-monitor topic="umrouter.1">
<lbm-config>/path/umrouter_monitor.cfg</lbm-config>
<publishing-interval>
...
</publishing-interval>
<remote-snapshot-request allow="1"/>
<remote-config-changes-request allow="0"/>
</daemon-monitor>
</daemon>
...
</tnw-gateway>


Router Element "<remote-snapshot-request>"  <-

Configures whether the UM Router will respond to monitoring apps requests to send on-demand snapshots of daemon statistics. See Daemon Statistics for general information on Daemon Statistics.

XML Attributes:

Attribute Description Valid Values Default Value
allow Enable or disable snapshot requests. "0" - Ignore snapshot requests.
"1" - Respond to snapshot requests.
"0"

Example:

<tnw-gateway version="1.0">
<daemon>
...
<daemon-monitor topic="umrouter.1">
<lbm-config>/path/umrouter_monitor.cfg</lbm-config>
<publishing-interval>
...
</publishing-interval>
<remote-snapshot-request allow="1"/>
<remote-config-changes-request allow="0"/>
</daemon-monitor>
</daemon>
...
</tnw-gateway>


Router Element "<web-monitor>"  <-

Identifies the address for the web monitor, in the form of interface:port. You can use "*" to specify the local host.

Omit this element to disable the web monitor.

See Webmon Security for important security information.

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Example:

<tnw-gateway version="1.0">
<daemon>
...
<web-monitor>*:21001</web-monitor>
</daemon>
...
</tnw-gateway>


Router Element "<monitor>"  <-

Container for UM Transport monitoring configuration elements.

XML Attributes:

Attribute Description Valid Values Default Value
interval Monitoring interval, in seconds. 0 disables monitoring. string "0"

Example:

<tnw-gateway version="1.0">
<daemon>
...
<monitor interval="30">
<transport-module module="lbm" options="config=/cfgs/TD1.cfg;topic=stats"/>
<format-module options="config=/cfgs/TD1.cfg;separator=|"/>
</monitor>
</daemon>
...
</tnw-gateway>


Router Element "<format-module>"  <-

Provides specifics about the monitoring format module.

XML Attributes:

Attribute Description Valid Values Default Value
module Selects the message formatting module. "csv" - Comma-separated values (currently the only supported format). "csv"
options Option string to be passed to the formatting module. Available option is "separator" (defaults to comma). string (if omitted, no options are passed to the formatting module)

Example:

<tnw-gateway version="1.0">
<daemon>
...
<monitor interval="30">
<transport-module module="lbm" options="config=/cfgs/TD1.cfg;topic=stats"/>
<format-module options="separator=|"/>
</monitor>
</daemon>
...
</tnw-gateway>


Router Element "<transport-module>"  <-

Specifies characteristics about the monitoring transport module used.

XML Attributes:

Attribute Description Valid Values Default Value
module Selects the message transport module. "lbm" - Publish messages via standard UM source.
"lbmsnmp" - Publish messages via standard UM source with special settings intended for the UM SNMP agent.
"udp" - Publish messages as simple UDP datagrams.
"lbm"
options Option string to be passed to the transport module. Available options are "config" (configuration file pathname) and "topic" (the topic name to use for sending and receiving statistics; defaults to "/29west/statistics"). string (if omitted, no options are passed to the transport module)

Example 1:

<tnw-gateway version="1.0">
<daemon>
...
<monitor interval=30>
<transport-module module="lbm" options="config=/cfgs/TD1.cfg;topic=stats"/>
<format-module options="config=/cfgs/TD1.cfg;separator=|"/>
</monitor>
</daemon>
...
</tnw-gateway>

Example 2:

Monitoring configuration options can be supplied directly in the XML.

<tnw-gateway version="1.0">
<daemon>
...
<monitor interval=30>
<transport-module module="lbm"
options="config=/cfgs/TD1.cfg;context|request_tcp_interface=192.168.135.131"/>
<format-module options="config=/cfgs/TD1.cfg;separator=|"/>
</monitor>
</daemon>
...
</tnw-gateway>


Router Element "<patternmap>"  <-

Determines characteristics of the internal topic resolution maps for wildcard patterns.

XML Attributes:

Attribute Description Valid Values Default Value
hash-function Topic resolution hash function to use. Informatica recommends the default. See resolver_string_hash_function (context) for more information. "classic" - UM's original hash function. May be better for certain specialized topic names.
"djb2" - The Dan Bernstein algorithm from comp.lang.c. May be better for topic names have a changing prefix with a constant suffix.
"sdbm" - Sdbm database library (used in Berkeley DB). May be better for certain specialized topic names.
"murmur2" - Good all-around hash function by Austin Appleby.
"murmur2"
size Number of buckets in hash table. Should be a prime number. string "131111"

Example:

<tnw-gateway version="1.0">
<daemon>
...
<patternmap hash-function="murmur2" size="131111">
</daemon>
...
</tnw-gateway>


Router Element "<topicmap>"  <-

Determines characteristics of the internal topic resolution maps for topic names.

XML Attributes:

Attribute Description Valid Values Default Value
hash-function Topic resolution hash function to use. Informatica recommends the default. See resolver_string_hash_function (context) for more information. "classic" - UM's original hash function. May be better for certain specialized topic names.
"djb2" - The Dan Bernstein algorithm from comp.lang.c. May be better for topic names have a changing prefix with a constant suffix.
"sdbm" - Sdbm database library (used in Berkeley DB). May be better for certain specialized topic names.
"murmur2" - Good all-around hash function by Austin Appleby.
"murmur2"
size Number of buckets in hash table. Should be a prime number. string "131111"

Example:

<tnw-gateway version="1.0">
<daemon>
...
<topicmap hash-function="murmur2" size="131111">
</daemon>
...
</tnw-gateway>


Router Element "<lbm-license-file>"  <-

Specifies the UM license file's pathname.

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Example:

<tnw-gateway version="1.0">
<daemon>
. . .
<lbm-license-file>lic0014.txt</lbm-license-file>
. . .
</daemon>
. . .
. . .
</tnw-gateway>


Router Element "<pidfile>"  <-

Contains the pathname for daemon process ID (PID) file.

XML Attributes:

Attribute Description Valid Values Default Value
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Example:

<tnw-gateway version="1.0">
<daemon>
...
<pidfile>\var\run\dro01.pid</pidfile>
</daemon>
...
</tnw-gateway>


Router Element "<gid>"  <-

Specifies a Group ID (GID) for daemon process (if run as root).

Example:

<tnw-gateway version="1.0">
<daemon>
...
<gid>1234</gid>
</daemon>
...
</tnw-gateway>


Router Element "<uid>"  <-

Specifies a User ID (UID) for the daemon process (if run as root).

Example:

<tnw-gateway version="1.0">
<daemon>
...
<uid>5555</uid>
</daemon>
...
</tnw-gateway>


Router Element "<log>"  <-

Specifies the destination for UM Router log messages. If you set the type for "file", use this element to contain the full pathname.

XML Attributes:

Attribute Description Valid Values Default Value
type Method of writing logs. "file" - Write log to disk file.
"syslog" - Write log to Unix "syslog".
"console" - Write log to standard out.
"console"
frequency Frequency by which to roll log file. Only applies for type="file". "disable" - Do not roll log file.
"daily" - Roll log file at midnight.
"hourly" - Roll log file after approximately an hour, but is not exact and can drift significantly over a period of time.
"test" - For Informatica internal use only. Do not use.
"disable"
size Number of millions of bytes of file size to roll log file. E.g. a value of 1 rolls after 1000000 bytes. Maximum value is 4000. Value of 0 disables rolling by file size. Only applies for type="file". string "0"
xml:space Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. "default" - Trim leading and trailing whitespace, and compress multiple whitespace characters into a single space.
"preserve" - Retain whitespace exactly as entered.
default

Example:

<tnw-gateway version="1.0">
<daemon>
...
<log type="syslog"/>
</daemon>
...
</tnw-gateway>


UM Router Configuration DTD  <-

Here is the XML configuration DTD with the comments removed. To see the DTD with comments included, enter tnwgd --dump-dtd.

<!ELEMENT tnw-gateway (daemon?, portals)>
<!ATTLIST tnw-gateway
version (1.0) #REQUIRED
>
<!ELEMENT daemon (name?, log?, uid?, gid?, pidfile?, lbm-license-file?, topicmap?, patternmap?, monitor?, web-monitor?, daemon-monitor?, propagation-delay?, xml-config?, route-info?, route-recalculation?)>
<!ELEMENT log ( #PCDATA )>
<!ATTLIST log
type (file | syslog | console) "console"
frequency (disable | daily | hourly | test) "disable"
size CDATA "0"
xml:space (default | preserve) "default"
>
<!ELEMENT pidfile ( #PCDATA )>
<!ATTLIST pidfile xml:space (default | preserve) "default">
<!ELEMENT uid ( #PCDATA )>
<!ELEMENT gid ( #PCDATA )>
<!ELEMENT lbm-license-file ( #PCDATA )>
<!ATTLIST lbm-license-file xml:space (default | preserve) "default">
<!ELEMENT topicmap EMPTY>
<!ATTLIST topicmap
hash-function ( classic | djb2 | sdbm | murmur2 ) "murmur2"
size CDATA "131111"
>
<!ELEMENT patternmap EMPTY>
<!ATTLIST patternmap
hash-function ( classic | djb2 | sdbm | murmur2 ) "murmur2"
size CDATA "131111"
>
<!ELEMENT portals (endpoint | peer)+>
<!ELEMENT endpoint (name, domain-id, cost?, source-deletion-delay?, max-queue?, smart-batch?, lbm-config?, lbm-attributes?, acl?, topic-resolution?, late-join?, topic-purge?, topic-interest-generate?, topic-domain-activity?, pattern-purge?, pattern-interest-generate?, pattern-domain-activity?, remote-topic?, remote-pattern?, source-context-name?, receiver-context-name?, sqn-window?, context-query?, publishing-interval? )>
<!ELEMENT peer (name, cost?, sourcemap?, (tcp | single-tcp), source-deletion-delay?, max-queue?, smart-batch?, max-datagram?, batching?, lbm-config?, lbm-attributes?, acl?, topic-purge?, topic-interest-generate?, topic-domain-activity?, pattern-purge?, pattern-interest-generate?, pattern-domain-activity?, topic-use-check?, pattern-use-check?, source-context-name?, receiver-context-name?, sqn-window?, context-query?, gateway-keepalive?, publishing-interval? )>
<!ELEMENT name ( #PCDATA )>
<!ATTLIST name xml:space (default | preserve) "default">
<!ELEMENT domain-id ( #PCDATA )>
<!ELEMENT cost ( #PCDATA )>
<!ELEMENT source-deletion-delay ( #PCDATA )>
<!ELEMENT sourcemap EMPTY>
<!ATTLIST sourcemap
size CDATA "131072"
>
<!ELEMENT tcp (interface?, listen-port, receive-buffer?, send-buffer?, keepalive?, nodelay?, compression?, tls?, companion )>
<!ELEMENT interface ( #PCDATA )>
<!ELEMENT listen-port ( #PCDATA )>
<!ELEMENT receive-buffer ( #PCDATA )>
<!ELEMENT send-buffer ( #PCDATA )>
<!ELEMENT keepalive EMPTY >
<!ELEMENT nodelay EMPTY >
<!ELEMENT companion (address, port)>
<!ELEMENT compression ( #PCDATA )>
<!ELEMENT tls (certificate, certificate-key, certificate-key-password?, trusted-certificates?, cipher-suites? )>
<!ELEMENT certificate ( #PCDATA )>
<!ELEMENT certificate-key ( #PCDATA )>
<!ELEMENT certificate-key-password ( #PCDATA )>
<!ELEMENT trusted-certificates ( #PCDATA )>
<!ELEMENT cipher-suites ( #PCDATA )>
<!ATTLIST companion
reconnect-interval CDATA "5000"
>
<!ELEMENT address ( #PCDATA )>
<!ELEMENT port ( #PCDATA )>
<!ELEMENT single-tcp (interface?, receive-buffer?, send-buffer?, keepalive?, nodelay?, compression?, tls?, (initiator | acceptor ) )>
<!ELEMENT initiator (address, port)>
<!ATTLIST initiator
reconnect-interval CDATA "5000"
>
<!ELEMENT acceptor (listen-port)>
<!ELEMENT max-queue ( #PCDATA )>
<!ELEMENT smart-batch ( #PCDATA )>
<!ELEMENT max-datagram ( #PCDATA )>
<!ELEMENT batching (min-length?, batch-interval?)>
<!ELEMENT min-length ( #PCDATA )>
<!ELEMENT batch-interval ( #PCDATA )>
<!ELEMENT lbm-config ( #PCDATA )>
<!ATTLIST lbm-config xml:space (default | preserve) "default">
<!ELEMENT lbm-attributes (option+)>
<!ELEMENT option EMPTY>
<!ATTLIST option
scope (receiver | context | source | wildcard_receiver | event_queue) #REQUIRED
name CDATA #REQUIRED
value CDATA #REQUIRED
>
<!ELEMENT acl (inbound?, outbound?)>
<!ELEMENT inbound (ace+)>
<!ELEMENT outbound (ace+)>
<!ELEMENT ace (topic | pcre-pattern | regex-pattern | transport | source-ip | multicast-group | udp-source-port | udp-destination-port | tcp-source-port | xport-id)+ >
<!ATTLIST ace match (accept | reject) #REQUIRED >
<!ELEMENT topic ( #PCDATA )>
<!ATTLIST topic
xml:space (default | preserve) "default"
>
<!ELEMENT pcre-pattern ( #PCDATA )>
<!ATTLIST pcre-pattern
xml:space (default | preserve) "default"
>
<!ELEMENT regex-pattern ( #PCDATA )>
<!ATTLIST regex-pattern
xml:space (default | preserve) "default"
>
<!ELEMENT transport EMPTY>
<!ATTLIST transport
value (tcp | lbt-rm | lbtrm | lbt-ru | lbtru | lbt-ipc | lbtipc) #REQUIRED
comparison (eq | equal | ne | notequal) #REQUIRED
>
<!ELEMENT source-ip EMPTY>
<!ATTLIST source-ip
value CDATA #REQUIRED
comparison (eq | equal | ne | notequal | lt | lessthan | le | lessthanequal | gt | greaterthan | ge | greaterthanequal) #REQUIRED
>
<!ELEMENT multicast-group EMPTY>
<!ATTLIST multicast-group
value CDATA #REQUIRED
comparison (eq | equal | ne | notequal | lt | lessthan | le | lessthanequal | gt | greaterthan | ge | greaterthanequal) #REQUIRED
>
<!ELEMENT udp-source-port EMPTY>
<!ATTLIST udp-source-port
value CDATA #REQUIRED
comparison (eq | equal | ne | notequal | lt | lessthan | le | lessthanequal | gt | greaterthan | ge | greaterthanequal) #REQUIRED
>
<!ELEMENT udp-destination-port EMPTY>
<!ATTLIST udp-destination-port
value CDATA #REQUIRED
comparison (eq | equal | ne | notequal | lt | lessthan | le | lessthanequal | gt | greaterthan | ge | greaterthanequal) #REQUIRED
>
<!ELEMENT tcp-source-port EMPTY>
<!ATTLIST tcp-source-port
value CDATA #REQUIRED
comparison (eq | equal | ne | notequal | lt | lessthan | le | lessthanequal | gt | greaterthan | ge | greaterthanequal) #REQUIRED
>
<!ELEMENT xport-id EMPTY>
<!ATTLIST xport-id
value CDATA #REQUIRED
comparison (eq | equal | ne | notequal | lt | lessthan | le | lessthanequal | gt | greaterthan | ge | greaterthanequal) #REQUIRED
>
<!ELEMENT topic-resolution (topic-use-query?, pattern-use-query?, remote-topic-interest?, remote-pattern-interest?, domain-route?, initial-request? )>
<!ELEMENT topic-use-query (rate-limit? ) >
<!ATTLIST topic-use-query
timeout CDATA "3000"
max CDATA "5"
periodic-interval CDATA "300000"
>
<!ELEMENT pattern-use-query (rate-limit? ) >
<!ATTLIST pattern-use-query
timeout CDATA "3000"
max CDATA "5"
periodic-interval CDATA "300000"
>
<!ELEMENT remote-topic-interest (rate-limit? ) >
<!ATTLIST remote-topic-interest
min-interval CDATA "1000"
max-interval CDATA "60000"
>
<!ELEMENT remote-pattern-interest (rate-limit? ) >
<!ATTLIST remote-pattern-interest
min-interval CDATA "1000"
max-interval CDATA "60000"
>
<!ELEMENT domain-route (rate-limit? ) >
<!ATTLIST domain-route
min-interval CDATA "100"
max-interval CDATA "1000"
>
<!ELEMENT rate-limit EMPTY>
<!ATTLIST rate-limit
bps CDATA #IMPLIED
objects-per-second CDATA #IMPLIED
>
<!ELEMENT initial-request EMPTY>
<!ATTLIST initial-request
periodic-interval CDATA "1000"
duration CDATA "10"
>
<!ELEMENT late-join EMPTY>
<!ATTLIST late-join
provide ( source | always | never ) "source"
forward ( yes | no ) "yes"
>
<!ELEMENT topic-purge EMPTY>
<!ATTLIST topic-purge periodic-interval CDATA #IMPLIED>
<!ELEMENT topic-interest-generate EMPTY>
<!ATTLIST topic-interest-generate
periodic-interval CDATA #IMPLIED
max-topics CDATA #IMPLIED
interval CDATA #IMPLIED
>
<!ELEMENT topic-domain-activity EMPTY>
<!ATTLIST topic-domain-activity timeout CDATA #IMPLIED>
<!ELEMENT pattern-purge EMPTY>
<!ATTLIST pattern-purge periodic-interval CDATA #IMPLIED>
<!ELEMENT pattern-interest-generate EMPTY>
<!ATTLIST pattern-interest-generate
periodic-interval CDATA #IMPLIED
max-patterns CDATA #IMPLIED
interval CDATA #IMPLIED
>
<!ELEMENT pattern-domain-activity EMPTY>
<!ATTLIST pattern-domain-activity timeout CDATA #IMPLIED>
<!ELEMENT remote-topic EMPTY>
<!ATTLIST remote-topic
check-interval CDATA "90000"
max-topics CDATA "100"
timeout CDATA "300000"
>
<!ELEMENT remote-pattern EMPTY>
<!ATTLIST remote-pattern
check-interval CDATA "90000"
max-patterns CDATA "100"
timeout CDATA "300000"
>
<!ELEMENT topic-use-check EMPTY>
<!ATTLIST topic-use-check periodic-interval CDATA #IMPLIED>
<!ELEMENT pattern-use-check EMPTY>
<!ATTLIST pattern-use-check periodic-interval CDATA #IMPLIED>
<!ELEMENT monitor (transport-module?, format-module?)>
<!ATTLIST monitor
interval CDATA "0"
>
<!ELEMENT transport-module EMPTY>
<!ATTLIST transport-module
module (lbm | lbmsnmp | udp) "lbm"
options CDATA #IMPLIED
>
<!ELEMENT format-module EMPTY>
<!ATTLIST format-module
module (csv) "csv"
options CDATA #IMPLIED
>
<!ELEMENT web-monitor ( #PCDATA )>
<!ATTLIST web-monitor xml:space (default | preserve) "default">
<!ELEMENT propagation-delay EMPTY>
<!ATTLIST propagation-delay delta CDATA #IMPLIED>
<!ELEMENT xml-config ( #PCDATA )>
<!ATTLIST xml-config xml:space (default | preserve) "default">
<!ELEMENT source-context-name ( #PCDATA )>
<!ATTLIST source-context-name xml:space (default | preserve) "default">
<!ELEMENT receiver-context-name ( #PCDATA )>
<!ATTLIST receiver-context-name xml:space (default | preserve) "default">
<!ELEMENT sqn-window EMPTY>
<!ATTLIST sqn-window
size CDATA "16384"
increment CDATA "2048"
>
<!ELEMENT context-query EMPTY>
<!ATTLIST context-query
periodic-interval CDATA #IMPLIED
max-contexts CDATA #IMPLIED
interval CDATA #IMPLIED
timeout CDATA #IMPLIED
>
<!ELEMENT gateway-keepalive EMPTY>
<!ATTLIST gateway-keepalive
idle ( yes | no ) "yes"
interval CDATA "5000"
timeout CDATA "15000"
>
<!ELEMENT route-info EMPTY>
<!ATTLIST route-info
propagation-interval CDATA "1000"
check-interval CDATA "750"
timeout CDATA "4000"
max-hop-count CDATA "100"
>
<!ELEMENT route-recalculation EMPTY>
<!ATTLIST route-recalculation
backoff-interval CDATA "5000"
warning-interval CDATA "10000"
>
<!ELEMENT daemon-monitor (lbm-config?, publishing-interval?, remote-snapshot-request?, remote-config-changes-request?)>
<!ATTLIST daemon-monitor topic CDATA "tnwgd.monitor">
<!ELEMENT publishing-interval (group+)>
<!ELEMENT group EMPTY>
<!ATTLIST group name (default | gateway-config | route-manager-topology | malloc-info | portal-config | portal-stats ) #REQUIRED>
<!ATTLIST group ivl CDATA #REQUIRED>
<!ELEMENT remote-snapshot-request EMPTY>
<!ATTLIST remote-snapshot-request allow (0 | 1) "0">
<!ELEMENT remote-config-changes-request EMPTY>
<!ATTLIST remote-config-changes-request allow (0 | 1) "0">


UM Router Daemon Statistics  <-

This section contains details on the UM Router's Daemon Statistics feature. You should already be familiar with the general information contained in Daemon Statistics.


UM Router Daemon Statistics Structures  <-

The different message types are:

Each one has a specific structure associated with it, as detailed in the file tnwgdmonmsgs.h.

Note that message types ending with "CFG" are in the config category. All others are in the stats category. See Daemon Statistics Structures for information on how the two categories are handled differently.


UM Router Daemon Statistics Byte Swapping  <-

A monitoring application receiving these messages must detect if there is an endian mismatch (see Daemon Statistics Binary Data). The header structure tnwg_dstat_msg_hdr_t contains a 16-bit field named magic which is set equal to LBM_TNWG_DAEMON_MAGIC. The receiving application should compare it to LBM_TNWG_DAEMON_MAGIC and LBM_TNWG_DAEMON_ANTIMAGIC. Anything else would represent a serious problem.

If the receiving app sees:

then it can simply access the binary fields directly. However, if it sees:

then most (but not all) binary fields need to be byte-swapped. See tnwgdmon.c for an example, paying special attention to the macros COND_SWAPxx (which conditionally swaps based on the magic test) and the functions byte_swapXX() (which performs the byte swapping).


UM Router Daemon Statistics String Buffers  <-

UM Router Daemon Statistics data structures sometimes contain string buffers. Strings in these data structures are always null-terminated. These messages are generally sent as fixed-length equal to the sizes of the structures, and therefore include all of the declared bytes of the string fields, even if the contained string uses fewer bytes than declared. For example, the structure tnwg_dstat_record_hdr_t contains the field tnwg_dstat_record_hdr_t_stct::portal_name which is a char array of size TNWG_DSTAT_MAX_PORTAL_NAME_LEN. If portal_name is set to "p1", then only 3 bytes of the buffer are used (including the null string terminator). However, all TNWG_DSTAT_MAX_PORTAL_NAME_LEN bytes will be sent in the TNWG_DSTATTYPE_RM_PORTAL message type.

Contrast this with Store Daemon Statistics String Buffers.

There are two exceptions to this rule: TNWG_DSTATTYPE_PORTCFG and TNWG_DSTATTYPE_GATEWAYCFG.

The TNWG_DSTATTYPE_PORTCFG message is of type tnwg_pcfg_stat_grp_msg_t and has the field tnwg_pcfg_stat_grp_msg_t_stct::data. This field is a variable-length string buffer which contains one or more null-terminated strings. The total length of the TNWG_DSTATTYPE_PORTCFG message is the sum of the length of its sub-structures plus the number of bytes of string data (characters plus string-terminating nulls). The number of strings in tnwg_pcfg_stat_grp_msg_t_stct::data is given by tnwg_pcfg_stat_grp_msg_t_stct::rechdr->num_options. The monitoring application must step through the string buffer that many times to find each string. For an example of how to do this, see tnwgdmon.c in the code following, "`case TNWG_DSTATTYPE_PORTCFG:`".

The TNWG_DSTATTYPE_GATEWAYCFG message is of type tnwg_dstat_gatewaycfg_msg_t and has the field tnwg_dstat_gatewaycfg_msg_t_stct::data. This field is a variable-length string buffer which contains exactly one null-terminated string. This string contains the entirety of the UM Router's configuration file. The individual lines contain the normal line-ending character(s). The total length of the TNWG_DSTATTYPE_GATEWAYCFG message is the length of its sub-structure plus the number of bytes of string data (characters plus string-terminating nulls).


UM Router Daemon Statistics Configuration  <-

There are three places in the UM Router configuration file that Daemon Statistics are configured:

  • The <daemon-monitor> element inside the <daemon> definition. Configures all aspects of the Store Daemon Statistics feature, including publishing intervals.
  • The <publishing-interval> element inside the <peer> definition. Configures only the publishing intervals on a peer portal basis.
  • The <publishing-interval> element inside the <endpoint> definition. Configures only the publishing intervals on an endpoint portal basis.

Here is an example of configuring daemon statistics.

<?xml version="1.0" encoding="UTF-8" ?>
<!-- G1 xml file- 2 endpoint portals -->
<tnw-gateway version="1.0">
<daemon>
...
<publishing-interval>
<group name="default" ivl="3"/>
<group name="gateway-config" ivl="120"/>
<group name="portal-config" ivl="120"/>
</publishing-interval>
<remote-snapshot-request allow="1"/>
<remote-config-changes-request allow="1"/>
</daemon>
<portals>
<endpoint>
<name>G1-TRD1</name>
...
<publishing-interval>
<group name="default" ivl="6"/>
<group name="gateway-config" ivl="120"/>
<group name="portal-config" ivl="120"/>
</publishing-interval>
</endpoint>
...
</portals>
</tnw-gateway>

In this example, all stats-type messages are (conditionally) published on a 3-second interval, except those of portal G1-TRD1, which are published (conditionally) on a 6-second interval. All config-type messages are published (unconditionally) on a 120-second interval.


UM Router Daemon Statistics Requests  <-

The UM Router Daemon supports a monitoring application to send a specific set of requests to control the operation of Daemon Statistics. The <remote-snapshot-request> and <remote-config-changes-request> configuration elements control whether the Store enables this request feature (defaults to disabled).

If enabled, the monitoring application can send a command message to the UM Router in the form of a topicless unicast immediate "request" message (see lbm_unicast_immediate_request() with NULL for topic). The format of the message is a simple ascii string, with or without null termination. Due to the simple format of the message, no data structure is defined for it.

When the UM Router receives and validates the command, it sends a UM response message back to the requesting application containing a status message (which is not null-terminated). If the status was OK, the Store also performs the requested action.

The example program tnwgdcmd.c demonstrates the correct way to send the messages and receive the responses.

Commands enabled by <remote-snapshot-request>:

version
The UM Router returns in its command response the value of LBM_UMESTORE_DMON_VERSION. No daemon statistics messages are published.
snap mallinfo
The UM Router immediately publishes the memory allocation usage message of type TNWG_DSTATTYPE_MALLINFO.
snap pstat
The UM Router immediately publishes the portal statistics message(s) of type TNWG_DSTATTYPE_PORTSTAT.
snap ri
The UM Router immediately publishes the route information message(s) of types TNWG_DSTATTYPE_RM_LOCAL, TNWG_DSTATTYPE_RM_PORTAL TNWG_DSTATTYPE_RM_OTHERGW, and TNWG_DSTATTYPE_RM_OTHERGW_NBR.
snap gcfg
The UM Router immediately publishes the gateway configuration message TNWG_DSTATTYPE_GATEWAYCFG.
snap pcfg
The UM Router immediately publishes the portal configuration message(s) TNWG_DSTATTYPE_PORTCFG.

Commands enabled by <remote-config-changes-request>:

mallinfo N
Set the publishing interval for memory allocation usage.
For example: mallinfo 5
ri N
Set the publishing interval for the route information messages.
For example: ri 5
gcfg N
Set the publishing interval for the gateway configuration message.
For example: gcfg 5
pstat N
Set the publishing interval for the portal statistics messages. This command can be preceded by a portal name in double quote marks to only set the publishing interval for that portal.
For example: "G1-TRD1" pstat 5
pcfg N
Set the publishing interval for the portal configuration messages. This command can be preceded by a portal name in double quote marks to only set the publishing interval for that portal.
For example: "G1-TRD1" pcfg 5


UM Router Monitoring  <-


UM Router Web Monitor  <-

The built-in web monitor (configured in the tnwgd XML configuration file; see XML Configuration Reference) provides valuable statistics about the UM Router and its portals, for which, the Web Monitor separates into receive statistics and send statistics. The Web Monitor provides a page for each endpoint and peer portal.

Warning
The UM Router's web monitor is not designed to be a highly-secure feature. Anybody with access to the network can access the web monitor pages.

Users are expected to prevent unauthorized access to the web monitor through normal firewalling methods. Users who are unable to limit access to a level consistent with their overall security needs should disable the store web monitor (using <web-monitor>). See Webmon Security for more information.

Note
the UM daemon designs are evolving away from simple web-based monitoring and towards a publish/subscribe model of distributing monitoring events and statistics.


Main Page  <-

This page displays general information about the UM Router, and also provides the following links to more detailed statistical and configuration information.

UM Router Configuration
Displays the UM Router XML configuration file used by this UM Router.
Portals
Displays portal statistics and information, one portal per page. The Portals page allows you to link to any of the Peer or Endpoint portals configured for the UM Router.
Topology Info
This links to a page that displays UM Router network connectivity information from the perspective of this UM Router.
Path Info
This lets you query and display a hop path that messages will take between any two TRDs.

On some platforms, the Main page may include a link (GNU malloc info) to a memory allocation display page that displays the following:

arena
Non-mmapped space allocated (bytes)
ordblks
Number of free chunks
hblks
Number of mmapped regions
hblkhd
Space allocated in mmapped regions (bytes)
uordblks
Total allocated space (bytes)
fordblks
Total free space (bytes)


Endpoint Portal Page  <-

The Endpoint Portal Page displays Receive and Send statistics for the selected endpoint portal. Receive statistics pertain to messages entering the portal from its connected TRD. Send statistics pertain to messages sent out to the TRD.

Click on any of the links at the top of the page to review configuration option values for the portal's UM topic resolution domain. The two columns provide different units of measure for a given statistic type, where the first column is typically in fragments or messages (depending on the statistic type), and the second column is in bytes.


Endpoint Portal name

Domain ID
The ID for the Topic Resolution Domain (TRD) to which this portal is connected.
Portal Cost
The cost value assigned to this portal.
Local Interest
Totals (listed below) for topics and patterns in this portal's interest list that originated from receivers in the immediately adjacent TRD.
Topics
Of the local interest total, the number of topics.
PCRE patterns
Of the local interest total, the number of wildcard patterns, using PCRE pattern matching.
REGEX patterns
Of the local interest total, the number of wildcard patterns, using REGEX pattern matching.
Remote Interest
Totals (listed below) for topics and patterns in this portal's interest list that originated from receivers beyond and downstream from the immediately adjacent TRD.
Topics
Of the remote interest total, the number of topics.
PCRE patterns
Of the remote interest total, the number of wildcard patterns, using PCRE pattern matching.
REGEX patterns
Of the remote interest total, the number of wildcard patterns, using REGEX pattern matching.
Proxy Receivers
The number of proxy receivers active in this portal.
Receiver Topics
The number of topics in which the other portals in the UM Router have detected current interest and summarily propagated to this portal.
Receiver PCRE patterns
The number of wildcard patterns, using PCRE pattern matching, in which the other portals in the UM Router have detected current interest and summarily propagated to this portal.
Receiver REGEX patterns
The number of wildcard patterns, using REGEX pattern matching, in which the other portals in the UM Router have detected current interest and summarily propagated to this portal.
Proxy Sources
The number of proxy sources active in this portal.


Endpoint Receive Statistics

Transport topic fragments/bytes received
The total transport-based topic-related traffic of messages containing user data received by this portal from a TRD. The first column counts the number of fragments (or whole messages for messages that were not fragmented).
Transport topic request fragments/bytes received
Topic messages received that are request messages, i.e., messages send via lbm_send_request*() rather than lbm_src_send*().
Transport topic control msgs/bytes received
The total transport-based topic-related traffic received by this portal from a TRD. These are supervisory messages, which include TSNIs, SRIs., etc. The first column counts the number of messages.
Immediate topic fragments/bytes received
The total number of Multicast Immediate Messaging (MIM) messages or message fragments, and bytes (second column), that have a topic, received at this portal.
Immediate topic request fragments/bytes received
Of the MIM topic messages received, this is the amount of those that are requests.
Immediate topicless fragments/bytes received
The total number of MIM messages or message fragments, and bytes (second column), with null topics, received by his portal.
Immediate topicless request fragments/bytes received
Of the MIM topicless messages received, this is the amount of those that are requests.
Unicast data messages/bytes received
The total number of Unicast Immediate Messaging (UIM) messages (and bytes, second column) containing user data, received by this portal.
Duplicate unicast data messages/bytes dropped
UIM data messages discarded because they were duplicates of messages already received.
Unicast data messages/bytes received with no stream info
UIM data messages discarded because they were from an earlier, incompatible version of UM. This tally should stay at 0; otherwise, contact Informatica Support.
Unicast data messages/bytes received with no route to destination
UIM data messages that are on a wrong path, possibly due to a route recalculation. This tally should stay at 0, though it may increment a few messages at the time of a topology change.
Unicast control messages/bytes received
The total number of Unicast Immediate Messaging (UIM) supervisory (non-data) messages (and bytes, second column) received by this portal.
Duplicate unicast control messages/bytes dropped
Supervisory UIMs dropped because they were duplicates of messages already received.
Unicast control messages/bytes received with no stream info
Supervisory UIMs dropped because they were from an earlier, incompatible version of UM. This tally should stay at 0; otherwise, contact Informatica Support.
Unicast control messages/bytes received with no route to destination
Supervisory UIM messages that are on a wrong path, possibly due to a route recalculation. This tally should stay at 0, though it may increment a few messages at the time of a topology change.


Endpoint Send Statistics

Transport topic fragments/bytes forwarded
The total transport-based topic-related traffic forwarded to this portal from other portals in this UM Router. This could include user messages, TSNIs, SRIs, etc. The first column counts the number of fragments (or whole messages for messages that were not fragmented).
Transport topic fragments/bytes sent
Of the transport topic traffic forwarded, this is the amount of traffic sent out to the TRD.
Transport topic request fragments/bytes sent
Of the messages sent, this is the amount of those that are requests.
Duplicate transport topic fragments/bytes dropped
Of the messages forwarded to this portal, this is the total of those that were discarded because they were duplicates of messages already received.
Transport topic fragments/bytes dropped due to blocking
Of the messages forwarded to this portal, this is the amount of those that were discarded because they were blocked from sending, and were unable to be buffered. Message rates on other portals probably exceeded the rate controller limit on this portal.
Transport topic fragments/bytes dropped due to error
Of the messages forwarded to this portal, this is the total of those that were discarded due to an application or network connection failure.
Transport topic fragments/bytes dropped due to fragment size error
Of the messages forwarded to this portal, this is the total of those that were discarded possibly because of a configuration error. If this count is not at or near 0, verify that maximum datagram size for all transports is the same throughout the network.
Immediate topic fragments/bytes forwarded
The total number of Multicast Immediate Messaging (MIM) messages or message fragments, and bytes (second column), forwarded to this portal from other portals in this UM Router.
Immediate topic fragments/bytes sent
Of the MIM topic messages forwarded to this portal, this is the amount of traffic sent out to the TRD.
Immediate topic request fragments sent
Of the MIM topic messages sent, this is the amount of those that are requests.
Immediate topic fragments/bytes dropped due to blocking
Of the MIM topic messages forwarded to this portal, this is the amount of those that were discarded because they were blocked from sending, and were unable to be buffered. Message rates on other portals probably exceeded the rate controller limit on this portal.
Immediate topic fragments/bytes dropped due to error
Of the MIM topic messages forwarded to this portal, those that were discarded due to an application or network connection failure.
Immediate topic fragments/bytes dropped due to fragment size error
Of the MIM topic messages forwarded to this portal, those that were dropped possibly because of a configuration error. If this count is not at or near 0, verify that maximum datagram size for all transports is the same throughout the network.
Immediate topicless fragments/bytes forwarded
The total number of Multicast Immediate Messaging (MIM) messages or message fragments, and bytes (second column), with null topics, forwarded to this portal from other portals in this UM Router.
Immediate topicless fragments/bytes sent
Of the MIM topicless messages forwarded to this portal, this is the amount of traffic sent out to the TRD.
Immediate topicless request fragments sent
Of the MIM topicless messages sent, this is the amount of those that are requests.
Immediate topicless fragments/bytes dropped due to blocking
Of the MIM topicless messages forwarded to this portal, this is the amount of those that were discarded because they were blocked from sending, and were unable to be buffered. Message rates on other portals probably exceeded the rate controller limit on this portal.
Immediate topicless fragments/bytes dropped due to error
Of the MIM topicless messages forwarded to this portal, those that were discarded due to an application or network connection failure.
Immediate topicless fragments/bytes dropped due to fragment size error
Of the MIM topicless messages forwarded to this portal, those that were dropped possibly because of a configuration error. If this count is not at or near 0, verify that maximum datagram size for all transports is the same throughout the network.
Unicast messages/bytes forwarded
The total number of Unicast Immediate Messaging (UIM) messages (and bytes, second column), both control and containing user data, forwarded to this portal.
Unicast messages/bytes sent
Of the UIM data messages forwarded to this portal, this is the amount of traffic sent out to the TRD.
Unicast messages/bytes dropped due to error
Of the UIM data messages forwarded to this portal, those that were discarded due to an application or network connection failure.
Current/maximum data bytes enqueued (limit: n)
For bytes in this portal's send buffer (due to a blocking send), the first column is a snapshot of the current amount, and the second column is a high-water mark. The displayed limit (n) is the configuration value for option <max-queue>.


Peer Portal Page  <-

This page allows you to see Receive and Send statistics for the selected peer portal. Click on any of the links at the top of the page to review configuration option values for the portal's UM topic resolution domain.

The peer portal page displays the following statistics:


Peer Portal name

Portal Cost
The cost value assigned to this portal.
Interest
Totals (listed below) for topics and patterns in this portal's interest list that originated from receivers beyond and downstream from the immediately adjacent UM Router.
Topics
Of the interest total, the number of topics.
PCRE patterns
Of the interest total, the number of wildcard patterns, using PCRE pattern matching.
REGEX patterns
Of the interest total, the number of wildcard patterns, using REGEX pattern matching.
Proxy Receivers
The number of proxy receivers active in this portal.
Receiver topics
All topics in which the other portals in the UM Router have detected current interest and summarily propagated to this portal.
Receiver PCRE patterns
All wildcard patterns, using PCRE pattern matching, in which the other portals in the UM Router have detected current interest and summarily propagated to this portal.
Receiver REGEX patterns
All wildcard patterns, using REGEX pattern matching, in which the other portals in the UM Router have detected current interest and summarily propagated to this portal.
Proxy Sources
The number of proxy sources active in this portal.


Peer Receive Statistics

Data messages/bytes received
The total of messages containing data received at this portal. The first column counts the number of fragments (or whole messages for messages that were not fragmented).
Transport topic fragment data messages/bytes received
The total of user-data messages received on any topic resolved through this portal. The first column counts the number of fragments (or whole messages for messages that were not fragmented).
Transport topic fragment data messages/bytes received with unknown source
Topic messages received whose source this UM Router has not seen before.
Transport topic request fragment data messages/bytes received
These are topic messages received that are request messages, i.e., messages send via lbm_send_request*() rather than lbm_src_send*().
Transport topic request fragment data messages/bytes received with unknown source
Of the request messages received, the topic messages received whose source this UM Router has not seen before.
Immediate topic fragments/bytes received
The total number of Multicast Immediate Messaging (MIM) messages or message fragments, and bytes (second column), that have a topic, received by all proxy receivers at this portal.

Immediate topic request fragments/bytes received Of the MIM topic messages received, this is the total of those that are requests.

Immediate topicless fragments/bytes received
The total number of MIM messages or message fragments, and bytes (second column), with null topics, received by all proxy receivers at this portal.
Immediate topicless request fragments/bytes received
Of the MIM topicless messages received, this is the total of those that are requests.
Unicast data messages/bytes received
The total number of Unicast Immediate Messaging (UIM) messages (and bytes, second column) containing user data, received by this portal.
Unicast data messages/bytes received with no stream information
UIM data messages discarded because they were from an earlier, incompatible version of UM. This tally should stay at 0; otherwise, contact Informatica Support.
Unicast data messages/bytes received with no route to destination
UIM data messages that are on a wrong path, possibly due to a route recalculation. This tally should stay at 0, though it may increment a few messages at the time of a topology change.
Control messages/bytes received
The total of supervisory messages (containing no data) received at this portal.
Transport topic control messages/bytes received
Of the control messages received, those that are transport/topic based (such as TSNIs, SRIs., etc.).
Transport topic control messages/bytes received with unknown source
Of the transport/topic control messages received whose source this UM Router has not seen before.
Unicast control messages/bytes received
The total number of Unicast Immediate Messaging (UIM) supervisory (non-data) messages (and bytes, second column) received by this portal.
Retransmission requests/bytes received
Supervisory UIMs that are requests for retransmission of lost (or Late Join) messages.
Control messages/bytes received with no stream info
Supervisory UIMs discarded because they were from an earlier, incompatible version of UM. This tally should stay at 0; otherwise, contact Informatica Support.
Control messages/bytes received with no route to destination
Supervisory UIM messages that are on a wrong path, possibly due to a route recalculation.
Gateway control messages/bytes received
The total of UM Router-only, peer-to-peer supervisory messages received at this portal.
Unhandled control messages/bytes received
Supervisory UIMs discarded because, though they are well-formed, they have no valid action request. This tally should stay at 0; otherwise, contact Informatica Support.


Peer Send Statistics

Transport topic fragments/bytes forwarded
The total transport-based topic-related traffic forwarded to this portal from other portals in this UM Router. This could include user messages, TSNIs, SRIs., etc. The first column counts the number of fragments (or whole messages for messages that were not fragmented).
Transport topic fragments/bytes sent
Of transport topic messages forwarded to this portal, the amount of traffic sent to the adjacent UM Router.
Transport topic request fragments/bytes sent
Of transport topic messages sent, those that were request messages.
Transport topic fragments/bytes dropped (duplicate)
Of transport topic messages forwarded to this portal, messages discarded because they were duplicates of messages already received.
Transport topic fragments/bytes dropped (blocking)
Of transport topic messages forwarded to this portal, this is the amount of those that were discarded because they were blocked from sending, probably due to TCP flow control, and were unable to be buffered. The UM Router's XML configuration file may need to be adjusted.
Transport topic fragments/bytes dropped (not operational)
Of transport topic messages forwarded to this portal, messages discarded because the peer link is down.
Transport topic fragments/bytes dropped (queue failure)
Of transport topic messages forwarded to this portal, messages discarded due to a memory allocation failure.
Unicast messages/bytes forwarded
The total number of supervisory (no data payloads) Unicast Immediate Messaging (UIM) messages (and bytes, second column) forwarded to this portal from other portals in this UM Router. These messages can be either control (supervisory) messages or contain user data.
Unicast messages/bytes sent
Of the UIMs forwarded to this portal, the amount of traffic sent to the adjacent UM Router.
Unicast messages/bytes dropped (blocking)
Of the UIMs forwarded to this portal, this is the amount of those that were discarded because they were blocked from sending, probably due to TCP flow control, and were unable to be buffered. The UM Router's XML configuration file may need to be adjusted.
Unicast messages/bytes dropped (not operational)
Of the UIMs forwarded to this portal, messages discarded because the peer link is down.
Unicast messages/bytes dropped (queue failure)
Of the UIMs forwarded to this portal, messages discarded due to a memory allocation failure.
Gateway control messages/bytes sent
The total number of UM Router supervisory messages (and bytes, second column), generated at this portal.

Gateway control messages/bytes sent Of the UM Router supervisory messages generated, the number sent to the adjacent UM Router.

Gateway control messages/bytes dropped (blocking) The amount of UM Router supervisory messages that were discarded because they were blocked from sending, probably due to TCP flow control, and were unable to be buffered. The UM Router's XML configuration file may need to be adjusted.

Gateway control messages/bytes dropped (not operational)
The amount of UM Router supervisory messages that were discarded because the peer link was down.
Gateway control messages/bytes dropped (queue failure)
The amount of UM Router supervisory messages that were discarded due to a memory allocation failure.
Batches
The number of times messages were batched.
Minimum messages/bytes per batch
The lowest recorded number of messages in a batch, and the number of bytes in that batch.
Average messages/bytes per batch
The average number of messages in a batch, and the number of bytes in that average batch.
Maximum messages/bytes per batch
The highest recorded number of messages in a batch, and the number of bytes in that batch.
Current/maximum data bytes enqueued
For bytes in this portal's send buffer (due to a blocking send), the first column is a snapshot of the current amount, and the second column is a high-water mark. The displayed limit is the configuration value for option <max-queue>.
Keepalive/RTT samples
The number of keepalive messages that have been set to the other UM Router's portal and responded to.
Minimum RTT (microseconds)
Of the keepalives sent and responded to, the lowest recorded round-trip time.
Mean RTT (microseconds)
Of the keepalives sent and responded to, the mean recorded round-trip time.
Maximum RTT (microseconds)
Of the keepalives sent and responded to, the highest recorded round-trip time.
Last keepalive responded to
The send timestamp (date and time) of the last sent keepalive message that was responded to.


Topology Info Page  <-

This page allows you to see UM Router network connectivity information from the perspective of this UM Router. The Other UM Routers section (below) provides information in the same format as is used for the local UM Router.

Local UM Router Name
The UM Router name as assigned via configuration.
Local UM Router ID
A unique value that the UM Router assigns to itself automatically.
Self Version
A configuration version for this UM Router, as seen collectively by the UM Router network.
Topology Signature
An identifier for the "map" of this UM Router network's routes. This value should be the same for all UM Routers.
Last recalc duration
The amount of time in seconds that it took this UM Router to perform its most recent route recalculation.
Graph Version
The number of times this UM Router has updated its view of the topology.
UM Router Count
The number of UM Routers in this UM Router network.
Topic Resolution Domain Count
The number of TRDs in this UM Router network.


Portal (endpoint or peer)

This display is repeated for each portal of this UM Router.

Portal Name
The portal's name as assigned via configuration.
Adjacent Domain/UM Router ID
For an endpoint portal, this is the configured <domain-id> for the connected TRD. For a peer portal, this is an automatically assigned unique identifier for the connected UM Router.
Cost
This portal's configured cost.
Last interest recalc duration
The amount of time in seconds that it took this UM Router to perform a recalculation that resulted in an update to the interest status for this portal.
Last proxy receiver recalc duration
The amount of time in seconds that it took this UM Router to perform recalculation that resulted in an update to the status of proxy receivers (create, maintain, or destroy) for this portal.


Other UM Routers

This display is repeated for each other UM Router in this UM Router's network.

UM Router Name
The UM Router name as assigned via configuration.
UM Router ID
A unique value that the UM Router assigns to itself automatically.
Version
A configuration version for the UM Router, as seen collectively by the UM Router network.
Topology Signature
An identifier for the "map" of this UM Router network's routes. This value should be the same for all UM Routers.
Last Activity n seconds ago
How long since the last time this local UM Router received a route info packet from the designated "other" UM Router.
Adjacent Domain ID
The configured ID of one of this "other" UM Router's connected TRD, plus the cost assigned to the associate endpoint portal. If there are more than one endpoint portals in the UM Router, this line is repeated for each.
Adjacent UM Router ID
The automatically assigned ID of one of this "other" UM Router's connected UM Router, plus the cost assigned to the associate peer portal. If there are more than one peer portals in the UM Router, this line is repeated for each.


Path Info  <-

The Path Info page lets you query and display a hop path that messages will take between any two TRDs that you enter into the Domain ID 1 and Domain ID 2 text boxes. Fill in the boxes and click the Calculate Shortest Path button, and you see the following fields:

Hop Count
The number of hops from none node to the next along the displayed route, where a node can be either a UM Router or a TRD.
Aggregate Cost
A sum of the cost values of all portals along the displayed path.
Path
A display of the UM Router and TRD hops listed in route order from the starting TRD to the ending TRD.


UM Router Log Messages  <-

The UM Router daemon generates log messages that are used to monitor its health and operation. You can configure these to be directed to "console" (standard output), "syslog", or a specified log "file", via the <log> configuration element. Normally "console" is only used during testing, as a persistent log file is preferred for production use. The UM Router does not over-write log files on startup, but instead appends them.


UM Router Rolling Logs  <-

To prevent unbounded disk file growth, the UM Router supports rolling log files. When the log file rolls, the file is renamed according to the model:
  CONFIGUREDNAME_PID.DATE.SEQNUM
where:

  • CONFIGUREDNAME - Root name of log file, as configured by user.
  • PID - Process ID of the UM Router daemon process.
  • DATE - Date that the log file was rolled, in YYYY-MM-DD format.
  • SEQNUM - Sequence number, starting at 1 when the process starts, and incrementing each time the log file rolls.

For example: umrouterlog_9867.2017-08-20.2

The user can configure when the log file is eligible to roll over by either or both of two criteria: size and frequency. The size criterion is in millions of bytes. The frequency criterion can be daily or hourly. Once one or both criteria are met, the next message written to the log will trigger a roll operation. These criteria are supplied as attributes to the <log> configuration element.

If both criteria are supplied, then the first one to be reached will trigger a roll. For example, consider the setting:

<log type="file" size="23" frequency="daily">store.log</log>

Let say that the log file grows at 1 million bytes per hour. At 11:00 pm, the log file will reach 23 million bytes, and will roll. Then, at 12:00 midnight, the log file will roll again, even though it is only 1 million bytes in size.

Note
The rolling logs cannot be configured to automatically overwrite old logs. Thus, the amount of disk space consumed by log files will grow without bound. The user must implement a desired process of archiving or deleting older log files according to the user's preference.


Important UM Router Log Messages  <-

Connection Failure Messages

peer portal [name] failed to connect to peer at [IP:port] via [interface] [err]: reason
peer portal [name] failed to accept connection (accept) [err]: reason

Lost Connection Messages

peer portal [name] lost connection to peer at [IP:port] via [interface]
peer portal [name] connection destroyed due to socket failure
peer portal [name] detected dropped inbound connection (read) [err]: reason
peer portal [name] detected dropped inbound connection (zero-len read)

Endpoint Messages

If a UMP store is adjacent to the UM Router, and the UM Router has been restarted, you typically see messages of the form:

endpoint portal [name] has no forwarding entry for destination ctxinst [string], dropping msg (lbmc cntl ume)

These messages are normal, and cease when the UM Router has established the forwarding information for the given context.

Peer Messages

Acceptor: peer portal [name] received connection from [IP:port]
Initiator: peer portal [name] connected to [IP:port ]


UM Router Transport Stats  <-

Using the <monitor> element in a UM Router's XML configuration file and the UMS Monitoring feature, you can monitor the transport activity between the UM Router and its Topic Resolution Domain. The configuration also provides Context and Event Queue statistics. The statistics output identifies individual portals by name.


UM Router Glossary  <-

Access Control List (ACL)
A portal configuration you can use to filter out messages based on a variety of criteria.
forwarding cost
A value assigned to a portal to help determine best-path routing selection.
UM Router keepalive
Control messages exchanged between UM Routers to confirm that UM Routers are still running.
Interest Message
Control messages exchanged between UM Routers to confirm that UM Routers are still running.
Originating Transport ID (OTID)
Unique identifier of a message's transport session at the originating source.
portal
A TCP/IP interface (socket) on a UM Router through which the UM Router passes data. Endpoint portals interface TRDs, and peer portals interface peer portals of other UM Routers.
Topic Resolution Domain (TRD)
The realm of UDP multicast or unicast connectivity that allows UM topic resolution to occur. Blocking of this UDP connectivity (for example, by a firewall or a restrictive WAN link) defines a TRD's boundaries. Contexts within a TRD must have the same topic resolution configuration option settings (multicast group IP address/port and resolver interface full or CIDR address).
Use Query
A periodic control message distributed to all members of a TRD to verify the continued presence of receivers for a given topic or pattern.
web monitor
A web-based real-time UM Router statistics and configuration display.


Comparison to Pre-6.0 UM Gateway  <-

With the release of Ultra Messaging 6.0, the UM Gateway feature is discontinued and replaced by the Ultra Messaging Dynamic Routing Option (also referred to as the UM Router).

The UM Router's primary improvement over the UM Gateway is its ability to intelligently select efficient traffic routes from multiple path choices on a dynamic topic-by-topic basis.

Note
This release of the UM Router is not backward compatible with earlier versions of the UM Gateway in the sense that you cannot have UM Routers and UM Gateways in the same network.


Added Features and Differences  <-

In addition to routing functionality, the following are features of the UM Router that were not provided in the UM Gateway:

  • Multi-path, ring, or mesh topologies
  • Interoperability with MIM and Persistence (see UM Feature Compatibility for complete feature interoperability information)
  • Ability to restart the UM Router within a transport's activity timeout period
  • Reduced topic resolution traffic via more efficient use of Use Queries and Use Query Responses
  • The default value for the portal <cost> is 1 (one). 0 (zero) is not a valid cost value.
  • The UM Router daemon (tnwgd) logs version information on startup.
  • Compression and/or encryption may now be applied to peer links.

The following configuration options exist in the UM Router but not the UM Gateway. See XML Configuration Reference for more information on these options.

  • <name> (as a <daemon> child)
  • <route-info>
  • <route-recalculation>
  • <source-deletion-delay>
  • <max-queue>
  • <remote-topic-interest>
  • <remote-pattern-interest>
  • <rate-limit>
  • <domain-route>
  • <remote-topic>
  • <remote-pattern>
  • <sourcemap>
  • <compression>
  • <tls>