Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

In this section:

Table of Contents
maxLevel2



Noprint


Panel
bgColortransparent


Expand
titleClick here for expanded TOC...
Table of Contents
maxLevel4
minLevel2




New CLI in 9.0.0R0

Info
titleInfo

Default values are enclosed in square brackets [ ].

SBX-73090 Performance Registration Statistics per Domain

 The SBC now collects interval-based SIP registration statistics per domain. This allows you to retrieve statistics for the current interval or a series of intervals using the SBC CLI.

CLI Syntax

The following is the syntax for retrieving per-domain SIP registration statistics for the current statistics interval.

Code Block
> show status|table addressContext <addressContext_Name> sipRegCountDomainCurStats <DomainName>

The following is the syntax for retrieving per-domain SIP registration interval statistics.

Code Block
> show status|table addressContext <addressContext_Name> sipRegCountDomainIntStats <DomainName>

Command Parameters

The following statistic fields appear in the output. 

Caption
0Table
1SIP Current and Interval Registration Statistics per Domain


Output FieldDescription
number

For interval statistics, a sequence number which identifies the interval to which the set of statistics apply.

domainNameThe name of the domain to which the statistics apply. The domain name can be an IP address or FQDN.
intervalValidFor interval statistics, a value of "true" indicates that the the interval to which the set of statistics apply is valid.
timeFor interval statistics, the system uptime when the interval was collected.
countAttemptsThe number of SIP registration attempts on the SBC for the registration domain during the interval.
countCumCompletionsThe number of completed SIP registration attempts for the registration domain during the interval.
countPendingThe number of pending SIP registrations for the registration domain during the interval.
countStableThe number of stable SIP registrations for the registration domain during the interval.
countTotalThe total number of SIP registrations for the registration domain during the interval.
emergencyAcceptTotThe total number of accepted emergency SIP registrations for the registration domain during the interval.
emergencyActiveTotThe total number of active emergency SIP registrations for the registration domain during the interval.


Refer to Show Status Address Context - SIP Registration Status or Show Table Address Context - SIP Registration Status.

SBX-86128 Specifying More than 50 Destinations for SIPREC Group

To support specifying FQDNs for SRS servers, this feature adds FQDN-related parameters in the following contexts. 

Command Syntax – SRS Group Data

To enable configuring SRS servers with FQDNs, the SBC adds fqdn and fqdnPort parameters to the srsGroupData components in an SRS group profile. 

Code Block
% set global servers srsGroupProfile <profile name>
    description <0-199 characters>
    loadDistribution <roundRobin | sequence>
    numSimultaneousStream <1-2>
    srsGroupData <0-7>
        cryptoSuiteProfile <cryptoSuiteProfile>
        fqdn <FQDN>
          fqdnPort <0-65535> 
        ipAddress <IP address>
          ipPort <0-65535>
        ipTGId <IP TG Id>
        srtp <disable | enable>
        transport <tcp | tls | udp>

Command Parameters – SRS Group Data

ParameterLength/RangeDescriptionM/O
fqdn

up to 63 characters

Specifies an FQDN for the SRS server. Specify either an FQDN or IP address for the SRS entry, not both.

O
fqdnPort0-65535Specifies a TCP/UDP port number for the SRS FQDN. This option only becomes available after you configure an FQDN for the SRS.O

Command Syntax – Start Record

To enable initiating a recording through CLI using an FQDN, the SBC adds the srsFqdn1 and srsFqdn2 parameters for specifying a target SRS server in a SIPREC start record (startRecord).

Code Block
% request global siprec startRecord
        callLeg
            egress
            ingress
        gcid <0-2147483647>
        numOfStreams <1-2>
        srsFqdn1 <FQDN>
        srsFqdn2 <secondary FQDN>
        srsIpAddress <SRS IP address>
        srsIpAddress2 <secondary SRS IP address>
        srsPort <IP port number>
        srsPort2 <secondary IP port number>
        transport <tcp | udp>
        transport2  <tcp | udp>
        trunkGroup <trunk group name>
        trunkGroup2 <secondary trunk group name>

Command Parameters – Start Record

ParameterLength/RangeDescription
srsFqdn1

up to 63 characters

Specifies the FQDN of the SRS server to use for this recording. If you specify both an FQDN and individual IP address, the IP address takes precedence.

