ltm profile sip
ltm profile sip(1) BIG-IP TMSH Manual ltm profile sip(1)
NAME
sip - Configures a Session Initiation Protocol (SIP) profile.
MODULE
ltm profile
SYNTAX
Configure the sip component within the ltm profile module using the
syntax shown in the following sections.
CREATE/MODIFY
create sip [name]
modify sip [name]
options:
alg-enable [disabled | enabled]
app-service [[string] | none]
community [ [community name] | none]
defaults-from [ [name] | none]
description [string]
dialog-aware [disabled | enabled]
dialog-establishment-timeout [integer]
enable-sip-firewall [no | yes]
insert-record-route-header [disabled | enabled]
insert-via-header [disabled | enabled]
max-media-sessions [integer]
max-registrations [integer]
max-sessions-per-registration [integer]
max-size [integer]
registration-timeout [integer]
rtp-proxy-style [symmetric | restricted-by-ip-address | any-location]
secure-via-header [disabled | enabled]
security [disabled | enabled]
sip-session-timeout [integer]
terminate-on-bye [disabled | enabled]
user-via-header [ [via-header] | none]
log-publisher [log publisher name | none]
log-profile [log profile name | none]
edit sip [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
mv sip [ [[source-name] [destination-name]] | [[name] to-folder [folder-name]] | [[name...name] to-folder [folder-name]] ]
options:
to-folder
reset-stats sip
reset-stats sip [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list sip
list sip [ [ [name] | [glob] | [regex] ] ... ]
show running-config sip
show running-config sip [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show sip
show sip [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
DELETE
delete sip [name]
DESCRIPTION
You can use the sip component to manage a SIP profile.
EXAMPLES
create sip my_sip_profile defaults-from sip
Creates a SIP profile named my_sip_profile using the system defaults.
create sip my_sip_profile { terminate-bye disabled }
Creates a SIP profile named my_sip_profile that leaves a connection
open following the completion of a BYE transaction.
mv sip /Common/my_sip_profile to-folder /Common/my_folder
Moves a custom sip profile named my_sip_profile to a folder named
my_folder, where my_folder has already been created and exists within
/Common.
OPTIONS
alg-enable
Enables or disables the SIP ALG (Application Level Gateway)
feature. The default value is disabled. Note: for a SIP profile
with ALG enabled to function correctly, the virtual which uses the
profile must have destination and mask set to 0.0.0.0 for IPv4, or
:: for IPv6. Additionally, the virtual must have source-address-
translation enabled.
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.
community
Specifies the community to which you want to assign the virtual
server that you associate with this profile. The default value is
none.
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 sip.
description
User defined description.
dialog-aware
Enables or disables the ability for the system to be aware of
unauthorized use of the SIP dialog. The default value is disabled.
dialog-establishment-timeout
Indicates the timeout value for dialog establishment in a sip
session. The default value is 10 seconds.
enable-sip-firewall
Indicates whether to enable SIP firewall functionality or not.
Default value is no.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax.
insert-record-route-header
Enables or disables the insertion of a Record-Route header, which
indicates the next hop for the following SIP request messages. The
default value is disabled.
insert-via-header
Enables or disables the insertion of a Via header, which indicates
where the message originated. The response message uses this
routing information. The default value is disabled.
max-media-sessions
Indicates the maximum number of SDP media sessions that the BIG-IP
system accepts. The default value is 6.
max-registrations
Indicates the maximum number of registrations, the maximum
allowable REGISTER messages can be recorded that the BIG-IP system
accepts. The default value is 100.
max-sessions-per-registration
Indicates the maximum number of calls or sessions can be made by a
user for a single registration that the BIG-IP system accepts. The
default value is 50.
max-size
Specifies the maximum SIP message size that the BIG-IP system
accepts. The default value is 65535 bytes.
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.
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.
registration-timeout
Indicates the timeout value for a sip registration. The default
value is 3600 seconds.
rtp-proxy-style
Indicates the style in which the RTP will proxy the data. When a
dialog is established, the necessary SDP data needs to know where
the RTP flows are directed. The default value is symmetric. The
options available are:
symmetric
Indicates the use of a bidirectional related flow.
restricted-by-ip-address
Indicates the use of ephemeral listeners to support fixed
client IP, listener is restricted to connections coming from
a particular source.
any-location
Indicates the use of ephemeral listeners to support wildcard,
connections are allowed to come from anyway.
secure-via-header
Enables or disables the insertion of a Secure Via header, which
indicates where the message originated. When you are using SSL/TLS
(over TCP) to create a secure channel with the server node, use
this setting to configure the system to insert a Secure Via header
into SIP requests. The default value is disabled.
security
Enables or disables security for the SIP profile. The default
value is disabled.
sip-session-timeout
Indicates the timeout value for a sip session. The default value
is 300 seconds.
terminate-on-bye
Enables or disables the termination of a connection when a BYE
transaction finishes. Use this parameter with UDP connections
only, not with TCP connections. The default value is enabled.
to-folder
sip profiles can be moved to any folder under /Common, but
configuration dependencies may restrict moving the profile out of
/Common.
user-via-header
Enables or disables the insertion of a Via header specified by a
system administrator. The default value is none.
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.
SEE ALSO
create, delete, edit, glob, list, ltm virtual, modify, mv, 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 2008-2010, 2012-2014, 2016. All
rights reserved.
BIG-IP 2016-03-14 ltm profile sip(1)