Oam&p PDF

Compleat-200 Operations, Administration,
Maintenance, and Provisioning Guide

April 2007
Release 6.0 Issue 5
Part No. 600-0600-002
Carrius Technologies, Inc.

2140 Lake Park Blvd., Suite 500
Richardson, TX. 75080
(214) 572-7800
(214) 575-9007 Fax
info@carriustech.com
© 2007 Carrius Technologies, Inc. All Rights Reserved.
No part of this publication, or the software, firmware or hardware described within this
publication, may be reproduced, stored in a retrieval system, or transmitted in any form or
by any means, electronic, mechanical, photocopying, recording or otherwise without the
prior written permission of Carrius Technologies, Inc..
Compleat-200 OAM&P Guide
Table of Contents
Preface ............................................................................................................................................. P-1

Chapter 1 Command Line Interface ........................................................................................1-1
1.1 Introduction...................................................................................................................1-1
1.2 CLI Command Help Files .............................................................................................1-1
1.3 Command Usage Hints ................................................................................................1-1
1.3.1 Parameter Prompting ...............................................................................................1-3
1.4 Input Provisioning Flow ................................................................................................1-4
1.5 CLI Script Operation .....................................................................................................1-4
1.6 CLI Navigation ..............................................................................................................1-4
1.6.1 Login and Logout......................................................................................................1-4
1.6.2 Issue Commands .....................................................................................................1-5
1.6.3 CLI Keywords and Parameters ................................................................................1-6
1.6.4 Access Help .............................................................................................................1-6
1.6.5 Hot Keys...................................................................................................................1-7
1.6.6 Command Completion Feature ................................................................................1-7
1.7 Log Files .......................................................................................................................1-8
1.8 Facility/Port Number Formats.......................................................................................1-8
1.8.1 Slot Numbering.........................................................................................................1-8
1.8.2 Port Numbering ......................................................................................................1-11
1.9 Resource Types .........................................................................................................1-13
1.10 User Accounts ............................................................................................................1-15
1.10.1 User ID and Password Conventions ......................................................................1-15
1.10.2 Security Levels .......................................................................................................1-16
Chapter 2 Operations, Administration, Maintenance, and Provisioning .......................2-1
2.1 Introduction...................................................................................................................2-1
2.2 Device State Management ...........................................................................................2-1
2.2.1 Provisioning Devices ................................................................................................2-2
2.2.2 Remove and Restore ...............................................................................................2-3
2.2.3 Graceful Removal of a Device..................................................................................2-8
2.2.4 Device Provisioning..................................................................................................2-8
2.2.5 Shelf .........................................................................................................................2-8
2.2.6 Slot ...........................................................................................................................2-9
2.2.7 System Cards.........................................................................................................2-10
2.2.8 Spans .....................................................................................................................2-11
2.2.9 Channels (TDM Channels).....................................................................................2-11
2.2.10 Clocking..................................................................................................................2-11
2.3 Distributed Multiple-Chassis System ..........................................................................2-12
2.3.1 Distributed Networks ..............................................................................................2-13
2.3.2 Liberator in a Distributed Multiple-Chassis System................................................2-14
Release 6.0 Issue 5 Compleat-200 OAM&P Guide

Part No. 600-0600-002 Page TOC-1
Table of Contents
2.3.3 Inter-Chassis Communication Paths...................................................................... 2-14

2.3.4 Distribution of B and D-channels of PRI NFAS Group ........................................... 2-14
2.3.5 I/O Card Clock Timing............................................................................................ 2-14
2.3.6 Provisioning a Multi-Shelf System.......................................................................... 2-15
2.4 Call Routing................................................................................................................ 2-15
2.4.1 Virtual Endpoints .................................................................................................... 2-15
2.4.2 Creating Endpoint Pools ........................................................................................ 2-16
2.4.3 Modifying Endpoint Pools....................................................................................... 2-17
2.4.4 Deleting an Endpoint Pool...................................................................................... 2-17
2.4.5 Adding Spans to an EndPoint Pool ........................................................................ 2-18
2.4.6 Removing Spans from an EndPoint Pool............................................................... 2-18
2.5 Route Lists ................................................................................................................. 2-18
2.5.1 Create a Route List ................................................................................................ 2-20
2.5.2 Modify a Route List ................................................................................................ 2-20
2.5.3 Delete a Route List................................................................................................. 2-20
2.6 Route Tables .............................................................................................................. 2-20
2.6.1 Create a Route Table............................................................................................. 2-20
2.6.2 Delete a Route Table ............................................................................................. 2-20
2.6.3 Modify a Route Table ............................................................................................. 2-21
2.7 Routing Algorithms ..................................................................................................... 2-22
2.7.1 Originator as Preferred Shelf ................................................................................. 2-24
2.7.2 Master Routing Shelf.............................................................................................. 2-29
2.7.3 Hunting Algorithms................................................................................................. 2-31
2.8 Enhanced Call Routing............................................................................................... 2-32
2.8.1 Route Advancement............................................................................................... 2-32
2.8.2 Incoming Translation Routing ................................................................................ 2-33
2.9 Call Transfer............................................................................................................... 2-35
2.9.1 Call Transfer over CAS Signaling .......................................................................... 2-35
2.9.2 Call Transfer over ISDN TBCT............................................................................... 2-37
2.9.3 Call Transfer using SIP Refer Signaling................................................................. 2-39
2.9.4 Call Transfer using DTMF (*8) Signaling on the Bearer Channel .......................... 2-42
2.9.5 SIP to H.323 Call Transfer ..................................................................................... 2-44
2.10 SIP Call Hold and Retrieve......................................................................................... 2-46
2.11 External NAT/Firewall Configuration .......................................................................... 2-48
2.11.1 External NAT Firewall Provisioning........................................................................ 2-48
2.11.2 Compleat-200 Capabilities ..................................................................................... 2-50
2.11.3 Single IP Address for Compleat-200...................................................................... 2-51
2.11.4 Multiple IP Addresses for Compleat-200................................................................ 2-59
2.11.5 Simple NAT Solution .............................................................................................. 2-62
2.12 Application Programs ................................................................................................. 2-62
2.12.1 Create an Application............................................................................................. 2-63
2.12.2 Specify Log File Sizes............................................................................................ 2-64
2.12.3 Specifying Command Line Options........................................................................ 2-64
2.12.4 Deleting Applications.............................................................................................. 2-65
2.12.5 Displaying Applications .......................................................................................... 2-65
2.12.6 External Applications.............................................................................................. 2-67
2.12.7 Application Redundancy ........................................................................................ 2-67
2.12.8 Remove and Restore Applications......................................................................... 2-68
Compleat-200 OAM&P Guide Release 6.0 Issue 5

Page TOC-2 Part No. 600-0600-002
Table of Contents
2.13 VoIP Protocol Configuration .......................................................................................2-69

2.13.1 Session-Initiation Protocol ......................................................................................2-69
2.13.2 H.323 ......................................................................................................................2-71
2.14 TDM Configuration......................................................................................................2-72
2.14.1 Primary Rate Interface (PRI) ..................................................................................2-72
2.14.2 Non-Facility Associated Signaling (NFAS) .............................................................2-73
2.15 Channel Associated Signaling (CAS) .........................................................................2-75
2.15.1 CAS Signaling Types..............................................................................................2-75
2.15.2 CAS Commands .....................................................................................................2-76
2.15.3 Programmable CAS................................................................................................2-76
2.16 Line-Side FXS to PBX Interface .................................................................................2-77
2.16.1 Answering Machine Detection ................................................................................2-79
2.17 Announcements and Tones ........................................................................................2-80
2.17.1 Pre-Recorded Announcements ..............................................................................2-80
2.17.2 Preconfigured Tones ..............................................................................................2-82
2.18 Configuring Digit and Pattern Manipulation ................................................................2-83
2.18.1 Digit Patterns ..........................................................................................................2-83
2.18.2 Digit Fields and Tags ..............................................................................................2-84
2.18.3 Digit-Pattern CLI Commands..................................................................................2-85
2.18.4 Pattern Sets ............................................................................................................2-86
2.19 Reports and Queries...................................................................................................2-86
2.19.1 Resource Query .....................................................................................................2-86
2.19.2 Alarm Report ..........................................................................................................2-86
2.20 Log Files .....................................................................................................................2-87
2.20.1 Log File Location ....................................................................................................2-87
2.21 Statistical Reports .......................................................................................................2-90
2.22 Call Information Records ............................................................................................2-90
2.23 Simple Network Management Protocol (SNMP).........................................................2-91
2.23.1 SNMP Management Information Bases .................................................................2-91
2.23.2 SNMP Basic Components ......................................................................................2-93
2.23.3 SNMP Support........................................................................................................2-93
2.23.4 SNMP Traps ...........................................................................................................2-94
2.24 Chassis Management Network Security .....................................................................2-94
2.25 DS0 Grooming ............................................................................................................2-94
2.25.1 Example of DS0 Grooming for E1 Facilities ...........................................................2-94
2.26 Message Waiting Indication ........................................................................................2-96
2.26.1 Supported Interfaces ..............................................................................................2-96
2.26.2 Sending MWI Notification .......................................................................................2-97
2.26.3 Enabling MWI .........................................................................................................2-98
2.27 Echo Cancellation .......................................................................................................2-98
2.27.1 Hybrid Echo ............................................................................................................2-98
2.27.2 Acoustic Echo .........................................................................................................2-99
2.27.3 Echo in Packet Voice Networks..............................................................................2-99
2.27.4 PSTN Phone User Hears Echo ............................................................................2-100
2.27.5 IP Phone User Hears Echo ..................................................................................2-101

Part No. 600-0600-002 TOC-3
Table of Contents
Chapter 3 Database Backup and Restore ............................................................................. 3-1

3.1 Introduction................................................................................................................... 3-1
3.2 CLI Backup of Database .............................................................................................. 3-1
3.3 CLI Restore of Database.............................................................................................. 3-2
3.4 Backup Binary Database Procedure ............................................................................ 3-2
3.4.1 FTP Example ........................................................................................................... 3-2
3.5 Restore Binary Database Procedure............................................................................ 3-3
3.5.1 FTP Example ........................................................................................................... 3-3
Chapter 4 System Access ......................................................................................................... 4-1
4.1 Introduction................................................................................................................... 4-1
4.2 Customer-Supplied Encryption/Authentication Keys .................................................... 4-1
Chapter 5 Wireless Prepaid Charging.................................................................................... 5-1
5.1 Introduction................................................................................................................... 5-1
5.2 Redundancy Between the Application Server and the Compleat-200 System ............ 5-3
5.3 Redundancy Between the Compleat-200 System and the MSC.................................. 5-4
Chapter 6 SS7 Signaling Architecture ................................................................................... 6-1
6.1 Introduction................................................................................................................... 6-1
6.1.1 Service Switching Point............................................................................................ 6-1
6.1.2 Signal Transfer Point................................................................................................ 6-2
6.1.3 Service Control Point ............................................................................................... 6-3
6.2 SS7 Links ..................................................................................................................... 6-4
6.2.1 T1/E1 Alarm Detection ............................................................................................. 6-4
6.2.2 Link Types................................................................................................................ 6-5
6.3 Linksets ........................................................................................................................ 6-8
6.4 SS7 Signaling Interfaces .............................................................................................. 6-8
6.5 SS7 Provisioning .......................................................................................................... 6-9
6.5.1 MTP3 Commands .................................................................................................... 6-9
6.5.2 ISUP Commands ..................................................................................................... 6-9
6.5.3 SCCP Commands.................................................................................................. 6-10
6.5.4 TCAP Commands .................................................................................................. 6-11
6.5.5 Additional Resources ............................................................................................. 6-11
6.6 Intelligent Network Application Protocol ..................................................................... 6-11
Chapter 7 Craftsperson Trace Tool ........................................................................................ 7-1
7.1 Introduction................................................................................................................... 7-1
7.2 Trace Utility CLI............................................................................................................ 7-1
7.2.1 Enter-Trace-CallInformation..................................................................................... 7-2
7.2.2 Modify-Trace-CallInformation................................................................................... 7-6
7.2.3 Remove-Trace-CallInformation ................................................................................ 7-6
7.2.4 Enable/Disable-Trace............................................................................................... 7-6
7.2.5 Show-Trace-CallInformation .................................................................................... 7-7
7.2.6 Watch-App-TraceLog ............................................................................................... 7-7
7.2.7 Capture-App-TraceLog ............................................................................................ 7-8
7.2.8 Retrieve-App-TraceLog............................................................................................ 7-8
7.3 Trace Output ................................................................................................................ 7-9

Table of Contents
Chapter 8 Graphical User Interface.........................................................................................8-1

8.1 Introduction ...................................................................................................................8-1
8.2 Launching the GUI ........................................................................................................8-1
8.2.1 Logging In to the GUI ...............................................................................................8-2
8.2.2 Home Page...............................................................................................................8-3
8.2.3 Status Page ..............................................................................................................8-5
8.2.4 Cut-thru Page ...........................................................................................................8-6
8.2.5 Statistics Page..........................................................................................................8-7
8.2.6 Help Page.................................................................................................................8-9
8.2.7 GUI Permissions.......................................................................................................8-9
Appendix A CLI User Access Levels ................................................................................ A-1
Appendix B System-Provisioned Tones........................................................................... B-1
Appendix C Pre-Recorded Announcements .................................................................... C-1
Appendix D Alarm Severity Table ..................................................................................... D-1
Appendix E Reporting Statistics ....................................................................................... E-1
Appendix F CLI Keywords and Parameters ..................................................................... F-1

Part No. 600-0600-002 TOC-5
Table of Contents

Preface
Introduction
This section describes the following information for the Carrius Technologies
Compleat-200 Operations, Administration, Maintenance, and Provisioning Guide:
• Document Objectives
• Audience
• Overview
• Additional Information
• Admonitions
• Change History
Carrius Technologies, Inc. documentation and additional literature are available on
a CD-ROM that ships with the product. To order additional copies of the
documentation, contact your local sales representative or customer service at
1-866-CARRIUS (1-866-227-7487).
Document Objectives
This guide describes the operation, administration, maintenance, and provisioning
requirements for the Compleat-200 system.
Audience
This document is for Engineers tasked with network design and planning for the
Compleat-200 system.

Part No. 600-0600-002 P-1
Preface
Overview
The Compleat-200 OAM&P Guide contains the following chapters:
• Chapter 1 - Command Line Interface
• Chapter 2 - Operations, Administration, Maintenance, and Provisioning
• Chapter 3 - Database Backup and Restore
• Chapter 4 - System Access
• Chapter 5 - Wireless Prepaid Billing
• Chapter 6 - SS7 Signaling Architecture
• Chapter 7 - Craftsperson Trace Tool
• Chapter 8 - Graphical User Interface
• Appendix A - CLI User Access Levels
• Appendix B - System-Provisioned Tones
• Appendix C - Pre-Recorded Announcements
• Appendix D - Alarm Severity Table
• Appendix E - Statistics
• Appendix F - CLI Keywords and Parameters
Additional Information
Refer to 600-0600-018 Documentation Guide for a list of the Compleat-200 system
support documentation.
Admonitions
The following admonitions may appear in this document.
CAUTION indicates a potential hazard that could result in injury to the user,
damage to the equipment or loss of data.
CAUTION
TIP indicates a solution that may help resolve a problem.
TIP
DLP indicates a path to a Detailed Level Procedure (DLP).

DLP

P-2 Part No. 600-0600-002
Preface
NOTE indicates helpful suggestions or useful background information.
Change History
This sections contains the change history for this document.
Date Description
June 2006 Release 5.0 Issue 1
September 2006 Release 5.1 Issue 1
December 2006 Release 6.0 Issue 1
February 2007 Release 6.0 Issue 2
February 2007 Release 6.0 Issue 3
March 2007 Release 6.0 Issue 4
April 2007 Release 6.0 Issue 5

Part No. 600-0600-002 P-3
Preface

P-4 Part No. 600-0600-002
C H A P T E R 1
Command Line Interface
1.1 Introduction
A command line interface (CLI) is a method of interacting with the Compleat-200
software by entering lines of textual commands (a sequence of characters) either
from the console or through a remote network connection.
The CLI provides commands that you use to perform various tasks, including
monitoring and troubleshooting the software, configuring network connectivity, and
provisioning system hardware.
All maintenance requests are available through the CLI on the System Manager
shell application and to the application through the Compleat-200 system API. For
more information, refer to the Liberator API Programmer’s Guide.
1.2 CLI Command Help Files

The exact syntax options and parameters for all CLI commands are available in the
HTML-based CLI Documentation.
Alternatively, you can generate the HTML documentation by executing the
Help-DocHTML command. This command regenerates the HTML documentation
and places it in a default directory. To specify another location, add
/dir=<pathname> and define a directory path.
1.3 Command Usage Hints

Refer to the following hints for additional tips when using the CLI:
• Most commands and command arguments are not case sensitive, for example,
Enter-User or enter-user. However, some argument values (e.g., TP1610) are
case sensitive.
• Most "Show-" commands support the /verbose option to provide an additional
level of detailed information.
Command Prompt> Show SystemManager /verbose

Part No. 600-0600-002 Page 1-1
Chapter 1 Command Line Interface
• Spaces are optional in the CLI. For example, it is possible to enter enter-shelf
/id= or enter-shelf/id=.
• Reserved characters must be included in quotes. All math symbols, for
example, and most non-alphanumeric ASCII characters except the underscore
“_” are reserved. For instance, the dash "-" is a reserved character. To use a
dash in the "name" portion of a resource ID or any other text field, enclose the
entire text portion in quotes, for example, 5-"My-Logical-Resource".
• You can add arguments in any order. Both Enter-User /user=fred
/type=MONITOR /password=secret and Enter-User /type=MONITOR
/user=fred /password=secret work the same.
• The up and down arrow keys can be used to access commands previously
entered. In addition, the right-hand arrow can be used to repeat the last
command letter by letter.
• The “*” can be used as a wildcard when displaying resource IDs. It is possible
to display the device status of all spans related to a card by entering
Show-Device T1DS1-1-1-*.
• At the command line, type #, followed by any text to document entered
commands.
• Commands may be abbreviated by entering the fewest number of characters
that uniquely identify the command. For example, the command
“Enter-PRI-EndPointPool may be shortened to E-P-E.
• The same abbreviation rules apply to command parameters as well. For
example, the /verbose parameter may be shortened to /v.
• Command parameters with a boolean value (true or false) will default to “true,”
if a value is not specified. As such, entering “/verbose” or “/v” is the same as
entering “/verbose=true”.
• A history of all commands entered at the System Manager CLI prompt, including
comments preceded by the # character are output to the ASCII text file with the
suffix “.cmds” in the logs/SystemManager directory.

Page 1-2 Part No. 600-0600-002
1.3.1 Parameter Prompting

Users can enter a question mark () at the system prompt to display a list of
commands available for each command mode. You can also obtain a list of
associated keywords and arguments for any command, as shown in the following
table.
Command Purpose
abbreviated-com- Obtains a list of commands that begin with a particu-
mand-entry? lar character string.
For example:
#> Ent?
? Lists all commands available for a particular com-
mand mode.
For example:
#> ?
command? Lists the associated keywords for a command.
For example:
#> Enter?
command keyword? Lists the associated arguments for a keyword.
For example:
#> Enter-SBCCard?
abbreviated-com- Obtains a list of commands that begin with a particu-
mand-entry? lar character string.
For example:
#> Ent?
Table 1-1 Parameter Prompting Summary
Optional parameters are indicated as well and can be skipped by pressing Enter,
or the user can choose to enter an alternate value and press Enter.
The Compleat-200 CLI displays the entire CLI string once the craft has provided the
needed parameters for that command. The craft executes that command string
when the user presses Enter.
Once the completed string displays, the Compleat-200 CLI enables the user to edit
the parameters that have been entered by typing a question mark (?) after the
displayed command string.
The CLI is capable of being interrupted via the standard “tty” interrupt control
sequence – CTRL-C. The command abort (CTRL-C) sequence aborts CLI output or
CLI input and returns to the System Manager prompt (>>).

Part No. 600-0600-002 Page 1-3
1.4 Input Provisioning Flow

If starting from a blank database:
• Include the default “factory-settings” file provided with the SDK.
• Set up user accounts and their privilege levels using the Enter-User command.
• Provision physical resources – Shelves and cards.
• Provision logical resources – Endpoint Pools, routing tables, etc.
• Provision applications – System Managers, Call Managers, IO Managers – to
control the physical devices.
• Provision optional API programs that will be used to control the platform.
• Unlock all devices and applications to start the system.
1.5 CLI Script Operation