srsFqdn2up to 63 charactersSpecifies the FQDN of a secondary SRS server to use if the media stream is forked.

Command Syntax – Stop Record

The SBC adds the recorderFqdn and recorderId parameters in SIPREC stop records (stopRecord) to enable specifying the FQDN of an SRS server or a unique identifier for the recording session among the criteria that you can use to identify which recording session to stop.

Code Block
% request global siprec stopRecord
          gcid <0-2147483647>
          recorderAddress <SRS IP address>
          recorderFqdn <SRS FQDN>
          recorderId <session ID>
          recorderPort <port number>

Command Parameters – Stop Record

ParameterLength/RangeDescription
recorderFqdn

up to 63 characters

Specifies the FQDN of the SRS server on which to stop a recording.

recorderId
Specifies the unique identifier of the recording session to stop.   The user can determine the recorderId for a session using the show table global SipRecStatus command.

SBX-88296 ANI-DNIS Loop Detection

An ANI-DNIS loop refers to a situation when more than one call request shares the same combination of ANI (Automatic Number Identification) and DNIS (Dialed Number Identification Service) values. This feature adds a new aniDnisZoneloopDetection object to zones. This object has a state parameter to control whether ANI-DNIS loop detection is enabled and a parameter that defines the limit for loop instances per ANI-DNIS pair.

Command Syntax

Code Block
% set addressContext <addressContext name> zone <zone name> aniDnisZoneloopDetection
    aniDnisZoneLoopInstances <1..1250>
    aniDnisZoneState <disabled | enabled>

Command Parameters

ParameterDefaultDescription

aniDnisZoneLoopInstances

1

Use this parameter to specify an integer limit on call requests containing matching ANI-DNIS pairs. When the limit is reached, the SBC rejects any subsequent call requests for the same ANI-DNIS combination. The valid range is 1 to 1250.

aniDnisZoneState

disabled

Use this parameter to enable or disable ANI-DNIS loop detection for the specified zone.

  • disabled
  • enabled

Refer to Zone - ANI-DNIS Loop Detection - CLI for more information.

SBX-89017 - Call Notifications Events to AS

The SBC adds four new entities to configure call notification server data and matching criteria.

  • cnsGroupProfile
  • cnsGroupCluster
  • CallNotificationCriteria
  • CallNotificationCriteriaGroup

SIP trunk groups provide two new options for implementing call notifications: 

  • CallNotificationCriteriaGroup
  • sipCallNotificationMetadataProfile 

Command Syntax - cnsGroupProfile

Code Block
% set global servers cnsGroupProfile <profile name>
     cnsGroupData <sequence: 0 - 7>
        callNotifyTGId
        remoteAddress 
        remotePort
        transport
     description
     loadDistribution <roundRobin | sequence>
     uri
Command Parameters
ParameterLength/RangeDescription

<profile name>

up to 23 characters

Specifies a name for the cns group profile. The profile can specify up to 8 servers as potential recipients of call notifications. 

cnsGroupData <sequence>

0-7Specifies a sequence number for a server within the group. If the loadDistribution type is sequence, the SBC attempts to send call notifications to the servers in their specified sequence.

callNotifyTGId

up to 23 charactersSpecifies the trunk group through which the SBC sends call notifications. 

remoteAddress

up to 63 charactersSpecifies an IP address or FQDN for the server to receive call notifications.

remotePort

0-65535Specifies the number of a port to send call notifications on the server. The default is 5060.

transport

  • udp
Specifies the transport type to use for sending notifications to this server. Currently the only type is UDP.

description

up to 199 charactersSpecifies a description of this cns group profile.

loadDistribution

  • roundRobin
  • sequence

Specifies how to distribute call notifications among the servers in this group. The options are:

  • roundRobin - to distribute among the servers in a round-robin method.
  • sequence - (default) to distribute notifications in the same sequence for every call using the order defined by the server sequence value.

uri

up to 140 charactersSpecifies the URI to use in the Request-URI of NOTIFY messages for this group of servers. 

Command Syntax - cnsGroupCluster

Code Block
% set global servers cnsGroupCluster <cluster ID>
     cnsGroupClusterData <sequence: 0>
        cnsGroupId <CNS group profile name>
     description
