Page History

Add_workflow_for_techpubs

AUTH1	UserResourceIdentifier{userKey=8a00a0c86e9b2550016ec54396b5000a, userName='null'}
JIRAIDAUTH	SBX-116754
REV5	UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cb8305e9, userName='null'}
REV6	UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cb8305e9, userName='null'}
REV3	UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cc5007da, userName='null'}
REV1	UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cc5007da, userName='null'}

Internal_display_only

server	Ribbon JIRA
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	d45d42c2-4546-3f1b-bbde-ff79196e8c48
key	SBX-115015

Panel

In this section:

Table of Contents

Call Trace Filtering

Multiexcerpt include

MultiExcerptName	Call Trace Filtering
PageWithExcerpt	SBXDOC120:Media Capture and Call Trace

The maxTriggerCount parameter is used to set/reset the Trigger Count, a mechanism used to limit the logging of call/error filter events in the .TRC file.

Info

title	Note

A system reboot, an application restart or a Live Software Upgrade (LSWU) causes the following call trace filters to go offline:

callFilter
mediaPacketCapture
signalingPacketCapture

To rectify this, disable and then reenable the applicable filters using the following CLI command syntax:

Code Block

language	none

% set global callTrace signalingPacketCapture state disable 
% set global callTrace signalingPacketCapture state enable
% set global callTrace callFilter <filterName> state disabled
% set global callTrace callFilter <filterName> state enabled
% set global callTrace callFilter <filterName> mediaPacketCapture disable
% set global callTrace callFilter <filterName> mediaPacketCapture enable

Info

title	Note

As a general rule, set Call Trace to ingress mode unless egress mode is mandatory.

Warning

title	Warning

Do not turn on the Call Trace Filter call trace filter to trace all calls unless using level4. Use The use of the Call Trace feature can have significant impact on the network performance of the at other levels significantly impacts the

Spacevars

0	product

system's network performance.

Spacevars

0	company

strongly recommends configuring Call Filters, which result in small quantities of calls being traced to avoid heavy loads. Also, be sure to delete Call Trace Filters once you have obtained the necessary information.

Use the following criteria to establish a Call Trace Filter:

Called Party Number
Calling Party Number
Contractor Number
Peer IP Address
Redirecting Number
Transfer Capability
Trunk Group

Use the match keyword to specify criteria to use to capture call data upon a match. Use the key keyword to specify criteria on which to filter call data.
Call events captured are:

Call attempt
Lookup request sent
Lookup request received
Alerting received
Cut-through received
Call Answer received
Cut-through complete
Service established
Disconnect Request received
Call terminated
Wait for more digits
Extra digits received
Initiating new attempt
Signal messages received or sent
Egress call setup message
Route lookup failure
Call blocked
Policy Request
Policy Response
Policy processing of calls in different layers like pre-processor, services, pre-router, router, and post-router.
SIP signaling events for a single call incoming/outgoing to a particular source/destination IP endpoint
SIP Protocol Data Units (PDUs) for a single call incoming/outgoing from/to a particular source/destination IP endpoint
SIP out-of-dialog PDUs such as 18X, BYE, and INFO, regardless of whether they are successfully parsed

The TRC event log level must be info for this facility to operate properly.

Use the maxTriggerCount parameter to limit the logging of call/error filter events in the .TRC file. After configuring and enabling the callFilter, an ingress/egress call that matches the filter criteria causes the corresponding events to be logged to the .TRC file, as long as the Trigger Count has not been reached. Once the configured Trigger Count has been reached, the matching callFilter will not be triggered and events associated with the call trace filter will not be logged in the .TRC file. To reenable triggering, you must configure the Trigger Count to a non-zero value less than 65.

Once the maxTriggerCount is reached or callTraceTimer expires, the call trace stops. To restart the call trace without changing the callTrace configuration, use following CLI command:

Code Block

language	none

% request global callTrace action command start

Info

title	Note

This command is only exposed after callTrace configuration is established. If no entries are present in the callTrace, this command is not available from CLI.

Excerpt Include

	SBXDOC120:Call Trace Logs and Monitors - Signaling Packet Capture - FilterSBXDOC120:
	Call Trace Logs and Monitors - Signaling Packet Capture - Filter
nopanel	true

Command Syntax

Use following CLI syntax to configure call trace filters:

Info

title	Note

The maximum number of call trace filters allowed is 100.

Global Call Trace Syntax

Code Block

title	Global Call Trace Syntax

