To learn more about the various methods of controlling transport protocols for SIP signaling and how these work together, refer to Controlling SBC Core Transport Protocols for SIP Signaling.
In this section:
Use this object to configure SIP signaling ports for a specified zone. For additional routing details, refer to 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, SCTP, 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.
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:
Example 2:
Example 3:
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.
The SBC 7000 system supports 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 5400, which has only two physical media ports. You may configure the IP interfaces from the two physical ports within the same IP Interface Groups without restrictions.)
For complete details, refer to Configuring IP Interface Groups and Interfaces.
If a zone's sipSigPort
is configured for transportProtocolsAllowed
= sip-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.
% set addressContext <name> zone <name> sipSigPort <index #> action <dryup | force> dryUpTimeout <1-1440 mins> dryupModeHandling optionsKeepalive <disabled | reject | silentDiscard> optionsKeepaliveRejectReason <400-699> oodAndInvite <disabled | reject | silentDiscard> oodAndInviteRejectReason <400-699> enforceAORMatch <disabled | enabled> facState <disabled | system> 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> sipTcpConnectionAgingState <disabled | enabled> state <disabled | enabled> tcpConnectTimeout <0-180> tcpKeepaliveInterval <60-120 seconds> tcpKeepaliveProbes <1-10> tcpKeepaliveTime <60-7200 seconds> tcpUserTimeout < 0 | 10-3600 seconds > tlsProfileName <name> transportProtocolsAllowed <sip-sctp | sip-tcp | sip-tls-tcp | sip-udp | sip-ws-tcp | sip-wss-tls>
% set addressContext <name> zone <name> sipSigPort <index #> action <dryup | force> dryUpTimeout <1-1440 mins> dscpValue <0-63> enforceAORMatch <disabled | enabled> facState <disabled | system> ipInterfaceGroupName <name> ipPublicVarV4 <metadata> ipPublicVarV6 <metadata> ipVarV4 <metadata> ipVarV6 <metadata> maskIpAddressforRcb <disabled | enabled> maskPortforRcb <disabled | enabled> mode <inService | outOfService> portNumber <1-65535> recorder <disabled | enabled> sctpProfileName <name> siprec <disabled | enabled> sipTcpConnectionAgingState <disabled | enabled> state <disabled | enabled> tcpConnectTimeout <0-180> tcpKeepaliveInterval <60-120 seconds> tcpKeepaliveProbes <1-10> tcpKeepaliveTime <60-7200 seconds> tcpUserTimeout < 0 | 10-3600 seconds > tlsProfileName <name> transportProtocolsAllowed <sip-sctp | sip-tcp | sip-tls-tcp | sip-udp | sip-ws-tcp | sip-wss-tls>
Make sure when configuring sipSigPort
and dsbcSigPort
for an S-SBC deployment that you specify different IP addresses for them. To do so you must select different metavariables for each of them. The actual values of the metavariables are determined during orchestration based on your Heat templates.
Key |
---|
M = Mandatory O = Optional |
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.
NOTE: If a SIP signaling port is put out of service when | O |
dryUpTimeout | 1-1440 | Use this parameter to specify the duration (in minutes) during which existing calls are allowed to complete in out-of-service mode. (range: 1-1440 / default = 60) When
Once the NOTE: This parameter is only visible when NOTE: This parameter is configurable irrespective of the setting of the SIP Signaling Port state. | O |
dryupModeHandling | N/A | Handles actions while the SBC is in dry-up mode, including: silently discarding OPTIONS ping or keepalive messages, or reject messages with a configurable SIP cause code.
Modified: for 12.1.1 | |
dscpValue | 0-63 | DSCP value for packets from this SIP Signaling Port. (default = 0). | O |
enforceAORMatch | N/A | Enable this flag to enforce AOR matching for messages from registered users.
| O |
| N/A | Use this flag to control whether the fault avalanche control state uses the global level setting.
| |
ipAddressV4 | N/A | IPv4 address for this SIP signaling port in dotted decimal format (for example 128.127.50.224). NOTE: For S-SBC configurations, this parameter is replaced with the parameters in the S-SBC Parameter Differences table below. | O |
i pAddressV6 | 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). NOTE: For S-SBC configurations, this parameter is replaced with the parameters in the S-SBC Parameter Differences table below. | O |
ipInterfaceGroupName | 1-23 characters | The name of the IP Interface Group used by this signaling port. | M |
| 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.
NOTE: The flag | O |
| 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
NOTE: The flag | O |
mode | N/A | Operational mode for this SIP Signaling Port.
| O |
portNumber | 1-65535 | UDP/TCP port number of SIP Signaling Port (default = 5060). If For example, if media port range is 5000-6000, To view
| O |
recorder | N/A | Enable flag to indicate the port is being used for recording.
| O |
| 1-23 characters | 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.
NOTE: 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. NOTE: When the siprec flag is enabled, ensure the recorder flag is disabled. | O |
| N/A |
| O |
state | N/A | Administrative state of the SIP Signaling Port.
| O |
tcpConnectTimeout | 0-180 | The maximum time (in seconds) the SBC waits for an outbound connection to complete. (default = 5). NOTE: 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). NOTE: Always configure | O |
tcpUserTimeout | N/A | Maximum number of seconds that transmitted data remains unacknowledged before TCP forcibly closes the corresponding connection. | O |
tlsProfileName | N/A | TLS Profile name used by this Signaling Port. | O |
transportProtocolsAllowed | N/A | Transport protocols allowed on this signaling port.
NOTE: The SBC only supports UDP towards the recording server. | O |
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
).
For S-SBC configurations, the following parameters are used in lieu of ipAddressV4
and ipAddressV6
parameters listed in the above table.
S-SBC Parameter Differences
Parameter | Length/Range | Description | |
---|---|---|---|
ipPublicVarV4 | 1-255 characters | The name of the metaVariable used to fetch a public/floating IPv4 address for this SIP signaling port. | O |
ipPublicVarV6 | 1-255 characters | The name of the metaVariable used to fetch a public/floating IPv6 address for this SIP signaling port. | O |
ipVarV4 | 1-255 characters | The name of the metaVariable used to fetch a IPv4 address for this SIP signaling port. | O |
ipVarV6 | 1-255 characters | The name of the metaVariable used to fetch a IPv6 address for this SIP signaling port. | O |
To set SBC 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.11.12.13; 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;
To create a S-SBC SIP Signaling Port for a particular zone:
set system ntp timeZone vsbcSystem zone asia-Kolkata commit set addressContext default dnsGroup SWeDNS commit set addressContext default dnsGroup SWeDNS server SWeDNS ipAddress fd00:10:6b50:45c0::b4 priority 0 state enabled commit set addressContext default dnsGroup SWeDNS type ip interface S_IMS_SIG_V6 commit set addressContext default zone INTERNAL id 3 sipSigPort 1 ipInterfaceGroupName S_VBIZ_V4 ipVarV4 IF6.IPV4 portNumber 5060 transportProtocolsAllowed sip-udp,sip-tcp state enabled mode inService commit set addressContext default zone EXTERNAL id 4 sipSigPort 2 ipInterfaceGroupName S_IMS_SIG_V6 ipVarV6 IF2.IPV6 portNumber 5060 transportProtocolsAllowed sip-udp,sip-tcp state enabled mode inService commit set addressContext default zone INTERNAL id 3 sipSigPort 3 ipInterfaceGroupName S_CDMA_V4 ipVarV4 IF5.IPV4 portNumber 5060 transportProtocolsAllowed sip-udp,sip-tcp state enabled mode inService commit set addressContext default zone INTERNAL sipTrunkGroup INGRESS_TG mode inService state enabled media mediaIpInterfaceGroupName M_VBIZ_V4 commit set addressContext default zone INTERNAL sipTrunkGroup INGRESS_TG ingressIpPrefix 0.0.0.0 0 commit set addressContext default zone EXTERNAL sipTrunkGroup EGRESS_TG mode inService state enabled media mediaIpInterfaceGroupName M_IMS_SIG_V6 commit set addressContext default zone INTERNAL sipTrunkGroup EGRESS_TGV4 mode inService state enabled media mediaIpInterfaceGroupName M_CDMA_V4 commit set addressContext default zone EXTERNAL sipTrunkGroup EGRESS_TG ingressIpPrefix :: 0 commit
To set tcpUserTimeout:
set addressContext default zone defaultSigZone sipSigPort 1 tcpUserTimeout 0 commit