Command Parameters
ParameterLength/RangeDescription

<cluster ID>

up to 23 characters

Specifies a name for the cns group cluster.  A cns group cluster is included in call notification criteria to indicate the server(s) that should receive notifications when a call matches the criteria. 

cnsGroupClusterData <sequence>

currently set to 0Specifies a sequence number for a cns group profile in the cluster. Currently a cns group cluster can include only one cns group profile and the sequence is set to 0 by default.

cnsGroupId

up to 23 charactersSpecifies the name of the cns group profile to include in the cluster.

description

up to 199 charactersSpecifies a description for the cns group cluster.

Command Syntax - callNotificationCriteria

Code Block
% set global servers callNotificationCriteria <criteria ID>
     calledPartyId 
     calledPartyType <AoR | number>
     callingPartyId
     callingPartyType <AoR | number>
     cnsGroupClusterId <cns group cluster ID>        
     otherLegTG 
     role <egress | ingress | none>
     userPartType  <none | useCalledNumber | useCallingNumber | useConfigured>
       userPartValue
Command Parameters
ParameterLength/RangeDescription
<criteria ID>

up to 23 characters

Specifies a name for the set of call notification criteria. 

calledPartyId
up to 134 charactersSpecifies the called party user to match.  The value can be a specific calling number, prefix, calling uri or the "*" character. The default value is "*" which matches all.
calledPartyType
  • AoR
  • number
  • *

Specifies the format in which the called party is identified in the criteria. The options are:

  • AoR
  • number
  • * (a wildcard character to match any called party)
callingPartyId
up to 134 charactersSpecifies the calling party user to match. The value can be a specific calling number, prefix, calling uri or the "*" character. The default value is "*" which matches all.
callingPartyType
  • AoR
  • number
  • *

Specifies the format in which the calling party is identified in the criteria. The options are:

  • AoR
  • number
  • * (a wildcard character to match any calling party)
cnsGroupClusterId
up to 23 charactersSpecifies the name of the call notification server group cluster that should receive NOTIFY messages when a call matches this set of criteria.
otherLegTG
up to 23 charactersSpecifies the name of a SIP trunk group for the other call leg to match. The value can also be the "*" character which matches all.
role
  • both
  • egress
  • ingress

Specifies on which call leg to apply the criteria. The options are:

  • both – (both) applied on both ingress and egress.
  • egress - applied when the trunk group to which the criteria is attached is the egress trunk group.
  • ingress - applied when the trunk group to which the criteria is attached is the ingress trunk group.
userPartType
  • none
  • useCalledNumber
  • useCallingNumber
  • useConfigured

Specifies what to use to populate the userpart in the Request-URI within NOTIFY messages. The options are:

  • none (default)
  • useCalledNumber
  • useCallingNumber
  • useConfigured (requires you to specify a static value for the userpart using the userPartValue parameter.)
userPartValueup to 23 charactersSpecifies a static value for the userpart of the Request-URI within NOTIFY messages, only if you specify the userPartType as useConfigured.


Command Syntax - callNotificationCriteriaGroup

Code Block
% set global servers callNotificationCriteriaGroup <group ID>
     callNotificationCriteriaGroupData <sequence: 0 - 31>
        callNotificationCriteriaId <call notification criteria ID>
     description
Command Parameters
ParameterLength/RangeDescription
<group ID>

up to 23 characters

Specifies a name for a group of up to 32 sets of call notification criteria. Sets of criteria are identified within the group by a sequence number.

callNotificationCriteriaGroupData
<sequence>
0-31Specifies a sequence number for a set of call notification criteria within the group. The SBC checks for a match in sequence order until it finds a match or exhausts the list of  notification criteria.
callNotificationCriteriaId
up to 23 charactersSpecifies the name of the set of call notification criteria to associate with the sequence number.
description
up to 199 charactersSpecifies a description for the call notification criteria group.


Command Syntax - SIP Trunk Group Parameters

 Two parameters are added to SIP trunk groups to attach call notification criteria to the trunk group and to specify a SIPREC metadata profile to use in determining the session ID sent in call notifications. This feature uses the existing SIPREC metadata profile to map the session ID, it does not introduce a new type of profile. 