% set global callTrace 
	callFilter <callFilter_name> 
	callTraceTimer <1-360>
	errorFilter errorType <any | earlyAttempt | none | outOfDialog | parseError>
	level4TraceMessages <allMessages | rcvdInvite>
    maxTriggerCount <0-64>	
	sageFingerprint <disable | enable>
	sageTracing <disable | enable>
	signalingPacketCapture
		devices <mgmt0 | mgmt1 | pkt0 | pkt1 | pkt2 | pkt3> <VLAN tag>
		filter <signaling trace filter name>
		signalingPacketCaptureTimer <0-360 minutes>
		state <disable | enable>

Call Filter Syntax

Code Block

title	Call Filter Syntax

% set global callTrace callFilter <callFilter_name> 
	key <called | calling | cddn | contractor | peerIpAddress | redirecting | transferCapability | trunkGroup>
	level <level1 | level2 | level3 | level4>
	match
		called <string>
		calling <string>
		cddn <string>
		contractor <string>
		peerIpAddress <IP address>
		redirecting <string>
		transferCapability <audio31Khz | speech | unrestricted | unrestrictedWithTones | video>
		trunkGroup <trunkGroup_name>
	mediaPacketCapture <disable | enable>
	sipRecLegsCapture <disable | enable>
	state <disabled|enabled>
	stopMatch <supported | unsupported>

Info

title	Note

The default value for vlanTag is "0". If you want to configure VLAN and capture the packets on a specific VLAN, you must provide the devices name and the vlanTag value.

To configure signaling state:

Code Block

language	none

% set global callTrace signalingPacketCapture state <enable | disable>

Command Parameters

Global Call Trace Parameters

Parameter

Length/Range

Description

callFilter

1-23

The name of a call trace filter to apply to the system trace data log file. This filter may be created, configured, and deleted. See Call Trace - CLI#Call Filter Parameters table below for details.

callTraceTimer

1-360

Duration in minutes that call trace is enabled.

(default = 180)

errorFilter

N/A

Use this object to specify the system-wide call trace error filter trigger criteria.

errorType– Type of error to log:
- any – Log all SIP PDUs that meet the requirement of the parseError, outOfDialog, and earlyAttempt options below.
- earlyAttempt – Logs incoming SIP PDUs that result in early termination of the call (by either the pre-parser or SIP signaling).
- none (default) – No SIP PDU logging for this error filter.
- outOfDialog – Log incoming syntactically correct SIP PDUs (except INVITE) that do not belong to an existing dialog.
- parseError – Logs the number of malformed SIP PDUs. If an error is detected by SIP signaling, the accompanying PDUs is not associated with any dialog, including an existing dialog. Hence all in dialog and out of dialog PDUs are assigned to this category. If an error is detected at the front end pre-parser, the PDU is logged and not forwarded to SIP signaling to prevent logging an offending PDU by both the pre-parser and SIP signaling.

Include Page

	SBXDOC120:_Call_Trace_ErrorFilter_NoteSBXDOC120:
	_Call_Trace_ErrorFilter_Note

level4TraceMessages

N/A

Control to limit traces only to INVITE messages.

- allMessages – Level 4 call traces contain all matching messages.
- rcvdinvite – (default) Level 4 call traces contain only matching received INVITE messages.

maxTriggerCount

0-64

Maximum number of calls that match the callFilter criteria and the errorFilter type that may be logged to the .TRC file, per slot. When this limit is reached on a module in a particular slot, this parameter value becomes 0 and matching events are no longer logged. To re-enable logging, you must issue a CLI command that configures this parameter to a nonzero value.

(default = 0)

sageFingerprint

N/A

Enable this flag to generate an audio fingerprint for the incoming calls that can aid in robocalling campaign identification. The back-end systems (such as Identity Hub) use this feature to identify robocalling campaigns and classify individual calls that belong to a robocalling campaign. For more information, refer to Voice Analytics to Identify Voice Campaigns.

Audio fingerprinting is enabled by default. A global configuration option is provided to disable the fingerprinting on the SBC.

disable – Disabling audio fingerprinting can free the memory allocated to store the associated captured media.
enable (default)

sageTracing

N/A

Use this flag to allow a sampling of the call flows in the network using the L4 call trace.

When the Sage Tracing feature is enabled, the SBC captures a small set of level 4 SIP PDU trace logs automatically in order to help debug field issues. This logging utilizes a small amount of CPU, for example, 1%. This functionality has no impact if Level 4 SIP PDU tracing is already enabled to capture allMessages for all IPs, or the trace files are disabled in the eventLog configuration.

disable
enable (default)

signalingPacketCapture

N/A

Signaling Packet Capture configuration.

devices – Choose a port to perform signaling packet capture against.
- mgmt0
- mgmt1
- pkt0
- pkt1
- pkt2
- pkt3
<VLAN tag> – Enter VLAN tag of the device used for signaling capture (or enter "0" for no VLAN).
filter – Enter the user name of this signaling trace filter.
signalingPacketCaptureTimer – Call trace timer for both call and error trace filters. (range: 0-360 minutes/ default=180)
state – Use this flag to enable/disable Signaling Packet Captures.
- disable (default)
- enable

