Skip to end of metadata
Go to start of metadata

In this section:

Overview

Use this object to configure SIP signaling ports for a specified zone. For additional routing details, see Routing Mechanisms page.

A SIP Signaling Port is a logical address permanently bound to a specific zone and is used to send and receive SIP call signaling packets. A SIP Signaling Port is capable of multiple transports such as UDP, TCP and TLS/TCP.

SBC Core supports up to 16 SIP Signaling Ports per zone. These SIP Signaling Ports can use the same IP address, but each must have its own unique UDP/TCP port. In the example below, three SIP Signaling Ports are created using the same IP address but each with a unique UPD port.

  • SIP Signaling Port 1: 100.110.120.130 port 5060 
  • SIP Signaling Port 2: 100.110.120.130 port 5070
  • SIP Signaling Port 3: 100.110.120.130 port 5080

A SIP Signaling Port can contain an IPv4 address, an IPv6 address or both. However, all SIP Signaling Ports within a particular zone must use the same address types as shown in below examples.

Example 1:

  • SIP signaling port 1 - IPv4 address
  • SIP signaling port 2 - IPv4 address

Example 2:

  • SIP signaling port 1 - IPv6 address
  • SIP signaling port 2 - IPv6 address

Example 3:

  • SIP signaling port 1 - IPv4 / IPv6 addresses
  • SIP signaling port 2 - IPv4 / IPv6 addresses

A SIP Signaling Port must reference one IP Interface Group signifying that signaling associated with that port is restricted to IP Interfaces in that group. Only reference IP Interface Groups within the same Address Context.

Info

The SBC 52x0 and SBC 7000 systems support creating IP Interface Groups containing sets of IP interfaces that are not "processor friendly" (i.e. carried on physical Ethernet ports served by separate processors). However, restrictions exist regarding the usage of such Interface Groups.

(This ability does not apply to the SBC 51x0 and SBC 5400 systems which have only two physical media ports. IP interfaces from the two physical ports may be configured within the same IP Interface Groups without restriction.)

For complete details, refer to Configuring IP Interface Groups and Interfaces.

Note

Sonus recommends using the highest TLS version supported by both the SBC and the peer equipment.

Note

If a zone's sipSigPort is configured for transportProtocolsAllowed = sip-tls-tcp, and either Egress IPSP Transport Type is TLS Over TCP and/or the Egress TG’s transportPreference is tls-tcp, the SBC increments the configured portNumber by 1 and uses it as the new port number for SIP over TLS signaling. The SBC then opens a TCP socket for SIP over TLS for the new TCP port number.

Example: When sipSigPort is configured with a portNumber of 5060 and transportProtocolsAllowed = sip-tls-tcp, the SBC listens on TCP port 5061 for SIP over TLS.

Command Syntax

% set addressContext <name> zone <name> sipSigPort <index #>
	action <dryup | force>
	dryUpTimeout <1-1440 mins>
	dscpValue <0-63>
	ipAddressV4 <IPv4 address>
	ipAddressV6 <IPv6 address>
	ipInterfaceGroupName <name>
	maskIpAddressforRcb <disabled | enabled>
	maskPortforRcb <disabled | enabled>
	mode <inService | outOfService>
	portNumber <1-65535>
	recorder <disabled | enabled>
	sctpProfileName <name>
	siprec <disabled | enabled>
	state <disabled | enabled>
	tcpConnectTimeout <0-180>
	tcpKeepaliveInterval <60-120 seconds>
	tcpKeepaliveProbes <1-10>
	tcpKeepaliveTime <60-7200 seconds>
	tlsProfileName <name>
	transportProtocolsAllowed <sip-sctp | sip-tcp | sip-tls-tcp | sip-udp>

 

Command Parameters

Key

M = Mandatory

O = Optional

Table : Zone SIP Signaling Port Parameters

Parameter Length/Range Description  
<index #> 1-4096

The Sip Signaling Port for this zone.

M
action N/A

Use this object to specify a clearing action when the SIP Signaling Port goes out-of-service (OOS). Calls can be forcefully cleared or allowed to dry up in out-of-service mode.

  • dryup – SBC starts the dryUpTimeout timer indicating the time in minutes the calls are allowed to complete. Once the timer expires, ongoing calls are torn down gracefully.
  • force (default) – Ongoing calls on the given signaling port are cleared immediately
O
dryUpTimeout 1-1440

Use this parameter to specify the time (in minutes) until which existing calls are allowed to complete in out-of-service mode with dry up action. (range: 1-1440 / default = 60)

When action = dryup and sipSigPort goes OOS, SBC starts a dry up timer for the configured duration. The SBC exhibits the following behavior when the dry up mode is enabled:

  • Calls: All in-dialog messages are allowed, new INVITE messages are rejected with 503.
  • Registrations: All refresh REGISTER and de-REGISTER messages are allowed, new REGISTER messages are rejected with 503.
  • Out-Of-Dialog (OOD) relay messages: All new OOD messages are rejected with 503. However, in-dialog messages with-in REFER and SUBSCRIBE dialogs are allowed.