Code Block
% set addressContext <address context> zone <zone> sipTrunkGroup <TG name> policy callNotificationCriteriaGroup <group ID>


Code Block
% set addressContext <address context> zone <zone> sipTrunkGroup <TG name> services sipCallNotificationMetadataProfile <sipRecMetadataProfile profile name>
Command Parameters
ParameterLength/RangeDescription

callNotificationCriteriaGroup

up to 23 characters

Specifies the name of the call notification criteria group to attach to the trunk group to trigger call notifications for calls that match.


ParameterLength/RangeDescription

sipCallNotificationMetadataProfile

up to 23 characters

Specifies the name of a SIPREC metadata profile that defines the mapping of a SIP header to the Session-Id XML element in NOTIFY messages.  This parameter should be set on the trunk group used to send call notifications. Refer to Services - SIP Rec Metadata Profile for information on these profiles.

Refer to Configuring the SBC to Send Unsolicited Call Notifications to Application Servers.


SBX-91618 Using an OOD REFER to Terminate an Active Call

This feature adds a new signaling parameter for SIP trunk groups that controls whether the SBC locally handles OOD REFER requests. 

Command Syntax

Code Block
% set addressContext <addressContext name> zone <zone name> sipTrunkGroup <trunkGroup name> signaling localOODReferSupport <disabled | enabled>

Command Parameters

ParameterDescription

localOODReferSupport

Enable this flag to have the SBC locally handle out-of-dialog (OOD) REFER requests.

  • disabled (default)
  • enabled

Refer to SIP TG - Signaling - Local OOD REFER Support - CLI for more information.

SBX-93310 Enhance the processing of Contact headers in REGISTER messages

This feature adds a new configuration object, the Register Contact Profile, and a new zone option to assign a profile to a zone.

Command Syntax - Profile

Code Block
% set profiles signaling registerContactProfile <profile name>
    contactIncludeVariables <hostpart | userpart>

Command Parameters - Profile

ParameterDescription
 registerContactProfile
<profile name>

Specifies a name for the Register Contact Profile of up to 23 characters.

contactIncludeVariables

Specifies the element or elements within the Contact header to use as additional keys when creating or retrieving registration control blocks (RCBs). The options are:

  • userpart (default)
  • hostpart

If specifying more than one value, separate the values with a comma, such as: userpart,hostpart

Command Syntax - Zone

Code Block
% set addressContext <addressContext name> zone <zone name> registerContactProfileName <registerContactProfile name>

Command Parameter - Zone

ParameterDescription

registerContactProfileName
<registerContactProfile name>

Specifies the name of a Register Contact Profile to assign to a zone. The SBC uses the Contact header elements specified in the profile as additional keys when it creates or retrieves RCBs.

For more information refer to Creating Multiple User Registrations Based on Contact Headers in REGISTER Messages.


SBX-87520 - Add VLAN-ID to Available Fields for X-Header Submission on the Monitoring Interface

The parameter vlanTag is added to monitoringProfile header.

Command Syntax

With this enhancement, monitoringProfile has the following parameters:

Code Block
% set profiles services monitoringProfile <name>
    monitoringIpAddress <IPv4 | IPv6>
    monitoringIpPort <0-65535>
    headerPresence <disabled | enabled>
    header <index>
    headerName <name>
    sourceIpPort <disabled | enabled>
    destinationIpPort <disabled | enabled>
    additionalInformation <disabled | enabled>
    date <disabled | enabled>
    timestamp <disabled | enabled>
    vlanTag <disabled | enabled>

Corresponding changes in the result of the show command are shown below:

Code Block
% show profiles services monitoringProfile test_monitoring_profile
monitoringIpAddress 10.54.21.25;
monitoringIpPort    80;
headerPresence      enabled;
header 1 {
    headerName            To;
    sourceIpPort          enabled;
    destinationIpPort     enabled;
    timestamp             enabled;
    date                  enabled;
    additionalInformation enabled;
    vlanTag               enabled;
}
[ok][<YYYY-MM-DD HH:MM:SS>]

Command Parameters

ParameterLength/RangeDefaultDescriptionM/O
vlanTag

N/A

disabled

Adds VLAN ID of the interface on which the monitored message is sent/received.

  • disabled (default)
  • enabled
O