ltm message-routing sip profile session
ltm message-routing sip profilBIG-IPltmSmessage-routing sip profile session(1)
NAME
session - Configures a Session Initiation Protocol (SIP) Session
profile.
MODULE
ltm message-routing sip profile
SYNTAX
Configure the session component within the ltm message-routing sip
profile module using the syntax shown in the following sections.
CREATE/MODIFY
create session [name]
modify session [name]
options:
app-service [[string] | none]
custom-via [[via-header] | none]
defaults-from [[name] | none]
description [string]
do-not-connect-back [disabled | enabled]
generate-response-on-failure [disabled | enabled]
honor-via [disabled | enabled]
insert-record-route-header [disabled | enabled]
insert-via-header [disabled | enabled]
maintenance-mode [disabled | enabled]
loop-detection [disabled | enabled]
max-forwards-check [disabled | enabled]
max-msg-header-count [integer]
max-msg-header-size [integer]
max-msg-size [integer]
persistence {
persist-key [Call-ID | Custom | Src-Addr]
persist-timeout [integer]
persist-type [session | none]
}
enable-sip-firewall [no | yes]
edit session [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
reset-stats session
reset-stats session [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list session
list session [ [ [name] | [glob] | [regex] ] ... ]
show running-config session
show running-config session [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show session
show session [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
DELETE
delete session [name]
DESCRIPTION
You can use the session component to manage a SIP session profile.
EXAMPLES
create session my_session_profile defaults-from session
Creates a SIP session profile named my_session_profile using the system
defaults.
create session my_session_profile { insert-record-route-header enabled
}
Creates a SIP profile named my_session_profile with insertion of
record-route header in requests which establish a dialog.
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.
custom-via Specifies the value the system uses for the Sent-by field of
the Via header when the Insert Via Header setting is enabled. Note: The
value that you enter must include a format of SIP/SIP-version/protocol,
followed by a Sent-By value. For example, SIP/2.0/TCP
www.siterequest.com:4343 or SIP/2.0/SCTP 10.10.4.32.
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 session.
description
User defined description.
do-not-connect-back
Enables or disables whether a connection to a request originator
is re-established (if it no longer exists) in order to deliver a
response. When disabled, responses that cannot be forwarded using
an existing connection are dropped.
generate-response-on-failure
Enables or disables sending failure response messages such as 4xx,
5xx and 6xx, when a SIP request is being dropped. Note: Where it
is specified "silently" discarded/dropped, no error response is
generated. In any case, a dropped message (request/response) is
tracked by the Messages Dropped Statistic.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax.
honor-via
Enables or disables honoring any via which is not inserted by the
system for routing the response. This attribute has no effect if
the associated siprouter profileaXXs operation mode attribute is
set to \"application level gateway\".
insert-record-route-header
Enables or disables the insertion of a record-route header in
requests that establish dialog. When enabled, along with the URI,
the custom parameters may be added to facilitate the routing of
subsequent requests within this call to avoid route lookup. The
record route URI is the local-IP and port of flows that are used
for forwarding the message. This attribute has no effect if the
associated siprouter profileaXXs operation mode attribute is set
to \"application level gateway\".
insert-via-header
Enables or disables insertion of top via. When enabled, custom
parameters to help route the response back are inserted, along
with sent-by field of via. The source address:port of the flow
forwarding the request is filled as value for sent-by field of the
via unless a custom via value is specified. The custom parameters
inserted to help routing, helps improve performance as it
facilitates routing without any lookup. The via is inserted at
egress side of the flow, after the SIP_REQUEST_SEND event. This
attribute has no effect if the associated siprouter profileaXXs
operation mode attribute is set to \"application level gateway\".
maintenance-mode
Enables or disables maintenance mode. When enabled, SIP response
\"503 Service Unavailable\" will be sent for incoming SIP request.
SIP response will be dropped.
loop-detection
Enables or disables loop-detection checking. When a loop is
detected, the request is discarded. An error response is sent, if
configured. A request is detected as seen before
(forwarded/spiraled/looped) only if self inserted via is found in
the message and the value of its branch param plays a key role in
detecting loop versus spiral. Hence enabling via insertion becomes
a requirement to do loop detection check. This attribute has no
effect if the associated siprouter profileaXXs operation mode
attribute is set to \"application level gateway\".
max-forwards-check
Enables or disables checking on max-forwards. The max-forwards
header field serves to limit the number of hops a request can
transit on the way to its destination. If 0, the request is
discarded. An error response is sent, if configured. This
attribute has no effect if the associated siprouter profileaXXs
operation mode attribute is set to \"application level gateway\".
max-msg-header-count
Indicates the maximum count of expected SIP message header fields.
A message that exceeds this limit is silently discarded.
max-msg-header-size
Indicates the maximum SIP message header size (in bytes). A
message which exceeds this size is silently discarded.
max-msg-size
Indicates the maximum number acceptable SIP message size (in
bytes). A message which exceeds this size is silently discarded.
name Specifies a unique name for the component. This option is required
for the commands create, delete, and modify.
partition
Displays the administrative partition within which the component
resides.
persistence
Configure the persistence settings.
persistence.persist-key
Specifies the method which should be used to extract the key value
that is used to persist on. The options are:
Call-ID
Persist based on the "Call-ID" header field value in the
message.
Custom
Persist based on the custom key specified using an iRule.
Src-Addr
Persist based on originating IP address in the message.
The default option is Call-ID.
persistence.persist-timeout
Specifies the timeout value of persistence entries in seconds.
Upon receiving of the response for the initial SIP Request
message, the persistence record is updated with the persist-
timeout value.
persistence.persist-type
Specifies the type of the persistence to be used for the specified
"persist-key" attribute value. The options are:
session
Persistence is enabled guaranteeing that messages containing
a given persistence key will be delivered to the same peer.
none Persistence is disabled.
The default option is session.
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.
enable-sip-firewall
Indicates whether to enable the Application Firewall Security
policy. When enabled, the configured AFM security features will
apply to the virtual server(s) using this SIP session profile.
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 20ltm0message-routing sip profile session(1)