ltm message-routing diameter profile router
ltm message-routing diameter pBIltmPmessage-routing diameter profile router(1)
NAME
router - Configures a Diameter Router profile.
MODULE
ltm message-routing diameter profile
SYNTAX
Configure the router component within the ltm message-routing diameter
profile module using the syntax shown in the following sections.
CREATE/MODIFY
create router [name]
modify router [name]
options:
app-service [[string] | none]
associate-clientside-to-poolmember [disabled | enabled]
defaults-from [[name] | none]
description [string]
ha-message-sweeper-interval [integer]
ignore-peer-port [disabled | enabled]
irule-scope-message [ yes | no ]
max-pending-bytes [integer]
max-pending-messages [integer]
max-retries [integer]
mirrored [disabled | enabled]
pending-request-sweeper-interval [integer]
per-peer-stats [enabled | disabled]
routes [add | default | delete | none | replace-all-with] {
[route_name] ...
}
supported-applications [ [integer] ... ]
traffic-group [[string] | default | non-default | none]
transaction-timeout [integer]
use-local-connection [disabled | enabled]
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
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 Diameter router profile.
EXAMPLES
create router my_router_profile defaults-from router
Creates a Diameter router profile named my_router_profile using the
system defaults.
create router my_router_profile routes add { route1 route2 }
Creates a Diameter profile named my_router_profile with two static
routes.
OPTIONS
app-service
Specifies the name of the application service to which the object
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 object. Only the application
service can modify or delete the object.
associate-clientside-to-poolmember
If enabled, the configured routes will be scanned for a pool
member that matches a new clientside connection. If found, the
clientside connection will be associated with the pool member
allowing the activity on the clientside connection to be included
with the activity of the pool member. The default value is
disabled.
defaults-from
Specifies the profile that you want to use as the parent profile.
Your new profile inherits all of the settings and values from the
specified parent profile. The default value is router.
description
User defined description.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax.
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.
ignore-peer-port
If selected (enabled), any connection from a configured peer will
be suitable for routing a message to, regardless of its remote
port number. The default value is enabled.
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 Diameter 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.
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
65536.
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.
partition
Displays the administrative partition within which the component
resides.
per-peer-stats
If enabled, the profile specific statistics will be captured for
each pool member. The default value is disabled.
pending-request-sweeper-interval
Specifies the interval in milliseconds between passes of the
pending request sweeper. The pending request sweeper will delete
pending request entries that are older than twice the transaction-
timeout. If set to 0 the sweeper will be disabled. The default
value is 60000ms.
regex
Displays the items that match the regular expression. The regular
expression must be preceded by an at sign (@[regular expression])
to indicate that the identifier is a regular expression. See help
regex for a description of regular expression syntax.
routes
Specifies a list of static routes. The ordering of the route
entries is insignificant.
supported-applications
Defines the list of application ID values that will be supported.
If a message is received with an Auth-Application-ID or Acct-
Application-ID AVP that does not match any of the values in this
list, it will be dropped and the connection will be reset. A
value of 0 will match all application IDs. The default value is
none.
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.
transaction-timeout
Specifies the maximum time (in seconds) between a request and its
response. A provisional response restarts the timer. The default
value is 10 seconds. Note: This may not affect all transactions.
The scenarios where the system waits for response (eg. a final
response for REGISTER request), are impacted by dropping any
persistent data maintained for the request.
use-local-connection
Enables or disables a preference for local connections established
by the ingress TMM over connections established by other TMM's
when selecting the egress connection to destination peer. By
default this attribute is enabled.
SEE ALSO
create, delete, edit, glob, list, ltm virtual, modify, regex, reset-
stats, show, tmsh
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 2013-2014, 2016. All rights
reserved.
BIG-IP ltm0message-routing diameter profile router(1)