SIP proxy server custom properties

You can add the following custom properties to the configuration settings for the Session Initiation Protocol (SIP) proxy server.

To specify custom properties for a specific SIP proxy server, navigate to the custom properties page, and specify a value for the custom property.

  1. In the administrative console, expand Servers and click Application servers > server-name to open the configuration tab for the server.
  2. From SIP proxy server settings, expand SIP proxy settings, and click Custom properties.
  3. From Additional properties, select Custom properties > New .
  4. On the settings page, type the custom property to configure in the Name field, and type the value of the custom property in the Value field.
  5. Click Apply or OK.
  6. Click Save on the console task bar to save your configuration changes.
  7. Restart the server.

The following SIP proxy custom properties are provided with the product.

Overload custom properties

Several of the SIP proxy custom properties allow you to set overload controls. The overload settings provide real-time protection against container overload.

For more information on overload controls, refer to the information center topic on Session Initiation Protocol overload protection.

burstResetFactor [Fix Pack 13 or later]

Specifies the percentage of bursts during a given period of time. This custom property controls the amount of bursts that occur during the averaging period. This custom property is used only when the maxThroughputFactor custom property is configured.

Data type Integer
Default 100

deflatorRatio [Fix Pack 13 or later]

Specifies a static ratio of in-dialog to out-dialog messages. This custom property is used when the maxThroughputFactor custom property is configured to determine the admission rate of SIP requests that are not associated with an existing session.

If the deflatorRatio custom property is set and the proxyTransitionPeriod custom property is set, the fixed deflator ratio value is only used during the specified transition period. If the deflatorRatio custom property is set and the proxyTransitionPeriod custom property is not set, the deflatorRatio custom property is used at all times.

Data type Integer
Default 0

inDialogAveragingPeriod [Fix Pack 13 or later]

Specifies the period of time, in seconds, during which in-dialog messages are averaged. This custom property is used only when the maxThroughputFactor custom property is configured.

Data type Integer
Default 180

lsnLookupFailureResponseCode [Fix Pack 25 or later]

Specifies the response code when a SIP request for affinity fails. This custom property enables you to override the default 404 error response that normally displays when affinity fails.

Data type Integer value that is a valid SIP response code
Default 404

lsnLookupFailureReasonPhrase [Fix Pack 25 or later]

Specifies the response text to display when a SIP request for affinity fails. This custom property enables you to override the default "Not Found" error text that normally displays when affinity fails.

Data type String
Default "Not Found"

mindeflatorRatio [Fix Pack 13 or later]

Specifies the lower limit for the deflator ratio. Typically, the SIP proxy server dynamically adjusts its deflator ratio based on current network traffic. This ratio is often referred to as the dialog message ratio. The dialog message ratio is the ratio of in-dialog messages to new dialog messages. This custom property requires maxThroughputFactor to be configured.

Data type Integer
Default 0

maxdeflatorRatio [Fix Pack 13 or later]

Specifies the upper limit for the deflator ratio. Typically, the SIP proxy server dynamically adjusts its deflator ratio based on current network traffic. This ratio is often referred to as the dialog message ratio. The dialog message ratio is the ratio of in-dialog messages to new dialog messages.

During server transitions, such as failover, the deflatorRatio can increase because of the extra calls being retransmitted. To prevent this extra processing from causing an overload, or to maintain stability during heavy call flows, use the maxdeflatorRatio custom property. This custom property requires maxThroughputFactor to be configured.

Data type Integer
Default 50

maxThroughputFactor [Fix Pack 13 or later]

Specifies the percentage of the maximum number of messages per averaging period set. If no value is specified for this custom property or if the custom property value is set to 0, then the maximum throughput feature is disabled. This custom property is used to calculate the maximum number of messages allowed per second before the proxy server begins to discard requests for new sessions. This custom property must be set to the same value for each proxy server.

Data type Integer
Default 0
The following custom properties require maxThroughputFactor to be configured:
  • burstResetFactor
  • deflatorRatio
  • mindeflatorRatio
  • maxdeflatorRatio
  • inDialogAveragingPeriod
  • outDialogAveragingPeriod
  • perSecondBurstFactor

