APIRef_tm_ltm_profile_sipΒΆ

mgmt/tm/ltm/profile/sip

/tm/ltm/profile

Virtual server SIP traffic profile configuration

REST Endpoints

Collection URI
/mgmt/tm/ltm/profile/sip
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/ltm/profile/sip/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
algEnable string disabled optional read/write Indicates whether SIP ALG feature is enabled. The default value is disabled
appService string   optional read/write The application service to which the object belongs.
community string   optional read/write A string that groups SIP profiles together if dialog-aware is enabled.
defaultsFrom string   optional read/write Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
description string   optional read/write User defined description.
dialogAware string disabled optional read/write Indicates whether snooping of SIP dialogs is enabled.
dialogEstablishmentTimeout integer 10 optional read/write Indicates the timeout value for dialog establishment. The default value is 10 seconds.
enableSipFirewall string no optional read/write Indicates whether SIP firewall capability is enabled. Default value is no
insertRecordRouteHeader string disabled optional read/write 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.
insertViaHeader string disabled optional read/write 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.
logProfile string   optional read/write Configures the ALG log profile that controls logging.
logPublisher string   optional read/write Configures the log publisher that handles events logging for this profile.
maxMediaSessions integer 6 optional read/write Specifies the maximum number of SDP media sessions that the BIG-IP system accepts. The default value is 6.
maxRegistrations integer 100 optional read/write Specifies the maximum number of registrations, the maximum allowable REGISTER messages can be recorded that the BIG-IP system accepts. The default value is 100.
maxSessionsPerRegistration integer 50 optional read/write Specifies 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.
maxSize integer 65535 optional read/write Specifies the maximum SIP message size that the BIG-IP system accepts. The default value is 65535 bytes.
tmPartition string Common optional read/write Displays the administrative partition within which this profile resides.
registrationTimeout integer 3600 optional read/write Indicates the timeout value for sip registration. The default value is 3600 seconds
rtpProxyStyle string symmetric optional read/write Indicates the style in which the RTP will proxy the data. When a dialog is established, the necessary SDP data needs to know where RTP flows are directed. It is provided with three options 1.) Use of a bidirectional related flow (symmetric, the default option), 2.) Use of ephemeral listeners to support fixed client IP, listener is restricted to connections coming from a particular source (restricted-by-ip-address option) and 3.) Use of ephemeral listeners to support wildcard, connections are allowed to come from anyway (any-location option) .
secureViaHeader string disabled optional read/write 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 BIG-IP system to insert a Secure Via header into SIP requests. The default value is disabled.
security string   optional read/write Enables the use of enhanced SIP security checking.
sipSessionTimeout integer 300 optional read/write Indicates the timeout value for sip session. The default value is 300 seconds
terminateOnBye string enabled optional read/write 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.
userViaHeader string   optional read/write The header that is inserted if insert-via-header is enabled.
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.