ltm message-routing sip profile router
ltm message-routing sip profile router(1) BIG-IP TMSH Manual ltm message-routing sip profile router(1)
NAME
router - Configures a Session Initiation Protocol (SIP) Router profile.
MODULE
ltm message-routing sip profile
SYNTAX
Configure the router component within the ltm message-routing sip profile module using the syntax shown in the
following sections.
CREATE/MODIFY
create router [name]
modify router [name]
options:
app-service [[string] | none]
concurrent-sessions-per-subscriber [integer]
defaults-from [[name] | none]
description [string]
dialog-establishment-timeout [integer]
inherited-traffic-group [true | false]
log-profile [log profile name | none]
log-publisher [log publisher name | none]
max-global-registrations [integer]
max-pending-bytes [integer]
max-pending-messages [integer]
max-retries [integer]
media-proxy {
max-media-sessions [integer]
media-inactivity-timeout [integer]
}
mirror [enabled | disabled]
nonregistered-subscriber-callout [enabled | disabled]
nonregistered-subscriber-listener [enabled | disabled]
per-peer-stats [enabled | disabled]
registration-timeout [integer]
operation-mode [load-balancing | application-level-gateway ]
routes [add | default | delete | none | replace-all-with] {
[route_name] ...
}
session {
transaction-timeout [integer]
max-session-timeout [integer]
}
traffic-group [[string] | default | non-default | none]
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
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 SIP router profile.
EXAMPLES
create router my_router_profile defaults-from router
Creates a SIP router profile named my_router_profile using the system defaults.
create router my_router_profile routes add { route1 route2 }
Creates a SIP 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.
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.
log-publisher
Specify the name of the log publisher which logs translation events. See help sys log-config for more
details on the logging sub-system. Use the "sys log-config publisher" component to set up a log
publisher.
log-profile
Specify the name of the ALG log profile which controls the logging of ALG . See help ltm alg-log-profile
for more details on the logging profile sub-system. Use the "ltm alg-log-profile profile" component to
set up a ALG log profile.
max-pending-bytes
Specifies the maximum number of bytes contained within pending messages that will be held while waiting
for a connection to a peer to be created. 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
Specifies the maximum number of pending messages that will be held while waiting for a connection to a
peer to be created. Once 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.
Important: Changing traffic groups, with Connection Mirroring enabled, drops all mirrored connections and
loses all persistence data. If you change traffic groups, mirroring must restart.
per-peer-stats
If enabled, the profile specific statistics will be captured for each pool member. The default value is
disabled.
operation-mode
Specifies the behavior of the routing instance. The options are:
load-balancing
Messages will be load balanced.
application-level-gateway
The virtual will act as a forwarding virtual, forwarding messages to the server of peer identified
as the destination address of the incoming connection. The messages will be inspected so that
associated media flows can be created.
partition
Displays the administrative partition within which the component resides.
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.
session.transaction-timeout
Specifies the maximum time (in seconds) between a request and its response. A provisional response
restarts the timer. 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.
session.max-session-timeout
This attribute is valid when the operation-mode is application-level-gateway.Specifies the maximum
duration (in seconds) the media for a call remains active. After this period call media is terminated.
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.
media-proxy.max-media-sessions
This attribute is valid when the operation-mode is application-level-gateway.Specifies the maximum number
of media sessions that are allowed per call.
media-proxy.media-inactivity-timeout
This attribute is valid when the operation-mode is application-level-gateway.Specifies the maximum
duration (in seconds) that a media flow is active with no RTP packets. After this period the media flow
is removed. This attribute is applicable only to RTP packets. Inactivity time applicable to RTCP packets
is max-session-timeout.
max-global-registrations
This attribute is valid when the operation-mode is application-level-gateway. Specifies the maximum
number of registrations allowed. If the limit is reached the registrations are dropped. A default value
of 0 indicates the limit is ignored."
nonregistered-subscriber-callout
This attribute is valid when the operation-mode is application-level-gateway with translation. Enables
non-registered subscriber to initiate calls. The default value is enabled.
nonregistered-subscriber-listener
This attribute is valid when the operation-mode is application-level-gateway with translation. Enables
creation of an ephemeral listener when a non-registered subscriber initiates a calls. If enabled, Non-
registered subscribers will be able to receive incoming calls. The default value is enabled.
concurrent-sessions-per-subscriber
This attribute is valid when the operation-mode is application-level-gateway. Specifies the maximum
number of concurrent calls allowed per subscriber. It denotes the concurrent From-URI in the call
matching the registration key. If the limit exceeds then the call is dropped. Default value of 0
indicates that the limit is ignored."
registration-timeout
This attribute is valid when the operation-mode is application-level-gateway with LSN source-address-
translation. Specifies the maximum duration (in seconds) that a registration entry remains active while a
response has not been received from the registrar. After this period the registration entry is removed
from the registration table, unless the registrar has responded. A default value of 0 means this timeout
is ignored and the Expires header value is used.
dialog_establishment_timeout
This attribute is valid when the operation-mode is application-level-gateway. Specifies the timeout (in
seconds) that represents the Timer B as per RFC 3261, the INVITE transaction timeout. The dialog-
establishment-timeout is used by the Call Table. The default value is 32 seconds.
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.
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 2019-07-02 ltm message-routing sip profile router(1)