outDialogAveragingPeriod [Fix Pack 13 or later]

Specifies the period of time, in seconds, during which out-dialog messages are averaged. This custom property is used to determine the deflator ratio when the maxThroughputFactor custom property is configured.

Data type Integer
Default 360

perSecondBurstFactor [Fix Pack 13 or later]

Specifies the percentage of bursts that can pass through during a specified period of time. This custom property is used only when the maxThroughputFactor custom property is configured.

Data type Integer
Default 150

dropOverloadPackets [Fix Pack 13 or later]

Specifies whether to discard packets when the SIP proxy server detects an overloaded condition. If this value is set to False, then the SIP proxy server returns an error response when the SIP container is overloaded. Otherwise, the packet is discarded.

Data type String
Default False

keepAliveInterval [Fix Pack 11 or later]

Specifies the interval, in milliseconds, at which keepalive messages are sent to the SIP containers. A keepalive message is sent at the specified interval. If the specified number of keepAliveFailures messages is received from the SIP container, the proxy server considers the container to be down. The proxy server then routes data to a different SIP container until the connection between the proxy server and the primary container is restored.

The first keepalive message contains the interval of time between the keep alive messages and the number of failures that are required before the container is considered down. The starting values should be specified based on the high availability (HA) heartbeat configuration.

This custom property applies for SIP network outage detection. See the topic about SIP network outage detection for additional information. If your network is divided into a management network and a SIP network, this custom property must be configured in order to detect failures on the SIP network.

Data type Integer
Default 0

keepAliveFailures [Fix Pack 11 or later]

Specifies the number of keepalive messages that must be missed before the proxy determines that the connection with the SIP container is down.

The proxy sends a keepalive message to the container at each keepAliveInterval. If the proxy does not receive a response to the message, it considers the lack of response as a failure. If the proxy receives a specific number of consecutive failures, it considers the container down and begins forwarding messages to a different SIP container.

This custom property applies for SIP network outage detection. See the topic about SIP network outage detection for additional information. If your network is divided into a management network and a SIP network, this custom property must be configured in order to detect failures on the SIP network.

Data type Integer
Default 0

LBIPAddr

Specifies the IP address, such as 192.101.1.5, of the load balancer used to load balance the SIP proxy. Multiple load balancer addresses can be configured by separating each IP address using a semicolon (;).

When SIP messages with the method configured as SIPAdvisorMethodName are received by the SIP proxy server from the specified IP address, the SIP proxy server responds with a success message if the SIP proxy server can forward the messages to the SIP container. The SIP proxy server responds with a failure message if messages cannot be forwarded to the SIP container. The load balancer then determines if the messages are routed to the SIP proxy server.

Data type String
Default null

localOutboundTCPAddress

Specifies the source interface to which the proxy binds when establishing connections to SIP containers. This property is used when your proxy server is multihomed and needs to be configured to use a specific interface to send SIP traffic to the SIP containers. This property applies to both Transmission Control Protocol (TCP) and Transport Layer Security (TLS) connections.

Data type String
Default *

maxWriteQueueEntries

Specifies the number of messages that can be queued when a connection is slow or cannot be established. If the value is a large number, then more memory is consumed. A small number causes packets to be lost if the endpoint clears.

Data type Integer
Default 100000

overloadResponseCode [Fix Pack 13 or later]

Specifies the value for the response code returned from the proxy when overload occurs and SIP requests from the container are discarded. When the proxy is configured for overload protection, the SIP proxy can be configured to detect overload status. The proxy monitors the amount of traffic processed at the proxy and limits the number of new requests. If a container is overloaded, the proxy discards requests with a 503 response code. If you prefer to use a different response code for overload protection, you can configure this custom property to return a different response code.

Data type Integer
Default 503

overloadResponseReasonPhrase [Fix Pack 13 or later]

