SIP proxy server custom properties
We 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.
The custom properties are supported as the primary method of configuration. Therefore, if a custom property is set and then you set the corresponding setting in the admin console, the custom property value is used.
- In the admin console, expand Servers > Server Types > WebSphere application servers > server_name to open the configuration tab for the server.
- From SIP proxy server settings, expand SIP proxy settings, and click Custom properties.
- From Additional properties, select Custom properties > New .
- 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.
- Click Apply or OK.
- Click Save on the console task bar to save the configuration changes.
- Restart the server.
The SIP proxy custom properties listed here are provided with WAS ND. These properties are not shown on the settings page for a proxy server.
Overload custom properties
Several of the SIP custom properties allow us to apply proxy-managed overload protection (PMOP). The PMOP overload settings allow for real-time protection against container overload.
- burstResetFactor
- deflatorRatio
- dropOverloadPackets
- inDialogAveragingPeriod
- maxThroughputFactor
- outDialogAveragingPeriod
- perSecondBurstFactor
- proxyTransitionPeriod
- sipProxyStartupDelay
- overloadResponseCode
- overloadResponseReasonPhrase
See on overload controls, refer to the Information Center topic Session Initiation Protocol overload protection.
burstResetFactor
Percentage of bursts during a given period of time. This custom property controls the amount of bursts that occur during the averaging period.
| Data type | String |
| Default | 100 |
deflatorRatio
Specifies a static ratio. This custom property is only used during the transition period when a transition period is specified.
| Data type | String |
| Default | 0 |
dropOverloadPackets
Whether or not to drop packets when the SIP container is in an overloaded state. When this value is set to False, the proxy server responds with a 503 error when overloaded, otherwise the packet is dropped.
| Data type | String |
| Default | False |
http.pmiTimerInterval
Estimated time interval, in milliseconds, after which PMI statistics are recorded in the proxy server.
Avoid trouble: Specifying a value that is lower than the default of 100 milliseconds might impact proxy server performance because the proxy needs to check the current time more frequently.
| Data type | Integer |
| Default | 100 |
inDialogAveragingPeriod
Period of time, in seconds, during which in-dialog messages are averaged.
| Data type | String |
| Default | 180 |
maxThroughputFactor
Percentage of the maximum number of messages per averaging period set. If this 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 reject requests for new sessions. This custom property should be set to the same value for each proxy server.
| Data type | String |
| Default | 0 |
outDialogAveragingPeriod
Period of time, in seconds, during which out-dialog messages are averaged.
| Data type | String |
| Default | 360 |
perSecondBurstFactor
Percentage of bursts allowed through periodically (BTF).
| Data type | String |
| Default | 150 |
proxyTransitionPeriod
Period of time, in seconds, to lock the deflator after the container shuts down.
| Data type | String |
| Default | 0 |
sipProxyStartupDelay
Period of time, in seconds, before the proxy server restarts to allow the proxy to become stable in the cluster and avoid an erroneous overloaded state.
| Data type | String |
| Default | 0 |
overloadResponseCode
Value for the response code returned from the proxy when overload occurs and SIP requests from the container are rejected. 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 rejects requests with a 503 response code. If we prefer to use a different response code for overload protection, we can configure this custom property to return a different response code.
| Data type | String |
| Default | 503 |
overloadResponseReasonPhrase
Value for the response reason phrase provided from the proxy when overload occurs and SIP requests from the container are rejected. 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 rejects requests with a Service Unavailable response phrase. If we prefer to use a different response phrase, we can configure this custom property to return a different response phrase.
| Data type | String |
| Default | Service Unavailable |
General custom properties
The following SIP custom properties allow us to apply a variety of settings.
isSipComplianceEnabled
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 |
keepAliveInterval
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 considers the container to be down. The proxy then routes data to a back-up SIP container until the connection between the proxy 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.
| Data type | String |
| Default | 0 |
keepAliveFailures
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.
| Data type | String |
| Default | 0 |
LBIPAddr
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 from the specified IP address, the SIP proxy responds with a success message if the SIP proxy can forward the messages to the SIP container. The SIP proxy responds with a failure message if messages cannot be forwarded to the SIP container. The load balancer then determines if the messages should be routed to the SIP proxy.
| Data type | String |
| Default | null |
localOutboundTCPAddress
Source interface to which the proxy binds when establishing connections to back-end SIP containers. Is used when the 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 TLS connections.
| Data type | String |
| Default | * |
maxWriteQueueEntries
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 | String |
| Default | 100000 |
receiveBufferSizeChannel
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 | String |
| Default | 65535 |
receiveBufferSizeSocket
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 | String |
| Default | 1024000 |
retryAfterValue
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 | String |
| Default | 5 |
sendBufferSizeSocket
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 | String |
| Default | 1024000 |
serverUDPInterface
Specifies the host name or IP address 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 used for SIP container communications. When the firewall is between the SIP proxy and the SIP container, we 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 |
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.
Is used with the LBIPAddr property.
| Data type | String |
| Default | null |
Related concepts
Session Initiation Protocol overload protection
Related tasks
Load balancing with the Session Initiation Protocol proxy serverSet the SIP container
Create a proxy server