Once the dryup timer expires, SBC tears down ongoing calls and all ongoing SIP Registrations and non-call related dialogs are cleared internally. The SIP Signaling Port is then moved to OOS state where no SIP messages are admitted.

This parameter is only visible when action = dryup.

O
dscpValue
0-63 DSCP value for packets from this SIP Signaling Port. (default = 0). O
ipAddressV4 N/A IPv4 address for this SIP signaling port in dotted decimal format (for example 128.127.50.224). O
ipAddressV6 N/A

IPv6 address for this SIP signaling port in hexadecimal/colon format.   (for example, 1280:1276:3350:2224:2222:3333:8888:1245 or fd00:21:445:128::7880).

O
ipInterfaceGroupName 1-23 characters The name of the IP Interface Group used by this signaling port. M

maskIpAddressforRcb

N/A

Use this flag to fetch the RCB value for a user using only the source port and not the source IP address for generating the hashKey.

  • disabled (default)
  • enabled

The flag maskPortforRcb must be disabled to use this flag. Both flags cannot be enabled at the same time.


O

maskPortforRcb

N/A

Use this flag to fetch the RCB value for a user using only the source IP address and not the source port for generating hashKey

  • disabled (default)
  • enabled

The flag maskIpAddressforRcb must be disabled to use this flag. Both flags cannot be enabled at the same time.


O
mode   N/A

Operational mode for this SIP Signaling Port.

  • inService (default)
  • outOfService
O
 portNumber  1-65535

UDP/TCP port number of SIP Signaling Port (default = 5060).

If transportProtocolsAllowed is “sip-udp”, ensure that portNumber value is outside the configured system-wide mediaPortRange unless portNumber = default value “5060”. If portNumber is set to a number other than “5060”, the user is prompted to continue with the configuration.

For example, if media port range is 5000-6000, portNumber should be configured starting with 6002 (6001 cannot be used as its used for RTCP by default).

To view mediaPortRange values, use the command:

> show configuration details system media mediaPortRange

O
recorder  N/A

Enable flag to indicate the port is being used for recording.

  • disabled (default)
  • enabled
O

sctpProfileName

1-23 SCTP profile name. O
siprec   N/A

Administrative state of the SIP Signaling Recorder Port. Enable flag to use the port for recording using SIPREC Protocol.

  • disabled (default)
  • enabled

The SIPREC feature is controlled by a system-wide SBC license (SBC-SIPREC). If the license is not available, any SIPREC recording returned by a PSX is ignored.

When siprec flag is enabled, ensure the recorder flag is disabled.


O
state   N/A Administrative state of the SIP Signaling Port.
  • disabled (default)
  • enabled
O
tcpConnectTimeout   0-180

The maximum time (in seconds) the SBC waits for a TCP connection to complete. (default = 5).

This application level configuration has NO impact on any IP layer re-transmission of SYN.

O
tcpKeepaliveInterval 60-120

The number of seconds between TCP Keep-alive probes (default = 60).

O
tcpKeepaliveProbes 1-10

The maximum number of TCP Keep-alive probes to send until SBC decides that the connection is broken (default = 2).

O
tcpKeepaliveTime 60-7200 The number of seconds a TCP connection remains idle before TCP Keep-alive probes are sent out. A value of "0" disables this parameter (default = 0). O
tlsProfileName N/A TLS Profile name used by this Signaling Port. O
transportProtocolsAllowed N/A

Transport protocols allowed on this signaling port.

  • sip-udp – (default) BIT 0
  • sip-tcp – BIT 1
  • sip-tls-tcp – BIT 2
  • sip-sctp – BIT   3

The SBC supports only UDP towards the recording server.


O

Note

If recorder is enabled, the SBC does not handle the following requests. To overcome this, configure a separate SIP Signaling Port towards the recording server (with recorder enabled).

  • OPTIONS
  • NOTIFY
  • SUBSCRIBE
  • MESSAGE
  • PUBLISH
  • INFO
  • REFER
  • REGISTER

Command Example

The following example sets tcpKeepaliveTime to 90 seconds, tcpKeepaliveInterval to 60 seconds and tcpKeepaliveProbes count to 2.

% set addressContext default zone ZONE_SIPART_AS sipSigPort 2 tcpKeepaliveTime 90 tcpKeepaliveInterval 60 tcpKeepaliveProbes 2
% commit
 
% show details addressContext default zone ZONE_SIPART_AS sipSigPort 2
ipInterfaceGroupName      LIG2;
ipAddressV4               10.7.14.179;
portNumber                5060;
mode                      inService;
state                     enabled;
recorder                  disabled;
siprec                    disabled;
tcpConnectTimeout         5;
dscpValue                 0;
tlsProfileName            defaultTlsProfile;
transportProtocolsAllowed sip-tcp;
sctpProfileName           defaultSctpProfile;
tcpKeepaliveTime          90;
tcpKeepaliveInterval      60;
tcpKeepaliveProbes        2;

  • No labels