SIP Listeners

You can configure SIP listeners through the Admin Console or through the get and set commands. The server port on which the SIP container listens on can be configured using a SIP listener.

To list all SIP listeners in the default domain, type the following asadmin command:

list server.sip-service.sip-listener.*

Typical output is as follows:

server.sip-service.sip-listener.sip-listener-1
server.sip-service.sip-listener.sip-listener-2
server.sip-service.sip-listener.sip-listener-2.ssl

By default, a domain has two SIP listeners created: sip-listener-1 and sip-listener-2, representing the SIP and SIPS ports, respectively. By default, sip-listener-2 is configured to use TLS transport.

To list all attributes of sip-listener-1 in the default domain, type the following asadmin command:

get server.sip-service.sip-listener.sip-listener-1.*

Typical output is as follows:

server.sip-service.sip-listener.sip-listener-1.address = 0.0.0.0
server.sip-service.sip-listener.sip-listener-1.enabled = true
server.sip-service.sip-listener.sip-listener-1.external-sip-address =
server.sip-service.sip-listener.sip-listener-1.external-sip-port =
server.sip-service.sip-listener.sip-listener-1.id = sip-listener-1
server.sip-service.sip-listener.sip-listener-1.port = 5060
server.sip-service.sip-listener.sip-listener-1.transport = udp_tcp
server.sip-service.sip-listener.sip-listener-1.type = default

By default, the port is set to 5060 and the address to 0.0.0.0. The 0.0.0.0 address is what we call a BIND to ANY address and which allows you to bind the server socket to any network interface on your system.

To change the default port of sip-listener-1, use the following command:

set server.sip-service.sip-listener.sip-listener-1.port=5065

Communications Server provides the flexibility of changing the SIP listener at runtime. Currently, Communications Server does not consider the effects of those change. It is recommended that you plan ahead of time when you change SIP listener settings.

Creating and Editing a SIP Listener

To create a SIP listener, in the Admin Console, expand the Configuration node, select the configuration you want to configure, then select SIP service, then the SIP Listeners node, and click New. Define the SIP listener settings and click Save.

Alternatively, you can use the asadmin create-sip-listener command. A sample command is as follows:

asadmin create-sip-listener --siplisteneraddress=127.0.0.1 --siplistenerport=5066 --transport=udp_tcp mysiplistener

The following is a list of SIP listener attributes:

• Name (id): Provide a unique identifier for your new listener.

• Network Address (address): Enter 0.0.0.0 if you want the listener to listen on all IP addresses for the server, using a unique port value. Otherwise, type a valid IP address for the server.

• Listener Port (port): Enter a unique port value if the Network Address field is 0.0.0.0, or the desired port value if you are using another IP address.

• Enabled (enabled): Determines whether the listener is active. If set to false, any attempts to connect to the listener result in a socket exception (java.net.ConnectException).

• Transport (transport): Specifies the type of transport layer protocol. Allowed values are udp_tcp and tls.

• External SIP Port (external-sip-port): Specifies the external SIP port. If specified, this value overrides the value of the external SIP port in the SIP container.

• External SIPS Port (external-sips-port): Specifies the external SIP port. If specified, this value overrides the value of the external SIPS port in the SIP container.

• Transport (transport): Specifies the type of transport layer protocol. Allowed values are udp_tcp and tls.

• Type (type): Valid values for this options are internal, external, and default. If set to internal, this listener will be used only for proxying by the converged load balancer. If set to external, this listener will be used only for SIP user agents. If set to default, the listener will be used by SIP user agents and converged load balancers. By default, the value this option is set to default.

To change an attribute of the SIP listener you can use the asadmin set command or you can use the Admin Console. To edit a SIP listener, in the Admin Console, expand the Configuration node, select the configuration you want to configure, then select SIP service, then the SIP Listeners node, and choose the SIP listener to edit. Edit the SIP listener settings and click Save.

A sample command to change the SIP port of a SIP listener is: asadmin set server.sip-service.sip-listener.sip-listener-1.port=5065

To Configure a SIP Listener to Use SSL

1. In the Developer profile, expand the Configuration, SIP service, then SIP Listeners node.

2. In the Clusters and Enterprise profile, expand the Configuration node, select the configuration you want to configure, then select SIP service, then the SIP Listeners node.

3. Select the SIP Listener you want to configure.

4. Select the SSL tab to configure the listener to use SSL as follows:

   • Client Authentication: Check this field to force clients to authenticate themselves to the server when using this listener.

   • Certificate NickName: Enter the name of an existing server key pair and certificate. See the Security chapter for more information.

   • SSL3, SSL2, TLS: Check the Enabled checkbox to enable security protocol(s) on the listener. Check either SSL3, SSL2 or TLS, or all three.

   • Cipherssuites: Select the available cipher suite used by the protocol(s) and select the Add button. To enable all cipher suites, select the Add All button.

5. Click Save.

Equivalent asadmin command

create-ssl