Call Filter Parameters

Parameter

Description

key

Choose one or more active key components for this filter:

called
calling
cddn
contractor
peerIpAddress
redirecting
transferCapability
trunkGroup

level

The trace level of this call trace entry.

level1 – Trace everything.
level2 (default) – Trace everything but raw hex dumps.
level3 – Trace only external message information (ISDN/ ISUP/CAS etc.) and errors.
level4 – Trace all SIP Protocol Data Unit (PDU) calls (without logging other trace messages) at the line-rate without any dropping any SIP PDUs.

Note: Level 4 Call Trace Filter conditions/behavior:

Level 4 filters based ONLY on peerIpAddress. This call trace method does not trace/filter based on trunk group, called number, calling number, etc.
Configure a Level 4 filter with a wildcard peerIpAddress of 255.255.255.255 to match ALL packets to/from any IP IPv4 or IPv6 address.
Level 4 filters identify GCID when possible. However, some messages do not contain GCIDs and may have 0xfffffffff as the GCID (registration, notify, options ping, etc.).

For more information on the effect of different levels with respect to the flag sipRecLegsCapture, refer to Call Trace to Capture SIPRec Legs.

match

Use this keyword to specify criteria to use to capture call data upon a match. Options are:

called – Called number being traced. (range: 0-30).
calling – Calling number being traced. (range: 0-30).
cddn – Called directory number being traced. (range: 0-30).
contractor – Contractor number being traced. (range: 0-30).
peerIpAddress – The peer IPv4 or IPv6 address for call tracing.
redirecting – The redirecting number being traced (default is "").
transferCapability – Transfer capability of the call trace filter. Options are:
- audio31Khz – 3.1 kHz Audio – ITC 3.1 kHz audio calls are traced.
- speech – ITC Speech based calls are traced.
- unrestricted – (default) Calls with ITC Unrestricted are traced.
- unrestrictedWithTones – Calls with ITC Unrestricted Digital Information With Tones Announcements are traced.
- video – Calls with ITC Video are traced.
trunkGroup – Trunk group name to match against.

Note: For called, calling, cddn, contractor parameters, use "X" or "x" wildcard character to match any single digit, and "%" symbol to match any digits from that point forward. For example, using "978xxx1212" returns all calls between 9780001212 and 9789991212, and using "978%" returns all calls with a 978 prefix.

mediaPacketCapture

Specifies whether to enable or disable media packet capture settings. These files will be stored as ".pkt"files.

disable (default)
enable

Include Page

	SBXDOC120:_NICE_vs_MediaPacketCaptureSBXDOC120:
	_NICE_vs_MediaPacketCapture

sipRecLegsCapture

Enable this flag to trace and capture packets for SIPREC legs.

disable (default)
enable

For more information on this flag, refer to Call Trace to Capture SIPRec Legs.

state

Administrative state of this filter:

disabled (default) – Call filter is off. In this state no calls will be traced by this filter. The filter must be in this state to change its configuration.
enabled – When enabled, all calls are processed by this filter for possible inclusion in the system trace data log file.

stopMatch

Use this flag to stop matching filter profiles once a match is found:

unsupported (default) – Continue matching filter profiles even after a match is found (up to three profiles can be matched).
supported – Stop matching filter profiles once a match is made.

Command Examples

To enable call tracing based on the called number:

Code Block

language	none

% set global callTrace callFilter CF-1 level level1 state enabled key called,calling match called 978%  
% set global callTrace callFilter CF-1 mediaPacketCapture enable

To view the recently-enabled call trace filter:

Code Block

language	none

% show table global callTrace callFilter  
   callFilter CF-1 {  
	state enabled;  
	level level1;  
	key called,calling; 
	match {  
		called 978%;  
	}  
	mediaPacketCapture enable;

To enable signaling packet capture:

Code Block

language	none

% set global callTrace signalingPacketCapture state enable

To enable the sageFingerprint:

Code Block
set global callTrace sageFingerprint enable commit

To disable the sageFingerprint:

Code Block
set global callTrace sageFingerprint disable commit

Offline Call Trace Analysis Using LX Utility

Multiexcerpt include

MultiExcerptName	LX
PageWithExcerpt	SBXDOC120:Media Capture and Call Trace

Space shortcuts

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Call Trace Filtering

Command Syntax

Global Call Trace Syntax

Call Filter Syntax

Command Parameters

Global Call Trace Parameters

Call Filter Parameters

Command Examples

Offline Call Trace Analysis Using LX Utility