Specifies the value for the response reason phrase provided from the proxy when overload occurs and SIP requests from the container are discarded. When the proxy is configured for overload protection, the SIP proxy can be configured to detect overload status. The proxy monitors the amount of traffic processed at the proxy and limits the number of new requests. If a container is overloaded, the proxy discards requests with a Service Unavailable response phrase. If you prefer to use a different response phrase, then you can configure this custom property to return a different response.

Data type Integer
Default Service Unavailable

sipProxyStartupDelay [Fix Pack 13 or later]

Specifies the period of time, in seconds, before the SIP proxy server restarts, which allows the SIP proxy server to become stable in the cluster and avoid an erroneous overloaded state.

When a proxy server starts up in a cluster, the proxy server view of the cluster must be synchronized. Synchronization causes all proxy servers to have the same view. All proxy servers must have the same view in order for overload protection to function correctly.

Data type Integer
Default 0

proxyTransitionPeriod [Fix Pack 13 or later]

Specifies the period of time, in seconds, to lock the deflator after a container shuts down. This custom property is used to stabilize the admission controllers during periods of transition in the cluster. This custom property is used only when the maxThroughputFactor custom property is configured.

If this custom property is enabled, then the proxy server uses the previously calculated ratio for a specified period of time until traffic stabilizes. The proxy server dynamically adjusts its deflator ratio based on current network traffic. This ratio is sometimes referred to as the dialog message ratio, which is the ratio of in-dialog messages to new dialog messages. When a container shuts down, the ratio sometimes fluctuates and can cause erroneous overload warnings.

Data type Integer
Default 0

receiveBufferSizeChannel

Specifies the value, in bytes, for the maximum size of an incoming UDP packet, which is the size of the receive buffer that is allocated in the proxy server-side UDP connection.

Data type Integer
Default 65535

receiveBufferSizeSocket

Specifies the value, in bytes, for the lower-level datagram buffers, which is the size of the DatagramSocket receive buffer (SO_RCVBUF) in the proxy server-side User Datagram Protocol (UDP) connection.

Use this property to buffer multiple packets in the DatagramSocket layer. If the value of the property is too small, then packets might be lost if the server is overloaded. If the value is too large, then the packets might be delayed.

Data type Integer
Default 1024000

retryAfterValue [Fix Pack 11 or later]

Specifies the amount of time, in seconds, before the client tries again to route a request to the proxy server. This custom property value is returned to the client in the error response if the SIP container is overloaded or if the SIP proxy cannot locate a server to which to route a request.

Data type Integer
Default 5

sendBufferSizeSocket

Specifies the value, in bytes, for the lower-level datagram buffers, which is the size of the DatagramSocket send buffer (SO_SNDBUF) in the proxy server-side UDP connection.

Use this property to buffer multiple packets in the DatagramSocket layer. If the value of the property is too small, then packets might be lost if the server is overloaded. If the value is too large, then the packets might be delayed.

Data type Integer
Default 1024000

serverUDPInterface

Specifies the host name or IP address that is used for all communications between the SIP proxy and the SIP containers when the network is segmented. This interface is the specific network interface for all UDP data that enters or exits the SIP containers. You must use this property with the serverUDPPort property.

Data type String
Default *

serverUDPPort

Specifies the UDP port that is used for SIP container communications. When the firewall is between the SIP proxy and the SIP container, you might set this value if a specific interface is needed to communicate with the SIP containers or if a specific port is required to pass through the firewall.

Data type String
Default dynamic

isSipComplianceEnabled

Specifies whether or not compliance checking is enabled. Compliance checking might be disabled if a client is not compliant with a specification, such as RFC 3261, and you do not want to log an interoperability event.

Data type String
Default True

SIPAdvisorMethodName

Specifies a string value for the method sent by the load balancer to the SIP proxy for health checks. The format is OPTIONS or INFO. This property is used with the LBIPAddr property.

Data type String
Default null



Related tasks
Browse all SIP topics
Load balancing with the Session Initiation Protocol proxy server
Configuring the SIP container
Configuring the SIP proxy for network outage detection
Creating a proxy server
Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Aug 31, 2013 4:28:44 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=pix&product=was-nd-mp&topic=rjpx_sippxcustprops
File name: rjpx_sippxcustprops.html