Documente Academic
Documente Profesional
Documente Cultură
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
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.
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
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
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.
• 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.
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?
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 (>>).
ID PERMISSIONS
---------------------- -----------------------
* guest DEBUG
admin ADMINISTRATOR
An asterisk precedes the name of the user currently logged in.
Enter the following command to logout:
Refer to Section 1.10 for information on eclipsing the default user names.
• 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.
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
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:
You must type the shortest non-ambiguous form of the command for it to resolve
properly. Consider the following commands:
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.
or
or
or
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:
The following, however, does not work, because a numeric value has been
specified in the creation of the pool:
If the endpoint pool had been specified with only a name and not a number, the
above command would work.
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.
ID PERMISSIONS
---------------------- -----------------------
* guest MONITOR
admin ADMINISTRATOR
ted ADMINISTRATOR
DLP
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.
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).
The Shelf DALLAS is unlocked and the cards, spans or channels that reside on that
shelf are locked.
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
ADMIN
ID CARD TYPE STATE IP ADDRESS(ES)
---------- --------- ------- --------------
IOCARD-1-1 AC_TP1610 LOCKED 192.201.1.1
The show Card command reveals that the card is now in the unlocked state.
ADMIN
ID CARD TYPE STATE IP ADDRESS(ES)
---------- --------- ------- ---------------
IOCARD-1-1 AC_TP1610 UNLOCKED 192.201.1.1
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.
Example 4:
With shelf, card, span and channel unlocked when the channel is locked.
The shelf, card and span remain unlocked.
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:
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
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:
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.
DLP
DLP
DLP
DLP
DLP
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.
For additional information/parameters, consult the HTML-based CLI documentation
or issue the following CLI command on a running system or simulator:
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.
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.
For additional information/parameters, consult the HTML-based CLI documentation
or issue the following CLI command on a running system or simulator:
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.
DLP
Call Routing
DLP
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.
Examples on usage and the available parameters can be found in the online help
or the HTML-based CLI documentation.
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
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.
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.
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
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.
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.
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
Modify-CASEndpointPool “CASPool-2-1-1” /algorithm=ROUND_ROBIN
Modify-CASEndpointPool “CASPool-1-1-2” /algorithm=ROUND_ROBIN
Modify-CASEndpointPool “CASPool-2-1-2” /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.
Originator/Round-Robin/First Available
Assume that the following modifications have been made to the example
configuration:
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.
Originator/Round-Robin/Round-Robin
Assume that the following modifications have been made to the example
configuration:
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.
Master/First Available/Round-Robin
Assume that the following modifications have been made to the example
configuration:
Master/Round-Robin/First Available
Assume that the following modifications have been made to the example
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.
Master/Round-Robin/Round-Robin
Assume that the following modifications have been made to the example
configuration:
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.
Least Active
Assume that the following modifications have been made to the example
configuration:
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.
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:
To select the next route-choice, you must provision the ROUTELIST with at least
two route choices (resources).
Call Routing
DLP
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).
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.
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.
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)
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.
Step 1 Call arrives from a SIP element (Party A) to the Carrius switch. Signaling is SIP over
IP.
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).
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.
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.
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.
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, H323).
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.
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.
• 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.
The Re-invite requesting the call hold may alternatively be indicated via
“a=sendonly” as indicated in the diagram below.
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.
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.
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)
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.
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.
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
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.
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.
Table 2-4 Port and Offset Mapping of Single IP address for 672-channel DSP Cards and
Modules
If 480-channel DSP cards or 16-span T1/E1 cards are equipped, the mappings
would look like Table 2-5.
Table 2-5 Port and Offset Mapping of Single IP address for 480-channel DSP Cards and
Modules
If 240-channel DSP cards or 8-span T1/E1 cards are equipped, the mappings would
look like Table 2-6.
Table 2-6 Port and Offset Mapping of Single IP address for 240-channel DSP Cards and
Modules
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.
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.
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.
Table 2-7 Port and Offset Mapping of Multiple IP addresses for 672-channel DSP Cards and
Modules
Table 2-8 Port and Offset Mapping of Multiple IP addresses for 480-channel DSP Cards and
Modules
DLP
• Enter-SystemMonitor
DLP
• Enter-CallManager
DLP
• Enter-IOManager
DLP
• Enter-APIProgram
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.
All Applications
The following options exist for all applications:
• Trace log:
• VR_LOGSIZE=unlimited |<size limit in bytes>
• VR_LOGTYPE=file | memory
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>
Command Prompt> <program> -n <name> -p <port> [-bsxvVh] [-c <command>] [-i >>
[@|#]<file>] [[@|#]<file> [[@|#]<file> ...]]
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
• 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.
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
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
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
DLP
Refer to the following DLP to provision the SIP Element.
DLP
Refer to the following DLP to provision the SIP User Agent.
DLP
Additional details and mandatory parameters for related SIP commands for
creation, modification, and removal can be found in the accompanying
HTML-based CLI documentation.
The ladder diagrams are examples of SIP and API message flows.
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
DLP
Additional related H.323 commands for creation, modification and removal can be
found in the accompanying HTML-based CLI documentation.
DLP
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
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
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.
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.
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.
DLP
Task CLI
Create a Permanent Connection Enter-Permanent-Connection
Modify a Permanent Connection Modify-Permanent-Connection
Delete a Permanent Connection Remove-Permanent-Connection
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
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.
Examples on usage and the available parameters can be found in the online help
or the HTML-based CLI documentation.
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.
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.
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.
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.
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.
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.
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.
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.
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".
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”.
DLP
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.
Verify:
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
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)
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.
@030513144822@ true
@030513144824@
@030513144824@ >
-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-EOF-
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.
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
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.
Standard MIBs
• RFC1213-MIB
• IF-MIB
• BRIDGE-MIB
• SNMPv2-MIB
• DOT12-IF-MIB
• EtherLike-MIB
• IANAifType-MIB
• SNMP-FRAMEWORK-MIB
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
Compleat-200 system.
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.
1610 IO Card
SBC Card
Patch Panel
signaling links
Distand-End Distand-End
Switch Switch
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
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
DLP
DLP
DLP
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
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.
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”.
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
Compleat-200 system.
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.
DLP
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.
DLP
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.
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.
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.
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.
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.
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)
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.
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.
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.
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.
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
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
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
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
DLP
DLP
DLP
DLP
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.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
• 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.
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
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.
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 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.
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.
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.
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.
In the above example, the CMAPP-ALL application trace log will be retrieved.
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.
The IP address is the IP of the SBC running the System Manager. The port number
is always 28484.
To log into the Compleat-200 GUI, enter a username and password for a configured
administrator in the fields provided; then click OK.
• 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
The following figure shows a sample statistic report after selecting a statistic type
and clicking the Submit button.
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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