In order to facilitate the entry of CLI commands into the system, you may create an
ASCII text file that contains CLI commands and then import that file into the system.
This is achieved with the CLI command 'include' (from the CLI enter the "help
include" command for additional parameters). Including a command file will
sequentially execute each command in the file, appropriately adding or modifying
the database. Any error encountered in a command line script will stop the script on
the command that has the error. Error messages are sent to both the CLI display
and the appropriate “.cmds” log file.
1.6 CLI Navigation

This section familiarizes the user with the operation of the Compleat-200 system
using the command line interface. Along with describing the various access
methods to the CLI, this section also describes general manipulations to navigate
through the system and to perform CLI operations.
1.6.1 Login and Logout

The Login and Logout commands control the user’s access to the Compleat-200
system. Login requires the user ID and password parameters.
When accessing the system for the first time, a user can login as either a guest or
administrator.
By default, the “guest” account does not have a password assigned to it. For
security purposes, it is important to modify the “guest” account to add a password
at the earliest possible time.

Page 1-4 Part No. 600-0600-002
Enter the following command to display the user accounts:
Command Prompt> Show-User
ID PERMISSIONS
---------------------- -----------------------
* guest DEBUG
admin ADMINISTRATOR
An asterisk precedes the name of the user currently logged in.
Enter the following command to logout:
Command Prompt> Logout
Refer to Section 1.10 for information on eclipsing the default user names.
1.6.2 Issue Commands

To issue a CLI command, enter the command at the command prompt.
Enter the appropriate ‘Show’ command to display the output on the screen. The
following figure shows a sample CLI command and output display.
Figure 1-1 Sample CLI Command Output

Part No. 600-0600-002 Page 1-5
1.6.3 CLI Keywords and Parameters

You can configure all properties of the Compleat-200 system, including interfaces,
routing information, routing protocols, user access, and system hardware
properties.
All CLI commands start with a keyword. Some commands require no further
information; others require one or more parameters such as file name, component
name, or resource name.
Every command requires at least one keyword; however, a command can contain
additional keywords.
Parameters are often required elements of a command; however, for some
commands, parameters are not required. A parameter is a value that you specify
after the keyword/s. There are different types of parameters, such as strings,
integers, or resources.
1.6.4 Access Help

To display a list of all CLI commands, enter the help command at the CLI prompt.
For help on a particular command, enter the help <keyword-parameter>
command.
To display the most verbose help, enter help <keyword-parameter> /verbose.
• Following a Help command with the /options parameter will provide a brief
description of all parameters for that command.
Command Prompt> Help Enter-SystemManager /options
• Following a Help command with the /parameter option will provide all
parameters for that command and a brief description of the parameter identified
in the command.
Command Prompt> Help Enter-SystemManager /parameter=<parameter ID>

Page 1-6 Part No. 600-0600-002
1.6.5 Hot Keys

For many editing functions, the CLI editor provides hot keys. The following table
lists some editing shortcuts that are available.
Key Function
Delete Removes one character to the right of the cursor
Backspace Removes one character to the left of the cursor
Up Arrow ↑ Allows user to scroll forward through former commands
Down Arrow ↓ Allows user to scroll backward through former commands
Right Arrow → Fills in the last command one character at a time
Left Arrow ← Moves to the left of the command without removing the
character
End key Moves to the end of the command line
Home key Moves to the beginning of the command line
Table 1-2 CLI Hot Keys
1.6.6 Command Completion Feature

It is not always necessary to enter the full name of a CLI command or its argument.
If you enter enough letters to make the command or argument unambiguous, the
CLI accepts the abbreviated name. Once you type enough letters of a command
name or command argument to make it unambiguous, press Enter to resolve the
command. For example, if you enter Show-De, the CLI completes the command
Show-Device.
If you enter the command,
Command Prompt> Show-T1Sp /id=1-6-1
The CLI interprets the command correctly, although the component name (T1Span)
is not complete.
If the command were Show-PRI-EndpointPool, the following commands would
also work:
Command Prompt> S-P-E
Command Prompt> Show-PRI-E
You must type the shortest non-ambiguous form of the command for it to resolve
properly. Consider the following commands:
Command Prompt> Load-Audio
Command Prompt> Lock-App

Part No. 600-0600-002 Page 1-7
Lo-A is not acceptable because it does not unambiguously resolve the command.
Loc-A would give you the Lock-App command.
Loa-A would give you the Load-Audio command.
Lo-Au would give you the Load-Audio command.
1.7 Log Files

During CLI operation, the system generates a daily log file that records all input and
output accepted by and generated from the CLI shell. Each line is time stamped
with the exact time of day that the command was executed and the output that was
generated. You can find the log file by accessing the RT-ENV\logs directory and
opening the appropriate subdirectory.
1.8 Facility/Port Number Formats

If a CLI command requires card and port/facility numbers, you must enter the shelf,
slot, and port/facility parameters. For example, to issue a show-t1span command
to port 4 on card 6 in shelf 1, you would enter the following command:
Command Prompt> Show-T1Span /id=1-6-4
1.8.1 Slot Numbering

Refer to the following table for a mapping of the chassis slot numbers.
Chassis Card Slot

ZT5085 SBC 3-20
12U • SBC PMC Slots 9-12 are reserved
(PTI) for 3rd party applications
• SBC PIM
Input/Output Card (I/O) 3-8, 13-18
• AudioCodes 1610_02 (2-span)
TP2810_DS3 (28 spans in one DS3) 3-8, 13-18
AudioCodes 1610 (Conferencing Card - 3-8, 13-18
8-spans on a 16-span card)
CMM 1A
1B
Table 1-3 Slot Numbering

Page 1-8 Part No. 600-0600-002
Chassis Card Slot

ESC 2
21
ZT5086 SBC 3-20
12U • SBC PMC
(PTI) • SBC PIM
I/O Card 3-18
TP2810_DS3 (28 spans in 1 DS3) 3-18
AudioCodes 1610 (Conferencing Card - 8 3-18
spans on a 16 span card)
CMM 1A
1B
ESC 2
21
ZT5091 SBC 2-7
4U • SBC PMC
• SBC PIM
I/O Card 2-7
TP2810_DS3 (28 spans in 1 DS3) 2-7
AudioCodes 1610 (Conferencing Card - 2-7
8-spans on a 16-span card)
CMM 9
ESC 1

Part No. 600-0600-002 Page 1-9
Chassis Card Slot

ZT5091eA SBC 2-7
4U • SBC PMC
• SBC PIM
I/O Card 2-7
TP2810_DS3 (28 spans in 1 DS3) 2-7
AudioCodes 1610 (Conferencing Card - 8 2-7
CMM 9
ESC 1
4U SBC 1-6
(PDSi) • SBC PMC
• SBC PIM
I/O Card 1-6
TP2810_DS3 (28 spans in 1 DS3) 2-5
EAN 11
ESC 7-8
1U SBC 1
(PDSi) SBC PMC
SBC PIM
I/O Card 2
TP2810_DS3 (28 spans in 1 DS3) 2

Page 1-10 Part No. 600-0600-002
1.8.2 Port Numbering

Refer to the following table for a mapping of the chassis port numbers.
Chassis Card Physical Port # Logical Port #

ZT5085 SBC N/A
12U • SBC PMC 1-4 0-3
(PTI) • SBC PIM 1-4 0-3
Input/Output Card (I/O)
• AudioCodes 1610_02 (2-span) 1-2 0-1
• AudioCodes 1610_04 (4-span) 1-4 0-3
• AudioCodes 1610_08 (8-span) 1-8 0-7
• AudioCodes 1610_16 (16-span) 1-16 0-15

TP2810_DS3 (28 spans in one DS3) 1
AudioCodes 1610 (Conferencing Card - 8 8
CMM N/A
ESC N/A
ZT5086 SBC N/A
12 • SBC PMC 1-8 0-7
(PTI) • SBC PIM 1-8 0-7
I/O Card
• AudioCodes 1610_02 (2-span) 1-2 0-1
• AudioCodes 1610_04 (4-span) 1-4 0-3
• AudioCodes 1610_08 (8-span) 1-8 0-7
• AudioCodes 1610_16 (16-span) 1-16 0-15

CMM N/A
ESC N/A
Table 1-4 Port Numbering

Part No. 600-0600-002 Page 1-11

ZT5091 SBC N/A
4U • SBC PMC 1-8 0-7
1-8 0-7
• SBC PIM
I/O Card
• AudioCodes 1610_02 (2-span) 1-2 0-1
• AudioCodes 1610_04 (4-span) 1-4 0-3
• AudioCodes 1610_08 (8-span) 1-8 0-7
• AudioCodes 1610_16 (16-span) 1-16 0-15
CMM N/A
ESC N/A
ZT5091eA SBC N/A
4U • SBC PMC 1-8 0-7
1-8 0-7
• SBC PIM
I/O Card
• AudioCodes 1610_02 (2-span) 1-2 0-1
• AudioCodes 1610_04 (4-span) 1-4 0-3
• AudioCodes 1610_08 (8-span) 1-8 0-7
• AudioCodes 1610_16 (16-span) 1-16 0-15
CMM N/A
ESC N/A
4U SBC N/A
(PDSi) • SBC PMC 1-8 0-7
1-8 0-7
• SBC PIM
I/O Card
• AudioCodes 1610_02 (2-span) 1-2 0-1
• AudioCodes 1610_04 (4-span) 1-4 0-3
• AudioCodes 1610_08 (8-span) 1-8 0-7
• AudioCodes 1610_16 (16-span) 1-16 0-15
TP2810_DS3 (28 spans in 1 DS3)
EAN
ESC N/A

Page 1-12 Part No. 600-0600-002

1U SBC N/A
(PDSi) • SBC PMC 1-8 0-7
1-8 0-7
• SBC PIM
I/O Card
• AudioCodes 1610_02 (2-span) 1-2 0-1
• AudioCodes 1610_04 (4-span) 1-4 0-3
• AudioCodes 1610_08 (8-span) 1-8 0-7
• AudioCodes 1610_16 (16-span) 1-16 0-15
TP2810_DS3 (28 spans in 1 DS3)
1.9 Resource Types

Action verbs, such as Enter, Modify, Remove, Show, AddTo, and RemoveFrom,
indicate the resource type that the system performs. This can be a physical
resource, such as an I/OCard, Span, or Endpoint or a logical resource, such as a
RouteList, Endpoint Pool, or Pattern Set.
The objectId is a string that for physical resources indicates the physical location
and/or type of resource and for logical resources indicates the numeric ID and/or
the logical name of the resource. The syntax of a physical resource ID is as follows:
Command Prompt> <type>-<shelf>
or
Command Prompt> <type>-<shelf>-<slot>
or
Command Prompt> <type>-<shelf>-<slot>-<instance>
or
Command Prompt> <type>-<shelf>-<slot>-<facility>-<instance>
The presence of each field in a physical resource ID is dependent on the

ResourceType specified in the command. For example, if a command is targeted
towards a shelf resource, the type field is not necessary:
Command Prompt> Enter-Shelf <shelf id>

Part No. 600-0600-002 Page 1-13
However, if the command is targeted towards a set of resources that can be of

different types, the resource type is in the name of the command in order to
differentiate it. For instance:
Command Prompt> Modify-CAS-EndpointPool /id=<CAS endpoint pool id>

/<parameter>=<value>
Not all physical resource IDs require every physical location to be specified.
Shelves require only that the parameter <shelf> be specified, whereas card
resources require both <shelf> and <slot> to be specified. TDM endpoints
(channels) require <shelf>-<slot>-<facility>-<instance> to be specified.
Logical resources, such as endpoint pools and route lists, are not tied to any
physical location and as such have different resourceId syntax. They may be
specified either with a numeric-only, a numeric-named or as a named-only syntax.
The logical resource number, if used, always comes first, followed by a dash, if
name is present, followed by the resource name. The following are all valid logical
resource identifiers:
Command Prompt> Enter-<resource> 5
Command Prompt> Enter-<resource> 5-MyLogicalResource
Command Prompt> Enter-<resource> 5-”My Logical Resource”
Command Prompt> Enter-<resource> My Logical Resource
If a logical resource number is specified, the resource may be referred to by number

only as the following example illustrates:
Command Prompt> Enter-CAS-EndpointPool 1-MyCASPool /parm=value
Command Prompt> Modify-CAS-EndpointPool 1 /parm=value
The following, however, does not work, because a numeric value has been
specified in the creation of the pool:
Command Prompt> Modify-CAS-EndpointPool MyCASPool /parm=value
If the endpoint pool had been specified with only a name and not a number, the
above command would work.
Command Prompt> Enter-CAS-EndpointPool MyCASPool /parm=value
The exact syntax options and parameters for all CLI commands can be determined
through the online help or through the HTML-based CLI help files that accompany
this document set.

Page 1-14 Part No. 600-0600-002
1.10 User Accounts

When you install your switch, the system automatically creates the two user
accounts shown in the following table. Carrius recommends that the system
administrator eclipse these users with new user accounts. To eclipse these built-in
users, you can simply enter new users of the same name by executing the
Enter-User command.
Account Name Password Permission

guest null DEBUG
admin PA$$W0RD (The 0 in Pa$$W0RD is the ADMINISTRATOR
numeric character ‘zero’ and not the alpha
character ‘oh’)
Table 1-5 System Accounts
1.10.1 User ID and Password Conventions

Refer to the following conventions:
• User ID (Required) – User IDs must be less than 20 characters in length. User
IDs can contain alphanumeric characters (a-z, A-Z, or 0-9) and special
characters (e.g., *&^%). It is required that the user ID be placed in quotation
marks ("") when using non-alphanumeric characters. User IDs are case
sensitive.
• Permissions (Access Levels) - A blank Permissions field indicates that the
User has no access to the system.
• Passwords (Required) – Passwords can contain alphanumeric characters (a-z,
A-Z, or 0-9) and special characters (e.g. *&^%). Surround the password with
quotation marks ("") when using non-alphanumeric characters. Passwords are
case sensitive. If you do not provision a password when creating the user, the
system will prompt for one.
The following is an example of a system with an Administrator and two users with
access to ALL system commands.
Command Prompt> Show-User
ID PERMISSIONS
---------------------- -----------------------
* guest MONITOR
admin ADMINISTRATOR
ted ADMINISTRATOR

Part No. 600-0600-002 Page 1-15
Add a User Account

All users can access shared accounts to operate and manage the node from the
CLI. If you prefer, you can create additional accounts.
Remove a User Account

You can delete a system profile for a person or account that has access to the
system.
Modify a User Account

You can modify login profiles for persons or accounts that access the system. You
can also use this command to reset a user password.
Refer to the following DLP to add, modify, or delete a login profile.
Add, Modify, or Delete Login Profiles
DLP
1.10.2 Security Levels

Access levels determine the CLI commands that the user will be able to execute. A
list of access levels and their meaning can be found in Appendix A CLI/User Access
Levels. The following access levels are available to each user.
• MONITOR
• MAINTENANCE
• ADMINISTRATOR
• DEBUG

Page 1-16 Part No. 600-0600-002
C H A P T E R 2
Operations, Administration, Maintenance,
and Provisioning
2.1 Introduction
This chapter describes the Operations, Administration, Maintenance, and
Provisioning (OAM&P) of the Compleat-200 system platforms.
All maintenance requests are available through the Command Line Interface
(CLI) on the System Manager Shell Application and to the application through
the Compleat-200 API. Refer to the Liberator API Programmer’s Guide for
details.
2.2 Device State Management

A device represents a physical component that is under the control of the
Compleat-200 system. Users can control and/or configure the following resources
on the Compleat-200 system:
• Shelf
• Card (CMM, IO, SBC, Switch, TVP)
• Span (DS1)
• Channel (DS0)
Devices conform to a containment hierarchy that is used to determine the service
state of the resource. This arrangement is as follows: shelves contain cards; cards
contain spans and DSP channels, spans contain channels (or endpoints).

Part No. 600-0600-002 Page 2-1
Chapter 2 Operations, Administration, Maintenance, and Provisioning
The following figure shows the device containment hierarchy.
Figure 2-1 Device Containment Hierarchy
2.2.1 Provisioning Devices

The following figure shows the device provisioning hierarchy for the different
devices that the Compleat-200 system supports.
Figure 2-2 Device Provisioning Hierarchy

Page 2-2 Part No. 600-0600-002
2.2.2 Remove and Restore

The Compleat-200 system allows administrative state control over certain devices
in the system. The devices containment hierarchy determines the service state of
the resource. System administrators may remove devices from service (“Locked”)
and restore devices to service (“Unlocked”). If a containment device is removed
from service, all subordinate devices are also removed from service.
For example, changing the administrative state of a span to “Locked” results in all
of its contained channels to assume the same state. Likewise, changing the
administrative state of a card will cause all of the spans and DSP resources to
acquire the same state. Any device administrative state change will result in the
system generating an event notification report. A device must be locked prior to any
reconfiguration or manual testing.
The “Lock” command will terminate any call processing on the affected device. All
calls will be aborted for any Endpoints associated with the affected device. An
alternative to the "Lock" command is to issue "ShutDown" which will block
origination attempts and automatically lock the device when all existing calls on the
resource have ceased.
Refer to the HTML-based CLI documentation for the full range of Lock and Unlock
commands the Compleat-200 system supports to change the service state of
devices.
If the device ID supplied in the request is not a valid shelf, card, span, or endpoint,
the system will display an appropriate error response.
Assume the following configuration for the examples cited in the following sections.
Command Prompt> Enter-Shelf /id=1 /type= ZT5085
Command Prompt> Show-Shelf /id=1 /verbose
ID TYPE RESERVED H110 ADMIN STATE

------- ---------------- --------------- ------------------
SHELF-1 SHELFTYPE-ZT5085 0-2047 LOCKED
Fields:
id.............................. SHELF-1
reservedH110.................... 0-2047
type............................ SHELFTYPE-ZT5085
Attributes:
Admin state..................... LOCKED

Part No. 600-0600-002 Page 2-3
Command Prompt> Show-Card
Admin
Card Identification Card Type State IP address
------------------- -------------- -------- ----------------
SBC_CARD-1-4 ZT5504 LOCKED 0.0.0.0
IO_CARD-1-1 AC_TP1610 LOCKED 192.201.1.1
CHASSIS_MONITOR-1-3-0 ZT7102 LOCKED 0.0.0.0
ETH_SWITCH_CARD-1-2 ZX4500P LOCKED 0.0.0.0
View the automatically created spans (created when the IO card was provisioned).
Command Prompt> Show-Span T1DS1-1-1-0
SpanID Framing Encoding Loopmode LineBuildOut Admin-State

------ ------ ------ -------- ----------- ---------
T1DS1-1-1-0 ESF B8ZS OFF LBO_0_133FT UNLOCKED
View an individual DS0.
Command Prompt> Show-Chan T1DS0-1-1-0-0
ChannelID Endpoint Pool Signaling Admin-State

---------- ---------------- ------------- ---------------
T1DS0-1-1-0-0 NOT ASSIGNED UNKNOWN LOCKED
In the above scenario, a shelf was created with four card types; an SBC, a CMM, a
Switch card and an IO card. The shelf and associated cards are in a locked state.
After entering an IO card, the spans and channels for that card are also created and
placed in a locked state.
The last example shows the IO card’s administrative state for the first span (span
0) and channel (channel 0).
The following sections provide examples of the effect a device's administrative
state can have on itself and the subordinate devices.

Page 2-4 Part No. 600-0600-002
Unlock a Superior Device with a Subordinate Device Locked

Command Prompt> Unlock-Shelf 1
The Shelf DALLAS is unlocked and the cards, spans or channels that reside on that
shelf are locked.
Command Prompt> Show-Card
ADMIN
ID CARD TYPE STATE IP ADDRESS(ES)
------------- ------------ ------------ ----------------
SBC_CARD-1-4 ZT5504 LOCKED 0.0.0.0
IO_CARD-1-1 AC_TP1610 LOCKED 192.201.1.1
CMM-1-3-0 ZT7102 LOCKED 0.0.0.0
ETHSW-1-2 ZX4500P LOCKED 0.0.0.0
Command Prompt> Show-Span /id=T1DS1-1-1-0
ID FRAMING ENCODING MODE LINEBUILDOUT CLOCKMODE ADMIN-STATE

---- ------- -------- ---- ------------ --------- ----------
T1DS1-12-1-0 ESF B8ZS OFF LBO_0_133FT GENERATED LOCKED
Unlock a Subordinate Device when a Superior Device is Locked

When a contained device is unlocked, its state remains locked until all of its
containing devices are in the unlocked state.
With the DALLAS shelf still locked, the command to unlock IO_CARD 1-1 is
entered.
The Show-Card command reveals that the card remains in the locked state
because its parent is in the locked state. The spans and channels for that card are
also locked.
Command Prompt> Show-Card /id=IOCARD-1-1
ADMIN
---------- --------- ------- --------------
IOCARD-1-1 AC_TP1610 LOCKED 192.201.1.1

Part No. 600-0600-002 Page 2-5
Unlock a Subordinate Device when a Superior Device is

Unlocked
When a contained device is unlocked and all of its containing devices are unlocked
then its administrative state transitions to unlocked.
The show Card command reveals that the card is now in the unlocked state.
Command Prompt> Show-Card /id=IOCARD-1-1
ADMIN
---------- --------- ------- ---------------
IOCARD-1-1 AC_TP1610 UNLOCKED 192.201.1.1
Lock a Subordinate Device with a Superior Device Unlocked

When a container device is locked all of its containing devices will also be marked
locked.
In each of the following examples the shelf, the IO Card, the first span of the IO
Card and the first channel of the first span are all unlocked.
Command Prompt> Unlock-Card IO_CARD-1-1
Command Prompt> Unlock-Span T1DS1-1-1-0
Command Prompt> Unlock-Chan T1DS0-1-1-0-0
Example 1:
With shelf, card, span and channel unlocked the shelf is locked.
This will lock IO_CARD-1-1, span T1DS1-1-1-0 and channel T1DS0-1-1-0.
Example 2:
With shelf, card, span and channel unlocked when the card is locked.
This will lock span T1DS1-1-1-0 and channel T1DS0-1-1-0.
The shelf remains unlocked.
Example 3:
With shelf, card, span and channel unlocked when the span is locked.
This will lock channel T1DS0-1-1-0.
The shelf and card remain unlocked.

Page 2-6 Part No. 600-0600-002
Example 4:
With shelf, card, span and channel unlocked when the channel is locked.
The shelf, card and span remain unlocked.
Unlock a Superior Device with a Subordinate Device Unlocked

When a container device is locked, all of its contained devices are also locked.
When a container is unlocked all of its contained devices will assume the state they
had prior to the container being locked.
Example 1:
With shelf, card, span and channel locked, a command is issued to unlock a card.
Command Prompt> Unlock-Card IO_CARD-1-1
This command is intended to unlock card IO_CARD-1-1. However, the card

remains locked because it’s containing device, Shelf 1 (DALLAS), is still locked.
Next, unlock shelf 1 (DALLAS). Because you previously unlocked the card, both the
shelf and card are unlocked.
Example 2:
With shelf, card, span and channel locked, a command is issued to unlock a span
and channel.
Command Prompt> Unlock-Span T1DS1-1-1-0
Command Prompt> Unlock-Chan T1DS0-1-1-0-0
These commands are intended to unlock span T1DS1-1-1-0 and channel

T1DS0-1-1-0. However, since their containing device, IO_CARD-1-1, is still locked
both span and channel remain locked.
Next, unlock the IO card. The span and channels are still locked. The card
(IOCARD-1-1) is marked as being locked because the containing device is locked.
Finally, unlock Shelf 1 (DALLAS). Now all containing devices for the shelf are
unlocked.
Lock a Superior Device with a Subordinate Device Locked

When a container device is locked all contained devices that were locked at the time
will remain locked.

Part No. 600-0600-002 Page 2-7
2.2.3 Graceful Removal of a Device

Graceful removal of a device from service is accomplished by issuing a “Shutdown”
request. The device being shut down will complete any current calls, but will not
accept any new requests for service. When all subordinate devices for the affected
device have been returned to an operational state, the affected device will
automatically transition to the “Locked” administrative state and an event
notification will be issued. Due to this behavior, the request complete response for
this request indicates that the request has been received, and not that the device
in question has transitioned to the out-of-service state.
2.2.4 Device Provisioning

All provisioning functions are on-line configurable, such that the platform does not
need to be stopped and restarted in order to change a resource parameter. Affected
devices, if any, must be removed from service or locked prior to reconfiguration. If
a device is not locked, the provisioning request will fail. Once reconfigured, devices
can be manually restored to service by unlocking the device.
Provisioning requests can be divided into two groups; those that can be performed
on a hardware device, and those that are used to configure a database.
2.2.5 Shelf
The Compleat-200 system only supports certain shelf model numbers that have
been pre-provisioned into the platform database. The model number provides the
configuration subsystem with information about the number of card slots in the
chassis, the number of fan trays, power supplies, Chassis Management Module
(CMM) cards, redundancy models and other shelf related information.
Multiple shelves are supported by provisioning a single shelf to have an SBC host
the System Manager, Call Manager and IO Manager. The additional shelves are
provisioned solely with IO cards. Interconnectivity is provided by the IP network.
Create a Switch
Execute the Enter-Switch command to add a new switch configuration:
Command Prompt> Enter-Switch [/id=]<a switch ID> [/alarmFloodThreshold=<integer>]
For additional information/parameters, consult the HTML-based CLI documentation

or issue the following CLI command on a running system or simulator:
Command Prompt> Help Enter-Switch

Page 2-8 Part No. 600-0600-002
Create a Shelf
Execute the Enter-Shelf command to create a hardware shelf.
Assumptions
Creating a shelf requires that you have logged into the System Manager and have
the appropriate privileges. Refer to the following DLP to configure a shelf.
Add a Shelf
DLP
Remove Shelf
Execute the Remove-Shelf command to delete a hardware shelf.
Deprovision all cards before executing this command. This is the last step in a
complete deprovisioning of the system.
CAUTION
Refer to the following DLP to remove a shelf.
Remove a Shelf
DLP
2.2.6 Slot
The slots on the shelves can be provisioned to have the power on the boards that
go into the slots disabled. Given the Shelf ID and Slot Number (1st and 2nd
arguments) the API would either turn ON, turn OFF or RESET (depending on the
value selected) power on a board (as specified by the Shelf and Slot).
Chassis Model:
• MXP_3000: 1-18, 26, 27 (26=S1 and 27=S2 as displayed on chassis)
• ZT_508x: 2-21
• ZT_509x: 1-8
• PDSI_4U: 1-8
Enter the following command to set the slot power:
Command Prompt> Set-Slot-Power /Shelf=<a shelf ID> /SlotNum=<Slot Number>

/state=<Power State>

Part No. 600-0600-002 Page 2-9
2.2.7 System Cards

The Compleat-200 system supports a specific set of cards that have been
pre-provisioned into the platform database. The user must configure the cards
using provisioning requests prior to them being used by the platform. Once a card
is added to the system, the Compleat-200 system automatically determines and
configures the correct number of circuit-based facilities, simultaneous packet call
capacity, and/or the number and type of DSP resources available by knowing the
part number of the installed card.
Refer to the Compleat-200 Technical Specification for details on supported card
types. On a running system, execute the CLI command Show-CardType to see
exactly what has been provisioned for your system.
Provision a Card
An Enter-<card> command exists for each available card type.
With the exception of the CMM card, the administrative state of provisioned cards
is set to “LOCKED”.
Refer to the following DLPs to provision system cards.
Provision a Chassis Management Module
DLP
Provision an I/O Card (for bearer traffic)
DLP
Provision an I/O Card (for SS7/C7 functionality)
DLP
Provision a Single-Board Computer Card
DLP
Provision an Ethernet Switch Card
DLP

Page 2-10 Part No. 600-0600-002
2.2.8 Spans
Because the number of spans and type are automatically configured whenever an
I/O card is added to the system, spans cannot be created or deleted by the user or
through the application. However, there are several span characteristics that can
be modified.
Command Prompt> Help Modify-[E1Span|T1Span|DS3]
2.2.9 Channels (TDM Channels)

The manner in which A-B-C-D bit patterns are interpreted for TDM endpoints with
a robbed-bit signaling mode may be configured.
Use the Modify-Chan command to change the robbed-bit signaling mode and
signaling type channel flag.
Command Prompt> Help Modify-Chan
2.2.10 Clocking
Clocking at the shelf level is configured using the Modify-Shelf-Clock CLI
command. Redundant or non-redundant clocking can be from a source INTERNAL
to a card on the shelf, from NETWORK spans on the shelf or derived from the
incoming bit stream (AUTOLOOP). For redundancy, the clocking source must be
from two different cards.
Clocking for a shelf can be derived from a specified NETWORK DS1 span or the
INTERNAL oscillator of a card on the shelf. For redundancy, a second reference
can be specified of the same type (NETWORK or INTERNAL) using a different card
on the shelf.
Internal oscillators are not synchronized between boards so a switch-over may not
be transparent when using INTERNAL clocking. It is therefore recommended that
NETWORK clocking be used whenever possible.
AUTOLOOP clocking is available for small chassis configurations and is typically
used in a multi-shelf system. In this mode of operation there is no shelf level clock
synchronization (the H.110 bus is not used). Each module of an I/O card is clocked
independently from its first available network span. If that span fails, the module
selects its next available network span. If a connection is required from one I/O
module on the shelf to another, it is made using a VoIP connection over the local
IP network.

Part No. 600-0600-002 Page 2-11
Configure Shelf Clocking
DLP
T1/E1 Clocking
The system automatically establishes clocking at the DS1 level based upon the
shelf level clock configuration. All non-reference spans are configured as Generate
while spans used as clock references are configured as Recovered.
T3 Clocking
Clocking at the T3 level can be configured using the Modify-DS3 CLI command. The
T3 level clocking can be recovered from the far-end or generated to the far-end by
setting the ClockMode option to RECOVERED or GENERATED respectively.
Additionally, T3 level framing can be set to either M13 or CBIT by way of the framing
option.
Command Prompt> Help Modify-DS3
2.3 Distributed Multiple-Chassis System

The Compleat-200 system supports a distributed multiple chassis environment with
a single instance of Liberator System Manager and Call Manager. Liberator
operates in either a redundant or simplex mode. A maximum of 8 chassis and at
least 16 I/O cards are supported as a single Compleat-200 system. The 16 I/O
cards can be distributed across the 1 to 8 chassis. Chassis may include any
combination of the supported chassis including 12RU, 4RU, and 1RU. Supported
I/O cards may include any supported I/O card in the current software release.
Additional chassis in a distributed multiple-chassis system can be configured as
either collocated in a single rack (or close proximity) or across an IP-based wide
area network (WAN).
System performance and capacity will not be adversely impacted in a distributed
multiple-chassis configuration.

Page 2-12 Part No. 600-0600-002
The system supports distributed chassis behind NAT/firewalls.
Figure 2-3 Multi-Shelf Distribution (Basic Configuration)
2.3.1 Distributed Networks

The Compleat-200 system looks like a single network element to the VoIP and TDM
networks.
H.323 Network
A multiple chassis distributed Compleat-200 appears to an H.323 network
consisting of gateways, gatekeepers, and endpoints as a single network element
with regard to destination and origination addressing and discovery.
SIP Network
A multiple chassis distributed Compleat-200 appears to a SIP network consisting of
user agents, feature servers, SIP registrars, and endpoints as a single network
element with regard to destination and origination addressing and discovery.
SS7 Network
A multiple chassis distributed Compleat-200 appears to a SS7 network consisting
of SSP, SCPs, and STPs as a single network element with regard to destination and
origination addressing.

Part No. 600-0600-002 Page 2-13
2.3.2 Liberator in a Distributed Multiple-Chassis System

Embedded Liberator can be configured in any chassis of a distributed
multiple-chassis system. Liberator is configurable to operate on an embedded SBC
(simplex) or SBCs (redundant) or to host on an external server (simplex) or servers
(redundant). In all cases, the system executes on the Carrius Linux operating
system.
If either SBC hosting embedded Liberator is in a chassis with integrated Ethernet
Switch cards, both SBCs must be configured in the same chassis. SBCs hosting
embedded Liberator in a chassis without integrated Ethernet Switch cards must be
on the same IP sub-net.
2.3.3 Inter-Chassis Communication Paths

The inter-chassis voice paths are based on VoIP RTP.
The inter-chassis command and control communication paths are based on IP.
The inter-chassis voice and command and control communication paths support
redundant Ethernet paths for fault tolerance and high reliability.
The inter-chassis RTP voice path parameters are configurable on a system-wide
basis. These parameters include vocoding algorithm, RTP header compression,
packetization interval, echo cancellation, and silence suppression. The
inter-chassis RTP voice path parameters are G.711, 10 ms. packetization interval,
no echo cancellation, no silence suppression.
2.3.4 Distribution of B and D-channels of PRI NFAS Group

The distributed Compleat-200 supports B-channels of a PRI NFAS group across
multiple chassis within the same distributed system.
The distributed Compleat-200 supports configuration of D-channel pairs of a PRI
NFAS group across different chassis.
2.3.5 I/O Card Clock Timing

Chassis with an H.110 bus supports all existing clocking options.
• Internal - Timing generated from on-board local oscillator (Stratum 4E)
• Network - Timing generated from an external clocking source (DS1)
• Autoloop - Timing recovered from spans
It is possible to provision loop or local timing on cards in a chassis with an H.110
bus.It is also permissible to restrict the timing choices for that chassis to either all
Loop/Local or H.110 bus clocking. If all cards are provisioned as local/loop then the
H.110 bus cannot be used for TDM transport.

Page 2-14 Part No. 600-0600-002
2.3.6 Provisioning a Multi-Shelf System

Refer to the following DLP for adding a shelf to an existing system:
Provision a Multi-Shelf Configuration
DLP
2.4 Call Routing

The most basic element in the Compleat-200 system database is the Endpoint. An
Endpoint is a logical abstraction for an ingress or egress point in the system.
Endpoints may have a fixed identity, as in the case of the circuit-oriented endpoints,
where the slot, span, and channel number remain the same.
Other endpoints may only exist for the duration of a particular call, as in the case of
most packet-based endpoints. They do not necessarily correspond to a hard-wired
physical facility, but instead have a different logical address from one call to the
next.
Packet-based endpoints are an example of these dynamic endpoints because they
can be reused on a call-by-call basis to communicate with different called parties.
Packet endpoints, like their circuit-based counterparts, may be associated to a fixed
address or a set of fixed addresses; however, this association is always made
dynamically by using an EndpointPool.
Refer to the following DLP to provision call routing.
Call Routing
DLP
2.4.1 Virtual Endpoints

Virtual endpoints are an internal mechanism utilized for Voice Over IP (VoIP) calls.
Depending upon where the call leg terminates the virtual endpoint may not reside
on the switch. A virtual endpoint pool is used for each leg of a VoIP call. Calls being
converted from TDM to VoIP on the Compleat-200 system would use a single virtual
endpoint. The software license key associated with the system controls the number
of virtual endpoints.
VoIP Endpoint identities are allocated 14 bits yielding a maximum quantity of
16,384 endpoints (2^14). Although users can provision 16K endpoints, the
Compleat-200 system supports 10,000 calls per system. Therefore, in the case of
VoIP-VoIP traffic, the Compleat-200 system would support approximately eight
thousand (8,000) simultaneous two-way calls. (In the case of TDM-VoIP, the
maximum case would be 10,000 simultaneous two-way calls.)

Part No. 600-0600-002 Page 2-15
The EndpointPool allows the user to specify a set of similar endpoints that will be
used for routing purposes. Endpoint pools allow for greater control and network
reliability by offering multiple connection points. This helps eliminate exposure to
endpoint single point of failure.
Aside from grouping a set of endpoints for routing purposes, all members of an
EndpointPool share the same signaling characteristics. Consequently,
circuit-based and packet-based Endpoints cannot be members of the same
EndpointPool. Likewise, CAS circuit-based endpoints and ISDN PRI circuit-based
endpoints cannot be in the same EndpointPool.
The number of simultaneous calls supported by a particular I/O card determines the
maximum number of endpoints that can be put into an endpoint pool for that card.
A card’s endpoints can also be placed into different endpoint pools. However, the
same endpoint may not be a member of more than a single endpoint pool. This is
done to guarantee a predefined level of service for a given customer. Endpoints
from different slots can be combined into the same endpoint pool as well.
2.4.2 Creating Endpoint Pools

Endpoint pools are collections of endpoints. Endpoints can be added individually or
as a span.
Endpoint pools are created using the appropriate version of the Enter-<signaling
method>-EndpointPool command. All endpoint pools are named using a variable
length ASCII string.
In cases where multiple dialing schemes such as 7 digit and 10 digit dialing are
expected on the same CAS endpoint pool careful consideration must be given to
timer interaction with the provisioned digit patterns. The digit pattern parameter
"delay" (the time-out for a full sequence of digits to be dialed) must be less than the
CAS endpoint pool parameter "interDigitTimeout".
The basic types of endpoint pools can be specified using the following commands:
Command Prompt> Enter-PRI-EndpointPool
Command Prompt> Enter-CAS-EndpointPool
Command Prompt> Enter-ISUP-EndpointPool
Command Prompt> Enter-CC-EndpointPool

Command Prompt> Help Enter-[PRI|CAS|ISUP|CC]-EndPointPool

Page 2-16 Part No. 600-0600-002
2.4.3 Modifying Endpoint Pools

A Modify-EndpointPool command is supplied to provision characteristics common
to all endpoint pools such as certain timing parameters, disconnect treatments or
routing algorithms for the endpoint pool. When using the Modify command, it is
important to specify the endpoint pool type when specifying the particular endpoint
pool that is to be modified.
Command Prompt> Modify-EndpointPool /id=<unique endpoint ID> /name=<name>

/glare=[RELEASE|CONTROLLING] /treatment=[PERMANENT|
TIMED]/algorithm=[FIRST_AVAILABLE|ROUND_ROBIN)
A detailed description on the routing algorithms used for endpoints in an

EndpointPool can be found in Section 2.7, ‘Routing Algorithms’.
Special-purpose modify commands for each endpoint pool signaling type are also
provided which allow signaling-specific parameters to be modified.
Additional information about the use of the PRI and CAS EndpointPool commands
can be found in Section 2.14.1, ‘Primary Rate Interface (PRI)’ and Section 2.15,
‘Channel Associated Signaling (CAS)’.
Command Prompt> Help Modify-EndPointPool
2.4.4 Deleting an Endpoint Pool

Endpoint pools are deleted using versions of the Remove-<signaling
method>-EndpointPool command. In order to delete an endpoint pool, it must be
empty. Previously added spans can be removed from the endpoint pool using the
RemoveFrom-EndpointPool command.
Endpoint pools can be deleted using the following commands:
Command Prompt> Remove-PRI-EndPointPool
Command Prompt> Remove -CAS-EndpointPool
Command Prompt> Remove -ISUP-EndpointPool
Command Prompt> Remove -CC-EndpointPool

Command Prompt> Help Remove-[PRI|CAS|ISUP|CC]-EndPointPool

Part No. 600-0600-002 Page 2-17
2.4.5 Adding Spans to an EndPoint Pool

Spans are added to endpoint pools are using versions of the AddTo-<signaling
method>-EndpointPool command. In order to add a span to an endpoint pool the
span must be Locked using the Lock-Device command. All endpoint pools are
named using a variable length ASCII string.
To add spans to an endpoint pool, enter the following commands:
Command Prompt> AddTo-PRI-EndpointPool
Command Prompt> AddTo-CAS-EndpointPool
Command Prompt> AddTo-ISUP-EndpointPool
Command Prompt> AddTo-CC-EndpointPool

Command Prompt> Help AddTo-[PRI|CAS|ISUP|CC]-EndPointPool
2.4.6 Removing Spans from an EndPoint Pool

Spans are removed from existing endpoint pools by using versions of the
RemoveFrom<signaling method>-EndpointPool command. In order to remove a
span from an endpoint pool the span must be Locked using the Lock-Device
command. Endpoint pools can be specified by entering the following commands:
Command Prompt> RemoveFrom-PRI-EndpointPool
Command Prompt> RemoveFrom-CAS-EndpointPool
Command Prompt> RemoveFrom-ISUP-EndpointPool
Command Prompt> RemoveFrom-CC-EndpointPool
Examples on usage and the available parameters can be found in the online help
or the HTML-based CLI documentation.
2.5 Route Lists

Route lists are collections of endpoints, endpoint pools, or VOIP (SIP and H.323)
elements. Route lists are used to determine an outbound path from the switch,
based on a variety of inbound signaling parameters selected by the operator. Route
lists are searched either by using a “first available” algorithm, which always starts
from the first element in the list, or by using a “round robin” algorithm, which picks
up where the previous routing function left off.

Page 2-18 Part No. 600-0600-002
Route Lists can consist of any number of endpoint pools, each having different
signaling characteristics. If a set of endpoint pools is specified, these pools may be
selected from the Route List using either First Available or Round Robin algorithms.
First Available endpoint pool selection is used to specify alternative endpoint pools
to be used when a preferred endpoint pool is unavailable. Round Robin endpoint
pool selection allows for an even distribution of calls over a set of endpoint pools.
Additionally, individual DS0 circuits can be inserted into a Route List in addition to
VOIP (H.323 or SIP) elements.
Route Lists are arranged in the Route Table and are selected using the digits
stream of a fully qualified E.164 number, or in the case of H.323 and SIP the
appropriate URI.
In summary, there is a containment hierarchy used for call routing. This
arrangement is as follows:
• Endpoints are individual channels on spans
• Endpoint Pools contain Endpoints
• Route Lists can contain:
– VOIP elements
– Endpoint Pools
– Individual Endpoints (Channels)
• The Route Table is a collection of Route Lists.
The following figure shows the call routing containment hierarchy
Figure 2-4 Call Routing Hierarchy

Part No. 600-0600-002 Page 2-19
2.5.1 Create a Route List

Route Lists are created using the Enter-RouteList command. All route lists IDs
consist of a number and /or a variable length ASCII string.
2.5.2 Modify a Route List

Route Lists are modified using the Modify-RouteList, AddTo-RouteList, and
RemoveFrom-RouteList commands. Use Add-To and Remove-From to add or
remove elements to or from the route list. Elements are added to the end of the list
in the order that they are provisioned from the command line.
2.5.3 Delete a Route List

Route Lists are deleted using the Remove-RouteList command. Deleting a route list
does not delete the elements contained within the route list. In fact, the same
endpoint pool or endpoint can be in multiple route lists simultaneously.
2.6 Route Tables

The Compleat-200 system uses route tables to select the appropriate signaling
path for each message, or signal unit, that it must forward.
2.6.1 Create a Route Table

A route table is created using the Enter-RouteTable command. Carrius has tested
the Compleat-200 system to support the provisioning of up to ten route tables,
although additional tables can be added, if necessary. A route table with the name
"DEFAULT" is pre-provisioned on the system. A different route table may be
associated with each inbound signaling group, if so desired; however, the
DEFAULT route table is used in most situations.
2.6.2 Delete a Route Table

You can delete a route table using the Remove-RouteTable command. The name
is used to identify which route table should be deleted. Deleting a route table does
not delete the elements contained within the route table. The default route table
(DEFAULT) cannot be removed.

Page 2-20 Part No. 600-0600-002
2.6.3 Modify a Route Table

Route lists are added to a route table by using the AddTo-RouteTable command.
When configuring an E.164 address the specified number of digits (numDigits) is
the fully qualified E.164 address for which the specified route list is valid, and the
digit prefix for which to use the specified route list. The digit prefix may be a fully
qualified E.164 address if so desired.
When configuring a VOIP resource the address is the fully qualified URI for which
the specified route list is valid.
E.164 route lists will always be selected using the most significant number of digits
possible. The following example will help to illustrate this.
Assume that only the following route lists are configured for a 10-digit dialing plan
and that 10 digits have been collected.
Command Prompt> AddTo-RouteTable /routeList=rl-1 /numDigits=10, /prefix=972
In this example, since a specific route table was not referenced, the default is used.
A called party address of “9725551212” will use route list “rl-1” for endpoint
selection, whereas a called party address of “9728441200” will use route list “rl-2”
for endpoint selection. Only the called party address ”9728441212” will cause route
list “rl-3” to be used. If less than 10 digits or more than 10 digits are collected, the
routing will fail.
The same route list may be inserted into the route table in multiple locations, using
different prefixes and a different number of digits in the dialing plan. Only one route
list can be specified for a given digit length / prefix combination. For this reason,
both the number of digits and the prefix must be specified when removing a route
list from the route table. Use the RemoveFrom command for this purpose. The
following command will remove the route list “rl-1” in the previous example from the
route table.
Command Prompt> RemoveFrom-RouteTable /numDigits=10, /prefix=972
The name of the route list need not be specified since only one route list can
be inserted for the given digit length/prefix combination.
Prior to deleting a route list, all references to it in the route table must first be
manually deleted.

Part No. 600-0600-002 Page 2-21
2.7 Routing Algorithms

There are 10 basic combinations that can be applied to a given route list based
upon the previous discussion of the different routing configuration options. Route
lists can be specified where the preference is given to endpoints on the originating
shelf or not. If the originating shelf is not preferred, a master shelf is specified to
perform the routing function for the route list. Additionally, endpoint pools can be
selected from the route list in either a Round-Robin or First Available fashion. Also,
the endpoints within the endpoint pool itself can be selected using either
Round-Robin or First Available. Lastly, all of the endpoints in all of the endpoint
pools in a route list can be selected using either a Least Recently Used or Least
Active algorithm. In order to use this last option, you must specify a master shelf.
The following table shows the 10 different combinations.
Shelf Preference Route List Algorithm Endpoint Pool Algorithm

(for pools in the Route (for Endpoints in the
List) pool)
Originator First Available First Available
Originator First Available Round-Robin
Originator Round-Robin First Available
Originator Round-Robin Round-Robin
Master Shelf First Available First Available
Master Shelf First Available Round-Robin
Master Shelf Round-Robin First Available
Master Shelf Round-Robin Round-Robin
Master Shelf Least Recently Used N/A
Master Shelf Least Active N/A
Table 2-1 Route List Algorithms
Each of these combinations will produce different results based upon the same
endpoint/endpoint pool/route list configuration. The following sections will use
examples to illustrate the different possible routing configurations.
Assume the following configuration for the examples cited below:
Add Shelf 1, Slot 1, First DS1 to this pool
Command Prompt> Enter-CASEndpointPool /id=“CASPool-1-1-1”
Command Prompt> AddTo-CASEndpointPool /id="CASPool-1-1-1" /span=T1DS1-1-1-1

Page 2-22 Part No. 600-0600-002
Add from Shelf 1, Slot 1, Second DS1 to this pool
Add Shelf 2, Slot 1, First DS1 to this pool
Add Shelf 2, Slot 1, Second DS1 to this pool
Add the endpoint pools to a route list in the following order:
Command Prompt> Enter-RouteList /id=XYZ
Command Prompt> AddTo-RouteList /id=XYZ /resource=CASPool-1-1-1

Part No. 600-0600-002 Page 2-23
Figure 2-5 Route Table-Route List-Endpoint Pool Relationship
2.7.1 Originator as Preferred Shelf

The next four sections discuss how the routing algorithms behave when the
endpoints on the originating shelf are preferred over those on other shelves. It will
become apparent how in a multi-shelf system where calls can be presented in
random times from different shelves, the routing behavior is difficult to predict, yet
makes efficient use of telephony resources.
Originator/First Available/First Available

When origMaster is true, routes on the same shelf as the originator are given
preference over routes on a shelf separate from the originator. Only when all routes
on the originating shelf are exhausted will routing to alternate shelves be attempted.
This can result in unpredictable routing assignments depending upon when
originations occur and on which shelves.

Page 2-24 Part No. 600-0600-002
However, this option does minimize the number of VoIP connections and resources
that must be made between shelves. When origMaster is false, routing is always
performed on the shelf specified by the "masterShelf" argument, and route
selection is true to their order in the route list and the algorithm selected. This
method ensures a balanced usage of egress resources.
Command Prompt> Modify-RouteList /id=XYZ /algorithm=FIRST_AVAILABLE
Command Prompt> Modify-CASEndpointPool “CASPool-1-1-1” /algorithm=FIRST_AVAILABLE
The first 24 calls routed using route list XYZ will use circuits from either
CASPool-1-1-1 or CASPool-2-1-1 depending on from which shelf the call
originated. As long as endpoints in CASPool-1-1-1 are available, this is always the
chosen Endpoint Pool for calls originating from shelf 1. Likewise, an endpoint from
CASPool-2-1-1 will always be selected for calls originating on shelf 2 as long as one
is idle. Endpoints are always selected from the endpoint pool on a first available
basis, starting with timeslot 0 and continuing to timeslot 24 (or timeslots 1 to 31, with
0 used for sync in the case of an E1 facility).
Only when all circuits in the first span are actively processing traffic will the second
span be selected. Again, the routing algorithm will give preference to the circuits on
the originating shelf, such that CASPool-1-1-2 is preferred for calls emanating from
Shelf 1 and CASPool-2-1-2 is selected for calls emanating from Shelf 2. When any
endpoint from DS1-1 becomes available on a given shelf, it will be selected the next
time a routing request is received.
Only when all of the endpoints on a particular originating shelf are busy will an
endpoint on the other shelf be selected.

Part No. 600-0600-002 Page 2-25
Figure 2-6 Originator/First Available/First Available
Originator/First Available/Round-Robin
Assume that the following modifications have been made to the example
configuration:
Modify-RouteList /id=XYZ /origMaster=true
Modify-RouteList /id=XYZ /algorithm=FIRST_AVAILABLE
Modify-CASEndpointPool “CASPool-1-1-1” /algorithm=ROUND_ROBIN
This configuration behaves the same as the one in the first example except that the
endpoints are selected from the endpoint pool in a Round-Robin fashion. This
means that when an endpoint is selected as a route, it will not be selected again
until all endpoints in the facility have been selected at least once, even if the
endpoint is idle prior to the next route selection request. The selection algorithm
acting on the endpoint pool continues from where it left off rather than starting from
the beginning of the endpoint pool list, so that when active endpoints become idle,
they must wait their turn to be selected again.
As before, the Route List will select CASPool-1-1-1 or CASPool2-1-1 for endpoint
selection as long as there is an idle endpoint in the one of these pools and
depending upon where the call originated.

Page 2-26 Part No. 600-0600-002
Originator/Round-Robin/First Available
configuration:
Command Prompt> Modify-RouteList /id=XYZ /origMaster=true
Command Prompt> Modify-RouteList /id=XYZ /algorithm=ROUND_ROBIN
Command Prompt> Modify-CASEndpointPool "CASPool-2-1-1” /algorithm=FIRST_AVAILABLE
This time, terminating endpoints for calls originated from shelf 1 will toggle between
CASPool-1-1-1 and CASPool-1-1-2, as long as there are idle endpoints to be found
in each of those endpoint pools. Likewise, terminating endpoints for calls
originated from shelf 2 will toggle between CASPool-2-1-1 and CASPool-2-1-2.
Within the endpoint pool itself, endpoints are checked for availability starting at
circuit 0, and proceeding to the last circuit in the facility.
Figure 2-7 Originator/Round Robin/First Available

Part No. 600-0600-002 Page 2-27
Originator/Round-Robin/Round-Robin
configuration:
Command Prompt> Modify-RouteList /id=XYZ /origMaster=true
Command Prompt> Modify-CASEndpointPool “CASPool-1-1-1” /algorithm=ROUND_ROBIN
This configuration behaves similarly to the one described in Figure 2-7 except that
circuits are selected from within the endpoint pool itself in a round robin fashion.
Figure 2-8 Originator/Round Robin/Round Robin

Page 2-28 Part No. 600-0600-002
2.7.2 Master Routing Shelf

The next four sections discuss how the routing algorithms behave when a shelf is
selected to be the routing master for a particular route list. Using a master routing
shelf, the same endpoint will be selected for a given call origination, regardless of
from which shelf the call originates. It is important to note that if the shelf designated
as the master shelf is unreachable, the originating shelf will override this setting and
perform the routing algorithm. This will effectively cause the route list to fall back to
the master=ORIGINATOR mode of operation.
It does not really matter which shelf in the system is selected as the master routing
shelf for a given route list. Routes will be selected correctly regardless of which
shelf is the designated master. From a system engineering perspective, however,
it is more efficient to select the shelf on which the majority of endpoints reside for
the given route list. For example, if all of the endpoints on a route list terminate in
shelf two, then shelf two should be the selected master routing node.
Master/First Available/First Available

configuration:
Command Prompt> Modify-RouteList /id=XYZ /master=1
Command Prompt> Modify-RouteList /id=XYZ /algorithm= FIRST_AVAILABLE
In this configuration, CASPool-1-1-1 will always be selected first, regardless of from

where the call originated, as long as it contains an idle endpoint. When all endpoints
in CASPool-1-1-1 are busy, CASPool-2-1-1 is always selected next, regardless of
where the call originated. The selection algorithm continues in order using
CASPool-1-1-2 and CASPool-2-1-2 when previously selected endpoint pools
contain only busy endpoints.

Part No. 600-0600-002 Page 2-29
Master/First Available/Round-Robin
configuration:
Command Prompt> Modify-RouteList /id=XYZ /algorithm=FIRST_AVAILABLE
This configuration will behave the same as in “Master/First Available/First

Available”, except that the endpoints are selected internally to the endpoint pool in
a Round-Robin fashion. The routing algorithm will occur on shelf 2 as long as it is
reachable from the originating shelf.
Master/Round-Robin/First Available
configuration:
This configuration ensures an even distribution of incoming calls across all four
endpoint pools regardless of which shelf originates the call. Routes will be selected
in round robin fashion starting first from CASPool-1-1-1 and continuing through
CASPool-2-1-2. Internal to the endpoint pool itself, endpoints are selected using a
first available selection algorithm.

Page 2-30 Part No. 600-0600-002
Master/Round-Robin/Round-Robin
configuration:
This configuration behaves similarly to that described in “Master/Round-Robin/First

Available”, except that endpoints are selected from the endpoint pool in a
round-robin fashion.
2.7.3 Hunting Algorithms

Two hunting algorithms are available for configuration on a route list. When either
of these algorithms is configured, all endpoints from every endpoint pool contained
by the route list are treated as if they belong to one big endpoint pool for routing
purposes. The master configuration can not be set to ORIGINATOR for either of
these hunting algorithms. These algorithms utilize usage statistics that are
maintained on each endpoint. These statistics are refreshed by the route list at a
periodic rate that is configurable on the system as a whole, and not on an individual
route list basis.
Least Recently Used

configuration:
Command Prompt> Modify-RouteList /id=XYZ /algorithm=LEAST_RECENTLY_USED
The Least Recently Used algorithm selects an endpoint from a route list that has
been idle for the longest amount of time. The time is calculated starting from the
time that the shelf that controls this endpoint was initialized. Time is accurate to a
one-second granularity. All endpoints in the route list are considered when making
this determination, regardless of their location or signaling type.

Part No. 600-0600-002 Page 2-31
Least Active
configuration:
Command Prompt> Modify-RouteList /id=XYZ /master=2 /algorithm=LEAST_ACTIVE
The Least Active algorithm selects an endpoint from a route list that has had the
least amount of total activity, regardless of when the last call was completed on that
endpoint. All endpoints in the route list are considered when making this
determination, regardless of their location or signaling type.
2.8 Enhanced Call Routing

The Enhanced Call Routing feature provides two capabilities for the Compleat-200
system:
• Route Advancement
• Incoming Translation Routing
2.8.1 Route Advancement

The Route Advancement feature allows call routing to be retried if errors in the
network prevent the call from successful completion. A routing context is returned
to the Call Model on successful route selection. The routing context tracks the state
of the route list selection algorithm for the current route. If a call setup fails due to
network problems, the Call Model re-initiates the routing algorithm based on where
it previously left off. This continues until all routes are exhausted or until a call is
successfully terminated.
This feature allows both TDM and VoIP routes to be intermixed in the same route
list. This allows a carrier to perform least cost routing, whereby a cheaper VoIP
route could be attempted first, followed by the more expensive TDM route if the
VoIP route failed.

Page 2-32 Part No. 600-0600-002
The system advances to the next route choice if a terminator (VoIP or TDM) returns
one of the following cause codes/SIP error responses, regardless of the origination
signaling type:
H.323/PRI 34 = No circuit/channel available

41 = Temporary Failure
42 = Switching Equipment Congestion
44 = Requested circuit/channel unavailable
49 = QOS Unavailable
91 = Invalid transit network selection
SIP SIP - 480 = Temporarily unavailable
SIP - 500 = Internal Server error
SIP - 501 = Not implemented
SIP - 502 = Bad gateway
SIP - 503 = Server unavailable
SIP - 504 = Server timeout
Table 2-2 Cause Codes/SIP Error Response
To select the next route-choice, you must provision the ROUTELIST with at least
two route choices (resources).
2.8.2 Incoming Translation Routing

Incoming Translation Routing allows you to route incoming calls based on signaling
information other than the Called Party Number.
The translation elements that you can use for routing are listed below:
• CIN - Calling Party Address
• CIN_USER - “user” part of Calling Party Address
• CIN_HOST - “host” part of Calling Party Address
• CPN - Called Party Address
• CPN_USER - “user” part of Called Party Address
• CPN_HOST - “host” part of Called Party Address
• CC - Country Code
• OCN - Original Called Party Address
• OCN_USER - “user” part of Original Called Party Address
• OCN_HOST - “host” part of Original Called Party Address
• FROM_URI - From URI
• FROM_URI_HOST - From URI Host
• FROM_URI_USER - From URI User

Part No. 600-0600-002 Page 2-33
• REQ_URI - Requestor URI

• REQ_URI_HOST - Requestor URI Host
• REQ_URI_USER - Requestor URI User
• TO_URI - To URI
• TO_URI_HOST - To URI Host
• TO_URI_USER - To URI User
The routing can also be setup for Directed Routing, meaning all calls coming from
one endpoint can be routed to another. To do this, the following option is used:
• PERM – Permanent
The following five CLI commands are used to provision this feature:
Command Prompt> Enter-TranslationSequence
Command Prompt> AddTo-TranslationSequence
Command Prompt> Show-TranslationSequence
Command Prompt> RemoveFrom-TranslationSequence
Command Prompt> Remove-TranslationSequence
Multiple translation elements can be added to the translation sequence that is

applied to the inbound signaling group. The evaluation of translation elements
within the translation sequence continues until a route list is found. Once a route list
is found that successfully meets the translation element criteria, that route list is
used for all subsequent route selection and route advance algorithms.
Once the translation sequence has been defined, it can be added to an incoming
signaling group (either an endpoint pool or a SIP user agent) using the appropriate
“Modify-” command.
Refer to the following DLP for additional routing information:
Call Routing
DLP

Page 2-34 Part No. 600-0600-002
2.9 Call Transfer

The Compleat-200 system supports the following call transfer types:
• Call transfer over CAS signaling
• Call transfer over ISDN TBCT signaling
• Call transfer using SIP Refer Signaling
• Call transfer using DTMF (*8) signaling on the bearer channel for CAS and PRI
call originations
• SIP to H323 Call Transfer
The Carrius switch acts as the controller of the call transfer, and works in
conjunction with the far-end switch and a Carrius based API program to perform the
call transfer. The following sections describe, at a high level, how the call transfer
feature works with the far-end switch and a Carrius based API program.
2.9.1 Call Transfer over CAS Signaling

In this configuration, the CAS circuit at the far-end switch is a Foreign Exchange
Office (FXO), and the Carrius CAS circuit is a Foreign Exchange Station (FXS).
Circuits can be provisioned as a loop-start or ground start circuit.
Step 1 Call arrives from the far-end switch (Party A) to the Carrius switch.
Step 2 Carrius switch answers call and establishes a call in-conversation to Party A.
Step 3 Leg to Party B may be established using any signaling supported by the Carrius
switch (CAS, PRI, SS7, SIP, H.323).

Part No. 600-0600-002 Page 2-35
Step 4 Call to Party C is established as follows: (All Carrius switch to far-end switch
signaling is performed on the same circuit that originated the call from Party A)
• The application triggers call transfer
• Carrius switch sends a hook-flash to the far-end switch to indicate that a call
transfer is being requested
• Far-end switch responds with dial-tone to indicate it is ready to collect digits
(alternatively the dial-tone option can be turned off and the switch will outpulse
digits after a provisioned time delay)
• The Carrius switch outpulses the destination digits that identify Party C
• Far-end switch puts Party A on hold, and establishes the call to Party C.
Step 5 Carrius switch sends a disconnect (on-hook) to the far-end switch to indicate that
the transfer from Party A to Party C should be completed. The disconnect is sent
when the following conditions are detected by the Carrius switch:
• If a blind transfer had been requested by the application, the disconnect is sent
when alerting (ringing) or answer is detected from Party C.
• If supervised alerting transfer had been requested by the application, the
application will trigger the disconnect when alerting on Party C is detected. If
alerting is not detected but answer is detected then the trigger will be performed
at answer.
• If supervised answer transfer had been requested by the application, the
application will trigger the disconnect when the answer is detected on Party C.

Page 2-36 Part No. 600-0600-002
2.9.2 Call Transfer over ISDN TBCT

In this configuration, the call originates into the Carrius switch on an ISDN PRI
circuit. The switch establishes a call leg to the same originating far-end switch using
another PRI circuit on the same PRI group (same D-channel). This call leg is for
termination to Party C. The TBCT Facility message is used to communicate the call
transfer request to the far-end switch and contains the call reference value of the
originating Party A circuit to tie this call back to the originating Party A. Refer to the
following figures for the high-level interactions.
Step 1 Call arrives from far-end switch (Party A) to the Carrius switch. Signaling is ISDN
PRI signaling over the D-channel for the PRI group associated with this circuit.
switch (CAS, PRI, SS7, SIP, H.323)

Part No. 600-0600-002 Page 2-37
Step 4 Call to Party C is established as follows:

• The application triggers call transfer
• Carrius switch selects a PRI circuit in the same PRI group as the originating call
(Party A) and uses PRI signaling to set up a call to Party C by way of the far-end
switch (for example Sends/receives Setup/Call
Proceeding/Alerting/Connect/ConnectAck, etc. messages).
• Carrius switch sends the FACILITY message to the far-end switch to indicate
that a call transfer is being requested. The FACILITY message contains the call
reference value of the circuit that originated the call from Party A. The FACILITY
is sent based on the following criteria:
– If a blind transfer had been requested by the application, the FACILITY
message is sent by the Carrius switch when Party A has reached the alerting
state.
– If transfer at alerting had been requested by the application, the application
will trigger the FACILITY message to be sent when Party AC has reached
the alerting state
– If transfer at answer had been requested by the application, the application
will trigger the FACILITY message to be sent when Party C has reached the
connect state.
Step 5 Far-end switch sends a FACILITY response for the leg C indicating transfer
success.
Step 6 The far-end switch then sends disconnects for leg A and leg C to indicate that the
call transfer between the far-end switch and the Carrius switch is complete. At this
point the call transfer of Party A to Party C has occurred at the far-end switch.

Page 2-38 Part No. 600-0600-002
2.9.3 Call Transfer using SIP Refer Signaling

In this configuration, the call originates into the Carrius switch from a SIP element.
The Carrius switch, using SIP signaling, establishes a call incoming from Party A
by way of the IP-network. Refer to the following figures for the high-level
interactions.
Step 1 Call arrives from a SIP element (Party A) to the Carrius switch. Signaling is SIP over
IP.
switch (CAS, PRI, SS7, SIP, H.323).

Part No. 600-0600-002 Page 2-39
Step 4 Compleat-200 sends the SIP REFER message to Party A to initiate the call transfer.
Party A establishes a call to Party C and responds to the Compleat-200 with a
NOTIFY TRYING message to indicate that it is trying to send alerting to Party C and
with a NOTIFY 200 OK when Party C has answered.

Page 2-40 Part No. 600-0600-002
Alternatively, the following diagram illustrates a supervised transfer at answer.

Part No. 600-0600-002 Page 2-41
2.9.4 Call Transfer using DTMF (*8) Signaling on the Bearer Channel
In this configuration, the call originates into the Carrius switch on either a CAS or a
PRI circuit. The switch establishes a call to the far-end switch. The Carrius switch
then sends DTMF tones to the far-end switch on the same bearer channel as the
originating call to indicate a call transfer request. The far-end switch responds with
DTMF tones to indicate the outcome of the call transfer request. Refer to the
following figures for the high-level interactions. The CAS circuit on the Carrius end
may be provisioned as an FXO circuit for this scenario.
DTMF tones used to indicate success or failure can be provisioned at the

Carrius switch.
If the circuit at the far-end switch is CAS, the Carrius switch must be CAS. If
the circuit at the far-end is PRI, the Carrius switch must be PRI.
Step 1 Call arrives from the far-end switch (Party A) to the Carrius switch.
switch (CAS, PRI, SS7, SIP, H323).

Page 2-42 Part No. 600-0600-002
Step 4 Call to Party C is established as follows: (All Carrius switch to far-end switch
signaling is performed on the same circuit that originated the call from Party A)
• The application triggers call transfer.
• Carrius switch sends *8 DTMF tones to the far-end switch to indicate that a call
transfer is being requested.
• Far-end switch responds with dial-tone to indicate it is ready to collect digits.
(alternatively, the dial-tone option can be turned off and the switch will outpulse
digits after a provisioned time delay).
• The Carrius switch outpulses the destination digits that identify Party C.
• Far-end switch puts Party A on hold, and establishes the call to Party C.
Step 5 The Carrius switch sends a disconnect (on-hook) to the far-end switch to indicate
that the transfer from Party A to Party C should be completed. The disconnect is
sent when the following conditions are detected by the Carrius switch:
• If a blind transfer had been requested by the application, the disconnect is sent
when a call transfer success (**6 DTMF tones) reply is received from the
far-end.
• Supervised at alerting and supervised at answer transfer are not applicable
in this case. If requested, the behavior will be as for blind transfer.

Part No. 600-0600-002 Page 2-43
2.9.5 SIP to H.323 Call Transfer

The Compleat-200 supports Call Transfer inter-working between SIP and H.323
network elements as specified by the following industry standards:
• RFC 3515, SIP Refer Method
• ITU-T, H.450-2, Call Transfer Supplementary Service for H.323
The Compleat-200 receives incoming call requests from the H.323 gateway. These
calls are expected to be completed on an external SIP feature server such as an
IVR platform. The Compleat-200 uses H.323 to SIP inter-working capability to
terminate these calls.
Figure 2-9 Call Transfer Entities
When the SIP server decides to transfer the call to an agent (operator), the SIP
server sends a SIP Refer message to the Compleat-200. The Compleat-200 then
re-routes the call to the H.323 gateway. If the transfer operation fails, the original
call is re-established. Otherwise, the calling party is transferred to the agent at the
H.323 gateway.
Feature Dependencies
The feature dependencies are listed below:
• H.323 version 4
• H.323 Fast Connect
• SIP Refer message is used to request Call Transfer. This transfer request is
treated as an unattended Call Transfer. Referred-By and Replaces headers are
not required for the specified SIP to H.323 Call Transfer operation.
• In the Refer message, the Refer-to shall point to telephone number, i.e., it shall
be a telephony URI and “user=phone”.
• Simultaneous calls at the Compleat-200 is expected to be 300. However, no
requirement has been specified to impose this limit at this time.

Page 2-44 Part No. 600-0600-002
• The Compleat-200 will register with the H.323 gateway/gatekeeper, i.e., it acts
as an H.323 gateway (towards the H.323 side).
• If the Call Transfer operation fails, the SIP server is expected to release (send
BYE) the call or send another Call Transfer request.
• If the Call Transfer attempt fails, no attempt is made to map the H.323 return
code to different SIP return codes; rather the failure is indicated by a 603
Declined return code.
• H.450-2 specifies a timer (CT-T3) waiting for a response to a FACILITY
message sent to a SIP gateway. This timer is not a requirement for a minimal
implementation of the Call Transfer service.
The following figures show the inter-working of SIP and H.323 for a successful Call
Transfer operation and a Call transfer failure.
Figure 2-10 Successful Call Transfer

Part No. 600-0600-002 Page 2-45
Figure 2-11 Call Transfer Failure
2.10 SIP Call Hold and Retrieve

The Compleat-200 supports SIP call hold and retrieve capabilities.
The SIP server sends a call hold request to the Compleat-200 via a SIP Re-invite
message. When a call/session on hold is to be retrieved, another Re-invite is sent
to the Compleat-200.
The Re-invite message requesting the call hold is indicated via a Null IP address
(c=IN IP4 0.0.0.0), as indicated in the following diagram.
Figure 2-12 Re-invite Message using Null IP Address

Page 2-46 Part No. 600-0600-002
The Re-invite requesting the call hold may alternatively be indicated via
“a=sendonly” as indicated in the diagram below.
Figure 2-13 Re-invite Message using a=sendonly
The Re-invite requesting “call retrieve” can be done with SDP or without the SDP
content in the Re-invite message.
The following diagram shows “call retrieve” with SDP content.
Figure 2-14 Call Retrieve with SDP Content
The following diagram shows “call retrieve” without SDP content.
Figure 2-15 Call Retrieve without SDP Content

Part No. 600-0600-002 Page 2-47
Using the Compleat-200 and the call hold/resume methods described here, a third
party feature server (or SIP phone) can implement Call Transfer, transferring a
party to another SIP element.
A typical call sequence at this stage is for the SIP server to invite Z with the
offer from X, i.e., send an Invite to Z with SDPx. Z then responds with 200 OK
with SCPs. SIP Server acknowledges Z’s response with an ACK and then
sends an ACK to X with SDPz.
2.11 External NAT/Firewall Configuration

The Compleat-200 system is designed to operate in carefully managed networks.
These managed networks may have high-capacity firewalls, NATs, and Session
Border Controllers (SBC) that shield the managed network from public packet
networks. Other carriers, however, are interested in deploying the Compleat-200
system in networks that directly interface to public packet networks. These carriers
and service providers often need to hide certain network element and routing
details of one part of their network from the other. Carrius refers to this capability
as VoIP Network Masking (VNM). VNM consists of two capabilities:
• VoIP Signaling Interworking (both H.323 and SIP)
• RTP/RTCP IP Address Translation (RAT)
VNM is useful for customers who are re-selling VoIP calling capabilities to
end-users and need the ability to prevent users and the customer’s carriers from
inspecting the internal implementation of the customer’s network. VNM uses
signaling and RTP networking functions to hide a customer’s network topology.
This prevents subscribers from being able to by-pass VoIP billing and routing
functions by inspecting the IP messaging streams once a call is routed in the
customer’s network. Service providers generally use this capability as a boundary
plane between different networks or different parts of a network.
In addition, many VoIP carriers and service providers offer their customers virtual
network planes and/or VLANs as a way to segment their network services.
2.11.1 External NAT Firewall Provisioning

Details of provisioning for operation behind a firewall/NAT are contained in DLP 64,
Operation Behind a Firewall/NAT.
IO cards have varying board port ranges depending on the number of DSP
channels available on the card.
The /rtpPort parameter decides the base port range of the card, while the
/rtpPortIncrement decides the number of port(s) allocated for each DSP channel,
which is typically in steps of 10. However for NAT traversal of RTP streams, each
module on the IOCard can be allocated a unique publicly available
<ip-dot-address>[:<port-number>] combination using the /natfirewalladdress
parameter.

Page 2-48 Part No. 600-0600-002
The port number on the external NAT device is calculated based on the following
expression:
External NAT device Port number = port number provisioned in the
natfirewalladdress + (port number allocated on the DSP farm – value of /rtpPort
parameter).
For example:
• For an 8-span card (single DSP module onboard)
Command Prompt> Enter-IOCard /id=1-5 /type=AC_TP1610_FRAMERS_08T

/interface=192.168.130.200
/NATFirewallAddress=202.203.123.58:54000 /rtpPort=54000
/rtpIncrement=10
In this case all 240 dsps will have IP/Port as 202.203.123.58:(54000+dsp#*10)

• For a 16-span card (two DSP modules onboard)
Command Prompt> Enter-IOCard /id=1-5 /type=AC_TP1610_FRAMERS

/interface=192.168.130.200,192.168.130.201
/NATFirewallAddress=202.203.123.58:54000,202.203.123.58:59000
/rtpPort=54000,59000 /rtpIncrement=10
In this case all 240 DSPs on the first module will have IP/Port as
202.203.123.58:(54000+dsp#*10) and all 240 DSPs on the second module will
have IP/port as 202.203.123.58:(59000+dsp#*10)
If you do not supply the port-number for the /NATFirewallAddress it defaults to the
default base port for that card type.
For example:
For an 8-span T1/E1 cards the port-number for the /NATFirewallAddress defaults
to 4000.
The same port number must be specified on both the NatFirewall Address and
rtpPort fields.
Different port ranges can be provisioned for each card on the external device
based on the above scheme.

Part No. 600-0600-002 Page 2-49
2.11.2 Compleat-200 Capabilities

Capabilities of the Compleat-200 include:
• Compleat-200 system IP address reduction
– One externally routable IP address for the entire system
– One externally routable IP address for system management, one (or a set)
for signaling, one (or a set) for bearer
• Masking end-to-end VoIP signaling IP addresses
• Masking end-to-end VoIP bearer IP addresses
• RTP Address Translation (RAT)
• Firewall
– Allow/Bar for VoIP signaling and bearer
– Allow/Bar for maintenance
– Denial of Service (DOS) Mitigation
– Port/App screening
Masking end-to-end VoIP addressing for both signaling and bearer traffic is
illustrated in Figure 2-16. A call between the IP phone in Customer Network A and
Media Gateway 2 is handled by the Compleat-200. When setting up the call, the
Compleat-200 terminates and re-originates the VoIP signaling such that the Media
Gateway 2 does not see the IP address of the IP phone in Network A, and vice
versa. In this scenario, the RTP bearer streams are also passed through the
Compleat-200 so that the IP addresses of each endpoint are masked from each
other. The IP address of the Compleat-200 is seen, instead, by each endpoint for
both signaling and RTP streams.
Figure 2-16 Virtual Network Mask

Page 2-50 Part No. 600-0600-002
If RTP streams are passed through the Compleat-200 for transcoding, the RTP
streams are terminated and re-originated by DSP resources. However, if network
transcoding is not required for a given call and masking is required for the bearer
traffic, DSP resources terminate and re-originate the RTP streams.
2.11.3 Single IP Address for Compleat-200

To provide a solution for a single IP address for the Compleat-200 system, VNM,
and firewall, a network configuration is shown in Figure 2-17. In the example
configuration, only one IP address is visible to the Carrier Network that is required
to terminate the VoIP signaling (H.323 or SIP) and to support the RAT function
between the two networks. The same is true in the reverse direction from the
Subscriber Network to the Carrier Network. The IP address is 10.1.2.1, as shown
in Figure 2-17.
This particular solution is based on simplex equipment external to the
Compleat-200 including an Ethernet Switch and a NAT/Firewall. Depending on the
amount of VoIP traffic, (refer to Section 2.11.5) a 100 Mbps or a 1-Gbps Ethernet
interface from the Compleat-200 to the external Ethernet Switch should be
configured.
To hide internal Compleat-200 chassis topology from the external network, an
external NAT/Firewall device must be equipped. The NAT/Firewall device must be
configured with address translation rules to statically translate the externally
routable IP address and port number to the appropriate internal chassis component
IP address and port number. Handling address translations for the signaling is a
simpler matter to deal with than the RTP/RTCP streams. SIP User Agents, H.323
Local Gateways, and Remote VoIP Endpoints must provision a Firewall address
that is used by the call processing software in SIP and H.323 setup messages
instead of the internal virtual addresses mapped to redundant processors
(active-standby). By inserting the externally routable network addresses in the SIP
or H.323 signaling messages, a statically mapped NAT can properly translate the
IP addresses to line up accordingly, thus masking the internal topology of the
Compleat-200 chassis.
The following discussion describes a particular method for NATing the
Compleat-200 chassis. Depending on the particular firewall/NAT hardware chosen
and its particular capabilities, the address translations and port maps required may
be different.

Part No. 600-0600-002 Page 2-51
Figure 2-17 Compleat-200 with External Simplex NAT/Firewall
As indicated, 10.1.2.1 is the externally routable IP address for the system interfaced
to the IP network by way of the NAT/Firewall. That address is on the same subnet
as the external virtual router address 10.1.2.2 that moves from ESW1 to ESW2
depending on which one is active (10.1.2.3 and 10.1.2.4). The internal chassis
subnet is 192.168.1.0.
As mentioned earlier, RTP and RTCP are more complex. Figure 2-18 illustrates the
RTP audio stream and RTCP control connections between the remote VoIP
endpoints and the DSP cards within the Compleat-200 chassis.
Figure 2-18 Remote Endpoint IP Address and Port Connections for RTP/RTCP

Page 2-52 Part No. 600-0600-002
Each active IP-IP call requires two DSP channels on the Compleat-200 where each
DSP channel requires two UDP ports (one for RTP, one for RTCP) – for a total of
four Compleat-200 UDP ports. The IP Phone in Figure 2-18 has IP address
204.127.202.4. It uses port 3456 to receive the RTP stream and port 3457 to
receive the associated RTCP packets. The Compleat-200 has an externally
routable IP address of 10.1.2.1, accessible via the NAT/Firewall illustrated in
Figure 2-17. The IP Phone transmits its RTP stream that is terminated on port 4000
of Channel 1 of DSP1 Card in the Compleat-200 chassis. The internal IP address
of Module 1 of DSP1 Card is 192.168.1.10. Likewise, the IP Phone’s RTCP packets
are terminated on port 4001 of Channel one (1) of DSP1 card. Internally, a PCM
connection is made between the DSP channels providing the IP-IP connections
within the Compleat-200 chassis.1 In Figure 2-18, Channel 2 of DSP1 card
transmits and receives RTP streams on port 4010 while transmitting and sending
RTCP packets on port 4011. Media Gateway 2 has IP address 216.148.227.68 and
receives the RTP streams on port 14918, and RTCP packets on port 14919.
The Audiocodes DSP cards have two modules of DSP processors equipped. The
672-channel DSP card has 14 DSP processors on each module. Each DSP
processor can handle 24 channels. Each module has its own IP address, so there
are two IP addresses for each Audiocodes DSP card.
The Audiocodes DSP cards allocate 10 fixed ports to each DSP channel for audio,
media, and data connections associated with a given session. This is why the first
port on Channel 1 is 4000, while the first port on Channel 2 is 4010. The three ports
shown for each DSP channel in Figure 3 are the most common for two-party calls
and T.38 fax calls. Additional ports are used for video, conferencing, and other
services.
The total number of available RTP/RTCP ports for a single IP address configured
on the Compleat-200 is 48,536 (65,536-17,000). Since 4 UDP ports are utilized for
each IP-IP call, a single address could theoretically handle 12,134 simultaneous
calls. However, each 672-channel Audiocodes DSP card equipped in the
Compleat-200 utilizes 6720 ports (10 x 672). As a result, up to 7 672-channel
Audiocodes DSP cards can be equipped and referenced by a single external IP
address. Figure 2-19 illustrates the port map for the Compleat-200 single IP
address on the processor card.
1. Any IP-IP connection made by the Compleat-200™ is, by strict definition, transcoded since one
RTP stream is terminated by one DSP process, converted within our DSP card to PCM, and
re-originated on another DSP processor on the card to RTP. If the codecs of each leg happened
to be the same, from a system perspective it would not appear that they were transcoded. Inter-
nally the call was transcoded.

Part No. 600-0600-002 Page 2-53
Figure 2-19 System IP Address Port Mapping

Page 2-54 Part No. 600-0600-002
To hide internal Compleat-200 chassis topology from the external network, an

external NAT/Firewall device must be equipped. The NAT/Firewall device must be
configured with address translation rules to statically translate the externally
routable IP address and port number to the appropriate internal chassis component
IP address and port number. Table 2-3 lists the series of translations of the RTP
streams from the remote endpoints (IP Phone in Customer Network A and Media
Gateway 2) to illustrate how Compleat-200 call processing software, its DSPs, and
the NAT/Firewall provide for end-to-end connectivity.
CNA IP Phone NAT/FW Compleat-200 Compleat-200 NAT/FW MGW2

DSP1-1 Ch1 DSP1-1 Ch2
→ Src: Src: Src: Src: Src: Src:
RTP IPH:3456 IPH: 3456 IPH: 3456 DSP1-1:4010 Com- Com-
XMT Dst: Dst: Dst: Dst: pleat-200:17010 pleat-200:17010
Compleat-200:17000 DSP1-1:4000 DSP1-1:4000 MGW2:14918 Dst: Dst:
MGW:14918 MGW2:14918
→ Src: Src: Src: Src: Src: Src:
RTCP IPH:3457 IPH:3457 IPH:3457 DSP1-1:4011 Com- Com-
XMT Dst: Dst: Dst: Dst: pleat-200:17011 pleat-200:17011
Compleat-200:17001 DSP1-1:4001 DSP1-1:4001 MGW2:14919 Dst: Dst:
MGW:14919 MGW2:14919
← Src: Src: Src: Src: Src: Src:
RTP Compleat-200:17000Com- DSP1-1:4000 MGW2:14918 MGW2:14918 MGW2:14918
RCV Dst: pleat-200:17000 Dst: Dst: Dst: Dst:
IPH:3456 Dst: IPH:3456 DSP1-1:4010 DSP1:4010 Com-
IPH:3456 pleat-200:17010
← Src: Src: Src: Src: Src: Src:
RTCP Compleat-200:17001 Com- DSP1-1:4001 MGW2:14919 MGW2:14919 MGW2:14919
RCV Dst: pleat-200:17001 Dst: Dst: Dst: Dst:
IPH:3457 Dst: IPH:3457 DSP1-1:4011 DSP1:4011 Com-
IPH:3457 pleat-200:17011
Table 2-3 Single IP Address Translations for RTP/RTCP Connections
Table 2-3 Legend: Src is the source IP address, Dst is the destination IP address.
IPH is the IP address of the IP Phone (204.127.202.4). Compleat-200 is the
externally routable IP address of the Compleat-200 chassis (10.1.2.1). DSP1-1 is
the IP address of Module 1 of DSP Card 1 in the Compleat-200 (192.168.1.10).
MGW2 is the IP address of the remote Media Gateway 2 (216.148.227.68).
The translation schemes of Table 2-3 are based on the 672-channel Audiocodes
DSP card. If instead the 480-channel or 240-channel Audiocodes DSP cards are
used in a Compleat-200 chassis, the address and port map rules provisioned on the
NAT/Firewall system will be different (refer to Table 2-5 and Table 2-6). Table 2-4
maps the ports of a single externally routable IP address to the DSP channel ports
of the Audiocodes DSP cards. The Port Offset is discussed below.

Part No. 600-0600-002 Page 2-55
DSP Card Module Port External Port Board Port

Offset Range Range
1 1 13000 17000 – 20359 4000 – 7359
2 16360 20360 – 23719 4000 – 7359
2 1 19720 23720 – 27079 4000 – 7359
2 23080 27080 – 30439 4000 – 7359
3 1 26440 30440 – 33799 4000 – 7359
2 29800 33800 – 37159 4000 – 7359
4 1 33160 37160 – 40519 4000 – 7359
2 36520 40520 – 43879 4000 – 7359
5 1 39880 43880 – 47239 4000 – 7359
2 43240 47240 – 50599 4000 – 7359
6 1 46600 50600 – 53959 4000 – 7359
2 49960 53960 – 57319 4000 – 7359
7 1 53320 57320 – 60679 4000 – 7359
2 56680 60680 - 64039 4000 – 7359
Table 2-4 Port and Offset Mapping of Single IP address for 672-channel DSP Cards and
Modules
When an external NAT/Firewall is equipped with the Compleat-200 to mask the

internal chassis topology from the external network, a NAT/Firewall IP address
must be provisioned for each DSP card module equipped. Additionally, a port offset
for each DSP card module must be provisioned against that IP address. This allows
Liberator call processing software to provide the proper IP address and port
information in the call signaling messages (SIP SDP or H.323 bearer capabilities)
for the RTP/RTCP streams.

Page 2-56 Part No. 600-0600-002
If 480-channel DSP cards or 16-span T1/E1 cards are equipped, the mappings
would look like Table 2-5.
DSP Card Module Port External Port Board Port

Offset Range Range
1 1 13000 17000 – 19399 4000 – 6399
2 15400 19400 – 21799 4000 – 6399
2 1 17800 21800 – 24199 4000 – 6399
2 20200 24200 – 26599 4000 – 6399
3 1 22600 26600 – 28999 4000 – 6399
2 25000 29000 – 31399 4000 – 6399
4 1 27400 31400 – 33799 4000 – 6399
2 29800 33800 – 36199 4000 – 6399
5 1 32200 36200 – 38599 4000 – 6399
2 34600 38600 – 40999 4000 – 6399
6 1 37000 41000 – 43399 4000 – 6399
2 39400 43400 – 45799 4000 – 6399
7 1 41800 45800 – 48199 4000 – 6399
2 44200 48200 – 50599 4000 – 6399
8 1 46600 50600 – 52999 4000 – 6399
2 49000 53000 – 55399 4000 – 6399
9 1 51400 55400 – 57799 4000 – 6399
2 53800 57800 – 60199 4000 – 6399
10 1 56200 60200 – 62599 4000 – 6399
2 58600 62600 - 64999 4000 – 6399
Modules

Part No. 600-0600-002 Page 2-57
If 240-channel DSP cards or 8-span T1/E1 cards are equipped, the mappings would
look like Table 2-6.
DSP Module Port External Port Board Port

Card Offset Range Range
1 1 13000 17000 – 19399 4000 – 6399
2 1 15400 19400 – 21799 4000 – 6399
3 1 17800 21800 – 24199 4000 – 6399
4 1 20200 24200 – 26599 4000 – 6399
5 1 22600 26600 – 28999 4000 – 6399
6 1 25000 29000 – 31399 4000 – 6399
7 1 27400 31400 – 33799 4000 – 6399
8 1 29800 33800 – 36199 4000 – 6399
9 1 32200 36200 – 38599 4000 – 6399
10 1 34600 38600 – 40999 4000 – 6399
11 1 37000 41000 – 43399 4000 – 6399
12 1 39400 43400 – 45799 4000 – 6399
13 1 41800 45800 – 48199 4000 – 6399
14 1 44200 48200 – 50599 4000 – 6399
15 1 46600 50600 – 52999 4000 – 6399
16 1 49000 53000 – 55399 4000 – 6399
Modules
Not all NAT/Firewall products support port mapping/translation, like in the

previous table where external IP address ports 53000-55399 are mapped to
internal ports 4000-6399. A more common capability is the support of port
forwarding, where no modification of the IP port number takes place. In this
scenario, the /RTPPort attribute of the DSP modules on the Compleat-200
must be provisioned to match the assigned port range on the external IP
address.
Steps for Single IP Address for Compleat-200

This section briefly outlines the steps necessary to provision the Compleat-200 and
the external NAT equipment for a simplex single IP address configuration.
Step 1 Provision the Compleat-200 System Manager (SM) as protected with a Virtual IP
Address that automatically rolls to the active SM - VSM.
Step 2 Provision the Compleat-200 Call Manager (CM) with the Virtual IP Address for
H.323 or SIP signaling.

Page 2-58 Part No. 600-0600-002
Step 3 Configure the NAT for ingress address and port translations with at least the
following list:
• Compleat-200:5060? VCM:5060 (for SIP signaling)
• Compleat-200:1718-1720? VCM:1718-1720 (for H.323 signaling)
The exact list of VoIP signaling ports is dependant on the actual chassis
provisioning and may include multiple mapping of SIP/H.323 signaling ports to
multiple virtual IP addresses.
If the chassis is not using a separate management interface:

• Compleat-200:22? VSM:22 (ssh)
Step 4 Configure the NAT for ingress mappings of address and port translations as
indicated in Table 2-4 (or Table 2-5 or Table 2-6 depending on DSP cards).
Step 5 Configure the NAT for egress translation of IP address(es).
Step 6 Change range of dynamically allocated port numbers on the Compleat-200 SBC
Linux operating system to block out range of ports used for the Audiocodes DSP
cards.
Step 7 Provision NAT/Firewall IP address for each SIP User Agent, H.323 Local Gateway,
and/or Remote VoIP Endpoint that has traffic running through the NAT/Firewall.
Step 8 Provision NAT/Firewall IP address for each DSP card module configured in the
Step 9 Provision port offset value for each DSP card module configured in the
Step 10 Provision Allow/Bar IP addresses for maintenance access.
2.11.4 Multiple IP Addresses for Compleat-200

The solution outlined in “Steps for Single IP Address for Compleat-200” is easily
extended for a solution for multiple Compleat-200 IP addresses. In the multiple IP
address configuration, the following externally routable IP addresses might apply to
the following:
• Maintenance Access
• Each SIP User Agent or H.323 Local Gateway provisioned
• Pools of DSP cards (those that exceed what can be mapped for one IP address)

Part No. 600-0600-002 Page 2-59
The following two tables provide the port mappings of multiple IP addresses for
672-channel and 480-channel DSP card pools in the Compleat-200 chassis. The
240-channel card maps are the same for the single IP address configuration since
the chassis runs out of slots before IP address ports are exhausted.
DSP Module IP Address Port External Port Board Port

Card Offset Range Range
1 1 DSP-G1 13000 17000 – 20359 4000 – 7359
2 DSP-G1 16360 20360 – 23719 4000 – 7359
2 1 DSP-G1 19720 23720 – 27079 4000 – 7359
2 DSP-G1 23080 27080 – 30439 4000 – 7359
3 1 DSP-G1 26440 30440 – 33799 4000 – 7359
2 DSP-G1 29800 33800 – 37159 4000 – 7359
4 1 DSP-G1 33160 37160 – 40519 4000 – 7359
2 DSP-G1 36520 40520 – 43879 4000 – 7359
5 1 DSP-G1 39880 43880 – 47239 4000 – 7359
2 DSP-G1 43240 47240 – 50599 4000 – 7359
6 1 DSP-G1 46600 50600 – 53959 4000 – 7359
2 DSP-G1 49960 53960 – 57319 4000 – 7359
7 1 DSP-G1 53320 57320 – 60679 4000 – 7359
2 DSP-G1 56680 60680 - 64039 4000 – 7359
8 1 DSP-G2 13000 17000 – 20359 4000 – 7359
2 DSP-G2 16360 20360 – 23719 4000 – 7359
9 1 DSP-G2 19720 23720 – 27079 4000 – 7359
2 DSP-G2 23080 27080 – 30439 4000 – 7359
10 1 DSP-G2 26440 30440 – 33799 4000 – 7359
2 DSP-G2 29800 33800 – 37159 4000 – 7359
11 1 DSP-G2 33160 37160 – 40519 4000 – 7359
2 DSP-G2 36520 40520 – 43879 4000 – 7359
12 1 DSP-G2 39880 43880 – 47239 4000 – 7359
2 DSP-G2 43240 47240 – 50599 4000 – 7359
13 1 DSP-G2 46600 50600 – 53959 4000 – 7359
2 DSP-G2 49960 53960 – 57319 4000 – 7359
14 1 DSP-G2 53320 57320 – 60679 4000 – 7359
2 DSP-G2 56680 60680 - 64039 4000 – 7359
Table 2-7 Port and Offset Mapping of Multiple IP addresses for 672-channel DSP Cards and
Modules

Page 2-60 Part No. 600-0600-002
DSP Module IP Port External Port Board Port

Card Address Offset Range Range
1 1 DSP-G1 13000 17000 – 19399 4000 – 6399
2 DSP-G1 15400 19400 – 21799 4000 – 6399
2 1 DSP-G1 17800 21800 – 24199 4000 – 6399
2 DSP-G1 20200 24200 – 26599 4000 – 6399
3 1 DSP-G1 22600 26600 – 28999 4000 – 6399
2 DSP-G1 25000 29000 – 31399 4000 – 6399
4 1 DSP-G1 27400 31400 – 33799 4000 – 6399
2 DSP-G1 29800 33800 – 36199 4000 – 6399
5 1 DSP-G1 32200 36200 – 38599 4000 – 6399
2 DSP-G1 34600 38600 – 40999 4000 – 6399
6 1 DSP-G1 37000 41000 – 43399 4000 – 6399
2 DSP-G1 39400 43400 – 45799 4000 – 6399
7 1 DSP-G1 41800 45800 – 48199 4000 – 6399
2 DSP-G1 44200 48200 – 50599 4000 – 6399
8 1 DSP-G1 46600 50600 – 52999 4000 – 6399
2 DSP-G1 49000 53000 – 55399 4000 – 6399
9 1 DSP-G1 51400 55400 – 57799 4000 – 6399
2 DSP-G1 53800 57800 – 60199 4000 – 6399
10 1 DSP-G1 56200 60200 – 62599 4000 – 6399
2 DSP-G1 58600 62600 - 64999 4000 – 6399
11 1 DSP-G2 13000 17000 – 19399 4000 – 6399
2 DSP-G2 15400 19400 – 21799 4000 – 6399
12 1 DSP-G2 17800 21800 – 24199 4000 – 6399
2 DSP-G2 20200 24200 – 26599 4000 – 6399
13 1 DSP-G2 22600 26600 – 28999 4000 – 6399
2 DSP-G2 25000 29000 – 31399 4000 – 6399
14 1 DSP-G2 27400 31400 – 33799 4000 – 6399
2 DSP-G2 29800 33800 – 36199 4000 – 6399
15 1 DSP-G2 32200 36200 – 38599 4000 – 6399
2 DSP-G2 34600 38600 – 40999 4000 – 6399
16 1 DSP-G2 37000 41000 – 43399 4000 – 6399
2 DSP-G2 39400 43400 – 45799 4000 – 6399
Table 2-8 Port and Offset Mapping of Multiple IP addresses for 480-channel DSP Cards and
Modules

Part No. 600-0600-002 Page 2-61
2.11.5 Simple NAT Solution

A very simple NAT firewall configuration is where there is a 1:1 mapping of external
IP addresses to cards in the chassis. For example referring to Figure 2 -
Compleat-200™ with External Simplex NAT/Firewall, One external IP address
would be mapped to the virtual IP address of the SBC pair and additional external
IP addresses would be mapped 1:1 for each of the DSCP card modules. So, given
the example figure, 5 external IP address would be required where currently 64
need to be used if no NAT were in place. If possible along with the NAT additional
firewalling of the DSP cards would be desirable to prevent anything but RTP/RTCP
packets from getting to the DSP cards.
Sample 1:1 IP address NAT mapping

EXT1 <-> SBC Virtual 192.168.1.63
EXT2 <-> DSP-Card-1 Module-1 192.168.1.6
This configuration will allow RTP streams from active calls to come through.
2.12 Application Programs

The Compleat-200 system supports six different application program types:
• System Manager (SM) – is responsible for all operations, administration,
management, and provisioning (OAM&P) of the Compleat-200 system. It
maintains the system database and manages all of the provisioned applications.
All maintenance requests are available through the Command Line interface
(CLI) on the System Manager application.
• System Monitor – is used to remotely access a properly provisioned System
Manager. The System Monitor application can then be used to perform all
OAM&P functions available.
• Call Manager (CM) – is responsible for handling call resources and processing
call control requests on a system shelf. It is fully capable of processing an entire
call from origination to disconnection without outside intervention from another
application
• Ι/O Manager – handles the interface between the hardware devices and the
• API Programs – are user defined custom applications.
• Protected – is a defined group of programs, used for redundancy purposes.
An overview of all these applications can be found in the Compleat-200 Technical
Specification.

Page 2-62 Part No. 600-0600-002
2.12.1 Create an Application

A specific Enter application command exists for each of the application types. The
Compleat-200 system supports the following CLIs:
• Enter-SystemManager
Provision a System Manager Application
DLP
• Enter-SystemMonitor
Provision a System Monitor Application
DLP
• Enter-CallManager
Provision a Call Manager Application
DLP
• Enter-IOManager
Provision an I/O Manager Application
DLP
• Enter-APIProgram
Provision a Custom API Application
DLP
By executing the appropriate Enter command for the application types, users can
provision their custom-developed applications on the system. When a modification
is necessary, the appropriate Modify command may not support the changing of
certain parameters. In this case, it is necessary to Remove and then Enter the
application again. It is recommended that if you do need to modify an application’s
registration information (i.e., the port assignment) that you first lock the application
using the Lock-App CLI command.
All application provisioning changes can be made without affecting the call
processing of any other application.
For additional information/parameters, consult the HTML-based CLI

documentation.

Part No. 600-0600-002 Page 2-63
2.12.2 Specify Log File Sizes

Each application can control their various log file sizes by entering the appropriate
value in the /exeEnv parameter of the Enter-<application platform ID> command.
All Applications
The following options exist for all applications:
• Trace log:
• VR_LOGSIZE=unlimited |<size limit in bytes>
• VR_LOGTYPE=file | memory
These values can be adjusted by executing the Modify-App-TraceLog command.
CallManagers
The following options exist for CallManager applications:
• Call Log:
• VR_CALL_LOGSIZE=unlimited |<size limit in bytes>
SystemManagers
The following options exist for SystemManager applications:
• Command Log:
• VR_CMDLOGSIZE=unlimited |<size limit in bytes>
2.12.3 Specifying Command Line Options

Each application can be passed various command line options using the exeArgs
parameter of the Enter-<application platform IP> or the Modify-<application
platform ID> CLI commands. The options are specific to the application and must
be used with knowledge of the design and implementation of the application.
The following options are available:
• b - do not display a banner
• x - exit after processing script(s)
• s - enable audio simulation
• c - runs the specified command
• i - includes the specified file
• n - specifies the name of this application

Page 2-64 Part No. 600-0600-002
• p - specifies the base port number

• h - run in headless mode
• v - start all shells in VRCL (case insensitive) mode
• V - start all shells in VRCL (case sensitive) mode
• h - run in headless mode
File modifiers:
• @ - includes the file quietly
• # - imports the file
Example:
Command Prompt> <program> -n <name> -p <port> [-bsxvVh] [-c <command>] [-i >>
[@|#]<file>] [[@|#]<file> [[@|#]<file> ...]]
The system automatically supplies necessary options depending on your

configuration. Use caution before supplying conflicting values.
CAUTION
2.12.4 Deleting Applications

A specific Remove application command exists for each of the application types.
The Compleat-200 system supports the following CLIs:
• Remove-SystemManager
• Remove-CallManager
• Remove-IOManager
• Remove-SystemMonitor
• Remove-APIProgram
Deleting Compleat-200 system applications other than API programs can have a
negative impact upon system performance and should not be performed without
CAUTION appropriate consideration
2.12.5 Displaying Applications

A specific Show application command exists for each of the application types. The
Compleat-200 system supports the following CLIs:
• Show-SystemManager
• Show-SystemMonitor
• Show-CallManager

Part No. 600-0600-002 Page 2-65
• Show-IOManager
• Show-APIProgram
Show-App Command
The Show-App command will display all applications on the system. After entering
the Show-App command, the system displays the IP address and status of the
available applications. Refer to Table 2-9 for a list of status descriptions.
Command Prompt> showapp
ID IP ADDRESS(ES) STATUS
----------- --------------------- -------------------
CMAPP-CallMgrA 66.42.95.38:10100 ONLINE, STANDBY
CMAPP-CallMgrB 66.42.95.40:10100 ONLINE, ACTIVEDUPLEX
*SMAPP-SystemManagerA 66.42.95.38:10000 ONLINE, ACTIVE
SMAPP-SystemManagerB 66.42.95.40:10000 ONLINE
IOAPP-card1_3_A 66.42.95.38:10200 ONLINE, STANDBY
IOAPP-card1_3_B 66.42.95.40:10200 ONLINE, ACTIVEDUPLEX
IOAPP-card1_4_A 66.42.95.38:10300 ONLINE, STANDBY
IOAPP-card1_4_B 66.42.95.40:10300 ONLINE, ACTIVEDUPLEX
PROTAPP-card1_3_IOMgrs ONLINE
PROTAPP-CallMgrs 66.42.95.62 ONLINE
PROTAPP-SysMgrs ONLINE
Status Description
ONLINE The application is online
OFFLINE The application is offline
ACTIVE The application is active (unprotected applica-
tions)
STANDBY The application is standby (unprotected applica-
tions)
LOCKED The application is locked (removed from service)
ACTIVEDUPLEX The application is active and the standby appli-
cation is online (protected applications)
ACTIVESIMPLEX The application is active and the standby appli-
cation is offline (protected applications)
NA Not Available
WAITINGFORSYNCRESPONSE Waiting for a response from the application
WAITINGFORSYCCOMPLETE Waiting for synchronization between two appli-
cations to complete
INIT Not online or in the initialization stage
LDR RESTART Loader has restarted the application
Table 2-9 Application Status Description

Page 2-66 Part No. 600-0600-002
LDR COMMFAIL Loader cannot communicate with the application

SPAWN Application has been spawned
SPAWNFAIL Spawning of the application has failed
DWNLD Downloading software
FAILED Application recovery failed
Table 2-9 Application Status Description
2.12.6 External Applications

Applications can execute on an SBC that is external to the chassis that contains the
IO cards and common equipment or on an external computing platform other than
a CompactTCA SBC. A Carrius application can interface to the equipment in a
chassis over redundant IP/Ethernet communication paths for fault tolerance and
high reliability.
2.12.7 Application Redundancy

Applications may be designed to be redundant. The Liberator platform offers some
assistance to cooperating applications by allowing them to specify the mode in
which their IPC is delivered. Applications can be put into a Protected group which
allows one of three IPC delivery mechanisms to be specified:
• Active/Standby
• Broadcast
• Load Shared
In Active/Standby asynchronous Indication messages are only sent to the Active
application process. Requests are always processed from either application and
the RequestComplete callbacks are sent to the process that sent the original
request.
An application is declared “active” by meeting any of three possible conditions:
• Being the first application of a pair of applications to initialize
• Takeover when the currently active application fails
• “Locking” the currently active application
In Broadcast mode, asynchronous Indication messages are sent to all applications
in the protected group. Like Active/Standby mode, RequestComplete messages are
only sent to the application that originally requested the action.
In Load Shared mode, asynchronous Indication messages are sent to only one
application in the protected group. All related Call API’s are sent to the same
application. When a new Call-Indication starts, it is sent to the next Application in
the protected group. Thus a round-robin effect of calls is distributed across all
applications for load balancing functionality. If all Applications within the protected

Part No. 600-0600-002 Page 2-67
group request to receive Call-Info-Records, then all of the Applications will receive
Call-Info-Records. Like Active/Standby mode, RequestComplete messages are
only sent to the application that originally requested the action.
Task CLI
Create a Protected Application Enter-ProtectedApp
/id=(name)
/apps=(firstAppId, secondAppId)
/mode=(Active_Standby, Broadcast, Load_Shared)
Delete a Protected Application Remove-ProtectedApp /id=(name)
Display the Protected App rela- Show-ProtectedApp /id=(name)
tionships
Table 2-10 Protected APP Commands
2.12.8 Remove and Restore Applications

The Compleat-200 system has administrative state control over all applications in
the system. Applications may be removed from service (“Locked”) and restored to
service (“Unlocked”) discretely by the Compleat-200 system or directly through a
CLI command. When Locked, an application process will be removed from the
operating environment. Running applications will exit, except for API programs not
under the control of the processors Loader. When Unlocked an application under
the control of the system Loader will automatically reboot. Locking an “Active”
application will cause the “Standby” processor to become “Active” and to assume
control of system operations.
The Compleat-200 system supports the following CLIs to remove and restore
applications:
• Lock-App
• Unlock-App
The Lock-App command will terminate any processing performed by the affected
application. All calls will be aborted for any Endpoints associated with the affected
device.
When a new Application is created with the Enter-APIProgram command, the

application needs to be in an Unlocked state before running the application.

Page 2-68 Part No. 600-0600-002
2.13 VoIP Protocol Configuration

Two VoIP telephony protocols can be configured on the system.
2.13.1 Session-Initiation Protocol

The Compleat-200 system supports the Session-Initiation Protocol (SIP) as a User
Agent (UA). Up to 15 SIP User Agents may be provisioned in a single Compleat-200
chassis. SIP Elements represent external SIP devices which use the User Agent to
access voice service in the IP network. SIP Elements are provisioned against the
User Agent instance that will control them. To provision SIP, the following functions
must be completed in the order listed:
• Provision a SIP User Agent for the Chassis
• Provision a SIP Element for each device that will be associated with the system
• Provision the appropriate routing
Task CLI
Create a SIP User Agent Enter-SIP-UserAgent
Delete a SIP User Agent Remove-SIP-UserAgent
Change properties of a SIP User Agent Modify-SIP-UserAgent
Create a SIP Element Enter-SIP-Element
Delete a SIP Element Remove-SIP-Element
Change properties of a SIP Element Modify-SIP-Element
Display a SIP User Agent Show-SIP-UserAgent
Display a SIP Element Show-SIP-Element
Table 2-11 SIP Provisioning Commands
Refer to the following DLP to provision SIP.
Provision Session-Initiation Protocol
DLP
Refer to the following DLP to provision the SIP Element.
Provision SIP Element for Auto Out of Service
DLP
Refer to the following DLP to provision the SIP User Agent.
Provision SIP User Agent for Auto Out of Service
DLP

Part No. 600-0600-002 Page 2-69
Additional details and mandatory parameters for related SIP commands for
creation, modification, and removal can be found in the accompanying
HTML-based CLI documentation.
Early Media Support

The Compleat-200 system provides the control to an external application to play
media back to an incoming SIP caller and receive media from that SIP caller before
answer. The application accomplishes this by indicating in the Compleat-200
system “Call Progress Request” API call that early media is required. In situations
where it is impossible to facilitate early media (no SDP in the incoming INVITE and
no 100rel) it is up to the application to sense this and not ask for Early Media.
The source and listener of the early media can be either an external media server
or by way of the Compleat-200 system’s internal prompt and DTMF collection
resources.
In some instances the need arises for an application to play a prompt and then
receive feedback from a caller before a call is answered. This may be required to
warn the caller of impending charges and gives the caller a way to abort the call and
the charges before they incur. Early media establishes a media path before the
called party answers. The application determines on a call-by-call basis which calls
require early media and which do not.
Refer to the following figure for an example of a SIP early media environment.
The ladder diagrams are examples of SIP and API message flows.
Figure 2-20 Early Media Network/Call Flow

Page 2-70 Part No. 600-0600-002
For Early Media to be supported, all switches between the user and
Compleat-200 are required to support two-way media establishment before
answer.
Redundancy
If a switch-over occurs before the call in answered, the call will not be preserved
and resources will be released. This includes prompting and collection of digits
during early media.
2.13.2 H.323
The Compleat-200 may represent a number of H.323 Gateways controlling different
zones in an H.323 network. Much like SIP UserAgent / SIP Element relationship,
the H.323 devices in a particular zone are provisioned to the H.323 Gateway
instance controlling that zone. Up to 15 H.323 gateways may be provisioned in a
single Compleat-200 chassis. To provision H.323, the following functions must be
completed in the order listed:
• Provision an H.323 Gateway for the Chassis
• Provision an H.323 Element for each device that will be associated with the
system
• Provision the appropriate routing.
Task CLI
Create a H.323 Gateway Enter-H323-Gateway
Delete a H.323 Gateway Remove- H323-Gateway
Change properties of a H.323 Gateway Modify- H323-Gateway
Create a H.323 Element Enter-H323-Element
Delete a H.323 Element Remove-H323-Element
Change properties of a H.323 Element Modify-H323-Element
Display a H.323 Gateway Show- H323-Gateway
Display a H.323 Element Show-H323-Element
Table 2-12 H323 Provisioning Commands
To provision H323, refer to the following DLP.
Provision H323 Gateway and Element
DLP
Additional related H.323 commands for creation, modification and removal can be
found in the accompanying HTML-based CLI documentation.

Part No. 600-0600-002 Page 2-71
2.14 TDM Configuration
2.14.1 Primary Rate Interface (PRI)

ISDN PRI groups allow a single D channel to control multiple B-channels (up to 23).
Provision E1/T1 Spans for PRI
DLP
Provisioning PRI Endpoint Pools

In order to set up a PRI group, the following steps must be taken:
• Lock the channel that is to be designated as the D channels for NFAS
interfaces.
• Execute the Enter-PRIEndpointPool CLI command to create the PRI endpoint
pool and assign the D channels to the pool.
• Lock the spans that will be added to the endpoint pool.
• Execute the AddToPRIEndpointPool CLI command to add the locked spans to
the pool.
PRI Commands
Task CLI
Create a PRI Endpoint Pool Enter-PRI-EndpointPool
Modify the contents of a PRI Endpoint Modify-PRI-EndpointPool
Pool
Add a PRI Endpoint to a PRI pool AddTo-PRI-EndpointPool
Remove a PRI Endpoint from a PRI RemoveFrom-PRI-EndpointPool
pool
Delete a PRI Endpoint Pool Remove-PRI-EndpointPool
Display the contents of a PRI Endpoint Show-EndpointPool
Pool
Switch D-Channel and Backup Switch-Dchannel
D-Channel for a PRI Endpoint Pool
Table 2-13 PRI Provisioning Commands
The Modify-PRI-EndpointPool CLI is used to configure PRI pool parameters. The

AddTo-PRI-EndpointPool CLI is used to add T1/E1 channels to a pool.

Page 2-72 Part No. 600-0600-002
Disable a Channel or Interface

Before a span can be added to or removed from an Endpoint Pool it must be
disabled. This is accomplished by placing it in the in the administrative locked state.
A specified channel or an entire PRI interface can be disabled (taken out of
service). To disable a specific channel or PRI interface, complete one of the
following tasks through the System Manager’s CLI interface:
Task Command
Take an individual B or D channel out of service Lock-Chan or
Lock-Device
Set the entire PRI interface to the specified state. This can be Lock-Span or
done by locking the span associated with a T1/E1 facility. Lock-Span
If a D-Channel is locked for a 23B + D PRI interface, signaling will be unavailable,

and a RestartRequest will be initiated. Locking a Bearer circuit will result in all
active calls being released.
Enable a Channel or Interface

Before a channel or span can handle calls they must be enabled. This is
accomplished by placing it in the in the administrative unlocked state.
A specified channel or an entire PRI interface can be enabled (placed in-service).
To enable a specific channel or PRI interface, complete one of the following tasks
through the System Manager’s CLI interface:
Task Command
Place an individual B or D channel in-service Unlock-Chan or
Unlock-Device
Set the entire PRI interface to the in-service specified Unlock-Span or
state. This can be done by unlocking the span associated Unlock-Span
with a T1/E1 facility.
2.14.2 Non-Facility Associated Signaling (NFAS)

ISDN NFAS allows a single D channel to control more than 23 bearer circuits. As
mentioned previously, a backup D channel can be configured for use when the
primary NFAS D channel fails.
Using a single D channel to control multiple PRI interfaces can free more B
channels to carry other traffic.
Hard failures cause a switchover to the backup D channel so that current calls
remain connected.
When a backup NFAS D channel is configured and the primary NFAS D channel
fails, rollover to the backup D channel is automatic and all connected calls stay
connected.

Part No. 600-0600-002 Page 2-73
If the primary NFAS D channel recovers, the backup NFAS D channel remains
active and does not switch over again unless the backup NFAS D channel fails.
Provisioning PRI Endpoint Pools for NFAS

In order to set up a PRI group for NFAS do the following. Note that both NFAS and
FAS provisioning are the same with the only difference being that for NFAS a
backup D channel is selected.
The primary NFAS D channel and the optional backup D channel must be
provisioned before the T1/E1 channels are configured for PRI. That means a D
channel must be assigned to a PRI Endpoint Pool before any B channels are added.
• Lock the channel that is to be designated as the D channels for NFAS
interfaces. Also lock the backup D channel.
• Execute the Enter-PRIEndpointPool CLI command to create the PRI endpoint
pool and assign the D channels to the pool.
• Lock the spans that will be added to the endpoint pool.
• Execute the AddToPRIEndpointPool CLI command to add the locked spans to
the pool.
NFAS Commands
The commands listed in Section , ‘PRI Commands’ are also used for NFAS.
The Enter-PRI-EndpointPool CLI is used to select the D channel and backup D
channel. Refer to the following DLP to provision PRI for NFAS.
Provision NFAS PRI Protocol
DLP
Disable a Channel or Interface

Refer to Section , ‘Disable a Channel or Interface’.
Enable a Channel or Interface

Refer to Section , ‘Enable a Channel or Interface’.

Page 2-74 Part No. 600-0600-002
Permanent Connection Commands

The signaling type endpoints can be a permanent connection together with a
matching endpoint of the same type. One example of usage would be to have a
signaling channel stripped out of a span and terminated to the SBC, while the
bearer channels are terminated to an I/O card. Refer to Section 2.25.1, ‘Example of
DS0 Grooming for E1 Facilities’ for additional information.
Task CLI
Create a Permanent Connection Enter-Permanent-Connection
Modify a Permanent Connection Modify-Permanent-Connection
Delete a Permanent Connection Remove-Permanent-Connection
2.15 Channel Associated Signaling (CAS)

Channel Associated Signaling (CAS) is a method of signaling in which the signals
necessary to switch a given circuit are transmitted by way of the circuit itself or by
way of a signaling channel permanently associated with the circuit. The most
common types of T1 CAS signaling are loopstart, groundstart, and EANDM. In
addition to receiving and placing calls, EANDM CAS signaling also processes the
receipt of Dialed Number Identification Service (DNIS) and automatic number
identification (ANI) information, which is used to support authentication and other
functions.
Channel 16 is dedicated for E1 CAS signaling and the type of supported E1 CAS
signaling is MFC-R2.
2.15.1 CAS Signaling Types

• Loopstart Signaling
– NET_LOOP
– USER_LOOP
• Groundstart Signaling
– NET_GROUND
– USER_GROUND
• EANDM Signaling
– EANDM_IMMED
– EANDM_WINK
• MFC-R2
– ITU_R2

Part No. 600-0600-002 Page 2-75
2.15.2 CAS Commands

The following operations can be performed on CAS pools:
Task CLI
Create a CAS Endpoint Pool Enter-CASEndpointPool
Modify the contents of a CAS Endpoint Pool Modify-CASEndpointPool
Add a CAS Endpoint to a CAS pool AddTo-CASEndpointPool
Remove a CASEndpoint from a CAS pool RemoveFrom-CASEndpointPool
Delete a CAS Endpoint Pool Remove-EndpointPool
Display the contents of a CAS Endpoint Pool Show-EndpointPool
Provision E1/T1 Spans for CAS
DLP
The Enter-CASEndpointPool CLI is used to create and configure a CAS pool. The
AddTo-CASEndpointPool CLI is used to add T1/E1 channels to a pool. The
RemoveFrom-CASEndpointPool CLI is used to remove T1/E1 channels from a
pool.
2.15.3 Programmable CAS

The Enter-CASProtocol CLI is used to notify the system of an available CAS
protocol. The ID of the protocol being configured must align with the name of the
protocol definition file. While the command permits the addition of a numeric-id
prefix this is NOT recommended.
The Show-CASProtocol CLI is used to inform the user of the CAS protocols
available on the system. Optionally the user may provide the name of a CAS
protocol as an argument to the command.
The Modify-CASProtocol CLI is used to replace a given CAS protocol that is
available on the system. This is used to update the definition of a CAS protocol that
was previously provisioned and is in use by the system. The ID provided must
match the name of a configured protocol. The ID of the protocol being updated must
align with the name of the protocol definition file.
The Remove-CASProtocol CLI is used to remove a given CAS protocol from the
available on the system. Optionally the user may provide the name of a CAS
protocol as an argument to the command.

Page 2-76 Part No. 600-0600-002
2.16 Line-Side FXS to PBX Interface

The Compleat-200 system provides a T1 FXS interface to the line-side of a PBX.
This feature includes the CAS interface plus answer detection by way of audio
monitoring. Collection of mid-call DTMF digits is also supported. Refer to
Figure 2-21 FXS to PBX Interface
Call Flow
Step 1 Agent calls enter the call center environment and terminate on the Compleat-200
system. The application then causes the Compleat-200 system to issue a SIP Invite
to the media server and bridges the agent to the media server.
Step 2 The VoiceXML application running on the media server answers the agent call and
verifies that the DNIS is valid. The agent is prompted to input their agent ID and
password. (This interaction is transparent to the Compleat-200 system.) Once both
are validated and if the maximum number of agents logged-on threshold is not
reached, the VoiceXML application notifies the other components of the agents
availability. The agent is then told that they are logged in and notifies them if they
have voicemail. After listening to their voicemail, the agents are played recorded
music by way of a recording on the Compleat-200 system. The application does this
by way of an API call using a repeated prompt and collect.
Step 3 The customer calls enter the call center environment from the PSTN into the PBX.
For customer calls, the PBX makes a route request to a routing engine, which sends
back the correct Compleat-200 port or destination number for the PBX to distribute
the call.

Part No. 600-0600-002 Page 2-77
Step 4 The inbound customer call is then presented to the agent that is already connected
to the system. The DNIS is used to look up the whisper prompt (if there is one) and
uses the 'text to speech' engine to play the alert tone and whisper phrase to the
agent. The application answers the forwarded customer call and bridges the
customer to the matching agent.
Step 5 Once the call is connected, the agent and the customer will start conversation until
some specific DTMF sequence is entered or a hang-up event issued by the agent
or customer is detected. Depending on the DTMF commands, the application may
bridge the agent to various (per-programmed) VXML applications. Additionally, the
application may place an outbound call and bridge the agent to it.
In addition, the agent may need to involve a supervisor in a call. In this scenario,
the operator enters a DTMF string which causes the application to conference in a
supervisor using a conference bridge on the PBX. Refer to the following diagram
and steps for more information on how this is accomplished.
Figure 2-22 Setting up a Conference
Step 1 Operator and supervisor call in and log into the system.
Step 2 Call center user calls in. Application connects the user to the operator.
Step 3 Operator needs to include a supervisor. The operator enters the appropriate DTMF
command string.
Step 4 The application places an outbound call from a virtual endpoint in the Compleat-200
into the PBX. The application then stops the recorded music to the supervisor and
bridges the supervisor call into this new call.
Step 5 The application (through another control link into the PBX) adds the user, the
operator, and the supervisor into a conference.

Page 2-78 Part No. 600-0600-002
2.16.1 Answering Machine Detection

Certain applications require the ability to differentiate between human answer and
machine answer of a call. A call answered by a machine may need to be treated
differently then a call answered by a human. The Compleat-200 system can
differentiate between outgoing call scenarios such as fax detection, ringing, busy
tone, live answer and answer by machine. The following figure shows an example
configuration.
Figure 2-23 Network/Call Flow
The call is initiated by the application. The application places a call, through PRI
circuits connected to the PSTN, to a customer. During the placement of this call,
the application informs the Compleat-200 system to turn on answering machine
detection and optionally may conference in a third call leg to record the
conversation to a web server. Information about the call is sent back to the
application when the call is answered. Using the media server, the application plays
prompts to the called party. The prompts vary depending on whether the call was
answered by a person or an answering machine. If answered by a person, the
prompts will either direct the person to answer questions by way of DTMF or
transfer the call from the media server to a live operator.
If answering machine detection is enabled for an outgoing call and the voice
processing card reports that the call is answered by an answering machine, the
Compleat-200 system sends an event to the host application indicating answering
machine detection. Likewise, if a call is answered by a human, the Compleat-200
system sends an event to the host application indicating live answer detection.
These events, detected by way of software in-band audio analysis, are separate
from “answer” events returned by way of trunk signaling.

Part No. 600-0600-002 Page 2-79
Turning On/Off Answering Machine Detection

By using EnableInBandProgress, audio analysis functionality is provided through
the Liberator API to provide audio events to the host. A control is provided to allow
answering machine detection. This control is separate from the other in band audio
detection tones (fax, busy, ringback, etc). The host application can request
answering machine detection on a call-by-call basis. The answering machine
detection is enabled by the application at call initiation.
Conversation Recording
Through the Liberator API, an application can stream one HTTP media stream that
consists of a two-way conversation to an external media recording platform.
The application can start or stop the recording of the voice stream at any time
during the call. However, it is best to not interfere with a call in conversation.
2.17 Announcements and Tones

System administrators can record audio files, download audio files to the platform,
issue a unique identifier, and subsequently play it back on an endpoint connected
in listen-mode to an audio playback DSP resource.
2.17.1 Pre-Recorded Announcements

The Compleat-200 system supplies a basic set of pre-configured announcements.
The default announcement set is provisioned as cached announcements on all
cards that support caching announcements.
Refer to Appendix C, “Pre-Recorded Announcements” for a list of default
announcements.
Obtaining Recorded Announcement Data

The Compleat-200 system supports the following sources for obtaining recorded
announcement data:
• Local File Destination - i.e. file://path_to_file/file_name.
• HTTP Source - i.e. http://some_web_server.com[:optional port
number]/[optional directory path]/filename
All HTTP sourced announcements can be optionally provisioned as "On Demand"
using the "/OnDemand" CLI option on the Enter-Audio and Modify-Audio
commands. When HTTP sourced announcements are provisioned "On Demand",
the announcement remain on the HTTP server to be accessed at runtime. Even
though HTTP sourced announcements can be provisioned as "On Demand", the
supplied URL must be valid at the time of provisioning or an error will result.

Page 2-80 Part No. 600-0600-002
Announcement Delay
The Compleat-200 system, under maximum call per second load, makes a cached
recorded announcement audible to the listener of the associated leg of the call
within 400 microseconds of the call processing event that occurred to initiate the
playing of the recorded announcement.
Supported File Formats

All default announcements are in 8-bit G711U .wave or .wav file format.
As announcements are provisioned into the system they will be verified to ensure
that they are in the acceptable format.
Redundancy Support
The system distributes announcements to appropriate system components as they
are provisioned.
Audio Files
The system is able to load/update/delete a recorded announcement while the
system is processing calls. Adding/refreshing/deleting announcements will not
affect calls in progress
The following list includes the CLI commands to provision audio files:
• Enter-Audio
• Record-Audio
• Play-Audio
• Modify-Audio
• Remove-Audio
• Show-Audio
• Show-Audio-Memory
• Show-Audio-Stats
The maximum available storage space is 10 megabytes for all I/O card types. For
provisioning information/parameters, consult the appropriate HTML-based CLI
documentation for each command listed.
Performance Monitoring
If the system encounters a problem adding an announcement into the system (not
enough storage to load the announcement), the system issues an alarm. Refer to
Compleat-200 Troubleshooting Guide for additional information on alarms.

Part No. 600-0600-002 Page 2-81
2.17.2 Preconfigured Tones

The following illustrates the tones supported by the Compleat-200 system. Refer to
Appendix B, “System-Provisioned Tones” for details.
• DTMF: 0-9, #, *, A, B, C, D
• MF: 0-9, KP, ST, ST1, ST2, ST3
• Dial Tone
• Ring Back Tone
• Busy Tone
• Reorder Tone
Tone CLI Commands

The following CLI commands are provided to support tones:
• Enter-Tone
• Enter-CadencedTone
• Enter-PeriodicTone
• Enter-RangeDetectedTone
• Modify-Tone
• Modify-PeriodicTone
• Modify-RangeDetectedTone
• Remove-Tone
• Remove-CadencedTone
• Remove-PeriodicTone
• Remove-RangeDetectedToneEnter-Tone
• Show-Tone
• Show-CadencedTone
• Show-PeriodicTone
• Show-RangeDetectedTone
For provisioning information/parameters, consult the appropriate HTML-based CLI
documentation for each command listed.
Carrius Technologies will configure the default call progress tones off-line and
then download them to the TVP board. Refer to Appendix B,
“System-Provisioned Tones” for a list of the default Call Progress Tones.

Page 2-82 Part No. 600-0600-002
2.18 Configuring Digit and Pattern Manipulation
2.18.1 Digit Patterns

The Compleat-200 system allows the user to define a set of digit patterns that a digit
collector will compare against during its digit collection sequence. Once a pattern
is matched, the digit collection activities will cease and a notification event will be
sent to the Call Model state machine. This is of greatest benefit to the custom
application that is looking for very tight control over incoming digit streams that may
need to be handled by the application. Refer to the Liberator API Programmer’s
Guide for additional details.
Prefix Calling Party Number Stripping and Prepending
DLP
The pattern can be either a complete telephone number or a partial telephone
number with wildcard digits, represented by an asterisk (*) character. Each "*"
represents a wildcard for an individual digit that the digit collector expects to match.
For example, if the destination pattern for a dial peer is defined as "555*", then any
dialed string beginning with 555, and one or more additional digits will match the
pattern.
In addition to the asterisk (*), there are other symbols that can be used as wildcard
characters in the destination pattern. These symbols provide additional flexibility in
implementing dial plans and decrease the need for multiple dial peers in configuring
telephone number ranges.
In cases where multiple dialing schemes, such as 7-digit and 10-digit dialing
are expected on the same CAS endpoint pool, careful consideration must be
given to timer interaction with the provisioned digit patterns. The digit pattern
parameter "delay" and the time-out for a full sequence of digits to be dialed
must be less than the CAS endpoint pool parameter "interDigitTimeout".

Part No. 600-0600-002 Page 2-83
Digit-Pattern Characters
Digit patterns are specified as a string of ASCII digits that may include special
wildcard characters, as shown in the following table:
Character Description
Digits 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #.
* Matches any digit or any number of digits.
? Matches a single occurrence of any digit.
[wyz…] A nonconsecutive range of digits. Will match the first occurrence
found on the list. [12356] is an example of a list of nonconsecutive
digits.
[x-y] A consecutive range of digits. This is indicated with a hyphen (-). For
example, [2-9] matches any digit in the range 2 to 9.
Digit-Pattern Examples
Examples of patterns in the North American Numbering plan (NANP) are:
Pattern Description
“[2-9][0-9][0-9][2-9][0-9][0-9][0-9][ specifies the Local 10-digit NXX-NXX-XXXX
0-9][0-9][0-9]”
“[2-9][0-9][0-9][0-9][0-9][0-9][0-9]” specifies the Local 7-digit NXX-XXXX
“[1][2-9][0-9][0-9][2-9][0-9][0-9][0- specifies the Long distance 1 + 10-digit
9][0-9][0-9][0-9]”
[94]11 specifies the digit pattern for the special services
that can be accessed by dialing either “911” or
“411”.
2.18.2 Digit Fields and Tags

Once a digit pattern has been defined, fields of digits within the pattern can be
tagged with a name for translation purposes. The Compleat-200 system uses
specialized string syntax to define the tagged fields in a digit string. For example,
the NXX-NXX-XXXX pattern that was specified previously, the three distinct fields
can be tagged using the following digit string:
“3-npa.3-nnx.4-station”
This string specifies that the three most significant digits in the 10-digit string
matched by this pattern be tagged with the identifier “npa”, the next three digits be
tagged with the identifier “nxx”, and the last four digits in the string be identified by
the tag “station”. These tags can then be used by an CAS Protocol Definition to
identify substrings in the digit pattern that can be replaced or outpulsed on the
egress leg.

Page 2-84 Part No. 600-0600-002
Prefix Calling Party Number Stripping and Prepending
DLP
2.18.3 Digit-Pattern CLI Commands

Four commands are provided to support provisioning of digit patterns:
• Enter-DigitPattern
• Modify-DigitPattern
• Remove-DigitPattern
• Show-DigitPattern
Provision Digit Patterns and Pattern Sets
DLP
The Enter-DigitPattern command is used to create a symbolic name associated
with a digit pattern. The following example creates the digit pattern name
“TenDigitDial”. The numeric value of ‘1’ will be assigned to the pattern.
Command Prompt> Enter-DigitPattern /id=1/pattern=null
Verify:
Command Prompt> Show-DigitPattern
The Modify-DigitPattern defines a digit pattern for a given digit pattern name. Three
items of information are required. They are:
• PatternId – The numeric identifier of the digit pattern.
• pattern – The digit pattern string.
• translation - The tags associated with the digit pattern fields

Part No. 600-0600-002 Page 2-85
2.18.4 Pattern Sets

A pattern set is a collection of predefined digit patterns. These sets can be
associated with a trunk group or dynamically associated with an endpoint on a
per-call basis.
Pattern Set CLI Commands

The following commands are provided to support provisioning of pattern sets:
• Enter-PatternSet – create a pattern set
• AddTo-PatternSet – add digit pattern to a pattern set
• RemoveFrom-PatternSet – remove a digit pattern from a pattern set
• Remove-PatternSet – delete a pattern set
• Show-PatternSet – display digits patterns associated with a pattern set
2.19 Reports and Queries
2.19.1 Resource Query

A Resource Query is requested on-demand by an application to determine the
provisioning information associated with a system resource. An application has the
choice of a single resource query or a multi-resource query.
The response to the application making the resource query is the resource's
provisioning information. Additional details can be found in the HTML-based CLI
documentation.
2.19.2 Alarm Report

Alarm reports are generated when a device in the system experiences an abnormal
condition. Refer to Compleat-200 Troubleshooting Guide for details on alarm
reporting.

Page 2-86 Part No. 600-0600-002
2.20 Log Files

Platform applications and User defined applications generate log files. These log
files contain all console input/output that is produced by either a console shell or a
remotely logged in shell. Each line of the log file is time stamped with milliseconds
resolution so that the activity within a particular application can be traced and
diagnosed if a problem occurs. In addition, the System Manager will segregate all
Command Line Interface activity in a separate log file so that any and all
provisioning activity can be inspected.
The following applications produce log files:
• System Manager
• Call Manager
• I/O Manager
• User Defined Applications
Log files can be configured through the Enter or Modify CLI appropriate to the
individual Compleat-200 system application. This log file is rotated on a daily basis.
The file size is fixed at the time the Compleat-200 system application is launched.
The file size is controlled by specifying the number of bytes to the option
VR_LOGSIZE= option in the /exeEnv CLI configuration option.
Log files are a circular buffer that will be overwritten if sufficient output is generated
by the Compleat-200 system application. An End-Of-File (EOF) marker is placed
within the file to mark where the last output has occurred.
2.20.1 Log File Location

Log file information will be written to files in the platform’s RT-ENV directory. In this
logs directory there will be a sub-directory for each application that generates a log
file. The subdirectory will be named after the application it supports. For example,
the path name to the System Manager’s log file directory could be:
../RT-ENV/logs/SystemManager
Naming Convention
The file names will look like:
PortNumber.DayOfWeek.log.
Where:
PortNumber = the port number used by the logging application program. i.e.
“12000”
and
DayOfWeek = (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday,
Sunday)

Part No. 600-0600-002 Page 2-87
For example:
12000.Friday.log is the log file for an application using port 12000 on Friday.
The file naming convention limits the number of log files to one for each day of the
week. The system will automatically maintain the last seven days of log files.
Log File Contents

The log files contain a record of all commands typed at the command line prompt
along with all associated screen output. Each record in the log file is time stamped.
A sample Call Manger log file output after generating a manual test call would look
something like:
@030513144742@ >
@030513144743@ > ‘Tandem’ link 643689461 is CONNECTED
@030513144748@ ‘Tandem’ link 643689461 is ONLINE
@030513144748@
@030513144800@ >
@030513144800@ > CallInfoServer: Registered LinkId (643689461)
@030513144801@ callFW;
@030513144803@ >> (1052855283) Info: [0x02108200 @
VRToneGenerator] [State: AllocatingDSP] – StartStandardTone
@030513144803@ Playing dial tone
@030513144803@ >> (1052855285) Info: [0x02108200 @
VRDigitCollector] [State: WaitingForNextDigit] – DigitIndication
@030513144805@ Collected Digits: 8
@030513144805@
@030513144805@ > >> (1052855285) Info: [0x02108200 @
@030513144805@ >> (1052855285) Info: [0x02108200 @
@030513144805@ >> (1052855285) Info: [0x02108200 @
@030513144805@ >> (1052855285) Info: [0x02108200 @

Page 2-88 Part No. 600-0600-002
@030513144805@ >> (1052855285) Info: [0x02108200 @

@030513144805@ >> (1052855285) Info: [0x02108200 @
@030513144805@ >> (1052855285) Info: [0x02108200 @
@030513144805@ >> (1052855286) Info: [0x02108200 @
@030513144806@ >> (1052855286) Info: [0x02108200 @
VRDigitCollector] [State: Complete] – DigitIndication
@030513144806@ >> (1052855286) Info: [0x02128001 @ VRSimDS1]
[State: InService] – SimStartRing
@030513144806@ Start Ring DS0: 1
@030513144806@ >> (1052855286) Info: [0x02108200 @
VRToneGenerator] [State: AllocatingDSP] – StartStandardTone
@030513144806@ Playing ringback tone
@030513144806@ >> (1052855288) Info: [0x02128001 @ VRSimDS1]
[State: InService] – SimStopRing
@030513144808@ Stop Ring DS0: 1
@030513144808@ >> (1052855290) Info: [0x02128001 @ VRSimDS1]
[State: InService] – SimTone
@030513144810@ Tone Rcvd: RINGBACK_TONE on 0
@030513144810@ >> (1052855292) Info: [0x02128001 @ VRSimDS1]
[State: InService] – SimStartRing
@030513144812@ Start Ring DS0: 1
@030513144812@ answerFW;
@030513144814@ true
@030513144816@
@030513144816@ > >> (1052855296) Info: [0x02128001 @ VRSimDS1]
[State: InService] – SimSpeak
@030513144816@ speak: 0
@030513144816@ hangupFW;
@030513144822@ >> (1052855302) Info: [0x02128001 @ VRSimDS1]
[State: InService] – SimSpeak
@030513144822@ speak: 1

Part No. 600-0600-002 Page 2-89
@030513144822@ true
@030513144824@
@030513144824@ >
-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-
2.21 Statistical Reports

The system can generate statistical reports on any resource within the system.
Once a Statistical policy is defined for resource, associated statistics will be kept
and stored on a local disk. They can also be uploaded to any application that has
registered to receive the statistics. Refer to Compleat-200 Troubleshooting Guide
for more information.
2.22 Call Information Records

Call Information Records (CIR) contain details on the calls handled by the
Compleat-200 system. When using a custom Libertator API program their content
and time of generation are closely coupled to the design and implementation of the
custom application. Otherwise the CIR information for each call is generated
independently by the system at the time of the call processing event. These events
are outlined in the Liberator API Programmer’s Guide.
Custom applications can add their own specific content to the file that would not
be described in documentation provided by Carrius Technologies.
The CIR files are plain text and can be found on the Compleat-200 system in the
directory:
/usr/local/carrius/RT-ENV/logs/CallInfo
CIR generation is closely coupled to the design and implementation of the custom
application. Application configuration, including CIR generation parameters are
configured using the following CLI commands:
• Enter-APIProgram
• Modify-APIProgram
The command syntax and parameters can be found in the HTML-based CLI
documentation. Some of these parameters are coupled to the unique
implementation of the custom application and appropriate consultation should
occur with the application developer before any configuration is applied or
configuration changes are made.

Page 2-90 Part No. 600-0600-002
CIR files can be configured through the Enter-CallManager or Modify-CallManager

CLI command. The log file can be set to be rotated on a weekly or monthly basis.
The file size is fixed at the time the Compleat-200 system application is launched.
The file size is controlled by specifying the number of bytes to the option
VR_CALL_LOGSIZE= option in the /exeEnv CLI configuration option.
CIR files are a circular buffer that will be overwritten if sufficient output is generated
by the Compleat-200 system application. An End-Of-File (EOF) marker is placed
within the file to mark where the last output has occurred.
2.23 Simple Network Management Protocol (SNMP)

SNMP is an application-layer communication protocol that allows network devices
to exchange management information. SNMP enables network administrators to
manage network performance, find and solve network problems, and plan network
growth. The Compleat-200 system supports SNMP Version 2 (SNMPv2).
The Compleat-200 system uses SNMP to provide asynchronous event notification
to a network management system (NMS). It also supports SNMP queries on
Statistics and Configuration.
2.23.1 SNMP Management Information Bases

SNMP implementation uses standard Internet Engineering Task Force (IETF)
management information bases (MIBs) to convey node-level inventory, fault, and
performance management information. SNMP allows limited management of the
Compleat-200 system by a generic SNMP manager. A MIB is a hierarchically
organized collection of information. It consists of managed objects and is identified
by object identifiers. Network-management protocols, such as SNMP, are able to
access the MIBs. The Compleat-200 system SNMP agent communicates with an
SNMP management application using SNMP messages. Table 2-14 describes
these messages.
Operation Description
get-request Retrieves a value from a specific variable
get-next-request Retrieves the value following the named variable; this operation
is often used to retrieve variables from within a table. With this
operation, an SNMP manager does not need to know the exact
variable name. The SNMP manager searches sequentially to
find the needed variable from within the MIB
get-response Replies to a get-request, get-next-request, or get-bulk-request
sent by an NMS
get-bulk-request Fills the get-response with up to the max-repetition number of
get-next interactions, similar to a get-next-request
trap Indicates an event has occurred. An unsolicited message is
sent by an SNMP agent to an SNMP manager
Table 2-14 SNMP Message Types

Part No. 600-0600-002 Page 2-91
Supported MIBs
The Compleat-200 system uses the Carrius Technologies Enterprise MIBs for
system specific parameters such as system configuration, statistics and alarms.
ASN.1 documents are available that define the Carrius Technologies Enterprise
MIB support, allowing SNMP clients to have complete access to the parameters
supported by these MIBs. The ASN.1 documents are available both on the
Compleat-200 file system and on the provided CD-ROM. In addition the SNMP
Agent supports several standard MIBs. Below are the lists of supported MIBs.
Carrius Technologies Enterprise MIBs

• CARRIUS-REG-MIB – Base MIB used for Registration
• CARRIUS-EVENTS-MIB – Alarms/Events
• CARRIUS-SIP-MIB – SIP Configuration and Stats
• CARRIUS-CAS-MIB – CAS Configuration and Stats
• CARRIUS-INAP-MIB – INAP Configuration and Stats
• CARRIUS-WIN-AGENT-MIB – WIN Agent Configuration and Stats
• CARRIUS-H323-MIB – H323 Configuration and Stats
• CARRIUS-COMPLEAT-MIB – Compleat-200 node Configuration and DS1, DS0
and IO Card RTP Stats
• CARRIUS-PRI-MIB – PRI Configuration and Stats
• CARRIUS-ROUTE-LIST – MIB – SS7 Route List Configuration
• CARRIUS-ROUTE-TABLE-MIB – SS7 Route Table Configuration
• CARRIUS-SS7-ISUP-MIB – SS7 ISUP Configuration
• CARRIUS-SS7-ISUP-STATS-MIB – SS7 ISUP Stats
• CARRIUS-SS7-MTP-MIB – SS7 MTP Configuration
• CARRIUS-SS7-MTP-STATS-MIB – SS7 MTP Stats
• CARRIUS-SS7-SCCP-MIB – SS7 SCCP Configuration
• CARRIUS-SS7-TCAP-MIB – SS7 TCAP Configuration
Standard MIBs
• RFC1213-MIB
• IF-MIB
• BRIDGE-MIB
• SNMPv2-MIB
• DOT12-IF-MIB
• EtherLike-MIB

Page 2-92 Part No. 600-0600-002
• IANAifType-MIB
• SNMP-FRAMEWORK-MIB
2.23.2 SNMP Basic Components

An SNMP-managed network consists of three primary components; managed
devices, SNMP agents, and Network Management Systems (NMS).
Managed Devices
A managed device is a network node that resides on an SNMP-managed network
and is managed by an SNMP Agent. SNMP Agent collects and stores management
information from these managed devices and make this information available to
Network Management Systems. Managed devices include routers, access servers,
switches, bridges, hubs, computer hosts, and network elements such as the
SNMP Agent
An SNMP Agent is a software module that resides in a managed device. An agent
has local knowledge of management information and translates that information
into a form compatible with SNMP. The SNMP agent gathers data from the MIB,
which is the repository for device parameter and network data. The agent can also
send traps, which are notifications of certain events (such as changes), to the NMS.
The Carrius SNMP Agent is designed to take advantage of the security feature
using the host allow/deny file. By default, access to SNMP services is denied for all
nodes. This security feature grants access to SNMP services to select allowed
hosts only and denies access to all others.
To take advantage of this feature, decide on the hosts that need access to SNMP
services such as SNMP GET, SNMP GETNEXT, and SNMP SET.
Network Management Systems

An NMS executes applications that monitor and control managed devices. It
communicates with the SNMP Agent that manages devices. NMSs provide the bulk
of the processing and memory resources required for network management. One
or more NMSs must exist on any managed network.
2.23.3 SNMP Support

The Compleat-200 system supports SNMP v2 traps and SNMP queries on
configuration and statistics. The SNMP MIBs define alarms, traps, and statistics.
Through SNMP, NMS applications can query a management agent using a
supported MIB. Refer to Compleat-200 Troubleshooting Guide for statistics
supported by the Compleat-200 system for SNMP queries:

Part No. 600-0600-002 Page 2-93
2.23.4 SNMP Traps

The Compleat-200 system can receive SNMP requests from a number of SNMP
managers and send traps to trap receivers. The Compleat-200 system generates
all alarms and events as SNMP traps. The Compleat-200 system generates traps
containing an object ID that uniquely identifies the alarm. An entity identifier
uniquely identifies the entity that generated the alarm (slot, port, etc.). The traps
give the severity of the alarm (critical, major, minor, etc.). The traps also contain a
date/time stamp that shows the date and time the alarm occurred. The
Compleat-200 system also generates a trap for each alarm when the alarm
condition clears.
2.24 Chassis Management Network Security

The Compleat-200 system can be configured to have additional security from
access to the platform from the Signaling/Bearer network. The system can be
configured with separate management interfaces that only allow access to the
platform from configured nodes on the management LAN. This restricts
unauthorized users/nodes from accessing the platform from either the
Signaling/Bearer or Management LAN/WAN. Signaling/Bearer side can be
configured to allow remote entities to send call processing events to the platforms’
controller card(s). Any events from un-configured remote entities/nodes do not
make it to the processing cards within the platform. Access to other cards within the
chassis is restricted to the debug port on the platform.
2.25 DS0 Grooming

The DS0 Grooming feature allows the Compleat-200 system to nail-up the signaling
channel from a distant-end switch to a “signaling” span physically connected to the
Compleat-200 C7/SS7 signaling facilities on the SBC. Grooming is supported for
both E1 and T1 signaling channels. In the case of E1 facilities, this allows channel
16 of the E1 span to be “separated” from the other bearer channels in the E1 span
and groomed into the signaling span towards the SBC. This feature eliminates the
needs of an external DS-1/-0 Access Connect DACS-multiplexer system for
grooming of the signaling channels.
2.25.1 Example of DS0 Grooming for E1 Facilities

In Figure 2-24, the Compleat-200 system is connected with single spans to two
other switches. Each C7 E1 span connected to the Compleat-200 system contains
both the signaling and bearer channels. Figure 2-25 shows how the signaling
channels are permanently connected (nailed-up) at the Compleat-200 system to
permanently connect (groom) them to the signaling span connected to the
Compleat-200 signaling facilities on the SBC. Refer to Section for additional
information.

Page 2-94 Part No. 600-0600-002
1610 IO Card
SBC Card
14-7-1 14-4-0 14-4-1 14-4-2
Patch Panel
signaling links
Span from distant Span from distant

end switch end switch
Distand-End Distand-End
Switch Switch
Figure 2-24 Physical Connections for E1 Grooming (Example)
1-LNK E1DS0-14-7-1-0
2-LNK E1DS0-14-7-1-1
0 1 2 31
E1DS1-14-7-1 SBC E1 Signaling Links
OPC = 2-3-2
Channels other than ch 16 & ch 0 Channels other than ch 16 & ch 0

carry bearer traffic. carry bearer traffic.
Channel 16 nailed up at switch to Channel 16 nailed up at switch to

the SBC signaling ch 1-LNK the SBC signaling ch 2-LNK
DPC = 6-7-6
DPC = 6-7-7
0 16 31 0 16 31
E1DS1-14-4-0
E1DS1-14-4-2
0 1 2
signaling channels
E1DS1-14-4-1
Figure 2-25 Detailed Signaling Channel Connections for E1 (Example)

Part No. 600-0600-002 Page 2-95
2.26 Message Waiting Indication

The Compleat-200 system supports Message Waiting Indication (MWI) service to a
Voice Mail System (VMS). Once an MWI notification is received, the Compleat-200
system forwards the notification to the appropriate switching element. Figure 2-26
illustrates the currently supported network architecture for this service.
Figure 2-26 MWI Network Architecture
2.26.1 Supported Interfaces

The Carrius platform supports the following interfaces simultaneously:
• ANSI ISUP - for call setup
• ITU ISUP - for call setup
• UK ISUP - for call setup
• SS7 ISUP IEs - for voice mail features
• ANSI TCAP - for MWI activation and deactivation
• ITU TCAP - for MWI activation and deactivation
• TCAP (including WIN and Camel) - for signal transfer
• IS-41 (ANSI TCAP/SCCP/MTP) - for MWI activation and deactivation
• IS-41 (ANSI TCAP over ITU SCCP/MTP) - for MWI activation and deactivation
ISUP is used when a subscriber wants to access the voice mail system or when an
end-user is diverted to the voice mail system. TCAP or IS-41 is used to notify an
HLR that a voice mail subscriber has voicemail or that the mailbox is empty.
Each of the above signaling interfaces constitutes a separate network and as such
requires that the platform maintains separate Sub-System Numbers (SSNs). If
there are multiple destinations having the same interface (e.g., ANSI TCAP) for
MWI, they all use the same SSN when communicating with the Carrius platform
(refer to Figure 2-27).

Page 2-96 Part No. 600-0600-002
Figure 2-27 MWI to Multiple MSC/HLR (example)
2.26.2 Sending MWI Notification

When a SIP Notify message is received from the voice mail system, the Carrius
platform sends MWI notification to the provisioned destination node over the
provisioned signaling interface, as described in the following table.
Signaling MWI Activation MWI Deactivation

Interface
IS-41 Message Directive - TCAP INVOKE (LAST) in a Message Directive - TCAP INVOKE
(ANSI) TCAP QUERY WITH PERMISSION package. (LAST) in a TCAP QUERY WITH PER-
ANSI SS7 (TCAP, SCCP, and MTP). MISSION package. ANSI SS7 (TCAP,
SCCP, and MTP)
IS-41 Same as ANSI except: Same as ANSI except:
(ITU)
ITU SCCP and ITU MTP ITU SCCP and ITU MTP
TCAP TCAP message with Invoke component set to TCAP message with Invoke compo-
(ANSI) "Report Event - Voice Message Available". nent set to "Report Event - Voice Mes-
Package type: Query with Permission" sage Retrieved". Package type: Query
with Permission"
TCAP TCAP message type is set to "MWISet" TCAP message type is set to "MWIRe-
(ITU) set"
Table 2-15 MWI Notification

Part No. 600-0600-002 Page 2-97
2.26.3 Enabling MWI

Refer to the following DLP to provision MWI.
Provision Message Waiting Indication (MWI)
DLP
2.27 Echo Cancellation

This document describes how to troubleshoot and eliminate echo where possible in
IP Telephony networks with Compleat-200 system gateways.
There are two sources of echo:
• Hybrid echo
• Acoustic echo
2.27.1 Hybrid Echo

Hybrid echo is caused by an impedance mismatch in the hybrid circuit, such as a
two-wire to four-wire interface. This mismatch causes the Tx signal to appear on the
Rx signal.
Figure 2-28 Hybrid Echo

Page 2-98 Part No. 600-0600-002
2.27.2 Acoustic Echo

Acoustic echo is caused by poor acoustic isolation between the ear piece and the
microphone in handsets and hands-free devices.
Figure 2-29 Acoustic Echo
2.27.3 Echo in Packet Voice Networks

The packet segment of the voice connection introduces a significant delay (typically
30 ms in each direction). The introduction of delay causes echoes (from analog tail
circuits) that were normally indistinguishable from the side tone, to now being
perceived by the user.

Part No. 600-0600-002 Page 2-99
The delay introduced by packet voice is unavoidable. Therefore, the voice

gateways must prevent the echo. The following diagram illustrates how the gateway
uses an echo canceler to reduce the echo before it enters the packet voice network.
2.27.4 PSTN Phone User Hears Echo

This problem exists when the PSTN phone user hears echo which is caused by
acoustic coupling between the ear piece and the microphone in the IP phone
handset.
The solution is to use an IP phone, which includes echo suppression on the handset
and headset.

Page 2-100 Part No. 600-0600-002
2.27.5 IP Phone User Hears Echo

The problem exists when IP phone users hear echo caused by hybrids in a PSTN
network.
The solution is to configure and verify echo cancellation operation on the gateway.
The echo canceler in the voice gateway cancels the echo heard by the IP phone
user.
Administrators can provision echo cancellation within a network to reduce or

eliminate voice echoes. In the case where the Compleat-200 is used as a Tandem
Gateway switch, meaning a switch and other devices exist at the origination and
termination endpoints, the echo cancellation should be enabled at both endpoints
where possible. The closer to the endpoints the better.
In the case where a SIP or H323 phone is connected directly to the Compleat-200,
echo cancellation can be provisioned in the SIP UserAgent or H323 Gateway if
required.
Provision Echo Cancellation on a SIP UserAgent

To provision echo cancellation, you must modify the SIP UserAgent to enable echo
cancellation. Refer to the following DLP for provisioning echo cancellation.
Provision Session-Initiation Protocol
DLP
Provision Echo Cancellation on an H323 Gateway

To provision echo cancellation, you must modify the H.323 gateway to enable echo
cancellation.
Refer to the following DLP for provisioning echo cancellation.
Provision H323 Gateway and Element
DLP

Part No. 600-0600-002 Page 2-101

Page 2-102 Part No. 600-0600-002
C H A P T E R 3
Database Backup and Restore
3.1 Introduction
This chapter describes the backup and restore functions for the Compleat-200
database. In general, the decision to perform a backup depends on a number of
factors; these include but are not limited to:
• In-Service upgrade
• Frequency of database provisioning changes

• Probability of a hard disk failure
• Effort to recover from a failure if the database is not backed up
• Local corporate backup requirements
The backup and restore mechanism comprises two major functions:
• The backup mechanism takes a consistent snapshot of the system, as stored in
multiple databases. It also has the ability to store relevant system configuration.
• The restore mechanism reinstates the system to the exact state stored in the
relevant backup.
Databases may become corrupt, for example, if the hard disk fails, or if the machine
that the databases are stored on stops working. This situation is very serious for
mission critical software; therefore, backing up your databases and configuration to
another area of the disk can remedy this problem.
Backup and restore allows you to recover from hardware or software failures with
minimal loss of management data. You can also use backup and restore to move
databases from one installation to another, for example, to facilitate hardware
upgrades.
3.2 CLI Backup of Database

From the CLI of the System manager, execute the following command:
Command Prompt> Backup-DB /file=<filename>
The Backup-DB CLI takes a command line argument for a file name that the output
will be stored. The file contents will be a set of CLI commands that can be re-read
into the system to restore the database.

Part No. 600-0600-002 Page 3-1
Chapter 3 Database Backup and Restore
3.3 CLI Restore of Database

From the CLI of the System Manager with NO provisioning present, execute the
following command:
Command Prompt> Include /file=<filename>
The Include CLI takes a command line argument for a file name that will be read to
restore the database. The file specified must be a file as created in “CLI Backup of
Database”.
3.4 Backup Binary Database Procedure

Locate the database directory. The database directory can be found in the following
RT-ENV/db subdirectory.
/usr/local/carrius/RT-ENV/db
As well as the files in the RT-ENV/db directory, it is highly recommend that you
backup the database files: The user determines the location. It can be a local
directory or a remote directory on another machine. The user can also select how
to transfer the database file to the remote directory. Possible backup methods
include:
• Portable USB Hard Drive or Flash Disk
• Network File System (UNIX)

• SMB File System (Windows)
• FTP
3.4.1 FTP Example

Backup the database files to a remote named D:\iCSP\BACKUP\ using the File
Transfer Protocol (FTP).
Step 1 Login to the SBC where the database is located.

Step 2 Type in the command “ftp $BACKUPSERVER” Where $BACKUPSERVER is the
FQDN or IP address of the ftp server you wish to connect to. As shown below.
Step 3 Enter your username and your password when prompted to do so.
Step 4 At the ftp> prompt, type in the command “binary” to avoid data corruption in any
transferred files.
Step 5 To transfer a file from the Compleat-200 database directory to the specified remote
directory, at the ftp> prompt type in the command “mput
/usr/local/carrius/RT-ENV/db/*”. This will transfer all the files in the db directory.
For a listing of the remote directory, use the command “dir”. To find the pathname
for your specified remote directory, use the “pwd” command

Page 3-2 Part No. 600-0600-002
3.5 Restore Binary Database Procedure

The database files can be restored by first removing the existing database directory
and then copying the back-up database from their backup location to the
Compleat-200 database directory. Example: /usr/local/carrius/RT-ENV/db.
3.5.1 FTP Example

Restore the database files from a remote directory named D:\iCSP\BACKUP\ using
the File Transfer Protocol (FTP).
Step 1 Login to the SBC where the database is located.

Step 2 Enter the following command where $BACKUPSERVER is the FQDN or IP address
of the ftp server you wish to connect:
ftp $BACKUPSERVER
Step 3 Enter your username and your password when prompted.
Step 4 At the ftp> prompt, enter the following command to avoid data corruption in any
transferred files:
binary
Step 5 Enter the following command:
lcd /usr/local/carrius/RT-ENV/db
Step 6 To transfer a file from the remote backup location to the Compleat-200 database
directory, at the ftp> prompt, enter the following command to copy all the previously
backed-up database files:
mget *

Part No. 600-0600-002 Page 3-3

Page 3-4 Part No. 600-0600-002
C H A P T E R 4
System Access
4.1 Introduction
Craft personnel can access the Compleat-200 system through a standard SSH
connection. Various SSH protocol clients are available on the internet at little or no
cost. After initial system configuration, craft personnel can have direct access to the
Carrius Technologies technical support personnel use this same connection
mechanism, if they require remote access. This access allows, at the customer’s
request, technical support personnel to troubleshoot issues in the customer’s
network and development labs. As each customer’s network security requirements
and access methods differ, it is up to the customer to supply Carrius Technologies
with the needed permission to allow IP access to the Compleat-200 system
hardware.
Refer to the following DLP for the system access procedures.
Access the Command Line Interface
DLP
4.2 Customer-Supplied Encryption/Authentication Keys

The system can be configured to support remote SSH connection authentication
using customer-supplied keys. UserID/Password SSH authentication is not
recommended.
Carrius will supply default keys for SSH authentication. Users can replace the
default Carrius supplied keys.

Part No. 600-0600-002 Page 4-1
Chapter 4 System Access

Page 4-2 Part No. 600-0600-002
C H A P T E R 5
Wireless Prepaid Charging
5.1 Introduction
Pre-Paid Charging (PPC) has been one of the most successful telephony services
both in wire-line and wireless networks. Carrius telephony platform supports
wireless PPC service by providing IS-41/IS-826 protocol support along with the
ISUP protocol. A Third-Party PPC application will make use of the call control and
other signaling capabilities provided by the Carrius platform.
The Compleat-200 system supports Application Load Sharing for multiple
Application Servers.
Figure 5-1 PPC Network Architecture

Part No. 600-0600-002 Page 5-1
Chapter 5 Wireless Prepaid Charging
A PPC subscriber establishes an account with a service provider to access voice

telecommunication services in home and roaming networks. Charges are applied
and decremented on a real-time basis. PPC account information is given to the
subscriber at the beginning, during, or end of a call or other service. When a low
balance notification is given, the subscriber has the option to re-fill the account.
When the account balance reaches a pre-defined threshold, the subscriber is no
longer authorized to use the telecommunication services.
There are three logical entities in the Compleat-200 system, the Service Switching
Function (SSF), Service Resource Function (SRF), and Service Control Function
(SCF), which is responsible for handling all IS-826/IS-41 messages. Messages
from an MSC to the Compleat-200 system are routed by a SubSystem Number
(SSN) and a Point Code (PC) and not by GTT (Global Title Translation).
The Compleat-200 system can receive IS-826 queries for the Pre-Paid Application
from up to twenty MSCs.
Refer to the following DLP to provision the Wireless Pre-Paid Billing feature on your
system.
Provision a Wireless Prepaid Application
DLP

Page 5-2 Part No. 600-0600-002
5.2 Redundancy Between the Application Server and the

Compleat-200 System
The Compleat-200 system supports Application Load Sharing for multiple
application servers. In a 4U chassis configuration, redundant communication links
can be provisioned from the SBCs to the Endpoint Managers (EPMs) by way of the
Ethernet Switches. Therefore, if one link fails, the Compleat-200 can continue to
communicate with the Prepaid Charging Application using the other link(s).
Figure 5-2 Redundancy between the Compleat-200 system and the Application Server
If one application server fails, the Compleat-200 system routes traffic to the
remaining server(s) on the same site. The Compleat-200 system monitors the
communication links to the application. If one SBC (on one shelf) fails, the other
SBC takes over the full load for the system. Once a call is answered (stable calls),
the other SBC is aware of it. Therefore, if one SBC were to fail, all stable calls would
continue to be serviced by the other SBC. Non-stable calls (calls for which no
answer indication is received from the MSC) are not saved and will be lost.
If one Compleat-200 system fails (failure of both SBCs or failure of all
communication links), all calls served by the failed system will be lost.
Note The Compleat-200 system on one site does not serve as the backup of the
Compleat-200 system on another site.

Part No. 600-0600-002 Page 5-3
5.3 Redundancy Between the Compleat-200 System and the

MSC
Assuming each Compleat-200 system will have one Point Code, each linkset (from
the Compleat-200 system to an STP) consists of two signaling T1s with two links
each (proposed minimum). Traffic is shared among all links. If one link fails, traffic
is carried on to the remaining links on the linkset.
Figure 5-3 Redundancy between the Compleat-200 system and the MSC
If all links in a linkset (from the Compleat-200 system) fail, traffic from the
Compleat-200 system will continue to be routed on the other linkset to the other
STP.
The Compleat-200 system on one site takes half the traffic load. If all of the
communication links to this Compleat-200 system fails, the MSC/STP can re-route
traffic to the Compleat-200 on the other site.
The MSC does not need to know which SBC it is talking to. Even if the Call Manager
on one SBC dies, the signaling links on the SBC can still be active and running
traffic.
For each MSC, one Compleat-200 system is primary and the other is backup
(SCCP backup). Therefore, the MSC needs to store the DPC of each system.
If both Compleat-200 systems are lost, total service loss occurs until one
Compleat-200 system is restored to service.

Page 5-4 Part No. 600-0600-002
C H A P T E R 6
SS7 Signaling Architecture
6.1 Introduction
Signaling System 7 (SS7) is an architecture for performing out-of-band signaling to
support call establishment, billing, routing, and information-exchange functions
within a public switched telephone network (PSTN). The SS7 signaling architecture
consists of three main network points; signal switching point, signal transfer point
and signal control point. These components are interconnected by way of signaling
links.
The Compleat-200 system supports Stream Control Transmission Protocol (SCTP)
and MTP3 User Adaptation Layer (M3UA). All currently supported SS7-based
protocols are able to operate over SIGTRAN.
6.1.1 Service Switching Point

Service Switching Points (SSP) are switches that have the SS7 software and
terminating signaling links. SSPs originate or terminate a call and communicate on the
SS7 network with SCPs (if performing database queries) to determine how to route a
call or set up and manage certain features.
SSPs create packets and send those messages to other SSPs. They are also
responsible for querying remote shared databases to gather instructions for routing
calls. The SSP uses the dialed digits to determine how to route the call. The dialed
digits are matched to an entry in the SSP routing table to find the corresponding
trunk circuit and terminating exchange. An SS7 message is then sent to the
adjacent exchange requesting a circuit connection on the trunk which was specified
in the routing table.
The adjacent exchange sends an acknowledgement back, giving permission to use
that trunk. Using the calling party information contained in the setup info, the
adjacent exchange determines how to connect to the final destination. This might
require several trunks to be set up between several different exchanges.
The SSP manages all of these connections until the destination is reached.

Part No. 600-0600-002 Page 6-1
Chapter 6 SS7 Signaling Architecture
6.1.2 Signal Transfer Point

Signal Transfer Points communicate with SSPs on the SS7 network to set up and
tear down telephone calls. They also act as points to connect the SSP and the SCP
for services such as 800 number translations, calling card numbers, or mobile
subscriber identification numbers.
An STP can act as a firewall to screen SS7 messages exchanged with other networks.
Their main function is to route SS7 messages to the correct outgoing signaling link,
based on SS7 message address fields.
There are three levels of STPs.
• National STP
• International STP
• Gateway STP
National STP
A National STP exists within a national network and can transfer messages that use
the same national standard of protocol.
Messages can be passed to an International STP, but can not be converted by the
National STP. Protocol converters often interconnect a National and an
International STP by converting from ANSI to ITU-TS.
International STP
An International STP functions within an international network. It provides for SS7
interconnection of all countries, using the ITU-TS standard protocol.
All nodes connecting to an International STP must use the ITU-TS protocol
standard.
Gateway STP
A Gateway STP converts signaling data from one protocol to another. Gateway
STPs are often used as an access point to the international network. National
protocols are converted to the ITU-TS protocol standard. Depending on its location,
the Gateway STP must be able to use both the International and National protocol
standards.
A Gateway STP also serves as an interface into another network's databases, such
as from an interexchange carrier to an end office. The Gateway STP can also be
configured to screen for authorized users of the network.

Page 6-2 Part No. 600-0600-002
Gateway STPs also provide the following traffic and usage measurements:
• Traffic—Measures the peg counts of the type of messages entering or leaving
the network.
• Network events—Track events such as link out-of-service or processor outage,
for maintenance purposes.
• Usage—Provides peg counts of the record number of messages by message
type. Usage counts are sent to the Regional Accounting Office (RAO) for
processing in Bell Networks. RAOs invoice customers such as IXCs and
independent TELCOs, charging for access into the SS7 network, to help offset
the cost of deploying the network.
Figure 6-1 STP in Network
6.1.3 Service Control Point

A Service Control Point (SCP) is usually a computer used as a front end to a
database system. It is an interface to telco databases, not usually to other,
application-specific databases. The SCP is the network element that contains
service control logic such as instructions for converting a toll-free number to a
routable number.
Telco databases are usually linked to SCPs by X.25 links. The SCP can provide
protocol conversion from X.25 to SS7, or can provide direct access to the database
through the use of primitives which support access from one level of protocol to
another.
SCP applications may be implemented in STPs.

Part No. 600-0600-002 Page 6-3
The address of an SCP is a point code, and the address of the database it
interfaces with is a subsystem number. The database is an application entity which
is accessed by way of the TCAP protocol. Examples of databases that can be
accessed by an SCP are listed below:
• Business Services Database (BSD)
• Call Management Services Database (CMSD)
• Home Location Registry (HLR)
• Line Information Database (LID)
• Local Number Portability (LNP)
• Operations Support Systems
• Visitor Location Register (VLR)
6.2 SS7 Links

An SS7 link is the physical transmission line (serial 56/64 Kbps or DS0 channel)
that connects the individual nodes in an SS7 network.
SS7 networks are built to be highly reliable and redundant. Link diversity is built into
the network design, providing multiple signaling paths, so that there is no single
point of failure. This practice ensures that redundant links have the capacity to
handle all rerouted network traffic. The Compleat-200 supports up to 48 SS7 links
per system.
6.2.1 T1/E1 Alarm Detection

The Compleat-200 system detects and reports the setting and clearing of T1/E1
alarms for SS7 spans. Refer to Compleat-200 Troubleshooting Guide for additional
information:

Page 6-4 Part No. 600-0600-002
6.2.2 Link Types

A-Links
Access links (A-links) interconnect an STP and either an SSP or an SCP (signaling
end points). A-links deliver signaling to and from signaling end points. End points
always have at least two A-links.
Any signaling that an SSP or SCP needs to send to any other node in the SS7
network is sent on one of its A-links to its "home" STP, which processes and routes
the message along its way. Messages addressed to an SSP or SCP are routed to
its "home" STP, which forwards them to the addressed node over its A-links.
Figure 6-2 A-Links

Part No. 600-0600-002 Page 6-5
B/D-Links
Bridge links (B-links) are four links that interconnect peer pairs of STPs.
Diagonal links (D-links) are the four links that interconnect STP mated pairs at
different hierarchical levels. Because the SS7 network has no clear hierarchy, these
links are referred to as B-links, D-links or B/D-links.
Figure 6-3 B/D-Links

Page 6-6 Part No. 600-0600-002
C-Links
Cross links (C-links) interconnect STP pairs and are used when there is a link
failure that causes the STP to find an alternate route.
Figure 6-4 C-Links

Part No. 600-0600-002 Page 6-7
E- and F-Links
Extended links (E-links) connect an SSP to an alternate STP and provides backup
connectivity to the network if the SSP’s home cannot be reached on its A-link.
Fully associated links (F-links) directly connect two signaling end points (SSPs or
STPs). F-links are usually not used in networks with STPs because they allow
associated signaling only, thus bypassing the security features provided with an
STP.
Figure 6-5 E- and F-Links
6.3 Linksets
Links that share the same adjacent node can be grouped into a linkset. Traffic
alternates between all links in a linkset.
Alternate linksets are provisioned to provide backup paths in case of network
congestion. When a link fails, all other links in the linkset will take over. The
Compleat-200 supports up to 16 SS7 linksets per system.
6.4 SS7 Signaling Interfaces

Cards that support SS7 signaling terminate the T1/E1 physical links using standard
RJ-48C connectors on the SBC(s) RTM(s). For redundancy, SS7 physical links
should be split between redundant SBCs and linksets should be distributed
between SBCs.

Page 6-8 Part No. 600-0600-002
6.5 SS7 Provisioning

The Compleat-200 system supports SS7/C7 provisioning. The following sections
describe the SS7 provisioning capabilities on the Compleat-200 system.
6.5.1 MTP3 Commands

The Compleat-200 system supports SS7/C7 routing. To provision MTP3, the
following functions must be completed in the order listed:
• Provision a Signaling Point
• Provision Links
• Provision Linksets
• Provision any desired Combined Linksets
• Provision Routesets
Task CLI
Create an SS7 Signaling Point Enter-SS7-SignalingPoint
Create an SS7 link (up to 48 links can be Enter-SS7-Link
provisioned on the system)
Create an SS7 link set (up to 16 linksets can Enter-SS7-LinkSet
be provisioned on the system)
Create a combined SS7 link set Enter-SS7-CombinedLinkSet
Create an SS7 route set Enter-SS7-RouteSet
Table 6-1 SS7 Provisioning Commands
6.5.2 ISUP Commands

To provision ISUP, the following functions must be completed in the order listed:
• Provision a Service Access Point
• Provision ISUP EndpointPool
• Provision Routing

Part No. 600-0600-002 Page 6-9
Task CLI
Create an ISUP Service Access Point Enter-ISUP-SAP
Modify the configuration of a Service Access Modify-ISUP-SAP
Point
Create an ISUP Endpoint Pool Enter-ISUP-EndpointPool
Modify the contents of an ISUP Endpoint Pool Modify-ISUP-EndpointPool
Add an ISUP Endpoint to a ISUP pool AddTo-ISUP-EndpointPool
Remove an ISUP Endpoint from a ISUP pool RemoveFrom-ISUP-EndpointPool
Table 6-2 ISUP Provisioning Commands
6.5.3 SCCP Commands

The Compleat-200 system supports the SCCP networking.
To provision SCCP, the following functions must be completed in the order listed:
• Provision a SCCP Network
• Provision a SCCP Remote Subsystem associated with the system
• Provision the appropriate routing.
Task CLI
Create an SS7 SCCP Network Enter-SS7-SCCPNetwork
Modify an SS7 SCCP Network Modify-SS7-SCCPNetwork
Delete an SS7 SCCP Network Remove-SS7-SCCPNetwork
Create an SS7 SCCP Remote Sub- Enter-SS7-SCCPRemoteSubsystem
system
Modify an SS7 SCCP Remote Sub- Modify-SS7- SCCPRemoteSubsystem
system
Delete an SS7 SCCP Remote Sub- Remove-SS7- SCCPRemoteSubsystem
system
Create an SS7 SCCP Route Enter-SS7-SCCPRoute
Modify an SS7 SCCP Route Modify-SS7- SCCPRoute
Delete an SS7 SCCP Route Remove-SS7- SCCPRoute
Table 6-3 SCCP Provisioning Commands

Page 6-10 Part No. 600-0600-002
6.5.4 TCAP Commands

The Compleat-200 system supports TCAP messaging on the SCCP network and
TCAP (including WIN and Camel) signaling over the SIGTRAN family of protocols.
After provisioning the SCCP network, enter the following commands to provision a
TCAP subsystem.
Task CLI
Create an SS7 TCAP Subsystem Enter-SS7-TCAPSubsystem
Modify an SS7 TCAP Subsystem Modify-SS7-TCAPSubsystem
Delete an SS7 TCAP Subsystem Remove-SS7-TCAPSubsystem
Table 6-4 TCAP Provisioning Commands
6.5.5 Additional Resources

The following DLPs can be accessed for additional provisioning procedures.
Provision an I/O Card (for SS7/C7 functionality)
DLP
Provision SS7/C7 Interconnects
DLP
Provision Message Waiting Indication (MWI)
DLP
Provision a Wireless Prepaid Application
DLP
6.6 Intelligent Network Application Protocol

The Compleat-200 system functions as a front-end to an Intelligent Peripheral (IP),
interfacing with a Service Switching Point (SSP) and a Service Control Point (SCP).
The IP has a controller (the back-end, an Application), that makes use of the
signaling and media capabilities of the Compleat-200.
The Carrius Liberator API is the interface to the IN-IP application. ISUP is the
interface to the SSP and INAP is the interface to the SCP.
The IP may have other media resources for specialized applications such as
Text-to-Speech (TTS) and Automatic Speech Recognition (ASR). The
Compleat-200 will extend a call to such resources if requested by the Application.

Part No. 600-0600-002 Page 6-11
The network architecture for a typical deployment is shown below.
Figure 6-6 IN-IP Network Architecture

Page 6-12 Part No. 600-0600-002
C H A P T E R 7
Craftsperson Trace Tool
7.1 Introduction
Craftsperson Tracing enables the craftsperson to selectively trace call processing
and signaling protocol activities in real-time. The craftsperson can trace a variety of
system functions and select multiple criteria to narrow down the scope of the trace
as required. The system allows the craft to do tracing during peak traffic. However,
during high CPU usage, the system will begin shutting off all tracing.
7.2 Trace Utility CLI

The following CLI commands are used for creating, controlling, and viewing trace
profiles:
• Enter-Trace-CallInformation
• Modify-Trace-CallInformation
• Remove-Trace-CallInformation
• Enable/Disable-Trace
• Show-Trace-CallInformation
• Watch-App-TraceLog
• Capture-App-TraceLog
• Retrieve-App-TraceLog
For additional information/parameters, consult the HTML-based CLI
documentation.

Part No. 600-0600-002 Page 7-1
Chapter 7 Craftsperson Trace Tool
7.2.1 Enter-Trace-CallInformation
The Enter-Trace-CallInformation command allows the craftsperson to provision
trace information to aid in troubleshooting any provisioning and/or networking
problems that may occur during service activation.
The following parameters control and enable a trace:
• Level
• Modules
• Triggers
• Priority
• Duration
All of the options for a particular trace are stored in a profile. The profile must be
created prior to enabling a trace. Each profile can contain one or many modules but
can only contain one trigger and one level value.
Level
The level parameter specifies the tracing level desired.
• brief - produces high level tracing that is limited to a single line of output
• verbose - produces additional detail that may span multiple lines
A level of 'verbose' displays additional information only for the modules SIP,
H323, ISUP, PRI and Routing.
Modules
The modules parameter represents either a functional call processing area (such
as call control, signaling, etc.) or a signaling protocol (such as SIP, H.323, PRI,
etc.). Traces that use functional modules provide information on the internal Carrius
software flow and are generally used for debugging. Signaling protocol modules
provide information on the messages and signaling activity flowing in and out of the
Compleat-200 system and may help explain why a particular call is failing.
Valid modules include:
• Call Processing Functions
– CallControl - Traces Basic Call Model and Endpoint Control
– Routing - Traces the routing function
– MediaControl - Traces control of the media/bearer plane
– ConnectionControl - Traces control of Connections
– Signaling - Traces all of signaling agent control

Page 7-2 Part No. 600-0600-002
• Signaling Protocols
– H323 - Traces H323 Signaling
– ISUP - Traces ISUP Signaling
– PRI - Traces PRI Signaling
– SIP - Traces SIP Signaling
• Enable all traces
– All - Turns on all traces
Triggers
The triggers parameter specifies the triggering condition for a trace.
Specifying the trigger allows the operator to limit which calls will be traced. The
trigger specifies what attribute of the call must be matched to what value in order to
start a trace.
Triggers can include one or more attributes, operators or values.
Integer attributes begin with an 'n' and string attributes begin with a 'p'. Although
'nUaResourceId' and 'nResourceId' are integers, they can be compared to standard
Carrius resource id strings. nResourceId must refer to a DS0 circuit. Referring to a
span or card is not currently supported.

Part No. 600-0600-002 Page 7-3
Trigger Data Elements

Refer to the following table for a description of trigger data elements.
Data Elements Description

Attribute Signaling Type: VoIP Only
• Integer Attributes
– nUaResourceId - User Agent Resource ID
– nThirdPartyId - Third Party Number
• ASCII String Attributes
– pToSIPUri -
Signaling Type: SIP Only
– pToUri - "To" field contents
– pFromUri - "From" field contents
– pRequestUri -
Signaling Type: General to all signaling types
• Integer Attributes
– nCallingPartyPresentationIndicator
– nCallingPartyScreeningIndicator
– nCallingPartyNatureOfAddress
– nCallingPartyNumberingPlan
– nCalledPartyNumberingPlan
– nCalledPartyNatureOfAddress
– nCauseCode
– nResourceId
– pCalledPartyNumber
– pCalledPartySubaddress
– pCallingPartyName
– pCallingPartyNumber
– pCallingPartySubaddress
Table 7-1 Trigger Elements Data

Page 7-4 Part No. 600-0600-002
Data Elements Description

Operator Integer or string operators:
• Equals - the string in the data from a call is identical to the
specified string
String operators only:
• Contains - the data attribute from a call contains this substring
(i.e. 214-572-8900 contains 214)
Value The <value> specifies the exact string or number you wish to match.
Table 7-1 Trigger Elements Data
Trigger Examples
triggers=<attribute> <operator> “<value>”
The following list includes valid trigger examples.
• pCalledPartyNumber Equals "2145728900"
• pToUri Contains "carrius.com"
• nResourceId Equals "T1DS0-1-3-5-1"
• nUaResourceId Equals "SIP-UA-3"
Sample Commands
Command Prompt> Enter-Trace-CallInformation /id=1-Sample_Trace /level=VERBOSE
/enabled=true /triggers=pCalledPartyNumber Equals "2145728900"
/modules=CallControl /priority=1
Command Prompt> Enter-Trace-CallInformation /id=2-Sample_Trace /level=BRIEF

/enabled=false /triggers=nUaResourceId Equals "SIP-UA-3"
/modules=SIP /priority=2
Command Prompt> Enter-Trace-CallInformation /id=3-Sample_Trace /level=VERBOSE

/enabled=false /triggers=pToUri Contains "carrius.com"
/modules=MediaControl /priority=0

Part No. 600-0600-002 Page 7-5
Priority
The system allows the operator to prioritize traces. Priority levels are 1, 2, 3 and
None. Once a priority level of 1, 2 or 3 is assigned, that priority level cannot be
assigned to another trace. All other traces will have a priority level of 0 (default).
The operator may not assign a priority level to a trace that has all modules enabled.
The system will shut off traces when the CPU usage reaches the following levels:
Priority CPU
None 80%
3 85%
2 90%
1 95%
The system will turn traces on when the CPU usage reaches the following levels:
Priority CPU
1 85%
2 80%
3 75%
None 60%
Duration
Operators can enable traces for a specified amount of time. The time increments
are in minutes with the default duration being 10 minutes.
7.2.2 Modify-Trace-CallInformation
The Modify-Trace_CallInformation command allows the craftsperson to modify a
call control tracing profile.The specified tracing profile must be disabled before it
can be modified (Disable-Trace).
7.2.3 Remove-Trace-CallInformation
The Remove-Trace-CallInformation command allows the craftsperson to remove a
call control tracing profile. The specified tracing profile must be disabled before it
can be removed (Disable-Trace).
7.2.4 Enable/Disable-Trace
The Enable-Trace and Disable-Trace commands allow the craftsperson to enable
or disable traces from existing profiles.They also provide the ability to turn on or off
all profiles with one command.

Page 7-6 Part No. 600-0600-002
7.2.5 Show-Trace-CallInformation
The Show-Trace-CallInformation command allows the craftsperson to view all call
control tracing profiles. Setting the enabled parameter to true displays only the
enabled traces, and false displays only the disabled traces.
7.2.6 Watch-App-TraceLog
The Watch-App-TraceLog command directs all output from that application's log file
(including Info Alarms, etc.) to the current console. This may be useful even when
the trace feature is not being used.
The Watch-App-TraceLog command is a CLI blocking command. The System

Manager is blocked from executing further commands. To prevent this, open
ALERT an rshell to the System Manager and execute the Watch-App-Tracelog
command.
The trace output is generated by either the Call Manager or the SS7 IO Manager
internal application. Most traces useful for debugging are generated by the Call
Manager application. One trace (ISUP) is generated by the SS7 IO Manager. The
trace will always go to the appropriate internal application's log file (ISUP goes to
the SS7 IO Managers log; everything else goes to the Call Manager's log.) Trace
output is mixed with other Call Manager (or SS7 IO Manager) output.
The Watch-App-TraceLog command directs the internal application's output to the
console window in which the CLI is executed. If this command is not provisioned,
output will not be seen on the console even though a trace is turned on. To observe
the trace, the craftsperson must specify which application to observe (Call Manager
or SS7 IO Manager).
Command Prompt> Watch-App-TraceLog /id=CMAPP-ALL
The craftsperson can also direct the output into a specified file. The following
command sends all trace information from CMAPP-ALL to a specified output file.
The results are also displayed on the console.
Command Prompt> Watch-App-TraceLog /id=CMAPP-ALL /output=test
Output will continue to go to the console and (if enabled) to the specified file as long
as this command is allowed to run. The command will continuously prompt
"Terminate trace watch (Y|N)" and will not stop until the craftsperson selects "Y".
When the command is stopped, trace output to the console (and specified file) will
also stop. This will not stop the trace output from going to the internal application's
log file. To do this, execute the Disable-Trace command.

Part No. 600-0600-002 Page 7-7
7.2.7 Capture-App-TraceLog
The Capture-App-TraceLog command allows for the capturing of an application's
memory trace log without having to know the location of the file where the trace log
is stored.
Note Only applications with their trace type set to MEMORY will be captured.
Command Prompt> Capture-App-TraceLog /id=CMAPP-ALL /file=<file location

/keep=false
In the above example, the CMAPP-ALL application trace log will be captured and
the results of that capture will be stored in a specified location but the contents of
the MEMORY trace log within the application will not preserved during the capture
operation.
By default, a unique file name will be generated for each application being captured.
The generated file name is: logs//.mem.log.
The file specified is located on the machine running the specified application.
7.2.8 Retrieve-App-TraceLog
The Retrieve-App-TraceLog command retrieves an application's trace log to a fixed
known location.
The application’s trace log must first be captured by entering the

Capture-App-TraceLog command.
Command Prompt> Retrieve-App-TraceLog /id=CMAPP-ALL
In the above example, the CMAPP-ALL application trace log will be retrieved.

Page 7-8 Part No. 600-0600-002
7.3 Trace Output

The trace output always goes to the log file of the internal application (Call Manager
or SS7 IO Manager) that is in control of the trace. Optionally with the use of the
'Watch-App-TraceLog' the output can be directed to both the console where the CLI
is executed and a user specified file.
If an ISUP trace is enabled with any other trace and they are directed to the same
output (console or file) then the order of the entries may be out of sequence. This
occurs when two processes simultaneously send lines to the output; one is cached
while the other is being written. The cached process may contain earlier entries
than the last entries written by the other process. The file could later be sorted to
alleviate this issue.

Part No. 600-0600-002 Page 7-9

Page 7-10 Part No. 600-0600-002
C H A P T E R 8
Graphical User Interface
8.1 Introduction
The Compleat-200 system supports a web-browser Graphical User Interface (GUI)
to provide all Fault, Configuration, Accounting, Performance, and Security (FCAPS)
management functions that are required by the System Manager to operate,
administer, maintain, and provision (OAM&P) the system.
Access to the GUI is provided using Microsoft Internet Explorer version 6.
8.2 Launching the GUI

To start the GUI, point your browser to the SBC IP and System Manager port, as
shown in the following example:
http://127.0.0.1:28484
The IP address is the IP of the SBC running the System Manager. The port number
is always 28484.

Part No. 600-0600-002 Page 8-1
Chapter 8 Graphical User Interface
8.2.1 Logging In to the GUI

The following figure shows the login page with fields for your username and
password. This page displays when you first log into the system. It also displays
when you logout of the system, or if your session times out.
Figure 8-1 Login
To log into the Compleat-200 GUI, enter a username and password for a configured
administrator in the fields provided; then click OK.

Page 8-2 Part No. 600-0600-002
8.2.2 Home Page

The following figure shows the top-level Home page.
Figure 8-2 GUI Home Page

1. Config Page
The following figure shows the default Config page. The Config tab takes you to the
Configure page where you can configure any of the following Resources:
• Applications
• Audio
• Connection
• Device
• EndpointPool
• IN
• IS41
• MGCP
• Protocol
• Routing
• SS7
• Security

Part No. 600-0600-002 Page 8-3
• Services
• Statistics
• Throttle
• Tone
• Trace
• Translation
• VoIP
Each resource has submenus where you can click to configure the specific
parameters for that resource. For example, the Application resource contains the
following submenus:
• APIAPP
• CMAPP
• EXTAPP
• IOAPP
• PROTAP
• SMAPP
• SMONAPP
• SSPAPP

Page 8-4 Part No. 600-0600-002
Figure 8-3 Config Page
8.2.3 Status Page

The following figure shows the default Status page. The Status tab takes you to the
Status page where you can configure any of the following Resources:
• Alarms
• Apps
• Call Processing
• Cards
• Clocking
• Circuits
• SS7

Part No. 600-0600-002 Page 8-5
Figure 8-4 Status Page
8.2.4 Cut-thru Page

The following figure shows the default Cut-thru page. The Cut-thru tab takes you to
the Cut-thru page where you can enter CLI commands directly into the command
window, click Submit, and view the results in the Output window.

Page 8-6 Part No. 600-0600-002
Figure 8-5 Cut-thru Page
8.2.5 Statistics Page

The following figure shows an example Statistics page. The Statistics tab takes you
to the Statistics page where you can select a Statistic type and view the results.
You must Enter-StatisticPolicy and Enable-Statistic before viewing statistics

on the system.

Part No. 600-0600-002 Page 8-7
Figure 8-6 Statistics Page (Example)
The following figure shows a sample statistic report after selecting a statistic type
and clicking the Submit button.
Figure 8-7 Statistic Report (Example)

Page 8-8 Part No. 600-0600-002
8.2.6 Help Page

The following figure shows the default Help page. The Help tab takes you to the
Help page where you can access the following information:
• System Manager information
• Carrius Technologies contact information
• Carrius Technologies web page
• CLI Reference page
The CLI Reference page lists all of the available system commands, parameters,
and parameter definitions.
Figure 8-8 Help Page
8.2.7 GUI Permissions

The Compleat-200 system provides a GUI that enables a user to observe the
system but prevents that user from making changes outside of the allowable user
access level permissions. For a list of CLI User Access Levels, refer to Appendix A,
“CLI User Access Levels”.

Part No. 600-0600-002 Page 8-9

Page 8-10 Part No. 600-0600-002
A P P E N D I X A
CLI User Access Levels
Four access levels exist in all switches:

• Monitor— Has permission to view the configuration.
• Maintenance— Has permission to execute all commands but cannot create,

modify or delete user accounts.
• Administrator—Has permission to execute all commands and to set permission
levels based on user roles and groups
• Debug— Has permission to all administrator level commands and multiple
undocumented, unsupported and potentially destructive commands.
When you execute a command, perform command completion, or obtain context
sensitive help, the switch software allows the operation to progress if you have the
correct permission as specified in the description of the command. Refer to the
following table for a list of CLI command access levels. For additional
information/parameters, consult the HTML-based CLI documentation.
CLI Command Monitor Maintenance Administrator Debug

Ack-Alarm X X X X
Activate-SS7-Link X X X
Activate-SS7-LinkSet X X X
Activate-SwitchCard X X X X
AddTo-CAS-EndpointPool X X X
AddTo-CC-EndpointPool X X X
AddTo-ISUP-EndpointPool X X X
AddTo-PatternSet X X X
AddTo-PRI-EndpointPool X X X
AddTo-RouteList X X X
AddTo-RouteTable X X X
AddTo-SS7-CombinedLinkSet X X X
AddTo-SS7-LinkSet X X X
AddTo-Service-Group X X
AddTo-Translation-Sequence X X X
Table A-1 CLI Command Access Levels

Part No. 600-0600-002 Page A-1
Appendix A CLI User Access Levels
AddTo-WINAgent X X X
Allow-SS7-Subsystem X X X
Backup-DB X X X
Block-ISUP-Circuit X X X
Block-SS7-Link X X X
Capture-App-Tracelog X X X X
Clear-Alarm X X X
Clear-CMM-SEL X X X
Clear-CurrentStats X X X X
Compile X
Compile-File X
COT-DS0 X X X
COT-H110 X X X
COT-Loopback X X X
Deactivate-SS7-Link X X X
Deactivate-SS7-LinkSet X X X
Debug-App X
Detect-Board-Presence X X X
Disable-Alarm-Monitor X X X X
Disable-Statistics X X X
Disable-StatisticState X X X
Disable-Status_Line X X X X
Disable-Trace X X X
Display-CC-Stats X
ECMAMoode X
Enable-Alarm-Monitor X X X X
Enable-Statistics X X X
Enable-StatisticsState X X X
Enable-Status-Line X X X X
Enable-Trace X X X
Enter-APIProgram X X X
Enter-Audio X X X
Enter-CadencedTone X X X
Enter-CallManager X X X
Enter-CAS-EndpointPool X X X
Enter-CAS-Protocol X X X
Enter-CC-EndpointPool X X X
Enter-CMMCard X X X
Enter-CNAM-Service X X X
Enter-DigitPattern X X X
Table A-1 CLI Command Access Levels (continued)

Page A-2 Part No. 600-0600-002
Enter-EXTProgram X X X
Enter-GPCDevice X X X
Enter-H323-Element X X X
Enter-H323-Gateway X X X
Enter-IN-SCP X X X
Enter-IN-SRFServiceAgent X X X
Enter-IOCard X X X
Enter-IOManager X X X
Enter-ISUP-EndpointPool X X X
Enter-ISUP-SAP X X X
Enter-ManagementRoute X X X
Enter-MessageWaiting-Ser- X
vice
Enter-MGCP-CallAgent X X X
Enter-MGCP-Gateway X X X
Enter-MGCP-Terminal X X X
Enter-MonitorChannel X
Enter-MSC X X X
Enter-MWI-Service X X X
Enter-PatternSet X X X
Enter-PeriodicTone X X X
Enter-Permanent-Connection X X X
Enter-PRI-EndpointPool X X X
Enter-ProtectedApp X X X
Enter-RangeDetectedTone X X X
Enter-RouteList X X X
Enter-RouteTable X X X
Enter-SBCCard X X X
Enter-Service-Group X X X
Enter-Shelf X X X
Enter-SIP-Element X X X
Enter-SIP-UserAgent X X X
Enter-SS7-CombinedLinkSet X X X
Enter-SS7-Link X X X
Enter-SS7-LinkSet X X X
Enter-SS7-RouteSet X X X
Enter-SS7-SCCPNetwork X X X
Enter-SS7-SCCPRemoteSub- X X X
system
Enter-SS7-SCCPRoute X X X

Part No. 600-0600-002 Page A-3
Enter-SS7-SignalingPoint X X X
Enter-SS7-TCAPSubsystem X X X
Enter-SSPProgram X X X
Enter-StatisticPolicy X X X
Enter-Switch X X X
Enter-SwitchCard X X X
Enter-SystemManager X X X
Enter-SystemMonitor X X X
Enter-Threshold X X X
Enter-ThresholdPolicy X X X
Enter-Throttling-Policy X X X
Enter-Tone X X X
Enter-Trace-CallInformation X X X
Enter-Transfer-Profile X X
Enter-Transfer-Service X X X
Enter-Translation-Sequence X X X
Enter-User X X
Enter-WIN-Agent X X X
Exit X X X X
Help X X X X
Help-About X X X X
Help-Command X X X X
Help-Doc-HTML X X X X
Help-Offline X X X X
Help-Leaktool X
Help-Online X X X X
Include X X X X
Include-File X X X X
Inhibit-SS7-Link X X X
Load X
Load-Command X
Load-Patch X
Lock-App X X X
Lock-Card X X X
Lock-Chan X X X
Lock-Device X X X
Lock-DSP X X X
Lock-E1Span X X X
Lock-Shelf X X X
Lock-Span X X X

Page A-4 Part No. 600-0600-002
Lock-T1Span X X X
Login X X X X
Login-User X X X X
Logout X X X X
Logout-User X X X X
Modify-APIProgram X X X
Modify-App-Tracelog X
Modify-App X X X
Modify-Audio X X X
Modify-CadencedTone X X X
Modify-CAS-EndpointPool X X X
Modify-CAS-Protocol X X X
Modify-CC-EndpointPool X X X
Modify-CallManager X X X
Modify-Chan X X X
Modify-CNAM-Service X X X
Modify-DigitPattern X X X
Modify-DS3 X X X
Modify-DS3-Span X X
Modify-E1-Span X X X
Modify-E1Span X X X
Modify-EndpointPool X X X
Modify-EXTProgram X X X
Modify-H323-Element X X X
Modify-H323-Gateway X X X
Modify-IN-SCP X X X
Modify-IN-SRFServiceAgent X X X
Modify-IOCard X X X
Modify-IOManager X X X
Modify-ISUP-EndpointPool X X X
Modify-ISUP-SAP X X X
Modify-MGCP-CallAgent X X X
Modify-MGCP-Gateway X X X
Modify-MGCP-Terminal X X X
Modify-MSC X X X
Modify-MWI-Service X X X
Modify-PatternSet X X X
Modify-PeriodicTone X X X
Modify-PRI-EndpointPool X X X
Modify-RouteList X X X

Part No. 600-0600-002 Page A-5
Modify-RangeDetectedTone X X X
Modify-RouteTable X X X
Modify-Service-Group X X X
Modify-Shelf X X X
Modify-Shelf-Clock X X X
Modify-SIP-Element X X X
Modify-SIP-UserAgent X X X
Modify-SS7-CombinedLinkSet X X X
Modify-SS7-Link X X X
Modify-SS7-LinkSet X X X
Modify-SS7-RouteSet X X X
Modify-SS7-SCCPNetwork X X X
Modify-SS7-SCCPRemote- X X X
Subsystem
Modify-SS7-SCCPRoute X X X
Modify-SS7-SignalingPoint X X X
Modify-SS7-TCAPSubsystem X X X
Modify-StatisticPolicy X X X
Modify-Switch X X X
Modify-SystemManager X X X
Modify-SystemMonitor X X X
Modify-T1-Span X X
Modify-T1Span X X X
Modify-Threshold X X X
Modify-ThresholdPolicy X X X
Modify-Throttling-Policy X X X
Modify-Tone X X X
Modify-Trace X X X
Modify-Trace-CallInformation X X X
Modify-Transfer-Profile X X X
Modify-Transfer-Service X X X
Modify-User X X
Modify-WIN-Agent X X X
Nak-Alarm X X X X
Offline-Override X
Play-Audio X X X X
Prohibit-SS7-Subsystem X X X
Query-ISUP-Circuit X X X
Quit X X X X
Record-Audio X X X X

Page A-6 Part No. 600-0600-002
Remove-APIProgram X X X
Remove-Audio X X X
Remove-CadencedTone X X X
Remove-CallManager X X X
Remove-CAS-EndpointPool X X X
Remove-CAS-Protocol X X X
Remove-CC-EndpointPool X X X
Remove-CMMCard X X X
Remove-CNAM-Service X X X
Remove-DigitPattern X X X
Remove-EndpointPool X X X
Remove-EXTProgram X X X
Remove-GPCDevice X X X
Remove-H323-Element X X X
Remove-H323-Gateway X X X
Remove-IN-SCP X X X
Remove-IN-SRFServiceAgent X X X
Remove-IOCard X X X
Remove-IOManager X X X
Remove-ISUP-EndpointPool X X X
Remove-ISUP-SAP X X X
Remove-ManagementRoute X X X
Remove-MGCP-CallAgent X X X
Remove-MGCP-Gateway X X X
Remove-MGCP-Terminal X X X
Remove-MonitorChannel X X X
Remove-MSC X X X
Remove-MWI-Service X X X
Remove-PatternSet X X X
Remove-PeriodicTone X X X
Remove-Permanent-Connec- X X X
tion
Remove-PRI-EndpointPool X X X
Remove-ProtectedApp X X X
Remove-RangeDetectedTone X X X
Remove-RouteList X X X
Remove-RouteTable X X X
Remove-SBCCard X X X
Remove-Service-Group X X X
Remove-Shelf X X X

Part No. 600-0600-002 Page A-7
Remove-SIP-Element X X X
Remove-SIP-UserAgent X X X
Remove-SS7-CombinedLink- X X X
Set
Remove-SS7-Link X X X
Remove-SS7-LinkSet X X X
Remove-SS7-RouteSet X X X
Remove-SS7-SCCPNetwork X X X
Remove-SS7-SCCPRemote- X X X
Subsystem
Remove-SS7-SCCPRoute X X X
Remove-SS7-SignalingPoint X X X
Remove-SS7-TCAPSub- X X X
system
Remove-SSPProgram X X X
Remove-StatisticPolicy X X X
Remove-Switch X X X
Remove-SwitchCard X X X
Remove-SystemManager X X X
Remove-SystemMonitor X X X
Remove-Threshold X X X
Remove-ThresholdPolicy X X X
Remove-Throttling-Policy X X X
Remove-Tone X X X
Remove-Trace X X X
Remove-Trace-CallInforma- X X X
tion
Remove-Transfer-Profile X X X
Remove-Transfer-Service X X X
Remove-Transla- X X X
tion-Sequence
Remove-User X X
Remove-WIN-Agent X X X
RemoveFrom-CAS-Endpoint- X X X
Pool
RemoveFrom-CC-Endpoint- X X X
Pool
RemoveFrom-ISUP-Endpoint- X X X
Pool
RemoveFrom-PatternSet X X X

Page A-8 Part No. 600-0600-002
RemoveFrom-PRI-Endpoint- X X X
Pool
RemoveFrom-RouteList X X X
RemoveFrom-RouteTable X X X
RemoveFrom-Service-Group X X X
RemoveFrom-SS7-Com- X X X
binedLinkSet
RemoveFrom-SS7-LinkSet X X X
RemoveFrom-Transla- X X X
tion-Sequence
RemoveFrom-WinAgent X X X
Reset-Card X X X
Reset-Chan X X X
Reset-Device X X X
Reset-DSP X X X
Reset-E1Span X X X
Reset-ISUP-Circuit X X X
Reset-Shelf X X X
Reset-Span X X X
Reset-T1Span X X X
Retrieve-App-AlarmLog X X X X
Retrieve-App-CallLog X X X X
Retrieve-App-CommandLog X X X X
Retrieve-App-TraceLog X X X X
Set-Active-CMM X X X
Set-Slot-LED X X X
Set-Slot-Power X X X
Show-Alarm X X X X
Show-Alarm-History X X X X
Show-Alarms X X X X
Show-AlarmID X X X X
Show-APIProgram X X X X
Show-App X X X X
Show-App-CPU X
Show-App-DBVersion X
Show-App-IPC X
Show-App-Memory X
Show-App-TraceLog X X X X
Show-Audio X X X X
Show-Audio-Memory X X X X

Part No. 600-0600-002 Page A-9
Show-Audio-Stats X X X X
Show-CadencedTone X X X X
Show-CallManager X X X X
Show-Card X X X X
Show-CardType X X X X
Show-CAS-EndpointPool X X X X
Show-CASPool-Stats X X X X
Show-CASProtocol X X X X
Show-CC-Active X
Show-CC-EndpointPool X X X X
Show-CC-Stats X X
Show-Chan X X X X
Show-Chan-Stats X X X X
Show-ClearChan- X X X X
nelPool-Stats
Show-CMMCard X X X X
Show-CMMCardType X X X X
Show-CNAM-Service X X X X
Show-Conf X X X X
Show-Conn X
Show-Connections X
Show-CurrentStats X X X X
Show-Device X X X X
Show-DigitPattern X X X X
Show-DS3 X X X X
Show-DS3-Span X X X X
Show-DSP X X X X
Show-E1Span X X X X
Show-EndpointPool X X X X
Show-Endpoint-Stats X X X X
Show-Endpoint-Status X X X X
Show-EXTProgram X X X X
Show-GPCDevice X X X X
Show-H323-Element X X X X
Show-H323-Gateway X X X X
Show-H323-Stats X X X X
Show-IN-SCP X X X X
Show-IN-SRFServiceAgent X X X X
Show-INAP-Stats X X X X
Show-IOCard X X X X

Page A-10 Part No. 600-0600-002
Show-IOCardType X X X X
Show-IOManager X X X X
Show-ISUPPool-Stats X X X X
Show-ISUP-EndpointPool X
Show-ISUP-SAP X X X X
Show-ISUPSAP-Stats X X X X
Show-License-Limits X X X X
Show-Management Route X X X X
Show-MGCP-CallAgent X X X X
Show-MGCP-Gateway X X X X
show-MGCP-Terminal X X X X
Show-MSC X X X X
Show-MonitorChannel X X X X
Show-MWI-Service X X X X
Show-PatternSet X X X X
Show-PeriodicTone X X X X
Show-Permanent-Connection X X X X
Show-PRI-EndpointPool X X X X
Show-PRI-EndpointPool-Sta- X X X X
tus
Show-PRIPool-Stats X X X X
Show-Proc-CPU X
Show-ProtectedApp X X X X
Show-RangeDetectedTone X X X X
Show-RouteList X X X X
Show-RouteTable X X X X
Show-SBCCard X X X X
Show-SBCCardType X X X X
Show-SCCP-Stats X X X X
Show-Service-Group X X X X
Show-Shelf X X X X
Show-Shelf-Clock X X X X
Show-Shelf-SlotMap X X X X
Show-ShelfType X X X X
Show-SIP-Element X X X X
Show-SIPElement-Stats X X X X
Show-SIP-Stats X X X X
Show-SIP-UserAgent X X X X
Show-Span X X X X
Show-Span-Stats X X X X

Part No. 600-0600-002 Page A-11
Show-SS7-CombinedLinkSet X X X X
Show-SS7-Link X X X X
Show-SS7-Link-Stats X X X X
Show-SS7-Link-Status X X X X
Show-SS7-LinkSet X X X X
Show-SS7-LinkSet-Stats X X X X
Show-SS7-LinkSet-Status X X X X
Show-SS7-PointCode-Status X
Show-SS7-RouteSet X X X X
Show-SS7-RouteSet-Stats X X X X
Show-SS7-SCCPNetwork X X X X
Show-SS7-SCCPRemoteSub- X X X X
system
Show-SS7-SCCPRoute X X X X
Show-SS7-SignalingPoint X X X X
Show-SS7Subsystem-Status X X X X
Show-SS7-TCAPSubsystem X X X X
Show-SSPProgram X X X X
Show-StatisticPolicy X X X X
Show-StatisticState X X X X
Show-StatisticType X X X X
Show-Stats X X X X
Show-Switch X X X X
Show-SwitchCard X X X X
Show-SwitchCardType X X X X
Show-SystemManager X X X X
Show-SystemMonitor X X X X
Show-T1Span X X X X
Show-TCAP-Stats X X X X
Show-Threshold X X X X
Show-ThresholdPolicy X X X X
Show-Throttling-Policy X X X X
Show-Tone X X X X
Show-Trace X X X
Show-Trace-CallInformation X X X X
Show-Transfer-Profile X X X X
Show-Transfer-Service X X X X
Show-Translation-Sequence X X X X
Show-User X X X X
Show-User-Login X X X X

Page A-12 Part No. 600-0600-002
Show-WIN-Agent X X X X
Show-WIN-Stats X X X X
Shutdown-App X X X
Shutdown-Card X X X
Shutdown-Chan X X X
Shutdown-Device X X X
Shutdown-DSP X X X
Shutdown-E1Span X X X
Shutdown-Shelf X X X
Shutdown-Span X X X
Shutdown-T1Span X X X
Start-Test-Tone X X X
Status-SS7-Link X X X X
Status-SS7-LinkSet X X X X
Status-SS7-RouteSet X X X X
Stop-Test-Tone X X X
SWitch-DChannel X
Test-Permanent-Connection X X X
Trace-On-CC X
Unblock-ISUP-Circuit X X X
Unblock-SS7-Link X X X
Uninhibit-SS7-Link X X X
Unlock-App X X X
Unlock-Card X X X
Unlock-Chan X X X
Unlock-Device X X X
Unlock-DSP X X X
Unlock-E1Span X X X
Unlock-Shelf X X X
Unlock-Span X X X
Unlock-T1Span X X X
Validate-ISUP-Circuit X X X
VRPLMode X
Watch-App-TraceLog X X X
x X X X X

Part No. 600-0600-002 Page A-13

Page A-14 Part No. 600-0600-002
A P P E N D I X B
System-Provisioned Tones
The following table contains the supported default provisioned tones.
Tone ID Frequency 1 Frequency 2

TONE-0-DTMF_0 951 1336
TONE-1-DTMF_1 697 1209
TONE-2-DTMF_2 697 1336
TONE-3-DTMF_3 697 1477
TONE-4-DTMF_4 770 1209
TONE-5-DTMF_5 770 1336
TONE-6-DTMF_6 770 1477
TONE-7-DTMF_7 852 1209
TONE-8-DTMF_8 852 1336
TONE-9-DTMF_9 852 1477
TONE-10-DTMF_STAR 951 1209
TONE-11-DTMF_POUND 951 1477
TONE-12-DTMF_A 697 1633
TONE-13-DTMF_B 770 1633
TONE-14-DTMF_C 852 1633
TONE-15-DTMF_D 951 1633
TONE-16-MF_0 1300 1500
TONE-17-MF_1 700 900
TONE-18-MF_2 700 1100
TONE-19-MF_3 900 1100
TONE-20-MF_4 700 1300
TONE-21-MF_5 900 1300
TONE-22-MF_6 1100 1300
TONE-23-MF_7 700 1500
TONE-24-MF_8 900 1500
TONE-25-MF_9 1100 1500
TONE-26-MF_KP 1100 1700
Table B-1 Default Provisioned Tone Settings

Part No. 600-0600-002 Page B-1
Appendix B System-Provisioned Tones
TONE-27-MF_ST 1500 1700

TONE-28-MF_ST1 900 1700
TONE-29-MF_ST2 1300 1700
TONE-30-MF_ST3 700 1700
TONE-31-DIAL_TONE_NA 350 440
TONE-32-RINGBACK_TONE_NA 440 480
TONE-33-BUSY_TONE_NA 620 480
TONE-34-REORDER_TONE_NA 620 480
Table B-1 Default Provisioned Tone Settings

Page B-2 Part No. 600-0600-002
A P P E N D I X C
Pre-Recorded Announcements
The following list is the default provisioning for the Carrius supplied pre-recorded
announcements or voice prompts.
$notAvailable$.wav
allCircuitsBusy.wav
and.wav
bongTone.wav
calledBack.wav
callFailure.wav
callService.wav
cardExpired.wav
cent.wav
cents.wav
dollar.wav
dollars.wav
eight.wav
eighteen.wav
eighty.wav
eleven.wav
enterCardNumber.wav
enterDestNumber.wav
enterPhoneNumber.wav
enterPinNumber.wav
facilityTrouble.wav
fifteen.wav
fifty.wav
five.wav
followedByPound.wav
followedByStar.wav
forty.wav
Table C-1 Default Pre-Recorded Announcements

Part No. 600-0600-002 Page C-1
Appendix C Pre-Recorded Announcements
four.wav
fourteen.wav
goodbye.wav
hello.wav
iLecFacilityTrouble.wav
iLecTrouble.wav
invalidCardNumber.wav
invalidPhoneNumber.wav
invalidPinNumber.wav
million.wav
millions.wav
minute.wav
minutes.wav
nine.wav
nineteen.wav
ninety.wav
no911.wav
one.wav
oneHundred.wav
oneMinuteRemains.wav
oneThousand.wav
pagerCue.wav
pressOneOrTwo.wav
pressOneToCall.wav
pressPoundForDisconnect.wav
receiverOffHook.wav
recordUpdated.wav
remaining.wav
routingFailure.wav
second.wav
seconds.wav
seven.wav
seventeen.wav
seventy.wav
sitNoCircuit.wav
sitOperatorIntercept.wav
sitSystemBusy.wav
sitVacantCircuit.wav
six.wav
sixteen.wav
Table C-1 Default Pre-Recorded Announcements (continued)

Page C-2 Part No. 600-0600-002
sixty.wav
ten.wav
thirteen.wav
thirty.wav
three.wav
twelve.wav
twenty.wav
two.wav
twoMinutesRemain.wav
unit.wav
units.wav
youHave.wav
yourBalanceIs.wav
yourNumberIs.wav
zero.wav
Table C-1 Default Pre-Recorded Announcements (continued)

Part No. 600-0600-002 Page C-3

Page C-4 Part No. 600-0600-002
A P P E N D I X D
Alarm Severity Table
Refer to the Compleat-200 Troubleshooting Guide for a list of alarms, alarm

severity, and suggested troubleshooting steps to clear the alarm.

Part No. 600-0600-002 Page D-1
Appendix D Alarm Severity Table

Page D-2 Part No. 600-0600-002
A P P E N D I X E
Reporting Statistics
Refer to the Compleat-200 Troubleshooting Guide for more information on

reporting statistics.

Part No. 600-0600-002 Page E-1
Appendix E Reporting Statistics

Page E-2 Part No. 600-0600-002
A P P E N D I X F
CLI Keywords and Parameters
The following table contains a list of the CLI keywords and parameters. For a
complete list of all CLI keywords and parameters, consult the HTML-based CLI
documentation.
Keyword Parameter
Ack Acknowledge alarms
Syntax: Ack-Alarm
Activate Activate an SS7 link or linkset
Syntax: Activate (SS7-Link | SS7-LinkSet|SwitchCard)
AddTo Add resources to an existing element
Syntax: AddTo (CAS-EndPointPool | CC-EndPointPool |
ISUP-EndPointPool | Patternset | PRI-EndPointPool | RouteList |
RouteTable | Service-Group | SS7-CombinedLinkSet | SS7-LinkSet
| Translation-Sequence | WINAgent)
Allow Allow an SS7 subsystem
Syntax: Allow-SS7-Subsystem
Backup Backup the database
Syntax: Backup-DB
Block Block a channel or link
Syntax: Block (ISUP-Circuit | SS7-Link)
Capture Allow for the capturing of an application's memory trace log
Syntax: Capture-App-TraceLog
Clear Clear an active alarm, events from the CMM System Event Log, or
current statistics from a resource
Syntax: Clear (Alarm | CMM-SEL | CurrentStats)
COT Run a DSO, Loobback or H110 continuity test
Syntax: COT (DSO | H110 | Loopback)
Deactivate Deactivates an SS7 link or linkset
Syntax: Deactivate (SS7-Link | SS7-LinkSet)
Detect Detects the presence of a board in a selected slot
Syntax: Detect-Board-Presence
Table F-1 CLI Keywords and Parameters

Part No. 600-0600-002 Page F-1
Appendix F CLI Keywords and Parameters
Disable Disable a function

Syntax: Disable (Alarm-Monitor | Statistics | StatisticState | Sta-
tus-Line | Trace)
Enable Enable a resource
Syntax: Enable (Alarm-Monitor | Statistics| StatisticState | Sta-
tus-Line | Trace)
Enter Create a new resource
Syntax: Enter (APIProgram | Audio | CadencedTone | CallManager
| CAS-EndPointPool | CAS-Protocol | CC-EndPointPool |
CMMCard | CNAM-Service | DigitPattern | EXTProgram | GPCDe-
vice | H323-Element | H323-Gateway | IN-SCP | IN-SRFService-
Agent | IOCard | IOManager | ISUP-EndPointPool | ISUP-SAP |
ManagementRoute | ManagementRoute | MGCP-CallAgent |
MGCP-Gateway | MGCP-Terminal | MSC | MWI-Service | Pat-
ternSet | PeriodicTone | Permanent-Connection | PRI-EndPoint-
Pool | ProtectedApp | RangeDetectedTone | RouteList |
RouteTable | SBCCard | Service-Group | Shelf | SIP-Element |
SIP-UserAgent | SS7-CombinedLinkSet | SS7-Link | SS7-LinkSet |
SS7-RouteSet | SS7-SCCPNetwork | SS7-SCCPRemoteSub-
system | SS7-SCCPRoute | SS7-SignalingPoint | SS7-TCAPSub-
system | SSPProgram | StatisticPolicy | Switch | SwitchCard |
SystemManager | SystemMonitor | Threshold | ThresholdPolicy |
Throttling-Policy | Tone | Trace-CallInformation | Transfer-Profile |
Transfer-Service | Translation-Sequence | User | WIN-Agent)
Exit Terminate the current shell
Syntax: Exit
Help Provide help information
Syntax: Help (About | Command | Doc-HTML | Offline | Online)
Include Include a file into this shell
Syntax: Include (File)
Inhibit Inhibit an SS7 link
Syntax: Inhibit-SS7-Link
Lock Lock a resource
Syntax: Lock (App | Card | Chan | Device | DSP | E1Span | Shelf |
Span | T1Span)
Login Login as the specified user
Syntax: Login (User)
Logout Log off the current user
Syntax: Logout (User)

Page F-2 Part No. 600-0600-002
Modify Modify an existing resource

Syntax: Modify (APIProgram | APP | Audio | CadencedTone | Call-
Manager | CAS-EndPointPool | CAS-Protocol | CC-EndPointPool |
Chan | CNAM-Service | DigitPattern | DS3 | DS3-Span | E1-Span |
EndPointPool | EXTProgram | H323-Element | H323-Gateway |
IN-SCP | IN-SRFServiceAgent | IOCard | IOManager | ISUP-End-
PointPool | ISUP-SAP | MGCP-CallAgent | MGCP-Gateway |
MGCP-Terminal | MSC | MWI-Service | PatternSet | PeriodicTone |
PRI-EndPointPool | RangeDetectedTone | RouteList | RouteTable |
Service-Group | Shelf | Shelf-Clock | SIP-Element | SIP-UserAgent
| SS7-CombinedLinkSet | SS7-Link | SS7-LinkSet | SS7-RouteSet |
SS7-SCCPNetwork | SS7-SCCPRemoteSubsystem |
SS7-SCCPRoute | SS7-SignalingPoint | SS7-TCAPSubsystem |
StatisticPolicy | Switch | SystemManager | SystemMonitor |
T1-Span | Threshold | ThresholdPolicy | Throttling-Policy | Tone |
Trace | Trace-CallInformation | Transfer-Profile | Transfer-Service |
User | WIN-Agent)
Nak Negative acknowledge alarms
Syntax: Nak-Alarm
Play Play audio on a specific endpoint
Syntax: Play-Audio
Prohibit Prohibit an SS7 subsystem
Syntax: Prohibit-SS7-Subsystem
Query Query the specified circuit/s
Syntax: Query_ISUP-Circuit
Quit Terminate the current shell
Syntax: Quit
Record Record audio from a specific endpoint
Syntax: Record-Audio

Part No. 600-0600-002 Page F-3
Remove Remove a resource

Syntax: Remove (APIProgram | Audio | CadencedTone | CallMan-
ager | CAS-EndPointPool | CAS-Protocol | CC-EndPointPool |
CMMCard | CNAM-Service | DigitPattern | EXTProgram | GPCDe-
vice | H323-Element | H323-Gateway | IN-SCP | IN-SRFService-
Agent | IOCard | IOManager | ISUP-EndPointPool | ISUP-SAP |
ManagementRoute | MGCP-CallAgent | MGCP-Gateway |
MGCP-Terminal | MSC | | MWI-Service | MonitorChannel | |
PRI-EndPointPool | PatternSet | PeriodicTone | Permanent-Con-
nection | ProtectedApp | RangeDetectedTone | RouteList |
RouteTable | SBCCard | Service-Group | SIP-Element | SIP-User-
Agent | SS7-CombinedLinkSet | SS7-Link | SS7-LinkSet |
SS7-RouteSet | SS7-SCCPNetwork | SS7-SCCPRemoteSub-
system | SS7-SCCPRoute | SS7-SignalingPoint | SS7-TCAPSub-
system | SSPProgram | Shelf | StatisticPolicy | Switch | SwitchCard
| SystemManager | SystemMonitor | Throttling-Policy | Threshold |
ThresholdPolicy | Throttling-Policy | Tone | Trace-CallInformation |
Transfer-Service | Translation-Sequence | User | WIN-Agent)
RemoveFrom Remove a parameter from an existing resource
Syntax: RemoveFrom (CAS-EndPointPool | CC-EndPointPool |
ISUP-EndPointPool | PatternSet | PRI-EndPointPool | RouteList |
RouteTable | Service-Group | SS7-CombinedLinkSet | SS7-LinkSet
| Translation-Sequence | WINAgent)
Reset Reset a resource
Syntax: Reset (Card | Chan | Device | DSP | E1Span | ISUP-Circuit
| Shelf | Span | T1Span |
Retrieve Retrieves a resource to a fixed known location
Syntax: Retrieve (App-AlarmLog | App-CallLog | App-Command-
Log | App-TraceLog
Set Sets power or LEDs on a slot or set the active CMM
Syntax: Set (Active-CMM | Slot-LED | Slot-Power)

Page F-4 Part No. 600-0600-002
Show Displays existing resources

Syntax: Show (Alarm | Alarm-History | AlarmID | Alarms | APIPro-
gram | App | App-TraceLog | Audio | Audio-Memory | Audio-Stats |
CadencedTone | CallManager | Card | CardType | CAS-EndPoint-
Pool | CAS-Protocol | CASPool-Stats | CC-EndPointPool |
CC-Stats | Chan | Chan-Stats | ClearChannelPool-Stats |
CMMCard | CMMCardType | CNAM-Service | Conf | CurrentStats |
Device | DigitPattern | DS3 | DS3-Span | DSP | E1Span | EndPoint-
Stats | EndPointStatus | EndPointPool | EXTProgram | GPCDevice
| H323-Element | H323-Gateway | H323-Stats | IN-SCP | IN-SRF-
ServiceAgent | INAP-Stats | IOCard | IOCardType | IOManager |
ISUP-SAP | ISUPPool-Stats | ISUPSAP-Stats | License-Limits |
ManagementRoute | MGCP-CallAgent | MGCP-Gateway |
MGCP-Terminal | MonitorChannel | MSC | MWI-Service | Pat-
ternSet | PeriodicTone | Permanent-Connection | PRI-EndPoint-
Pool | PRI-EndPointPool-Status | PRIPool-Stats | | ProtectedApp |
RangeDetectedTone | RouteList | RouteTable | SBCCard | SBC-
CardType | SCCP-Stats | Service-Group | Shelf | Shelf-Clock |
Shelf-SlotMap | ShelfType | SIP-Element | SIP-Stats | SIP-User-
Agent | SIPElement-Stats | Span | Span-Stats | SS7-Com-
binedLinkSet | SS7-Link | SS7-Link_Stats | SS7-Link-Status |
SS7-LinkSet | SS7-LinkSet-Stats | SS7-LinkSet-Status | SS7-Rou-
teSet | SS7-RouteSet-Stats | SS7-SCCPNetwork | SS7-SCCPRe-
moteSubsystem | SS7-SCCPRoute | SS7-SignalingPoint |
SS7-Subsystem-Status | SS7-TCAPSubsystem | SSPProgram |
StatisticPolicy | Statistic-State | Statistic-Type | Stats | Switch |
SwitchCard | SwitchCardType | SystemManager | SystemMonitor |
T1Span | TCAP-Stats | Threshold | ThresholdPolicy | Throt-
tling-Policy | Tone | Trace | Trace-CallInformation | Transfer-Ser-
vice | Translation-Sequence | User | User-Login | WIN-Agent |
WIN-Stats)
Shutdown Administratively shut down a resource
Syntax: Shutdown (APP | Card | Chan | Device | DSP | E1Span |
Shelf | Span | T1Span)
Switch Switch D-channel
Syntax: Switch-Dchannel
Start Starts a test tone on a DS0
Syntax: Start-Test-Tone
Status Displays SS7 Status
Syntax: Status (SS7-Link | SS7-LinkSet | SS7-RouteSet)
Stop Stops a test tone on a DS0
Syntax: Stop-Test-Tone
Test Test a permanent connection
Syntax: Test-Permanent-Connection
Unblock Unblock a channel or link
Syntax: Unblock (ISUP-Circuit | SS7-Link)

Part No. 600-0600-002 Page F-5
Uninhibit Uninhibit an SS7 link

Syntax: Uninhibit-SS7-Link
Unlock Unlock a resource
Syntax: Unlock (App | Card | Chan | Device | DSP | E1Span | Shelf
| Span | T1Span)
Validate Validate the specified circuit/s
Syntax: Validate-ISUP-Circuit
Watch Allows the user to watch other application(s) trace log(s)
Syntax: Watch-App-TraceLog
x Terminate the current shell
Syntax: x

Page F-6 Part No. 600-0600-002

Oam&p PDF

Transféré par

Informations du document

Description originale:

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Oam&p PDF

Transféré par

Droits d'auteur :

Formats disponibles

Compleat-200 Operations, Administration,

Maintenance, and Provisioning Guide

Carrius Technologies, Inc.

Preface ............................................................................................................................................. P-1

Release 6.0 Issue 5 Compleat-200 OAM&P Guide

2.3.3 Inter-Chassis Communication Paths...................................................................... 2-14

Compleat-200 OAM&P Guide Release 6.0 Issue 5

2.13 VoIP Protocol Configuration .......................................................................................2-69

Release 6.0 Issue 5 Compleat-200 OAM&P Guide

Chapter 3 Database Backup and Restore ............................................................................. 3-1

Compleat-200 OAM&P Guide Release 6.0 Issue 5

Chapter 8 Graphical User Interface.........................................................................................8-1

Appendix A CLI User Access Levels ................................................................................ A-1

Appendix B System-Provisioned Tones........................................................................... B-1

Appendix C Pre-Recorded Announcements .................................................................... C-1

Appendix D Alarm Severity Table ..................................................................................... D-1

Appendix E Reporting Statistics ....................................................................................... E-1

Appendix F CLI Keywords and Parameters ..................................................................... F-1

Release 6.0 Issue 5 Compleat-200 OAM&P Guide

Compleat-200 OAM&P Guide Release 6.0 Issue 5

Release 6.0 Issue 5 Compleat-200 OAM&P Guide

TIP indicates a solution that may help resolve a problem.

DLP indicates a path to a Detailed Level Procedure (DLP).

Compleat-200 OAM&P Guide Release 6.0 Issue 5

NOTE indicates helpful suggestions or useful background information.

Release 6.0 Issue 5 Compleat-200 OAM&P Guide

Compleat-200 OAM&P Guide Release 6.0 Issue 5

1.2 CLI Command Help Files

1.3 Command Usage Hints

Command Prompt> Show SystemManager /verbose

Release 6.0 Issue 5 Compleat-200 OAM&P Guide

Compleat-200 OAM&P Guide Release 6.0 Issue 5

1.3.1 Parameter Prompting

Table 1-1 Parameter Prompting Summary

Release 6.0 Issue 5 Compleat-200 OAM&P Guide

1.4 Input Provisioning Flow

1.5 CLI Script Operation

1.6 CLI Navigation

1.6.1 Login and Logout

Compleat-200 OAM&P Guide Release 6.0 Issue 5

Enter the following command to display the user accounts:

Command Prompt> Show-User

Command Prompt> Logout

1.6.2 Issue Commands

Figure 1-1 Sample CLI Command Output

Release 6.0 Issue 5 Compleat-200 OAM&P Guide

1.6.3 CLI Keywords and Parameters

1.6.4 Access Help

Command Prompt> Help Enter-SystemManager /options

Command Prompt> Help Enter-SystemManager /parameter=<parameter ID>

Compleat-200 OAM&P Guide Release 6.0 Issue 5

1.6.5 Hot Keys

Table 1-2 CLI Hot Keys

1.6.6 Command Completion Feature

Command Prompt> Show-T1Sp /id=1-6-1

Command Prompt> S-P-E

Command Prompt> Show-PRI-E

Command Prompt> Load-Audio

Command Prompt> Lock-App

Release 6.0 Issue 5 Compleat-200 OAM&P Guide

1.7 Log Files

1.8 Facility/Port Number Formats