ltm message-routing generic router
ltm message-routing generic router(1) BIG-IP TMSH Manual ltm message-routing generic router(1)
NAME
router - Configures a message router instance for routing generic message protocol messages.
MODULE
ltm message-routing generic
SYNTAX
Configure the router component within the ltm message-routing generic module using the syntax shown in the
following sections.
CREATE/MODIFY
create router [name]
modify router [name]
options:
app-service [[string] | none]
defaults-from [ [name] | none]
description [string]
ha-message-sweeper-interval [integer]
ignore-client-port [ yes | no ]
max-pending-bytes [integer]
max-pending-messages [integer]
max-retries [integer]
mirrored [enabled | disabled]
per-peer-stats [enabled | disabled]
routes { [route-name] }
traffic-group [[string] | default | non-default | none]
use-local-connection [ yes | no ]
irule-scope-message [ yes | no ]
edit router [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
reset-stats router
reset-stats router [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list router
list router [ [ [name] | [glob] | [regex] ] ... ]
show running-config router
show running-config router [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show router
show router [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
DELETE
delete router [name]
DESCRIPTION
You can use the router component to manage a generic message router instance. All virtual servers containing
the same router instance share the same route table and can route messages between peers.
EXAMPLES
create router my_router defaults-from messagerouter
Creates a message router instance named my_router using the system defaults.
create router my_router { routes add { route1 route2 } }
Creates a router instance named my_router that contains two static routes, route1 and route2.
OPTIONS
app-service
Specifies the name of the application service to which the router belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
modify or delete the router. Only the application service can modify or delete the router.
defaults-from
Specifies the profile that you want to use as the parent profile. The new profile inherits all of the
settings and values from the specified parent profile. The default value is messagerouter.
description
User defined description.
ignore-client-port
If set to yes, the system ignores the remote port on clientside connections (connections where the peer
connected to the BIG IP system) when searching for an existing connection. The default value is no.
irule-scope-message
If set to yes, iRule events are scoped to the message executing (each message has its own execution
context). This allows multiple messages to process iRules concurrently without waiting for commands from
other messages. If set to no, all genericmsg iRule events are scoped to the connection flow (that is all
share a single execution context per flow) and therefore are forced to execute one at a time even though
they are processing independent messages (this is the legacy mode). The default value is no. Some
existing iRules might need to be adjusted to use the per-message scope.
ha-message-sweeper-interval
Specifies the maximum time in milliseconds that a message will be held on the standby device as it waits
for the active device to route the message. Messages on the standby device held for longer then the
configurable sweeper interval, will be dropped. The default value is 1000 milliseconds.
inherited-traffic-group
Read-only property that indicates if the traffic-group is inherited from the parent folder.
max-pending-bytes
Limits the number of bytes contained within messages held pending while waiting for a connection to a
peer. If irule-scope-message is set to yes, also limits the number of bytes contained within messages
that may concurrently process iRule events. Once reached any additional messages to the peer will be
flagged as undeliverable and returned to the originator. The default value is 32768.
max-pending-messages
Limits the number of messages held pending while waiting for a connection to a peer. If irule-scope-
message is set to yes, also limits the number of messages that may concurrently process iRule events.
Once the limit is reached, any additional messages to the peer will be flagged as undeliverable and
returned to the originator. The default value is 64.
max-retries
This attribute sets the maximum number of time a message may be resubmitted for rerouting by the
MR::retry iRule command. The default value is 1.
mirrored
If enabled, connection created on the active device of the traffic-group specified, will be mirrored on
the standby device. Messages processed on the active device will also be mirrored and perform equivalent
processing on the standby device.
per-peer-stats
If enabled, the profile specific statistics will be captured for each pool member. The default value is
disabled.
traffic-group
Specifies the traffic group on which the router is active. The default traffic group is inherited from
the containing folder.
inherited-traffic-group
Read-only property that indicates if the traffic-group is inherited from the parent folder.
use-local-connection
If true, the router will route a message to an existing connection on the same TMM as the message was
received on. If an existing connection is not found, it will route the message through an existing
connection based on a deterministic algorithm that may be on another TMM. If a matching existing
connection is not found, it will create a connection on the current TMM. Setting this flag may limit the
number of connections that are created to a peer.
routes
Specifies a list of static routes for the router instance to use.
SEE ALSO
create, delete, edit, glob, list, ltm virtual, modify, regex, reset-stats, show, tmsh, ltm message-routing
generic route ltm message-routing generic protocol
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2012-2014. All rights reserved.
BIG-IP 2019-12-19 ltm message-routing generic router(1)