Versions Compared

Old Version 6

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Noprint
Panel
borderColorgreen
bgColortransparent
borderWidth2

Back to Table of Contents

Back to CLI Configure Mode

Back to Global - CLI

Panel

In this section:

Table of Contents

...

Call Trace Filtering

...

Multiexcerpt include
MultiExcerptNameCall Trace Filtering
PageWithExcerptMedia 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
titleNote

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
languagenone
% 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
titleNote
...
As a general rule, set Call Trace to ingress mode unless egress mode is 
...
mandatory. 
 Warning
titleWarning
Do not turn on the Call Trace Filter to trace all calls. Use of the Call Trace feature can have significant impact on the network performance of the 
 Spacevars
0product
 system. 
 Spacevars
0company
 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
languagenone
% request global callTrace action command start 
 Info
...
titleNote
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
Call Trace Logs and Monitors - Signaling Packet Capture - Filter
Call Trace Logs and Monitors - Signaling Packet Capture - Filter
nopaneltrue
Command Syntax
Use following CLI syntax to configure call trace filters:
Global Call Trace Syntax
 Code Block
titleGlobal Call Trace Syntax
% set global callTrace 
	callFilter <callFilter_name> 
	callTraceTimer <1-360>
	errorFilter errorType <any | earlyAttempt | none | outOfDialog | parseError>
	maxTriggerCount <0-64>	
	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
titleCall 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>
	state <disabled|enabled>
	stopMatch <supported | unsupported>

...
 Info
titleNote
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
languagenone
% set global callTrace signalingPacketCapture state <enable | disable> 
Command Parameters
Global Call Trace Parameters
 Caption
0Table
1Global 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 Filter Parameters table below for details.
callTraceTimer1-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
Call_Trace_ErrorFilter_Note
Call_Trace_ErrorFilter_Note
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)
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
 Caption
0Table
1Call Filter Parameters
3Call Filter Parameters
 
Parameter
Description
...
  • disable (default)
  • enable
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.
...
 Info
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 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.).
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.
...
 Info
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
NICE_vs_MediaPacketCapture
NICE_vs_MediaPacketCapture
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
languagenone
% 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
languagenone
% 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
languagenone
% Set global callTrace signalingPacketCapture state enable
Offline Call Trace Analysis Using LX Utility
...
 Multiexcerpt-include
...
MultiExcerptNameLX
PageWithExcerptMedia Capture and Call Trace
...
 Pagebreak