Dynamic Routing Guide
|
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.
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.
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:
Container for all endpoint and peer portal configuration information.
Example:
Container element for all configuration options of a single peer portal.
Example:
Configures the rate at which Daemon Statistics messages are published. See Daemon Statistics for general information on Daemon Statistics.
Example:
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:
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.
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:
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:
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:
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:
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:
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.
Checks for interest in topics at periodic intervals. This element is deprecated and has no function.
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" |
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" |
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" |
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" |
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" |
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" |
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" |
Contains elements (inbound and outbound ACEs) that describe how an ACL (Access Control List) filters messages.
Example:
Container for ACE elements, to separate outbound ACEs from inbound ACEs.
Example:
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:
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:
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:
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:
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:
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:
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:
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:
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 |
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:
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:
Container for ACE elements, to separate inbound ACEs from outbound ACEs.
Example:
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:
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>.
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:
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:
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:
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:
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:
Specifies the maximum size a peer portal will allow an outgoing datagram to be before fragmenting it.
Example:
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:
Sets the maximum buffer size for blocking messages. If not specified, this defaults to 1000000 bytes.
Example:
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:
Contains elements for a peer portal's tcp settings, when configuring the peer for single-tcp operation.
Example:
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:
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:
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:
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:
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:
Contains elements to configure peer link encryption.
Example:
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.
Example:
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.
Example:
Specifies the passphrase needed to decrypt the server private key file specified by <certificate-key>.
Example:
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:
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:
Enables compression and sets the desired data compression algorithm for the peer link. Currently, only LZ4 lossless data compression is supported.
Example:
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:
When present, enables a TCP keepalive signal transmission, which is disabled by default.
Example:
Contains the size of the TCP send buffer. If not specified, the UM Router uses the system default size.
Example:
Contains the size of the TCP receive buffer. If not specified, the UM Router uses the system default size.
Example:
Contains the IP host or network address for this peer portal, specified in dotted-decimal or CIDR format.
Example:
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.)
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 |
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.
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:
Assigns a positive non-zero integer cost to the portal. The default value is 1. See Forwarding Costs.
Example:
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:
Container element for all configuration options of a single endpoint portal.
Example:
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:
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:
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" |
Container for UM Router topic resolution behavior options.
Example:
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:
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:
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) |
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) |
Example:
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:
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:
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:
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:
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:
Container for options common to the entire UM Router process.
Example:
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:
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:
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:
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 |
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:
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:
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:
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:
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:
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:
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:
Example 2:
Monitoring configuration options can be supplied directly in the XML.
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:
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:
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:
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:
Specifies a Group ID (GID) for daemon process (if run as root).
Example:
Specifies a User ID (UID) for the daemon process (if run as root).
Example:
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:
Here is the XML configuration DTD with the comments removed. To see the DTD with comments included, enter tnwgd --dump-dtd
.