SIP Service

You can change the following attributes of SIP service through the Admin Console, or by using the asadmin get and set commands. The SIP service attributes apply to all the listeners in the SIP service.

The sub-elements of the SIP service are the Access Log, Request Processing, Keep-Alive, SIP protocol, SIP listeners, and Connection Pool.

To edit SIP service sub-elements and their attributes through the Admin Console, click Configuration > config-name > SIP Service.

To list all the sub-elements of the SIP service, you can use the following command:

list server-config.sip-service.*

Typical output is as follows:

server-config.sip-service.access-log
server-config.sip-service.connection-pool
server-config.sip-service.keep-alive
server-config.sip-service.request-processing
server-config.sip-service.sip-listener.sip-listener-1
server-config.sip-service.sip-listener.sip-listener-2
server-config.sip-service.sip-listener.sip-listener-2.ssl
server-config.sip-service.sip-listener.sip-listener-3
server-config.sip-service.sip-protocol
server-config.sip-service.sip-protocol.sip-link
server-config.sip-service.sip-protocol.sip-timers

Setting the SIP Service Access Log Attributes

You can enable and configure rotation for the access logs for the SIP service. These logs are in the as-install/domains/domain_dir/logs/sipaccess directory and are named as follows: sip_access_log.yyyy-mm-dd. This location can be changed by editing the accesslog property under the sip-service element.

The accessLoggingEnabled property under sip-service is used for enabling SIP access log. Restart the server after enabling or disabling the access log. Use the following command:

asadmin set config.sip-service.property.accessLoggingEnabled=true

The accesslogsize property under sip-service can be used for log rotation based on file size. The default value of this property if set to 2000000.

The following is the list of SIP service access log attributes (The actual attribute name as defined in the domain.xml file appears in brackets)

• Rotation (rotation-enabled): Check the File Rotation box to enable file rotation.

• Rotation Policy (rotation-policy): Choose a policy from the Rotation Policy drop-down list. (The only policy available is time).

• Rotation Interval (rotation-interval-in-minutes): Enter a numeric value to specify the number of minutes between rotations of the access log. This field is valid only if the Rotation Policy is time. The default is 1440 minutes.

  When you specify a rotation-interval, and the rotation interval has elapsed, the access log file will be rotated only if the resulting rotation suffix of the new access log file is different from the rotation suffix of the existing access log file. So, the rotation interval must coincide with the rotation suffix in order to see your access log file rotated within the expected time-frame interval.

• Rotation Suffix (rotation-suffix): Enter a string value to specify the suffix to be added to the log file name after rotation. The default is YYYY-MM-DD.

• Format(format): Enter a string value to specify the format of the access log. Use the formats shown in the following table. The default format is %client.name% %auth-user-name% %datetime% %request% %status% %response.length%.

  The following SIP headers are also supported: client.name,auth-user-name,datetime, request, status, response.length, max.forwards, from, cseq, contact, to, content.type, via, call.id

  To enable all headers, run the following command:

  asadmin set server-config.sip-service.access-log.format="\"%client.name% %auth-user-name% %datetime% %request% %status% %response.length% %max.forwards% %from% %cseq% %contact% %to% %content.type% %via% %call.id%\""

  ---

  Note –

  Ensure that you escape the format string.

  ---

You can edit these properties through the Admin Console or through the following get and set commands

To get the values of all properties of the SIP service access log, use the following command: asadmin get server-config.sip-service.access-log.*

To set an attribute of the SIP service access log, use the set command as follows: asadmin set server-config.sip-service.access-log.rotation-enabled=false

Setting the SIP Service Keep Alive Attributes

You can edit these attributes through the Admin Console or through the following get and set commands

To get the values of all attributes and properties of the SIP service keep-alive, use the following command: asadmin get server-config.sip-service.keep-alive.*

You can set the timeout-in-seconds property of the SIP service keep-alive. By default, this property is set to —1. A value of 0 or less means keep alive connections are kept open indefinitely.

To set an attribute of the SIP service keep-alive, use the set command as follows: asadmin set server-config.sip-service.keep-alive.timeout-in-seconds=0

Setting the SIP Service Connection Pool Attributes

You can edit these attributes through the Admin Console or through the following get and set commands

To get the values of all attributes of the SIP service connection pool, use the following command: asadmin get server-config.sip-service.connection-pool.*

• Queue size(queue-size-in-bytes): Specifies the maximum number of messages that can be queued until threads are available to process them for SIP listeners. The default is —1 and specifies that there is no limit on the number of messages.

• Size of Receive Buffer (receive-buffer-size-in-bytes): Specifies the size of the byte buffer that is used to read from the socket channel. By default, this property is tuned to the socket channel receive buffer size.

• Size of Send Buffer (send-buffer-size-in-bytes): Specifies the maximium size of the SIP message that can be written out. By default, this property is set to 8192.

To set an attribute of the SIP service connection pool, use the set command as follows: asadmin set server-config.sip-service.connection-pool.receive-buffer-size-in-bytes=10

Setting the SIP Service Protocol Attributes

You can edit these attributes through the Admin Console or through the following get and set commands

To get the values of all attributes and properties of the SIP service protocol, use the following command: asadmin get server-config.sip-service.sip-protocol.*

• Enable Error Response (error-response-enabled): Specifies whether an error response is sent or not. Set to false by default.

• Default TCP Transport(default-tcp-transport): If set to true, transport=tcpis inserted in the URI of the contactand record-routeheaders.

To set an attribute of the SIP service protocol, use the set command as follows: asadmin set server-config.sip-service.sip-protocol.default-tcp-transport=false

The SIP Service Protocol has a sub-element called SIP timer. You can list the sub-elements of the SIP service protocol by using the following command: asadmin list server-config.sip-service.access-log.*

To get the values of all attributes and properties of the SIP service timers, use the following command: asadmin get server-config.sip-service.protocol.sip-timers.*