Command Line Interface Guide

3HP700021015GUZZA

Revision 3.4
Software Release 3.0

Alcatel-Lucent

Copyright 2006 Alcatel-Lucent, Inc.

The information contained in this document is subject to change. Changes will occur only in accordance
with formal change control procedures.
This document contains proprietary information, which is protected by copyright laws. All rights are
reserved. No part of this document may be photocopied, reproduced or translated to another language or
program language without prior written consent of Alcatel-Lucent, Inc.
Alcatel-Lucent, Inc. has prepared the information contained herein, solely for use by Alcatel-Lucent
employees, agents and customers. Dissemination of the information and/or concepts contained herein to
other parties is prohibited without Alcatel-Lucent's prior written consent.

Alcatel-Lucent
Command Line Interface Guide

About This Document

3HP700021015GUZZA

About This Document

Purpose
The Command Line Interface Guide document explains how to use the Command Line
Interface (CLI) to maintain softswitch configuration parameters.

Revision History
Date

Revision

Author

Comments

12-19-03

1.0

D. McFarland

Initial draft

01/01/06

2.0

C. Worsham

Updated to add information about mobility parameters,

translation and routing parameters, and to add new
BICC and CAS trunk information. Added error
messages and special commands sections.

04/04/06

3.0

A.Chang

Corrections to add omitted information. Minor updates

to correct incorrect wording.

07/14/2006

3.1

R. Musgrave

Updated EMERGENCYCALL.

07/25/2006

3.2

R. Musgrave

Made edits.

11/07/06

3.3

C. Worsham

Added Acces Type field definition for MSC MCC/

MNC section to accommodate new UMA LAC routing
capability.

11/23/2006

3.4

C. Worsham

Fixed error in Load command.

1/23/07
Revision 3.4

Proprietary and Confidential

Software Release 3.0

Page iii
Volume VII

Alcatel-Lucent
Provisioning Office Parameters

3HP700021003GUZZA

Table of Contents
SECTION 1. CLI OVERVIEW .......................................................................................... 1-1
1.1. INTRODUCTION ..................................................................................................... 1-1
1.2. ARCHITECTURE ..................................................................................................... 1-1
1.3. COMMAND LINE AND BATCH PROVISIONING ....................................................... 1-2
1.3.1. Launching the CLI ........................................................................................ 1-2
1.3.2. Creating and Loading Batch Files ................................................................ 1-5
1.4. CONVENTIONS USED IN THIS MANUAL ................................................................ 1-6
1.5. CLI CONTEXT HIERARCHY .................................................................................. 1-7
SECTION 2. CLI COMMANDS REFERENCE ................................................................... 2-1
2.1. ADD ...................................................................................................................... 2-1
2.2. CD ........................................................................................................................ 2-2
2.3. CHANGEPWD ......................................................................................................... 2-3
2.4. DEL ...................................................................................................................... 2-4
2.5. ECHO .................................................................................................................... 2-5
2.6. GETALARM ........................................................................................................... 2-6
2.7. GETEVENT ........................................................................................................... 2-7
2.8. HELP ..................................................................................................................... 2-8
2.9. HISTORY ............................................................................................................. 2-11
2.10. LIST .................................................................................................................. 2-12
2.11. LISTALIAS ......................................................................................................... 2-13
2.12. MOD ................................................................................................................ 2-14
2.13. PAUSE .............................................................................................................. 2-15
2.14. QUERY ............................................................................................................. 2-16
2.15. SENDMSG .......................................................................................................... 2-17
2.16. SET ................................................................................................................... 2-18
2.17. SETALIAS .......................................................................................................... 2-18
2.18. SETCATEGORY .................................................................................................. 2-19
2.19. SETSEVERITY .................................................................................................... 2-21
2.20. SHOWACTIVEUSERS .......................................................................................... 2-22
2.21. SHOWSERVERSTATUS ...................................................................................... 2-23
2.22. TCD ................................................................................................................... 2-24
2.23. UNALIAS ........................................................................................................... 2-25
2.24. UP ..................................................................................................................... 2-26
2.25. WHOAMI ........................................................................................................... 2-27
SECTION 3. CLI SPECIAL COMMANDS REFERENCE .................................................... 3-1
3.1. LOAD .................................................................................................................... 3-1
3.2. LOCK ................................................................................................................... 3-2
3.3. PROT .................................................................................................................... 3-2
3.4. RESET .................................................................................................................. 3-3

2/5/07
Revision 3.4

Proprietary and Confidential

Software Release 3.0

Page v
Volume VII

Alcatel-Lucent
Provisioning Office Parameters

3HP700021003GUZZA

3.5. SHUT ..................................................................................................................... 3-4

3.6. SWITCH ................................................................................................................. 3-4
3.7. UNLOCK ................................................................................................................ 3-5
3.8. WHOAMI ............................................................................................................... 3-5
SECTION 4. PROVISIONING THE ATRIUM SIGNALING GATEWAY ............................... 4-1
4.1. SIGNALING GATEWAY .......................................................................................... 4-1
4.2. SS7 CARD ............................................................................................................. 4-4
4.3. LOCAL SSN .......................................................................................................... 4-6
4.4. ...................................................................................MTP3 ROUTING OR DPCS 4-9
4.5. LINK SETS .......................................................................................................... 4-12
4.6. REACHABLE DPCS ............................................................................................. 4-14
4.7. LINKS .................................................................................................................. 4-15
4.8. SCCPS ................................................................................................................ 4-17
4.9. SSNS .................................................................................................................. 4-19
4.10. GLOBAL TITLE ROUTING .................................................................................. 4-21
4.11. OWN ........................................................................................ GLOBAL TITLE 4-26
SECTION 5. PROVISIONING THE ATRIUM WIRELESS MEDIA GATEWAY ................... 5-1
5.1. LOCK .................................................................................................................... 5-1
5.2. UNLOCK ................................................................................................................ 5-1
5.3. SHUTDOWN ........................................................................................................... 5-2
5.4. RESET ................................................................................................................... 5-2
5.5. SPEEDADD ............................................................................................................ 5-3
5.6. SPEEDDELETE ....................................................................................................... 5-4
5.7. MEDIA GATEWAY ................................................................................................. 5-5
5.8. CARDS ................................................................................................................ 5-17
5.9. T1 SPAN ............................................................................................................ 5-19
5.10. VOICE SERVER CARD (VS CARD) .................................................................... 5-25
5.11. GIGABIT ETHERNET CARD (GIGE CARD) ......................................................... 5-28
5.12. ATM CARD ...................................................................................................... 5-32
5.13. CHANNELIZED INTERFACE CARD (CI CARD) ................................................... 5-35
5.14. OC3 TIME DIVISION MULTIPLEX (TDM) CARD ............................................ 5-38
5.15. TDM SONET FACILITY ................................................................................... 5-42
5.16. ENABLE DS3 SONETPATH ............................................................................ 5-46
5.17. .......................................................ENABLE DS1 CHANNELIZATION FOR DS3 5-49
5.18. ENABLE DS0 CHANNELIZATION FOR UNAS DS1 ........................................... 5-53
5.19. ISUP CIC PARTITIONING ................................................................................. 5-58
5.20. ASSIGN DS0 CHANNELS TO BSS ..................................................................... 5-59
5.21. ASSIGN DS0 CHANNELS TO ISUP .................................................................... 5-61
5.22. ENABLE VT ON DS3 ........................................................................................ 5-63
5.23. ENABLE DS0 CHANNELIZATION (UNDER VT GROUP) .................................... 5-64
5.24. ASSIGN DS0 CHANNELS TO CALEA ............................................................... 5-65

2/5/07
Revision 3.4

Proprietary and Confidential

Software Release 3.0

Page vi
Volume VII

Alcatel-Lucent
Provisioning Office Parameters

3HP700021003GUZZA

SECTION 6. PROVISIONING ATRIUM ROUTING AND TRANSLATION ........................... 6-1

6.1. PREFIX TREE ......................................................................................................... 6-1
6.2. PREFIX TRANSLATION AND HLR CONSIDERATIONS ............................................ 6-3
6.2.1. Configuring a Prefix Translation Resource (PREFIXFENCE) .................... 6-3
6.2.2. HLR Considerations for 203-PREFIX Resource .......................................... 6-8
6.3. NATIONAL TRANSLATION GROUP ........................................................................ 6-9
6.4. NATIONAL DIGIT TRANSLATION ........................................................................ 6-11
6.5. INTERNATIONAL COUNTRY CODE TRANSLATION .............................................. 6-13
6.6. ORIGINATOR ROUTE DESCRIPTOR ...................................................................... 6-15
6.7. ORIGINATOR ROUTE MODIFIER .......................................................................... 6-16
6.8. ORIGINATOR ROUTE ........................................................................................... 6-17
6.9. CIC ROUTE DESCRIPTOR ................................................................................... 6-19
6.10. CIC ROUTE SELECTOR ..................................................................................... 6-20
6.11. CIC ROUTE ....................................................................................................... 6-21
6.12. IMSI ROUTE DESCRIPTOR ................................................................................ 6-23
6.13. IMSI ROUTE MODIFIER .................................................................................... 6-24
6.14. IMSI ROUTE ..................................................................................................... 6-25
6.15. CPC ROUTE DESCRIPTOR ................................................................................. 6-27
6.16. CPC ROUTE MODIFIER ..................................................................................... 6-28
6.17. CPC ROUTE ...................................................................................................... 6-30
6.18. LAC ROUTE DESCRIPTOR ................................................................................ 6-32
6.19. LAC ROUTE MODIFIER .................................................................................... 6-33
6.20. LAC ROUTE ..................................................................................................... 6-35
6.21. TOD ROUTE DESCRIPTOR ................................................................................. 6-37
6.22. TOD ROUTE SELECTOR .................................................................................... 6-39
6.23. TOD ROUTE ...................................................................................................... 6-40
6.24. ROUTE LIST ...................................................................................................... 6-42
6.25. BASE STATION SYSTEM (BSS) TRUNK GROUPS .............................................. 6-45
6.26. ISUP TRUNK GROUP ........................................................................................ 6-52
6.27. TRUNK GROUP BUNDLE ................................................................................... 6-64
6.28. BICC TRUNK GROUP ....................................................................................... 6-66
6.29. CAS TRUNK GROUP ......................................................................................... 6-77
6.30. UTRAN TRUNK GROUP ................................................................................... 6-85
6.31. LRN LIST ........................................................................................................ 6-87
6.32. LNP ORDER ...................................................................................................... 6-88
6.33. CALL SCREENING ............................................................................................. 6-89
6.34. TERMINATION TYPE ......................................................................................... 6-90
6.35. MSISDN TO HLR ............................................................................................ 6-91
SECTION 7. CLI MOBILITY CONFIGURATION .............................................................. 7-1
7.1. MOBILITY CONFIGURATION QUERY COMMANDS ................................................ 7-2

2/5/07
Revision 3.4

Proprietary and Confidential

Software Release 3.0

Page vii
Volume VII

Alcatel-Lucent
Provisioning Office Parameters

3HP700021003GUZZA

7.1.1. Showservices ................................................................................................ 7-2

7.1.2. VLRSubdel ................................................................................................... 7-3
7.2. VLRSUBQUERY .................................................................................................... 7-4
7.3. MSC NETWORK NODES ....................................................................................... 7-6
7.4. OWN MSC/VLR ................................................................................................. 7-10
7.5. NEIGHBORING MSC/VLR .................................................................................. 7-13
7.6. MSC EQUIVALENT PLMN LIST ......................................................................... 7-16
7.7. MSC PLMN ....................................................................................................... 7-18
7.8. MSC MCC/MNC ............................................................................................... 7-20
7.9. RAN/BSS ENTITY .............................................................................................. 7-22
7.10. GSM LAC CELL RANGE .................................................................................. 7-25
7.11. GLOBAL TITLE ALLOWED ROAMING ............................................................... 7-28
7.12. MSRN HON DISTRIBUTION ............................................................................. 7-30
7.13. ODB CONFIGURATION ..................................................................................... 7-32
7.14. IMSI TO CCM MAPPING .................................................................................. 7-34
7.15. MAP MESSAGE IE SETS .................................................................................. 7-35
7.16. CAP MESSAGE IE SETS ................................................................................... 7-37
7.17. RESTRICTED PLMN ......................................................................................... 7-39
7.18. RESTRICTED LAC/CELL RANGE ...................................................................... 7-41
7.19. DAYLIGHT SAVINGS TIME ................................................................................ 7-43
7.20. TIME ZONE DISTRIBUTION ............................................................................... 7-47
7.21. HOME PUBLIC LAND MOBILE NETWORK (HPLMN) CODES ........................... 7-51
7.22. INTERNATIONAL MOBILE EQUIPMENT IDENTITY (IMEI) CHECKING ............... 7-53
7.23. GSM TRACE ..................................................................................................... 7-56
SECTION 8. PROVISIONING CALEA ............................................................................. 8-1
8.1. OVERVIEW OF CALEA SUPPORT ......................................................................... 8-1
8.1.1. Configuring the TCP Connection for Law Enforcement .............................. 8-1
8.1.2. Locking and Unlocking Resources ............................................................... 8-1
8.1.3. Using the Query Command to See if a Resource is Locked ......................... 8-2
8.1.4. Unlocking a Resource ................................................................................... 8-2
8.1.5. Protection ...................................................................................................... 8-2
8.2. CONFIGURING THE CONNECTION TO THE LEA SERVER ...................................... 8-3
8.3. SETTING UP CALEA CASES ................................................................................. 8-5
SECTION 9. CLI PROVISIONING FOR E911 .................................................................. 9-1
9.1. EMERGENCY ZONE ............................................................................................... 9-1
9.2. EMERGENCY CALL ............................................................................................... 9-5
SECTION 10. CLI ERRORS ........................................................................................... 10-1

2/5/07
Revision 3.4

Proprietary and Confidential

Software Release 3.0

Page viii
Volume VII

Alcatel-Lucent
Command Line Interface Guide

SECTION 1
1.1

CLI Overview
3HP700021015GUZZA

CLI OVERVIEW

Introduction
The CLI (Command Line Interface) is used to monitor and provision the Atrium Wireless
Softswitch. This document introduces the CLI command set and explains how to provision
different parts of the Wireless Softswitch.

1.2

Architecture
Commands are issued from a PC or workstation acting as a client. The command interpreter
resides on the System Administration Module (SAM), one of the cards on the Wireless
Softswitch.You access the CLI command interpretter on the SAM from your PC or workstation
BY using Telnet.
Commands may be issued one line at a time, or they can be put into a batch file and sent to the
SAM all at once. The figure below depicts this architecture:

Figure 1-1 : CLI Architecture

1/23/07
Revision 3.4

Proprietary and Confidential

Page 1-1

Software Release 3.0

Volume 7

CLI Overview
3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Command Line and Batch Provisioning

1.3

Command Line and Batch Provisioning

CLI commands can be entered interactively at the command line after logging on to the CLI.
Alternatively, they can be entered in bulk.
To enter the commands interactively, the user accesses the command port on the Wireless
Softswitch using telnet. The user then enters a login ID and password. Once logged in, the CLI
prompt displays where the user can then enter the CLI batch load command.
To enter the commands in batch, the user types the commands into a file and stores it on the
SAM module of the Wireless Softswitch (WSS) using FTP. The user then logs onto the CLI
and issues a Load command. This executes the commands in the file.
See the a Load command in the CLI Reference section of this manual for more information.

1.3.1

Launching the CLI

To launch the Command Line Interface (CLI) from your PC or workstation:

Step 1

Use Telnet to access the command port on the CLI server:

Example:
telnet 192.168.7.7 5400

In the example, 192.168.7.7 is the IP address of the server where the CLI program resides. The
IP address is typically that of the active SAM card because the CLI server runs on the SAM
card. The port number is always 5400 as shown in the example.
Step 2

Log in using your UserId and Password. (The is the same UserID and Password used to log in
to the Element Management System.)
Example:
UserId: test1
Passwd: spatial1

Step 3

When you are logged in, you will see the System prompt:
Example:
System>

Step 4

Start typing CLI commands at the System> prompt:

Example:
System> help

(For online help)

Page 1-2

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Overview
3HP700021015GUZZA

Command Line and Batch Provisioning

1.3.1.1 Logging off from the CLI

To log off from the CLI enter:
System>Exit

1.3.1.2 ADD Operations

For Adds you can add values for all the parameters of a resource using one command line entry,
or you can let the system prompt you for the values. Below is an example of adding a resource
using one long command entry:
System/Office-Parameters/Routing-and-Translation/Wireless-Translation/InternationalTranslation>add countrycode Country_Code=28, Orig__Route_Descriptor=6, Name=Carltopia,
Min__Length=13, Max__Length=15
Command Successful

If you enter the Add command and the resource name with no parameters, this causes the
system to prompt you for the parameters. Simply respond with the values requested and press
enter in response to each prompt in order to add the values.Below is an example of how the
same command will be entered if you choose to let the system prompt you for the parameters
individually:
System/Office-Parameters/Routing-and-Translation/Wireless-Translation/InternationalTranslation>add countrycode
Country_Code: 28
Orig__Route_Descriptor: 6
Prompt for Optional? (y/yes/n/no): Y
Name (Default:Not Defined): Carltopia
Min__Length (Default:7): 13
Max__Length (Default:7): 15
Command Successful

You are prompted for required parameters first. Once they are completed, you are asked
whether you want to enter optional values. If you respond Y, you are prompted for them. If you
respond N, of course, you will not be prompted forany of the optional parameters.
You do not have to enter values for the optional parameters. They are optional. Just hit the
Enter key to skip them. Once you are through entering optional values you can type a period (.)
and hit the Enter key. This terminates all prompting and issues the command.

2/5/07
Revision 3.4

Proprietary and Confidential

Page 1-3

Software Release 3.0

Volume 7

CLI Overview
3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Command Line and Batch Provisioning

1.3.1.3 Result of a CLI Commands

When you enter a CLI command, the command result displays on the screen. For a successful
execution, command successful displays. For an unsuccessful one, command failed: <error
description> displays, where <error description> is a description of the error along with its
error code.

1.3.1.4 Lock, Unlock, Shut and Reset

When configuring certain resources, you may have to first shut it down and take it out-ofservice before modifying or deleting it. Not all resources must be shut down or locked before
modifying them, but it is important to know before you being that some do. After these
resources are locked, you can then change their configuration. Once you are through
configuring a locked resource, you must unlock it to bring it back into service.
A shut command is issued to shut the resource down. Then, a lock command is used to take a
resource out of service. The unlock command is used to bring a locked resource back into
service. All three commands have no parameters. You must cd to the resource, then issue the
command from within its context.
To determine if lock, unlock and shutdown commands are applicable to a resource, cd to the
context of the resource and enter help commands, as shown in the following example:
System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1-MSFNODE/Slots/38-1CHANINTFCARD/38-1-OC3TDMCARD/1-TDMSONETFACILITY/359696384-SONETPATH/1-VT_GROUP1/
1-SONETVT/3729-SPAN>help commands
Commands supported under this context are:
[cd, Set, sendMsg, showactiveusers, showserverstatus, whoami, getevt, getalarm, help, tcd, up, echo,
pause, load, setseverity, setcategory, history, Mod, List, Query, SHUTDOWNALLCHAN, SHUTDOWN,
LOCKALLCHAN, UNLOCKALLCHAN, UNLOCK, LOCK, Del, Add]

When a resource that must be out-of-service to modify is first added, it is automatically locked
by default. It needs to be unlocked to modify it.
The reset command is used for Hardware/Software reset of a resource where applicable.
For more information about the Shut, Lock, Unlock and Reset commands see the instructions in
this manual about the individual resource.

Page 1-4

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Overview
3HP700021015GUZZA

Command Line and Batch Provisioning

1.3.2

Creating and Loading Batch Files

Commands can be typed into a file and then loaded into the Wireless Softswitch as a group of
commands. The batch file can be any text file containing the commands you want to issue. To
load the file, you log into the CLI just like you were going to use the CLI interactively. (See
Launching the CLI.) You then issue the Load command.
Conceivably, you could have a batch command file containing thousands of command lines.
This is the usual way of provisioning the system the first time. The Wireless Element Manager
(WEM), a graphical user interface for entering CLI commands, and the interactive commandline capability are usually used only to make minor changes to the system.
Each command in the batch file follows the same syntax rules as when entering the command
interactively. Each command line in the file, though, must be separated by a semi-colon. Below
is an example of batch file content that can be loaded into a Wireless Softswitch:
cd;
cd System/Office-Parameters/Routing-and-Translation/Wireless-Translation/National-Translation;
add TRANSLATIONGROUP Group_Number=7, Name=Carltopia;
add TRANSLATIONGROUP Group_Number=1, Name=RemainingUSA;
cd;

In the above example, the first CD command line changes to the top level of the hierarchy -- the
System level. The next command line changes to the context where the national translation
groups reside. This command is followed by a command to add two national translation groups,
7 and 1. Finally, the last CD command is used to change back to the top level of the hierarchy.
(All commands are described in detail in this manual.)
If you save the batch file to a location on the Wireless Softswitch named /root/usr/johnbaston/
bload/NatXlate.txt, the load command to send it to the Wireless Softswitch would look like this
on the CLI command line:
System>load /root/usr/johnbaston/bload/NatXlate.txt, ErrorOutput.txt

In the above example, the ErrorOutput.txt file is an output file where any error messages
generated by the batch load are sent.
If you need to stop the batch job before it completes, press cntl-C.

2/5/07
Revision 3.4

Proprietary and Confidential

Page 1-5

Software Release 3.0

Volume 7

CLI Overview
3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Conventions Used in this Manual

1.4

Conventions Used in this Manual

This manual explains commands by using symbols denoting required fields, selection lists and
other command attributes. The symbols used and their meanings are:

Symbol

Meaning

<>

Words contained in angle braces are variables. Any value can be entered.

{}

Words contained in curly braces represent a selection list.

[]

Words contained in brackets are optional items.

...

Indicates that the items in the group preceding the ellipses can be repeated
one or more times.

One of the items separated by the vertical bar (or character) must be
selected from the list.

Page 1-6

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Overview
3HP700021015GUZZA

CLI Context Hierarchy

1.5

CLI Context Hierarchy

When issuing a CLI command, it only pertains to objects within a given context. For example,
if you perform an Add command while the context is System>Wireless-Soft-Switch, the Add
command only pertains to the wireless soft switch, if no other context is given in the command
line.
Usually, you can see the context in the prompt name. (It is possible to turn off this feature.) For
example, the context below is SS7 card configurations in the signaling gateway:
System/Signaling-Gateway/SS7-Card-Config>

The contexts are arranged in a hierarchy. Immediately below the System context are the Nodes,
Group, Subscriber-Options, Office-Parameters and Signaling-Gateway contexts within the
System context. Below System>Nodes are contexts that pertain only to Nodes, below WirelessSoft-Switch are contexts that pertain only to soft switches, and so on.
If you enter the List command at the System prompt, a list of the current contexts displays:
System/Nodes>list
Wireless-Soft-Switch
Wireless-Media-Gateway
WMG-Interconnections

To change to a context lower in the hierarchy, enter the cd command followed by the context
name. The example below changes to the Signaling-Gateway context just below the System
context:
System>cd Signaling-Gateway

To list the contexts below the Signaling-Gateway context enter list:

System/Signaling-Gateway>list
SS7-Card-Config
1-<001-008-165>-OPCCONFIG

Note that the context string in the command prompt changes after executing the cd command.
Commands you enter now pertain to the context represented by the new context string. In the
example, commands will now pertain to Signaling Gateways within the System.
You can target a command to affect a resource outside the current context by expressing its path
name. For example, this command affects the mtp3route that has a destination point code (dpc)
of 45. It changes the destination point code description (dpcdescription) to test1.
System/Signaling Gateway/1-65793-OPCCONFIG/MTP3-Routing-DPCs>mod mtp3route dpc=45,
dpcdescription=test1

2/5/07
Revision 3.4

Proprietary and Confidential

Page 1-7

Software Release 3.0

Volume 7

CLI Overview
3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CLI Context Hierarchy

The examples below shows the context hierarchy:

System>list
Geographic-Redundancy
Nodes
Groups
Subscriber-Options
Fault
Performance
Office-Parameters
Signaling-Gateway
System-Parameters
System-Status
Tools
Accounting
Security
System/Geographic-Redundancy
SS7-Cross-Connects
SS7-OPC-Maps
1-GEOREDXCONPROP
System/Nodes/Wireless-Soft-Switch
Wss-Protection-Groups
Wss-Cards
System/Nodes/Wireless-Media-Gateway
Spatial-Media-Gateway
IWF
System/Nodes/WMG-Interconnections
Intra-WSS
Inter-WSS-<BICC>
IWF-Interconnects
System/Groups>list
ISUP
BSS
BICC
CAS-Trunk
UTRAN
System/Groups/BSS
Groups
Circuits

Page 1-8

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Overview
3HP700021015GUZZA

CLI Context Hierarchy

System/Groups/ISUP
Groups
Circuits
System/Groups/BICC
Groups
System/Groups/CAS-Trunk
Groups
Circuits
System/Groups/UTRAN
Groups
System/Subscriber-Options
Wireless-CALEA
System/Fault
Filters
Event-Definitions
System/Performance
Performance-Control
System/Office-Parameters>list
ISUP-CIC
Optional-Feature-Control
Network-Parameters
Mobility-Config-Parameters
Routing-and-Translation
Service-Parameters
Call-Processing-Parameters
Cause-Code-Categories
Cause-Codes
Ring-Types
SMS
MGCP-Parameters
MSF-Trunk-Interconnects
Overload-Control
System/Office-Parameters/ISUP-CIC
System/Office-Parameters/Network-Parameters

2/5/07
Revision 3.4

Proprietary and Confidential

Page 1-9

Software Release 3.0

Volume 7

CLI Overview
3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CLI Context Hierarchy

LATAs
NPDB-Node
1-LRNLISTKEY
1-LNPLISTKEY
System/Office-Parameters/Mobility-Config-Parameters
Network-Nodes
Own-MSC-or-VLR
Neighborhood-MSC-or-VLR
MSC-Equivalent-PLMN-List
MSC-PLMN
MSC-MCC-and-MNC
RAN-or-BSS-Entity
GSM-LAC-or-CELL
Mobile-Global-Title-or-Allowed-Roaming-Number
MSRN-HON-Distribution
ODB-Config
Subscriber-Query-by-IMSI-or-MSISDN
IMSI-To-CCM-Mapping
MAP-Message-IE-Sets
CAP-Message-IE-Sets
Advice-of-Charge
Restricted-PLMN
Restricted-IMSI-To-HO
LAC-Restriction-Provisioning
Day-Light-Saving-Time-Provisioning
TimeZone-Distribution
LAC-or-CELL-Emergency-Call-Provisioning
Emergency-Service-Zone-Provisioning
HPLMN-Network-Codes
IMEI-Checking
GSM-Trace
MSC-E911-CALL
0-SYSTEMEMERGENCYCALL
System/Office-Parameters/Routing-and-Translation
MSISDN-To-HLR
Switch-ID-Routing
NOA-Routing
Wireless-Translation
Call-Screening
Routing
Route-List
OutPulse-Map

Page 1-10

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Overview
3HP700021015GUZZA

CLI Context Hierarchy

CLI-OutPulse-Map
Trunk-Group-Bundle
Timed-Based-Substitution
System/Office-Parameters/Service-Parameters
Voice-Mail
CAS-Profile
VoIP-Profile
Ring-Tone-Profiles
Network-Allowed-Services
Service-Network-List
System/Office-Parameters/SMS
SMS-Prepaid
SMPP-Client
Carrier-List
LDP-MNP-Config
System/Signaling-Gateway
Parameters
SS7-Card-Config
MAP
DFTHA-Sys-Mgr
Gateways
System/Signaling-Gateway/Parameters
COMMON
ANSI
ITU
C-7
System/Signaling-Gateway/DFTHA-Sys-Mgr
DFTHA-Resource-Sets
DFTHA-Node-Processor-Ids
System/Signaling-Gateway/Gateways/n-<n-nnn-n>-n-OPCCONFIG
Local-SSN
MTP3-Routing-DPCs
Link-Sets
SCCPs
Global-Title-Routing
Own-Global-Title
SCTP
Managers

2/5/07
Revision 3.4

Proprietary and Confidential

Page 1-11

Software Release 3.0

Volume 7

CLI Overview
3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CLI Context Hierarchy

System/Accounting
GSM-Configuration
GSM-Operation
System/Security
User-Groups
Security-Log-Query
System Policy-SECURITYPOLICY

Page 1-12

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

SECTION 2

CLI Commands Reference

3HP700021015GUZZA

CLI COMMANDS REFERENCE

Each Command Line Interface (CLI) command is described in this section. The commands are
presented in alphabetical order. Their use in configuring and provisioning the system is
described in other sections of this manual.

2.1

Add
NAME

Add

DESCRIPTION

Used to add a resource.

SYNTAX

add <resource> {name1=value1, name2=value2 . . . }

OPTIONS

<resource>

Name of the resource you are adding. If you add no

parameters following the resource name, the system prompts
you with the parameter names.

{name1=value1, name2=value2}
Name/value pairs made up of the name of the data you are
adding followed by the value for that data.
EXAMPLES

The following command adds a translation group:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation>add translationgroup Group_Number=4, Name=Carltopia
Command Successful

The following command adds an origroute descriptor to a origination route

modifier table:
System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/OrigRoute-Modifier/2-ORIGROUTEMODIFIER>Add origroute origroute_descriptor=1,
digit_type=1, ama_index=1, route_action=0, route_index=0

FILES

None.

SEE ALSO

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-1

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CD

2.2

CD
NAME

CD

DESCRIPTION

Used to change to a new context. Double-dots (..) can be specified to move

the context up one level. You may specify contexts by using their full path
name. Entering the cd command without parameters sets the context to the
top context, System.

SYNTAX

cd <contextname | .. >

OPTIONS

<contextname | .. >Enter either the pathname of the context to change to or

double-dots (..) . You can enter relative or absolute path
names. The double-dots (periods) indicate to change to the
next higher context above the current context. The
contextname can be entered in combination with the doubledots to express a context. For example, ../samelevel
expresses a context named samelevel on the same level as
the current context. If you do not enter the context or the
double-dots, the top context, System, is assumed.

EXAMPLES

To change from the System context to a context below Office Parameters,

named Cause Code Categories:
System>cd Office-Parameters/Cause-Code-Categories>
System/Office-Parameters/Cause-Code-Categories>

To move up one context level from the Cause Code Categories to the Office
Parameters level:
System/Office-Parameters/Cause-Code-Categories>cd ..
System/Office-Parameters>

To move from the Office Parameters context to a context that is on the same
level as the Office Parameters:
System/Office-Parameters> cd ../Groups
System/Groups>

To use an absolute path name with the cd command, the absolute path name
starts with a slash (/) and System is the assumed root directory, as follows:
System/Office-Parameters/Ring-Types>cd /nodes/wireless-soft-switch/wsscards
System/Nodes/Wireless-Soft_Switch/Wss-Cards>
FILES

None.

SEE ALSO

Up.

Page 2-2

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Changepwd

2.3

Changepwd
NAME

Changepwd

DESCRIPTION

Used to change your password.

SYNTAX

Changepwd newpassword=<value>, confirmpassword=<value>

OPTIONS

newpassword

The password you want to change to.

confirmpassword

Retype the password you want to change to.

EXAMPLES

The following is an example of changing a password. The characters you

type in response to the NewPassword and Confirmpassword prompts will
not be echoed to the screen::
System/Office-Parameters>changepwd
NewPassword:
ConfirmPassword:
Password successfully changed
Command Successful

FILES

None.

SEE ALSO

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-3

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Del

2.4

Del
NAME

Del

DESCRIPTION

Used to remove an existing resource from the system.

SYNTAX

Del <instance>-<resource>

OPTIONS

<instance>

The instance of the resource that you want to delete.

<resource>

The type of resource to delete.

EXAMPLES

To delete an MPT3 route that has an instance value of <001-002-003>:

System/Signaling-Gateway/Gateways/1-<000-000-001>-1-OPCCONFIG/MTP3Routing-DPCs>DEL <001-002-003>-MTP3ROUTE
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

To delete a translation group that has an instance value of 2:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation>DEL 2-TRANSLATIONGROUP
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Please note that when the del command is issued from a batch file, there are
no prompts asking whether you are sure you want to delete the file.
FILES

None.

SEE ALSO

Page 2-4

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Echo

2.5

Echo
NAME

Echo

DESCRIPTION

Prints a string to the client. This can be used in a batch file to issue messages
to the CLI command screen while the batch file is executing so that the user
can monitor the progress of the batch job.

SYNTAX

Echo <string>

OPTIONS

<string>

EXAMPLES

To display the word hi.

The string to print.

System>echo hi
System>hi
Command Completed

FILES

None.

SEE ALSO

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-5

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Getalarm

2.6

Getalarm
NAME

Getalarm

DESCRIPTION

Lists outstanding alarm messages on your screen starting from the

eventcode given, or stores the list in a file you specify. The list gives each
codes description, including its severity and category. This command can
be issued under any context. Any file specified is stored on the System
Administration Module (SAM), not on your local PC. The file name
specification is relative to the root directory on the SAM. If you do not
specify a file name, a Prompt for optional question displays that can be
answered y, yes, n or no. If you specify y or yes, you can give a file name
where the alarm messages will be stored; otherwise, if you specify n or no,
the messages display on the your screen.

SYNTAX

getalarm eventcode=<number,> [<outputfile>]

OPTIONS

eventcode=

Required parameter.

<number>

Starting event code for outstanding alarm messages that are

qualified to be displayed. The default is 1.

[<outputfile>]

Optionally, you can specify an output file name. Any file

specified will be stored on the System Administration Module
(SAM) relative to the root directory.

EXAMPLES

To display alarms starting with a 1000:

System>getalarm eventcode=1
Prompt for optional (y/yes/n/no): n
1017: MINOR:PLATFORM:2003/5/29 4:16:37 An attempt to log in to the EMS GUI
client was not successful. This alarm should be manually cleared by Group 0
users only.
10271: CRITICAL:PLATFORM:2003/5/30 2:48:51 OamFault has moved a WSS
card out of operational state.
Command Completed

To display alarms starting with 10270 and store the results in a file named
root/usr/admin/alarms.txt on the SAM:
System>getalarm eventcode=10270
Prompt for optional (y/yes/n/no): yes
File name: /usr/admin/alarms.txt
Command Completed
FILES

None.

SEE ALSO

Getevent, Set, Setcategory, Setseverity.

Page 2-6

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Getevent

2.7

Getevent
NAME

Getevent

DESCRIPTION

Lists outstanding event messages on your screen starting from the

eventcode given, or stores the list in a file you specify. The list gives each
codes description, including its severity and category. This command can
be issued under any context. Any file specified is stored on the System
Administration Module (SAM), not on your local PC. The file name
specification is relative to the root directory on the SAM. If you do not
specify a file name, a Prompt for optional question displays that can be
answered y, yes, n or no. If you specify y or yes, you can give a file name
where the alarm messages will be stored; otherwise, if you specify n or no,
the messages display on the your screen.

SYNTAX

getevent eventcode=<value>

OPTIONS

eventcode

EXAMPLES

To display outstanding events starting with event code 10270:

Starting event code for the outstanding event messages

qualified to be displayed. The default is 1.

System>getevent eventcode=10270

To display alarms starting with 10270 and store the results in a file named
root/usr/admin/EVENTS.txt on the SAM:
System>getevent eventcode=10270
Prompt for optional (y/yes/n/no): yes
File name: /usr/admin/EVENTS.txt
Command Completed

FILES

None.

SEE ALSO

Getalarm, Set, Setcategory, Setseverity.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-7

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Help

2.8

Help
NAME

Help

DESCRIPTION

Explains how to use a specified CLI command or lists the commands

available for the current context. After you enter the Help command, you are
asked for a number 1 through 4 to specify the kind of help output you want,
as follows:
Number
1
2
3
4

Information Displayed
Displays only the information about required parameters.
Displays only the information about the optional parameters.
Displays all the information, about required and optional
parameters.
Displays only the parameter names for the command with no
information about the parameters.

SYNTAX

Help <command> [resource] [parameter] | commands

OPTIONS

<command>

Help information is displayed about the command name

given here.

[resource]

The usage of a command can vary according to the type of

resource. For example, an Add command for one type of node
may require different parameters from an Add command
issued on a different type of node. To specify the resource,
type its name following the command. (Ex: Help Add
csdnode.) The resource name specified must available within
the current context.

[parameter]

To display help only for one parameter within the command,

enter the parameter name.

commands

The literal commands can be entered instead of a specific

command to get a list of the commands available under the
current context.

Page 2-8

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Help

EXAMPLES

To display help for the Add command as it applies to a translationgroup

resource:
System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation>help add translationgroup
Enter 1 to display the mandatory parameters
Enter 2 to display the optional parameters
Enter 3 to display all the parameters
Enter 4 display only parameter names without description
Enter the parameter name to get the help for that parameter only
Please enter the appropriate option :1
Usage:
add <resource name> {name1=value1, name2=value2..} OR For adding
contained object instances
Usage:
add <resource name> {name1=value1, name2=value2..}
{name1=value1..)&(name1=value2,..)
Add translationgroup
<Group_Number=value> Specifies the translation group number.Type
is:long,MIN:1,MAX:65535,DEFAULT:Not Defined
Command Successful

To issue the help command to see the commands available under the current
context.
System>help commands
Commands supported under this context are:
Generic : cd, changepwd, Set, sendMsg, whoami, help, tcd, up, echo, pause,
load, setAlias, unAlias, listAlias, history .
System : showserverstatus.
Fault : getevent, getalarm, setseverity, setcategory.
Security : showactiveusers.
Configuration : list
Command Completed

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-9

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Help

EXAMPLES
(CONT.)

To issue the help command for an individual parameter:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/PrefixTranslation/1-prefix>help add prefixfence protocol_type
Usage:
add <resource name> {name1=value1, name2=value2..} OR For adding
contained obect instances Usage:
add <resource name> {name1=value1, name2=value2..}
(name1=value1..)&(name1=value2,..)
Add prefixfence
<Protocol_Type=value> Type of protocol Type is:enum,Valid values
are:[CAMEL->1, INAP->2]
Command Successful

FILES

None.

SEE ALSO

Page 2-10

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

History

2.9

History
NAME

History

DESCRIPTION

Displays the last 20 commands issued.

SYNTAX

history

OPTIONS

No parameters for this command.

EXAMPLES

To display the history:

System>History
1. history
2. help setalias
3. help set alias
4. listalias
5. set alias add
6. set alias
7. setalias
8. set alias add dda
9. set alias
10. help setalias
11. setcategory plat=on
12. list
13. help commands
14. tcd groups
15. tcd
16. help tcd
17. help commands
18. help
19. help help
20. cd . .
Command Completed

FILES

None.

SEE ALSO

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-11

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

List

2.10

List
NAME

List

DESCRIPTION

Displays a list of the objects directly below the current context that are
within the current context.

SYNTAX

list

OPTIONS

No parameters for this command.

EXAMPLE

To display a list of objects under the Office-Parameters context:

System/Office-Parameters>list
ISUP-CIC
Network-Parameters
Mobility-Config-Parameters
Routing-Parameters
Service-Parameters
Call-Processing-Parameters
Cause-Code-Categories
Cause-Codes
Ring-Types
MSF-Trunk-Interconnects
Command Completed

FILES

None.

SEE ALSO

Page 2-12

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Listalias

2.11

Listalias
NAME

Listalias

DESCRIPTION

Displays a list of all aliases that have been created.

SYNTAX

listalias

OPTIONS

No parameters for this command.

EXAMPLE

To create a list of aliases:

System>listalias
la
q
show
users
Command successful.

FILES

None.

SEE ALSO

Setalias, Unalias.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-13

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Mod

2.12

Mod
NAME

Mod

DESCRIPTION

Used to modify a resource.

SYNTAX

If the operation is done inside a resource context, it applies only to that

resource and the syntax is:
mod {name1=value1, name2=value2, . . . }

If the operation is performed from outside the current context, the syntax
must specify the resource name, as follows:
mod <resource> <idname>=<id> , {name1=value1, name2=value2, . . . }

OPTIONS

<resource>

If you are outside the resource contex, the resource name is

required. If you are already positioned with the resource
context, the resource name is not required.

<idname=id>

The name of the resources indentification parameter

followed by its unique identification value. For some
resources, you will be required to enter more than one
idname=id pair to identify the resource. When using the
system interactively, you are prompted for any required
idname=id pair you do not enter, but you must enter at least
one. A comma must follow the idname=id name/value pair(s).

{name1=value1, name2=value2, . . .}
The name of a parameter to be modified followed by the new
value for the parameter.

EXAMPLES

To change the name parameter in translation group number 2 to the value

NewName:
System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation>mod translationgroup group_number=2, name=newname
Command Successful

The command below specifies the resource to change. The resource is

mtp3route. The command affects the specific mtp3route identified by the
point code 001-096-001.
System/Signaling-Gateway/Gateways/1-<001-021-255>-4-OPCCONFIG/MTP3Routing-DPCs>mod mtp3route point_code=001-096-001, name=Carltopia
Command Successful

Page 2-14

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Pause

EXAMPLES

The following changes the IP address for legal agency access. (Note that this
resource must be locked before the modification can be done, as shown in
the example.)
System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode/2leatcpconnection>lock
-30065:Are you sure Yes/Y/No/N : ?Y
Command Successful
System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode/2leatcpconnection>mod ip=192.167.7.7
Command Successful

FILES

None.

SEE ALSO

2.13

Pause
NAME

Pause

DESCRIPTION

Stops the client process for a specified time period.

SYNTAX

pause <sec>

OPTIONS

<sec>

EXAMPLE

The following command pauses the client for ten seconds:

Number of seconds to pause the client process.

System/Nodes>pause 10
FILES

None.

SEE ALSO

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-15

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Query

2.14

Query
NAME

Query

DESCRIPTION

Displays a resources parameter names and their values. The query

command with no parameters shows the names and values for the current
resource context. You may specify a specific resource when not in a
resource context.

SYNTAX

query [<instance>-<resource>]

OPTIONS

<resource>

Optional parameter used when you want to specify a resource

instead of accepting the current context as the query object.

<instance>

If explicitly specifying a resource instead of using the current

context as the resource, you can give a unique identification
for the resource by entering the identifier name and the value
for the unidentified.

EXAMPLE

The following command displays the parameter names and their values for
an mtp3 route when in the routes resource context:
System/Signaling Gateway/Gateways/1-<001-021-255>-4-OPCCONFIG/MTP3Routing-DPCs/<001-096-001>-MTP3ROUTE>query

MTP3ROUTE:Properties:
CLLI_Code [CLLI Code].......45616516516
ISUP_Protocol [ISUP Protocol].......15
Gateway_No [Gateway No].......1
Name [Name].......bp
Point_Code [Point Code].......001-096-001
SLS_Range [SLS Range].......sls_range_4bit -> 16
Node_Type [Node Type].......SP_TYPE -> 0
adjacent_PC [adjacent PC].......N->0
Network_ID [Network Type].......C7 -> 4
State:
Active_Link_Sets [Active Link Sets].......0
State [State].......MTP3R_UNAVAILABLE -> 1
Congestion_Indicator [Congestion Indicator].......NA_CONGESTED -> 4
Command Successful

Page 2-16

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Sendmsg

EXAMPLE
(CONT.)

The same command as above issued using the {idname=id}option would be

entered from the MTP3-Routing-DPCs level like this:
System/Signaling-Gateway/Gateways/1-<001-021-255>-4-OPCCONFIG/MTP3Routing-DPCs>QUERY <001-096-001>-MTP3ROUTE

FILES

None.

SEE ALSO

2.15

Sendmsg
NAME

Sendmsg

DESCRIPTION

Sends a message to another user.

SYNTAX

sendmsg user=<username>, msg=<message>

OPTIONS

user

The login name of the user to receive the message. Defaults

to all users.

msg

The text of the message to be sent.

EXAMPLE

The following command sends the message hello to test4:

System>sendmsg user=test4, msg=Hello

The output on test4s terminal will appear as follows:

[Mon Jun 02 17:38:53 CDT 2003] Message from admin:
Hello.
FILES

None.

SEE ALSO

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-17

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Set

2.16

Set
NAME

Set

DESCRIPTION

Turns events, alarms or prompts on or off.

SYNTAX

set {event|alarm|prompt}={on|off}

OPTIONS

{event|alarm|prompt}
Indicates what is to be turned on or off -- events, alarms or the
CLI context in the CLI prompt. If alarms or events are turned
off, they are no longer displayed until they are turned back
on.
{on|off}

EXAMPLE

Indicates whether the event, alarm or prompt is to be turned

on or off.

The following command turns alarms off:

Set alarm=off

2.17

FILES

No.

SEE ALSO

Getalarm, Getevent, Setcategory, Setseverity.

Setalias
NAME

Setalias

DESCRIPTION

Used to create an alternative name for a command. You can enter the new
name to execute the command. The old command is not replaced and can
still be used.

SYNTAX

setalias cmd=<value> alias=<value>

OPTIONS

cmd

Required entry that identifies the command for which you

want to create an alias.

alias

Required entry to establish the alias for the command named

in the cmd parameter.

EXAMPLE

The following command creates an alias of q for the query command:

Setalias cmd=query, alias=q

FILES

No.

SEE ALSO

Unalias, Listalias.

Page 2-18

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Setcategory

2.18

Setcategory
NAME

Setcategory

DESCRIPTION

Used to establish the categories of events and alarms that will display on
the CLI screen.

SYNTAX

setcategory {-alarm} { {plat|datab|bill|extrn|ntw|swlog|overload|calea|perfm|

secur|resrc|debug|cnf|sign|sgw|cot|noblk|access|ckt|app|resrc2} = {on/off} , . . . }

OPTIONS

{-alarm}

Include the -alarm subcommand to indicate that the

setcategory command will apply to events that are alarms, as
well as events that are not alarms. (Alarms are a subset of
events.) If the -alarm subcommand is left out of the command
line, the setcategory command only applies to events that are
not also alarms.

{plat|datab|bill|extrn|ntwk swlog|overload|calea|perfm|secur|resrc|debug|config|
sign|sgw|cot|noblk|access|ckt|app|resrc2}
Indicates the category or categories of events to be turned on
or off. You can enter multiple categories and their on/off
attribute in one command line. If you enter the setcategory
command without specifying a category, the system asks
whether you want to be prompted for each category. Respond
N to abort the command or Y to be prompted. If you respond
Y, each category displays and you may answer On or Off to
indicate whether you want that category of command to
display.
{on|off}

1/23/07
Revision 3.4

Enter On to display event messages in the category or Off to

suppress their display.

Proprietary and Confidential

Page 2-19

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Setcategory

EXAMPLE

The following command keeps events in the plat category from displaying.
It affects events, but not alarms, in the plat category:
System>setcategory plat=off

The command below lets the events and alarms in the plat category display:
System>setcategory -alarm plat=on

Turns several categories of events and alarms off:

System>setcategory -alarm ntwk=off, swlog=off, access=off
To lists each event so that you can specify which ones are to be turned on or off:
System>setcategory
System>Prompt for optional? Yes
plat: on
data : off
bill: on
extrn: |
.
.
.
FILES

No.

SEE ALSO

Getalarm, Getevent, Set, Setseverity.

Page 2-20

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Setseverity

2.19

Setseverity
NAME

Setseverity

DESCRIPTION

Sets the severity of events and alarms to display. You can display any
combination of critical, minor, warning or informational events and
alarms.

SYNTAX

setseverity {-alarm} { {critical|major|minor|warning|inform}={on|off} , . . .}

OPTIONS

{-alarm}

Include the -alarm subcommand to indicate that the

setseverity command will apply to events that are alarms, as
well as events that are not alarms. (Alarms are a subcategory
of event.) If the -alarm subcommand is left out of the
command line, the setseverity command only applies to
events that are not also alarms.

{critical|major|minor|warning|inform}
Indicates what severity of messages are to be turned on or
off. If a certain severity of event or alarm is turned off, it will
no longer display until it is turned back on.
{on|off}

EXAMPLE

Indicates whether the given severity level of message is to be

displayed (On) or the display of it is to be supressed (Off).

The following command turns alarms off:

Setseverity inform=off

FILES

No.

SEE ALSO

Getalarm, Getevent, Setcategory, Set.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-21

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Showactiveusers

2.20

Showactiveusers
NAME

Showactiveusers

DESCRIPTION

Lists users who are currently logged into the switch, including Wireless
Element Management (WEM) users and CLI users.

SYNTAX

showactiveusers

OPTIONS

None.

EXAMPLE

The following command lists active users:

System>showactiveusers
test4-USERACCOUNT
test1-USERACCOUNT
admin-USERACCOUNT
Command Successful

FILES

No.

SEE ALSO

Page 2-22

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Showserverstatus

2.21

Showserverstatus
NAME

Showserverstatus

DESCRIPTION

Shows the status of the active and stand by EMS server.

SYNTAX

showserverstatus

OPTIONS

None.

EXAMPLE

The following command lists active users:

System>showserverstatus
Version
Release 2.1.12.0 build srcbase.20030725
ActiveMSCHostName
wss6_all_1_1_1
StandbyMSCHostName
wss6_all_1_1_1
HostIpAddress
192.168.45.10
PeerHostIpAddress
ActiveMSCHostIpAddress
192.168.45.10
Status
ems.emscorba.common.enumdefs.ServerStatusEnum@76788a
PeerStatus
ems.emscorba.common.enumdefs.ServerStatusEnum@425343
ConnectionToPeerStatus
ems.emscorba.common.enumdefs.PeerConnectionStatusEnum@63ac42
HostName
wss6_all_1_1_1
StandbyMSCHostIpAddress
192.168.45.10
PeerHostName
Command Successful

FILES

No.

SEE ALSO

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-23

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Tcd

2.22

Tcd
NAME

Tcd

DESCRIPTION

This command changes the context to a specified temporary context. Any

commands to use the temporary context must be typed on the same line
following a semicolon. After the tcd command is issued the context
changes back to what it was before.

SYNTAX

tcd <tempcontext>; {commands}

OPTIONS

<tempcontext>

The pathname of the temporary context.

{commands}

Any commands to execute from within the temporary context.

EXAMPLE

The following commands list the contexts below the System context. They
then temporarily change the context from System to System/Fault and
performs another list command:
System>list
Nodes
Groups
Subscriber-Options
Office-Parameters
Signaling Gateway
System-Parameters
Command Completed
System>tcd Fault;list
Filters
Event-Definitions

FILES

No.

SEE ALSO

Page 2-24

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Unalias

2.23

Unalias
NAME

Unalias

DESCRIPTION

Removes an alias.

SYNTAX

unalias alias=<alias>

OPTIONS

alias

EXAMPLE

The following command removes an alias named q:

Required entry that identifies the alias you want ot remove.

Unalias q

FILES

No.

SEE ALSO

Setalias, Listalias.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-25

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Up

2.24

Up
NAME

Up

DESCRIPTION

Changes the context to the parent context. It is the same as performing the
cd .. command.

SYNTAX

up [<contextname>]

OPTIONS

<contextname>

EXAMPLE

The following command changes to the next higher context above the 4011card resource.

Optional name of a context higher in the current context path

that you can change to if you want to move up more than one
level. If you leave this off, the default is the next higher
context level.

System/Nodes/MSFNodes/1-msfnodes/Slots/40-11card>up
Command Successful.
System/Nodes/MSFNodes/1-msfnodes/Slots>

The following command changes to the Office-Parameters context:

System/Office-Parameters/Service-Parameters/VoIP-Profile>up OfficeParameters
Command Successful
System/Office-Parameters>

FILES

No.

SEE ALSO

CD

Page 2-26

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Commands Reference

3HP700021015GUZZA

Whoami

2.25

Whoami
NAME

Whoami

DESCRIPTION

Displays the current user name.

SYNTAX

whoami

OPTIONS

None.

EXAMPLE

A user named admin performs the whoami command:

System/Nodes/MSFNodes/1-msfnodes/Slots/40-11card>up
System/Nodes>whoami
admin
Command Completed

FILES

No.

SEE ALSO

1/23/07
Revision 3.4

Proprietary and Confidential

Page 2-27

Software Release 3.0

Volume 7

CLI Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Whoami

Page 2-28

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

SECTION 3

CLI Special Commands Reference

3HP700021015GUZZA

CLI SPECIAL COMMANDS REFERENCE

Some Command Line Interface (CLI) commands are used for special purposes and are not
available at all times on all kinds of resources. These are described in this section.

3.1

Load
NAME

Load

DESCRIPTION

Used to execute a batch file of CLI commands. Executes commands in a

specified file. The results can be directed into another file. Autologout
option enables the user to log out once the load command is entered.

SYNTAX

load [-autologout] inputfile=<x>, [outputfile=<y>,] [abort=yes|no]

OPTIONS

-autologout

Optional literal that says to log out the user immediately after
issuing the load command.

inputfile

Mandatory name of the file containing the list of commands to

execute.

outputfile

Optional name of an output file to create where the response

to the commands will be stored.

abort

If Yes, aborts the load command upon encountering an error

in the inputfile; if No, continues the load command upon
encountering an error in the file. This specification is
optional. The default is No.

EXAMPLE

To execute a file named bigprovisioner.conf and direct the output to a file

named bpmessages.txt:
System>load inputfile=bigprovisioner.conf, outputfile=bpmessages.txt

FILES

None.

SEE ALSO

2/5/07
Revision 3.4

Proprietary and Confidential

Page 3-1

Software Release 3.0

Volume 7

CLI Special Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Lock

3.2

Lock
NAME

Lock

DESCRIPTION

Administratively locks the resource in the current context, taking it out of

service until they are unlocked. You must cd to the resource you want to
lock. In order to update some resources, you must first lock them.

SYNTAX

lock

OPTIONS

No parameters required. The command pertains to the current resource only.

EXAMPLE

The following command locks the 11 card:

System/ Nodes/ MSFNodes/ 1-msfnode/ Slots/ 40-1-11card>lock

3.3

FILES

None.

SEE ALSO

Unlock.

Prot
NAME

Prot

DESCRIPTION

Clears or locks out protection.

SYNTAX

Prot {-lock}

OPTIONS

{-lock}

EXAMPLE

The following command clears protection:

Indicates to lock protection.

System>Prot
FILES

None.

SEE ALSO

Page 3-2

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Special Commands Reference

3HP700021015GUZZA

Reset

3.4

Reset
NAME

Reset

DESCRIPTION

Resets hardware or software for a resource, trunk or line group.

SYNTAX

reset [-sw | -grp]

OPTIONS

[-sw | -grp]

EXAMPLE

The following command resets a channelized interface card:

You can enter -sw or -grp to distinguish whether the

command is to affect software or a group. Where confusion
might exist for a given context, this is required.

system/ Nodes/ MSFNodes/ 10-msfnode/ Slots/ 37-2-Chanintfcard>reset

FILES

None.

SEE ALSO

1/23/07
Revision 3.4

Proprietary and Confidential

Page 3-3

Software Release 3.0

Volume 7

CLI Special Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Shut

3.5

Shut
NAME

Shut

DESCRIPTION

Administratively shuts down a resource.

SYNTAX

shut

OPTIONS

None.

EXAMPLE

The following command shuts down the 11 card:

system/Nodes/MSFNodes/1-msfnodes/slots/40-11card>shut

FILES

No.

SEE ALSO

3.6

Switch
NAME

Switch

DESCRIPTION

This command can be used to perform switchover to the protecting unit.

SYNTAX

switch -f

OPTIONS

-f

EXAMPLE

The following command performs the switchover to the protecting unit of

the channelized interface card.

Forces the switchover.

system/ Nodes/ MSFNodes/ 10-msfnode/ Slots/ 37-2-Chanintfcard> switch

FILES

No.

SEE ALSO

Page 3-4

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

CLI Special Commands Reference

3HP700021015GUZZA

Unlock

3.7

Unlock
NAME

Unlock

DESCRIPTION

Administratively unlocks the resource in the current context. You must cd

to the resource you want to unlock. Unlocking a resource can put it back
into service.

SYNTAX

unlock

OPTIONS

None.

EXAMPLE

The following command unlocks the 11 card in slot 40.

System/Nodes/MSFNodes/1-msfnodes/Slots/40-11card>unlock

3.8

FILES

No.

SEE ALSO

Lock.

Whoami
NAME

Whoami

DESCRIPTION

Displays the current user name.

SYNTAX

whoami

OPTIONS

None.

EXAMPLE

A user named admin performs the whoami command:

System/Nodes/MSFNodes/1-msfnodes/Slots/40-11card>up
System/Nodes>whoami
admin
Command Completed

FILES

No.

SEE ALSO

1/23/07
Revision 3.4

Proprietary and Confidential

Page 3-5

Software Release 3.0

Volume 7

CLI Special Commands Reference

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Whoami

Page 3-6

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
3HP700021015GUZZA

SECTION 4

Provisioning the Atrium Signaling Gateway

PROVISIONING THE ATRIUM SIGNALING GATEWAY

This section of the Command Line Interface Guide explains how to set up the signaling
gateway in the Atrium Wireless Soft Switch (WSS).

4.1

Signaling Gateway
The Add OPCCONFIG command establishes an instance of a signaling gateway in the Wireless
Softswitch (WSS).
NAME

Add OPCCONFIG

CONTEXT

System/Signaling-Gateway/Gateways

ADD COMMAND
SYNTAX

Add OPCCONFIG {parameter1=value1, parameter2=value2, . . .}

PARAMETERS

OPC1Gateway_Number
Number of SS7 Gateway WSS supports. Required.
OPC1Network_ID This is a required parameter that denotes the standard used
for traffic on this gateway, as follows:
Value

Meaning

1
2
3
4
5
6

ANSI92
ITU_INTL
ITU_NAL
C7
ITU_RES
ANSI96

OPC1own_point_code
The gateways own point code value. Required. Valid values
are existing point codes.
OPC1CLLI_code

The common language location identifier used to identify

equipment, facilities and other telecom company entities.
Required. Must be 11 alphanumeric characters.

OPC1backup_pc_indicator
This is a required parameter that denotes if the backup point
code indicator is present as follows:
Value

Meaning

0
1

Point code indicator is not present

Point code indicator is present

OPC1gateway_name
User-defined number for the SS7 signaling gateway. Optional.
Can be a value from 1 through 16.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 4-1

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Signaling Gateway

PARAMETER
(CONT.)

OPC1acc_indicatorThis is an optional parameter that denotes if the Automatic

Congestion Control (ACC) Indicator is present as follows:

OPC1backup_pc

OTHER
COMMANDS

Value

Meaning

0
1

ACC Indicator is not present

ACC Indicator is present

Backup Point Code. Optional. Must be entered in the format

nnn-nnn-nnn. Minimum value allowed is 0-0-0, with the
maximum value allowed 255-255-255.

From outside the resource context, use this format:

Del <n>-<nnn-nnn-nnn>-OPCCONFIG
Mod OPCCONFIG OPC1gateway_number=value, OPC1own_point_code=value,
OPC1network_id=value, {parameter1=value1, parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

EXAMPLES

To enter the OPCCONFIG values from the command prompt, at the System/
System/Signaling-Gateway/Gateways context:
add opcconfig
OPC1Gateway_Number:1
OPC1Network_ID:1
OPC1Own_Point_Code:000-000-001
OPC1CLLI_Code:12345678912
OPC1Backup_PC_Indicator:0
Prompt for Optional? (y/yes/n/no): y
OPC1Gateway_Name (Default:Not Defined):0
OPC1ACC_Indicator (Default:Y):1
OPC1Backup_PC (Default:0):000-000-002
Command Successful

Page 4-2

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Signaling Gateway

EXAMPLES
(CONT.)

An add opcconfig command as it might appear in a batch file:

cd;
cd Signaling-Gateway;
add opcconfig OPC1Gateway_Number=1, OPC1Network_ID=1,
OPC1Own_Point_Code=000-000-001, OPC1CLLI_Code=12345678912,
OPC1Backup_PC_Indicator=0, OPC1Gateway_Name=0, OPC1ACC_Indicator=1,
OPC1Backup_PC=000-000-002;
cd;

The following is an example of using the Mod command:

mod OPC1Backup_PC_Indicator=0

The following is an example of using the Del command:

del 1-<000-000-001>-OPCCONFIG

1/23/07
Revision 3.4

Proprietary and Confidential

Page 4-3

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

SS7 Card

4.2

SS7 Card
The Add SS7CARD command establishes an instance of an SS7 Card in the Wireless Softswitch
(WSS).
NAME

Add SS7CARD

CONTEXT

System/Signaling-Gateway/SS7-Card-Config

ADD COMMAND
SYNTAX

Add SS7CARD {parameter1=value1, parameter2=value2..}

PARAMETERS

Sim_Card_ID

Identifies the WSS node of the card to be administered.

Required. Valid values are 1 or 2.

Card

Identifies the card number to be provisioned. Required.

Minimum value allowed is 1, with the maximum value allowed
of 8. The default is 1.

Link_Class

This is a required parameter that classifies the link as follows:

Interface_Type

Baud_Rate

OTHER
COMMANDS

Value

Meaning

0
7
10

MTP2LINK
SAALLINK
HSLINK

This is an optional parameter that identifies the interface type

of the card to be administered as follows:
Value

Meaning

2
3

T1 (Default)
E1

This is an optional parameter that denotes the baud rate as

follows:
Value

Meaning

56
64
1544

DATARATE56
DATARATE64 (Default)
DATARATE1544

From outside the resource context, use this format:

Del <n>-<n>-SS7CARD

Page 4-4

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

SS7 Card

EXAMPLES

To enter the SS7CARD values from the command prompt, at the System/
Signaling-Gateway/SS7-Card-Config context:
add ss7card
Sim_Card_Id:1
Card:1
Link_Class:1
Interface_Type (Default:2):2
Baud_Rate (Default:64):64
Command Successful

An add SS7CARD command as it might appear in a batch file:

Cd;
Cd Signaling-Gateway; cd SS7-Card-Config;
add ss7card Sim_Card_Id =1, Card=1, Link_Class=1, Interface_Type=2,
Baud_Rate=64;
cd;

The following is an example of using the Del command:

del 1-1-SS7CARD

1/23/07
Revision 3.4

Proprietary and Confidential

Page 4-5

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Local SSN

4.3

Local SSN
The Add SGWOWNSSN command adds a local subsystem number to the signaling gateway.
NAME

Add SGWOWNSSN

CONTEXT

System/Signaling-Gateway/Gateways/<n>-<<nnn-nnn-nnn>>-OPCCONFIG/LocalSSN

ADD COMMAND
SYNTAX

Add SGWOWNSSN {parameter1=value1, parameter2=value2..}

Page 4-6

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Local SSN

PARAMETERS

SSN

Own Node TCAP SubSystemNumber SSN number. Required.

The minimum value allowed is 1, with the maximum value
allowed of 255. The default is 1.

No_of_concerned_PC
Number of concerned point codes. Required. Can be a value
from 0 through 5.
Concerned_pc_1
Concerned point code 1. Required. Valid values are existing
point codes.
Concerned_pc_2
Concerned point code 2. Required. Valid values are existing
point codes.
Concerned_pc_3
Concerned point code 3. Required.Valid values are existing
point codes.
Concerned_pc_4
Concerned point code 4. Required. Valid values are existing
point codes.
Variant

Network type. Optional. Valid values are:

Value
1
2
3
4
5
7

Application

Meaning
ITU_88 (Default)
ITU_92
ANSI_88
ANSI_92
ANSI_96
ITU_96

Application Identification. Optional. Valid values are as

follows:
Value

Meaning

3
7
11
19
35
71
131
259
170
771

BSC GSM
MAP
CAP
INAP
NPDB
IS41 + MAP
IWF APP
GSM SMLC/BSC CDMA
SGSN
RANAP

Concerned_pc_5 Concerned point code 5. Optional. Valid values are existing

point codes.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 4-7

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Local SSN

OTHER
COMMANDS

From outside the resource context, use this format:

Del <n>-SGWOWNSSN
Mod SGWOWNSSN SSN=value, {parameter1=value1, parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}
EXAMPLES

To enter the local subsystem values from the command prompt, at the
System/Signaling-Gateway/Gateways/1-<000-000-001>-OPCCONFIG/
Local-SSN context:
add SGWOWNSSN
SSN:1
No_of_concerned_PC:1
Concerned_PC_1:000-000-007
Prompt for Optional? (y/yes/n/no): y
Variant (Default:1):1
Application (Default:3):3
Command Successful

An add sgwownssn command as it might appear in a batch file:

Cd;
Cd Signaling-Gateway;
cd Gateways;
cd 1-<000-000-001>-OPCCONFIG;
cd Local-SSN;
add SGWOWNSSN SSN=1, No_of_concerned_PC=1, Concerned_pc_1= 000-000007, Variant=1, Application=3;
cd;

The following is an example of using the Mod command:

mod No_of_concerned_PC=1

The following is an example of using the Del command:

del 1-SGWOWNSSN

Page 4-8

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

MTP3 Routing or DPCs

4.4

MTP3 Routing or DPCs

The Add MTP3ROUTE command adds Message Transfer Part 3 (MTP3) routing destination
point codes (DPC) to the signaling gateway. These are required to set up the SS7 links.
NAME

Add MTP3ROUTE

CONTEXT

System/Signaling-Gateway/Gateways/<n>-<<nnn-nnn-nnn>>-OPCCONFIG/
MTP3-Routing-DPCs

ADD COMMAND
SYNTAX

Add MTP3ROUTE point_code=<value>, CLLI_code=<value>,

Isup_protocol=<value>, node_type=<value>,
[adjacent_PC=<value>,] [Name=<alue>,] [sls_Range=<value>]

PARAMETERS

MTP3ROUTE

This is a required keyword denoting the MTP3 routing DPC.

point_code

Specifies the Destination Point Code. Required. Valid values

are: [0..7]-[0..255]-[0..7].

CLLI_code

Specifies the CLLI code. Required. Must be 11 alphanumeric

characters. The default is Not Defined.

Isup_protocol

This is an optional parameter denoting the ISUP protocol of

this route as follows:

adjacent_PC

node_type

1/23/07
Revision 3.4

Value

Meaning

1
3
11
27

isupProt_itu
isupProt_ansi92
isupProt_ansi95 (Default)
isupProt_ansi92GRS.

This is an optional parameter that indicates whether this

route is to an adjacent signaling point as follows:
Value

Meaning

0
1

No (Default)
Yes

This is a required parameter that denotes the switch type as

follows:
Value

Meaning

0
1

SP (Default)
STP

Proprietary and Confidential

Page 4-9

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

MTP3 Routing or DPCs

PARAMETERS
(CONT.)

OTHER
COMMANDS

Name

Provides a freeform name for the MTP3 route. Optional.

Minimum value allowed is 1, with the maximum value allowed
of 16. The default is Not Defined.

sls_Range

This is an optional parameter that Indicates SLS Range type

of this route as follows:
Value

Meaning

16
32
256

sls_range_4bit
sls_range_5bit (Default)
sls_range_8bit

From outside the resource context, use this format:

Del <nnn-nnn-nnn>-MTP3ROUTE
Mod MTP3ROUTE point_code=value, {parameter1=value1, parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

Page 4-10

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

MTP3 Routing or DPCs

EXAMPLES

To enter the MTP3 Routing DPCs from the command prompt, at the System/
Signaling-Gateway/Gateways/1-<000-000-001>-OPCCONFIG/MTP3Routing-DPCs context:
add mtp3route
point_code:000-000-002
CLLI_Code:12345678912
Prompt for Optional? (y/yes/n/no): y
ISUP_Protocol:0
adjacent_PC (Default:N):0
Node_Type:0
Name (Default:Not Defined):test
SLS_Range (Default:32):32
Command Successful

An add mtp3route command as it might appear in a batch file:

Cd;
Cd Signaling-Gateway/Gateways;
cd 1-<000-000-001>-OPCCONFIG;
cd MTP3-Routing-DPCs;
add mtp3route point_code=0000-000-002, CLLI_Code=12345678912,
ISUP_Protocol=0, adjacent_PC=0, Node_Type=0, Name=test, SLS_Range=32;
cd;

The following is an example of using the Mod command:

mod Name=testlab

The following is an example of using the Del command:

del <001-002-003>-MTP3ROUTE

1/23/07
Revision 3.4

Proprietary and Confidential

Page 4-11

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Link Sets

4.5

Link Sets
The Add MTP3LINKSET command adds link sets to the signaling gateway. Before creating the
link sets, you must set up the oringation and destination point codes.
NAME

Add MTP3LINKSET

CONTEXT

System/Signaling-Gateway/Gateways/<n>-<nnn-nnn-nnn>-OPCCONFIG/LinkSets

ADD COMMAND
SYNTAX

Add MTP3LINKSET Link_Set_Id=<value>, Adjacent_DPC=<value>,

Point_Code=<value>

PARAMETERS

Link_Set_Id

Link Set Id. Required. The minimum allowed value is 1, with a

maximum of 128.

Adjacent_DPC

Adjacent Destination Point Code. Required. Valid values are

derived from existing destination point code (DPC) entries.

Point_Code

Origination Point Code. Required. Valid values are derived

from existing destination point code (DPC) entries.

OTHER
COMMANDS

From outside the resource context, use this format:

Del <n>-MTP3LINKSET
Mod MTP3LINKSET link_set_id=<value>, {parameter1=value1,
parameter2=value2..}

From outside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

Page 4-12

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Link Sets

EXAMPLES

To add link sets from the command prompt, at the System/SignalingGateway/Gateways/1-<000-000-001>-OPCCONFIG/Link-Sets context:
add mtp3linkset
link_set_id:10
Adjacent_DPC:000-000-007
Point_Code:000-008-005
No Optional Parameters for this Resource
Command Successful

An add sgwownssn command as it might appear in a batch file:

Cd;
Cd Signaling-Gateway;
cd 1-<000-000-001>-OPCCONFIG;
cd Link-Sets;
add mtp3linkset Link_Set_Id=10, Adjacent_DPC=000-000-007, Point_Code=000008-005;
Cd;

The following is an example of using the Mod command:

mod Adjacent_DPC=000-000-006

The following is an example of using the Del command:

del 1-MTP3LINKSET

1/23/07
Revision 3.4

Proprietary and Confidential

Page 4-13

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Reachable DPCs

4.6

Reachable DPCs
The Add MTP3COMBLINKSET command adds reachable Destination Point Codes (DPC) to
the link set. To add a DPC to the ling set, the DPC must already be set up in the system.
NAME

Add MTP3COMBLINKSET

CONTEXT

System/Signaling-Gateway/Gateways/<n>-<<nnn-nnn-nnn>>-OPCCONFIG/LinkSets/<n>-MTP3LINKSET/Reachable-DPCs

ADD COMMAND
SYNTAX

Add MTP3COMBLINKSET {parameter1=value1, parameter2=value2..}

PARAMETERS

Destination_PC

OTHER
COMMANDS

From outside the resource context, use this format:

Specifies the point code that can be reached through this

linkset. Required. Valid values are the point codes of existing
DPCs.

Del <nnn-nnn-nnn>-MTP3COMBLINKSET

EXAMPLES

To add reachable DPCs from the command prompt, at the System/SignalingGateway/Gateways/1-<000-000-001>-OPCCONFIG/Link-Sets/1MTP3LINKSET/Reachable-DPCs context:
add MTP3COMBLINKSET
Destination_PC:000-000-002
Command Successful

The MTP3COMBLINKSET command as it might appear in a batch file:

Cd;
Cd Signaling-Gateway;
Cd Gateways;
cd 1-<000-000-001>-OPCCONFIG;
cd Link-Sets;
cd 1-MTP3LINKSET;
cd Reachable-DPCs;
add MTP3COMBLINKSET Destination_PC=000-000-002;
Cd;

The following is an example of using the Del command:

del <000-000-005>-MTP3COMBLINKSET

Page 4-14

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Links

4.7

Links
The Add MTPLINK command add SS7 links to the link set.
NAME

Add MTPLINK

CONTEXT

System/Signaling-Gateway/Gateways/<n>-<nnn-nnn-nnn>-OPCCONFIG/LinkSets/<n>-MTP3LINKSET/Links

ADD COMMAND
SYNTAX

Add MTPLING SIM_Card_Id=<value>, Port_No=<value>, [Channel_No=<value>,]

Link_Id=<value>, [SLC=<value>,] Test_Pattern=<value>, [Baud_Rate=<value>]

PARAMETERS

SIM_Card_Id

Identifies the WSS node of the card to be administered.

Required. Valid values are 1 or 2.

Port_No

Specifies the port number in the card. Required. The

minimum allowed value is 0, with a maximum of 10. The
default is 1.

Channel_No

Specifies the channel number for T1/E1. The minimum

allowed value is 1. The maximum value for T1 is 24 and E1 is
32.

Link_Id

Specifies the MTP3 Link Index. This is used as SpId (SuId).

Required. Valid values are 1 through <maximum number of
links available in the WSS>.

SLC

Specifies the signaling link selection code for link Test.

Optional. The minimum allowed value is 0, with a maximum
value of 15.

Test_Pattern

Specifies the link test pattern in the form of hex digits. This
must be an even number of digits. Required. The maximum
number of digits is 30.

Baud_Rate

This is an optional parameter that denotes the data rate as

follows:

1/23/07
Revision 3.4

Value

Meaning

56
64
1544

DATARATE56
DATARATE64 (Default)
DATARATE1544

Proprietary and Confidential

Page 4-15

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Links

OTHER
COMMANDS

From outside the resource context, use this format:

Del <n>-MTPLINK
Mod MTPLINK Link_Id=value, {parameter1=value1, parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}
EXAMPLES

To add links from the command prompt, at the System/Signaling-Gateway/

Gateways/1-<000-000-001>-OPCCONFIG/Link-Sets/1-MTP3LINKSET/
Links context:
add mtplink
sim_card_id:1
port_no:1
Channel_No:1
Link_Id:2
slc:2
Test_Pattern:2222
Baud_Rate:64
Command Successful

An add mtplink command as it might appear in a batch file:

Cd;
Cd Signaling-Gateway;
cd 1-<000-000-001>-OPCCONFIG;
cd Link-Sets;
cd 1-MTP3LINKSET;
cd Links;
Add mtplink sim_card_id=1, port_no=1, Channel_No=1, Link_Id=2, slc=2,
Test_Pattern=2222, Baud_Rate=64;
Cd;

The following is an example of using the Mod command:

mod Test_Pattern=2222

The following is an example of using the Del command:

del 1-MTPLINK

Page 4-16

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

SCCPs

4.8

SCCPs
The Add SCCPROUTE adds Signaling Connection Control Parts (SCCP)s to the signaling
gateway. You must add the point codes to the system before setting up the SCCP routes.
NAME

Add SCCPROUTE

CONTEXT

System/Signaling-Gateway/Gateways/<n>-<nnn-nnn-nnn>-OPCCONFIG/SCCPs

ADD COMMAND
SYNTAX

Add SCCPROUTE {parameter1=value1, parameter2=value2..}

PARAMETERS

Point_Code

Specifies the origination point code. Required. Valid values

are exiting originating point code values.

Backup_PCs

This is a required parameter that denotes the backup point

code indicator as follows.
Value

Meaning

0
1
2

NOT_PRESENT
PRESENT
BACKUP2

Backup_PC

Specifies the backup point code. Optional. Valid values are

any available point codes.

Variant

This is an optional parameter that denotes the Variant of the

SCCP Route as follows:
Value

Meaning

1
2
3
4
5
6
7

ITU_88
ITU_92
ITU_96
ANSI_88
ANSI_92
ANSI_96
CHINA

Backup_PC1_Priority
Specifies the backup PC1 Priority. Optional. Minimum value
allowed is 0, with the maximum value allowed 15. The default
is 0.
Backup_PC2

1/23/07
Revision 3.4

Specifies backup point code 2. Optional. Valid values are any

available point codes.

Proprietary and Confidential

Page 4-17

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

SCCPs

PARAMETERS
(CONT.)

Backup_PC2_Priority
Specifies backup PC2 priority. Optional. Minimum value
allowed is 0, with the maximum value allowed 15. The default
is 0.
Traffic_Mode

OTHER
COMMANDS

This is an optional parameter that denotes the traffic

distribution mode as follows:
Value

Meaning

1
3

trfMod_domin
trfMod_dominShare

From outside the resource context, use this format:

Del <nnn-nnn-nnn>-SCCPROUTE
Mod SCCPROUTE point_code=value, {parameter1=value1, parameter2=value2..}

From outside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

EXAMPLES

To add SCCPs from the command prompt, at the System/SignalingGateway/Gateways/1-<000-000-001>-OPCCONFIG/SCCPs context:

add SCCPROUTE
point_code:000-000-005
Backup_PCs:0
Variant (Default:6):
Traffic_Mode (Default:1):
Command Successful

An add SCCPROUTE command as it might appear in a batch file:

Cd;
Cd Signaling-Gateway;
Cd 1-<000-000-001>-OPCCONFIG;
Cd SCCPs;
add SCCPROUTE point_code=000-000-005, Backup_PCs=0, variant=6,
Traffic_Mode=1;
Cd;

The following is an example of using the Mod command:

mod Backup_PCs=0

The following is an example of using the Del command:

del <000-000-002>-SCCPROUTE

Page 4-18

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

SSNs

4.9

SSNs
The Add SCCPSSN adds SSNs to the SCCP.
NAME

Add SCCPSSN

CONTEXT

System/Signaling-Gateway/Gateways/<n>-<nnn-nnn-nnn>-OPCCONFIG/SCCPs/
<nnn-nnn-nnn>-SCCPROUTE/SSNs

ADD COMMAND
SYNTAX

Add SCCPSSN {parameter1=value1, parameter2=value2..}

PARAMETERS

ssn

SubSystem Number. Required. Minimum value allowed is 1,

with the maximum value 255. The Default is 1.

Backup_PCs

This is a required parameter that denotes the backup point

code Indicator as follows:

OTHER
COMMANDS

Value

Meaning

0
1
2

No Backup
Backup
Backup2

Number_of_DPC

Number of destination point codes. Required. Valid values

are 0-2.

Description

Description. Optional. Minimum value allowed is 0, with the

maximum value allowed 16. The default is Not Defined.

Traffic_Mode

This is an optional parameter that denotes the traffic

distribution mode as follows:
Value

Meaning

1
3

trfMod_domin (Default)
trfMod_dominShare

Backup_PC

Backup Point Code. Optional. Minimum value allowed is 0-00, with the maximum value allowed 255-255-255.

DPC_1

Destination Point Code 1. Optional. Minimum value allowed is

0-0-0, with the maximum value allowed 255-255-255.

DPC_2

Destination Point Code 2. Optional. Minimum value allowed is

0-0-0, with the maximum value allowed 255-255-255.

From outside the resource context, use this format:

Del <n>-SCCPSSN
Mod SCCPSSN ssn=value, {parameter1=value1, parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 4-19

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

SSNs

EXAMPLES

To add remote SSNs from the command prompt, at the System/SignalingGateway/Gateways/1-<000-000-001>-OPCCONFIG/SCCPs/<nnn-nnnnnn>-SCCPROUTE/SSNs context:
add sccpssn
SSN:8
Backup_PCs:0
Number_of_DPC:1
Prompt for Optional? (y/yes/n/no): y
Description (Default:Not Defined):test
Traffic_Mode (Default:1):1
DPC_1 (Default:0):000-000-001
Command Successful

An add SCCPSSN command as it might appear in a batch file:

Cd;
Cd Signaling-Gateway;
Cd 1-<000-000-001>-OPCCONFIG; Cd SCCPs;
Cd <125-109-133>-SCCPROUTE;
Cd SSNs;
add sccpssn ssn=8, Backup_PCs=0, Number_of_DPC=1,
Description (Default:Not Defined)=test, Traffic_Mode (Default:1)=1, DPC_1
(Default:0)=000-000-001;
Cd;

The following is an example of using the Mod command:

mod Description=NewDesc

The following is an example of using the Del command:

del 3-SCCPSSN

Page 4-20

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Global Title Routing

4.10

Global Title Routing

The Add SCCGTT adds global title routing to the signaling gateway.
NAME

Add SCCGTT

CONTEXT

System/signaling-gateway/Gateways/<n>-<nnn-nnn-nnn>-OPCCONFIG/GlobalTitle-Routing

ADD COMMAND
SYNTAX

Add SCCGTT {parameter1=value1, parameter2=value2..}

PARAMETERS

Format

This is a required parameter that identifies the format as

follows:

Address

Value

Meaning

0
1
2
3
4

GTF_NO_GLOBAL_TITLE
GTF_WITH_NOA
GTF_WITH_TT
GTF_WITH_TT_NUMPLAN_ENCODING
GTF_WITH_TT_NUMPLAN_ENCODING_NOA

Address. Required. Minimum value allowed is 1, with a

maximum value 16. The default is Not Defined.

Encoding_SchemeThis is a required parameter that denotes the encoding

scheme as follows:
Value

Meaning

0
1
2
3

UNKNOWN_BCD
BCD_ODD
BCD_EVEN
NATIONAL

Nature_of_address
This is a required parameter that denotes the Nature of
Address as follows:

Translation_type

1/23/07
Revision 3.4

Value

Meaning

0
1
3
4

NP_UNKNOWN1
SUBSCRIBER_NUM
NATIONAL_SIGNIFICANT_NUM
INTERNATIONAL_NUM

Translation Type. Required. Minimum value allowed is 0, with

the maximum value allowed 255. The default is 0.

Proprietary and Confidential

Page 4-21

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Global Title Routing

PARAMETERS
(CONT.)

Same_GT_as_Incoming
This is a required parameter that indicates whether the values
for the global title outgoing parameters are the same as the
global title incoming parameters as follows:

Out_Format

Value

Meaning

0
1

N
Y

This is a required parameter that identifies the FormatType as

follows:
Value

Meaning

0
1
2
3
4

GTF_NO_GLOBAL_TITLE
GTF_WITH_NOA
GTF_WITH_TT
GTF_WITH_TT_NUMPLAN_ENCODING
GTF_WITH_TT_NUMPLAN_ENCODING_NOA

Number_of_pc

Number of point code. Required. Valid values are 1-2.

Point_Code

Origination Point Code. Required. Valid values are: [0..7][0..255]-[0..7].

outRtgInd

Routing Indicator. Optional. Valid values are:

Value

Meaning

0
1

GT
SSN

Comparing_Length
Compare Length. Optional. Minimum value allowed is 1, with
the maximum value allowed 16. The default is 16.
ssn

SSN of the Signaling gateway. Optional. Minimum value

allowed is 0, with the maximum value allowed 255. The default
is Not Defined.

Out_Address

Address. Optional. Minimum value allowed is 1, with the

maximum value allowed 16. The default is Not Defined.

Page 4-22

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Global Title Routing

PARAMETERS
(CONT.)

Traffic_mode

This is an optional parameter that denotes the traffic mode as

follows:
Value

Meaning

1
2

trfMod_domin
trfMod_share

Out_Nature_of_Address
This is an optional parameter that denotes the Nature of
Address as follows:
Value

Meaning

0
1
3
4

NP_UNKNOWN1
SUBSCRIBER_NUM
NATIONAL_SIGNIFICANT_NUM
INTERNATIONAL_NUM

Out_Encoding_Scheme
This is an optional parameter that denotes the encoding
scheme as follows:
Value

Meaning

0
1
2
3

UNKNOWN_BCD
BCD_ODD
BCD_EVEN
NATIONAL

Out_Translation_Type
Translation Type. Optional. Minimum value allowed is 0, with
the maximum value allowed 255. The default is 0.
Numbering_Plan

1/23/07
Revision 3.4

This is a required parameter that denotes the numbering plan

as follows:
Value

Meaning

0
1
2
3
4
5
6
7
8
9
15

NA_UNKNOWN1
ISDN_TELEPHONY1
GENUMBERING_PLAN
DATA_NUMBERING_PLAN1
TELEX_NUMBERING_PLAN1
MARINE_MOBILE_NUMBERING_PLAN
LAND_MOBILE_NUM1
ISDN_MOBILE_NUMBERING_PLAN
NATIONAL_NUM_PLAN1
PRIVATE_NUM_PLAN1
NTWK_SPEC

Proprietary and Confidential

Page 4-23

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Global Title Routing

PARAMETERS
(CONT.)

Out_Numbering_Plan
This is an optional parameter that denotes the Numbering
PlanType as follows:

PC_2

OTHER
COMMANDS

Value

Meaning

0
1
2
3
4
5
6
7
8
9
15

NA_UNKNOWN1
ISDN_TELEPHONY1
GENUMBERING_PLAN
DATA_NUMBERING_PLAN1
TELEX_NUMBERING_PLAN1
MARINE_MOBILE_NUMBERING_PLAN
LAND_MOBILE_NUM1
ISDN_MOBILE_NUMBERING_PLAN
NATIONAL_NUM_PLAN1
PRIVATE_NUM_PLAN1
NTWK_SPEC

Additional point code for the signaling gateway. Optional.

Valid values are any available point codes.

From outside the resource context, use this format:

Del <n>-<nnnnnnnnnnnnnnn>-<n>-<n>-<n>-<n>-<n>-SCCGTT

Page 4-24

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Global Title Routing

EXAMPLES

To add global title routing from the command prompt, at the System/
signaling-gateway/Gateways/1-<00-00-001>-OPCCONFIG/Global-TitleRouting context:
add sccgtt
Format:0
Address:1
Encoding_Scheme:0
Nature_of_Address:0
Translation_Type:0
Same_GT_as_Incoming:1
Out_Format:1
Number_of_PC:2
Point_Code:000-000-001
Prompt for Optional? (y/yes/n/no): y
outRtgInd (Default:0):0
Comparing_Length (Default:1):1
SSN (Default:1):1
Out_Address (Default:Not Defined):
Traffic_Mode (Default:1):1
Out_Nature_of_Address (Default:Not Defined):
Out_Encoding_Scheme (Default:0):0
Out_Translation_Type (Default:0):0
Numbering_Plan (Default:0):0
Out_Numbering_Plan (Default:0):0
PC_2 (Default:0):000-000-001
Command Successful

An add SCCGTT command as it might appear in a batch file:

Cd;
Cd Signaling-Gateway;
Cd 1-<000-000-001>-OPCCONFIG;
Cd Global-Title-Routing;
add SCCGTT format=0, address=1, Encoding_Scheme=0, Nature_of_address=0,
Translation_type=0, Same_GT_as_Incoming=1, Out_Format=1,
Number_of_PC=2, Point_code=000-000-001, outRtgInd=0, Comparing_Length=1,
ssn=3, Out_Address=1, Traffic_Mode=1, Out_Nature_of_Address=0,
Out_Encoding_Scheme=0, Out_Translation_Type=0, Numbering_Plan=0,
Out_Numbering_Plan=0, PC_2=000-000-001;
Cd;

The following is an example of using the Del command:

del 0-100000000000000-0-0-1-0-0-SCCGTT

1/23/07
Revision 3.4

Proprietary and Confidential

Page 4-25

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Own Global Title

4.11

Own Global Title

The Add OPCGTT adds a global title to the signaling gateway.

NAME

Add OPCGTT

CONTEXT

System/signaling-gateway/Gateways/<n>-<nnn-nnn-nnn>-OPCCONFIG/OwnGlobal-Title

ADD COMMAND
SYNTAX

Add OPCGTT {parameter1=value1, parameter2=value2..}

PARAMETERS

format

This is a required parameter that denotes the format as

follows:
Value

Meaning

0
1
2
3
4

No Global Title 0
GT NOA 1
GT TT 2
GT Num Encoding 3
GT TT Num Encoding 4

address

Address. Required. Minimum value allowed is 1, with the

maximum value allowed 16. The default is Not Defined.

ssn

SSN of the Signaling gateway. Required. Minimum value

allowed is 1, with the maximum value allowed 255. The default
is Not Defined.

Nature_of_Address
This is an optional parameter that denotes the Nature of
Address as follows:
Value

Meaning

0
1
3
4

Unknown (Default)
Subscriber Number 1
National Significant Number 3
International Number 4

Translation_Type Translation Type. Optional. Minimum value allowed is 0, with

the maximum value allowed 255. The default is 0.

Page 4-26

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Own Global Title

PARAMETERS
(CONT.)

Numbering_Plan

This is an optional parameter that denotes the Numbering

Plan as follows:
Value

Meaning

0
1
2
3
4
5
6
7
8
9

Unknown (Default)
ISDN/Telephony Numbering(E.164) 1
Generic Numbering 2
Data Numbering(X.121) 3
Telex Numbering (F.69) 4
Marine Mobile Numbering (E.211) 5
Land Mobile Numbering(E.212) 6
ISDN Mobile Numbering 7
National Num Plan 8
Private Num Plan 9

Encoding_SchemeThis is an optional parameter that denotes the Encoding

Scheme as follows:

OTHER
COMMANDS

Value

Meaning

0
1
2

Unknown (Default)
BCD Odd 1
BCD Even 2

From outside the resource context, use this format:

Mod OPCGTT format=value, address=value, ssn=value, {parameter1=value1,
parameter2=value2..}
Del <n>-<nnnnnnnnnnnnnnnn>-<n>-OPCGTT

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 4-27

Software Release 3.0

Volume 7

Provisioning the Atrium Signaling Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Own Global Title

EXAMPLES

To add a global title from the command prompt, at the System/signalinggateway/Gateways/1-<000-000-001>-OPCCONFIG/Own-Global-Title

context:
add opcgtt
Format:0
Address:1
SSN:1
Prompt for Optional? (y/yes/n/no): y
Nature_of_Address (Default:0):0
Translation_Type (Default:0):0
Encoding_Scheme (Default:0):0
Numbering_Plan (Default:0):0

An add OPCGTT command as it might appear in a batch file:

Cd;
Cd Signaling-Gateway;
Cd 1-<000-000-001>-OPCCONFIG;
Cd Own-Global-Title;
add OPCGTT format=0, address=1, ssn=1, Nature_of_Address=0,
Translation_Type=0, Encoding_Scheme=0, Numbering_Plan=0;
Cd;

The following is an example of using the Mod command:

mod Encoding_Scheme=2

The following is an example of using the Del command:

del 0-0100000000000000-1-OPCGTT

Page 4-28

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
3HP700021015GUZZA

SECTION 5

Provisioning the Atrium Wireless Media Gateway

Command Line Interface Guide

PROVISIONING THE ATRIUM WIRELESS MEDIA GATEWAY

This section of the Command Line Interface Guide explains how to provision a Wireless Media
Gateway.

5.1

Lock
The lock command is used to take a resource out of service.
NAME

Lock

DESCRIPTION

Administratively locks the resource in the current context. You must cd to

the resource you want to lock.

SYNTAX

lock

OPTIONS

No parameters required. The command pertains to the current resource only.

EXAMPLE

The following command locks the 11 card:

System/ Nodes/ MSFNodes/ 1-msfnode/ Slots/ 40-1-11card>lock

5.2

FILES

None.

SEE ALSO

Unlock.

Unlock
The Unlock command is used to bring a locked resource back into service.
NAME

Unlock

DESCRIPTION

Administratively unlocks the resource in the current context. You must cd

to the resource you want to unlock.

SYNTAX

unlock

OPTIONS

None.

EXAMPLE

The following command unlocks the 11 card in slot 40.

System/Nodes/MSFNodes/1-msfnodes/Slots/40-11card>unlock

FILES

No.

SEE ALSO

Lock.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-1

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Shutdown

5.3

Shutdown
The shut command is typically used as an intermediate step before using the lock command.
NAME

Shutdown

DESCRIPTION

Administratively shutdown a resource.

SYNTAX

shutdown

OPTIONS

None.

EXAMPLE

The following command shuts down the 11 card:

system/Nodes/MSFNodes/1-msfnodes/slots/40-11card>shutdown

FILES

5.4

No.

Reset
The reset command is used for Hardware/Software reset of a resource where applicable.
NAME

Reset

DESCRIPTION

Resets hardware or software for a resource, trunk or line group.

SYNTAX

reset [-sw | -grp]

OPTIONS

[-sw | -grp]

EXAMPLE

The following command resets a channelized interface card:

You can enter -sw or -grp to distinguish whether the

command is to affect software or a group. Where confusion
might exist for a given context, this is required.

system/ Nodes/ MSFNodes/ 10-msfnode/ Slots/ 37-2-Chanintfcard>reset

FILES

None.

Page 5-2

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Speedadd

5.5

Speedadd
This command can be used to help you quickly configure channels on a channelized span. This
command is only valid to configure ISUP and BSS channels.
NAME

Speedadd

DESCRIPTION

Configures channels on a channelized span.

SYNTAX

Speedadd {TrunkGrpNumber} {NumChannels} {StartChannelNum} {StartCIC}

{StartCKT} {AttenuationProfile} {Loopback} {SpanName}

OPTIONS

TrunkGrpNumber-Mandatory Parameter
SS7 or BSS group number
NumChannels-Mandatory Parameter
Number of channels user wants to configure
StartChannelNum-Mandatory Parameter
Number of start Channel
StartCIC-Mandatory Parameter
CIC id to be assigned to first channel
StartCKT-Mandatory Parameter
CKT id to be assigned to first channel
AttenuationProfile-Mandatory Parameter
Attenuation profiles for channels
Loopback-Mandatory Parameter
Loop back for channels
SpanName-Mandatory Parameter
Name of span

EXAMPLE

The following is the command to channelized and configure all channels of

span 5 under the T1 card in slot 21.
System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1-MSFNODE/
Slots/21-1-T1CARD/5-SPAN>Channelization=2
Command completed
System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1-MSFNODE/
Slots/21-1-T1CARD/5-SPAN>
Speedadd TrunkGrpNumber=1600, NumChannels=24, StartChannelNum=1,
StartCIC=100, StartCKT=100,AttenuationProfile=0, Loopback=0,
SpanName=testCli

FILES

1/23/07
Revision 3.4

None.

Proprietary and Confidential

Page 5-3

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Speeddelete

5.6

Speeddelete
This command can be used to help you quickly unconfigure channels on a channelized span.
This command is only valid to configure ISUP and BSS channels.
NAME

Speeddelete

DESCRIPTION

Unconfigures channels on a channelized span.

SYNTAX

Speeddelete

OPTIONS

None.

EXAMPLE

The following is the command to unconfigure all channel of span 5 under T1

card in slot 21
System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1-MSFNODE/
Slots/21-1-T1CARD/5-SPAN> shutdownallchan
speeddelete

FILES

None.

Page 5-4

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Media Gateway

5.7

Media Gateway
The Add MSFNODE command establishes an instance of a media gateway in the Wireless
Softswitch (WSS).
NAME

Add MSFNODE

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway

ADD COMMAND
SYNTAX

Add MSFNODE {parameter1=value1, parameter2=value2, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-5

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Media Gateway

PARAMETERS

WMG_node

Identifies the WMG node to be administered. Required. Valid

values are 2-64.

Msfnodetype

Identifies the type of MSF node to use. Required.

Node_Group

Value

Meaning

0
1

MSF_NODE_STANDARD
MSF_NODE_RS

Specifies the group id of this node. Required.

CM_Slot_7_M_IP_1
Specifies the IP Address of Control Card A at slot 7 on this
node. Required. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
CM_Slot_14_M_IP_1
Specifies the IP Address of Control Card B at slot 14 on this
node. Required. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
CM_Slot_7_SN1_2
Specifies serial number 1 for CM card at slot 7. Required. This
value can be up to 12 alphanumeric characters. Default:Not
Defined.
CM_Slot_7_SN2_2
Specifies serial number 2 for CM card at slot 7. Required. This
value can be up to 12 alphanumeric characters. Default:Not
Defined.
CM_Slot_14_SN1_2
Specifies serial number 1 for CM card at slot 14. Required.
This value can be up to 12 alphanumeric characters.
Default:Not Defined.
CM_Slot_14_SN2_2
Specifies serial number 2 for CM card at slot 14. Required.
This value can be up to 12 alphanumeric characters.
Default:Not Defined.
ATM_Call_Subnet_Mask
Specifies the subnet mask for call control NIC for WMG.
Required. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
CC_Subnet_Mask Specifies the subnet mask for call control Ethernet in the
WMG. Required. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
CC_IP

Specifies the floating IP Address of Call Control Traffic

Ethernet Interface. The minimum allowed value is 0.0.0.0, with
a maximum of 255.255.255.255.

Page 5-6

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Media Gateway

Mgmt_Intf_IP

Specifies the floating IP Address of the Management Traffic

Ethernet Interface. Required. The minimum allowed value is
0.0.0.0, with a maximum of 255.255.255.255.

Call_WSS_Router_IP
Specifies the call-control router IP address. Required. The
minimum allowed value is 0.0.0.0, with a maximum of
255.255.255.255.
Mgmt_WMG_Router_IP
Specifies the Management Ethernet router IP address.
Required. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
WMG_CC_Router_IP
Specifies the Call Control Ethernet router IP address.
Required. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
Mgmt_NIC_IP

Specifies the Management NIC IP address. Required. The

minimum allowed value is 0.0.0.0, with a maximum of
255.255.255.255.

Call_NIC_IP

Specifies the Call Control NIC IP address. Required. The

minimum allowed value is 0.0.0.0, with a maximum of
255.255.255.255.

Sm_Span_Type

This is a required parameter that specifies the type of Spans

on the Service Matrix cards in this WMG Node as follows:
Value

Meaning

0
1

T1
E1

Pri_ReferenceType
This is a required parameter that specifies the type of primary
clock reference as follows:

1/23/07
Revision 3.4

Value

Meaning

1
2
4
5

EXT-1
EXT-2
ATM
CHAN

Pri_Slot

Specifies the slot number in which the primary clock

reference resides, if the type is not external. Required. Valid
values are 1-40. Default: Not Defined.

Pri_Card

Specifies the the facility number which provides the primary

clock reference, if the type is not external. Required. Valid
values are 1-60. Default: Not Defined.

Pri_Facility

Specifies the facility number which provides the primary

clock reference, if the type is not external. Required. Valid
values are 1-60. Default: Not Defined.

Proprietary and Confidential

Page 5-7

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Media Gateway

Sec_ReferenceType
This is a required parameter that specifies the type of
secondary clock reference as follows:
Value

Meaning

1
2
4
5

EXT-1
EXT-2
ATM
CHAN

Sec_Slot

Specifies the the slot number in which the secondary clock

reference resides, if the type is not external. Required. Valid
values are 1-40. Default: Not Defined.

Sec_Card

Specifies the card number on which the secondary clock

reference resides, if the type is not external. Required. Valid
values are 1-8. Default: Not Defined.

Sec_Facility

Specifies the facility number which provides the secondary

clock reference, if the type is not external. Required. Valid
values are 1-60. Default: Not Defined.

Switch_ID

A six digit number for recording the msfNode Switch_ID for

billing purposes. Required. Default: Not Defined

SVC

This is a required parameter that enables accounting for

Switched Virtual Circuit (SVC) connections at the WMG Node
level as follows:

CBR

Value

Meaning

1
2

On
Off

This is a required parameter that specifies the cell count for

SVC CBR connections at the WMG node level as follows:
Value

Meaning

1
2
3

On
Off
Study

Software_Version_A
Specifies the software version for the CM card at slot 7.
Required.
Software_Version_B
Specifies the software version for the CM card at slot 14.
Required.

Page 5-8

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Media Gateway

Time_Zone_Index Specifies time zone index defined in Time Zone Distribution

table. Required.
cpuMsfNode

Identifies the WMG node to be administered. Optional.

Optional. Valid values are 1-64. Default: Not Defined.

Name

Provides a freeform entry for recording a name for the node.

Optional. Valid values are 1-64 alphanumeric characters.
Default: Not Defined.

Contact

Provides a freeform entry for recording the contact person for

the node. Optional. Valid values are 1-64 alphanumeric
characters. Default: Not Defined.

Location

Provides a freeform entry for recording the location of the

node. Optional. Valid values are 1-64 alphanumeric
characters. Default: Not Defined.

Node_Location_Type
This is an optional parameter that specifies the location of the
node as follows:
Value

Meaning

0
1

Local
Remote

site

Provides a freeform entry for recording the site where the

node is located. Optional. Valid values are 1-32 alphanumeric
characters. Default: Not Defined.

aisle

Provides a freeform entry for recording the aisle where the

node is located. Optional. Valid values are 1-32 alphanumeric
characters. Default: Not Defined.

frame

Provides a freeform entry for recording the frame where the

node is located. Optional. Valid values are 1-32 alphanumeric
characters. Default: Not Defined.

shelf

Provides a freeform entry for recording the shelf where the

node is located. Optional. Valid values are 1-32 alphanumeric
characters. Default: Not Defined.

CLLI_Code

Specifies the Common Language Location Code of the WMG

node. Optional. Valid values are 1-11 alphanumeric
characters. Default: Not Defined.

MSC_Next_Hop_Router
IP address of the router used by the MSC to reach this MSF.
Optional. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
Default_Gateway IP address of the default gateway on the subnet of this MSF
node. Optional. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-9

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Media Gateway

Cntrl_NIC_Card_Type
This is an optional parameter that specifies the card type of
the control NIC as follows:
Value

Meaning

0
1
2

NA (Default)
ai
ci

Gtwy_Cntrl_Protocol
This is an optional parameter that specifies the gateway
control protocol as follows:
Value

Meaning

1
2

EGCP (Default)
MEGACO

ATM_Address_Prefix
Specifies the 26 digits ATM Switch Address Prefix. Optional.
Valid values are 0-30 digits. Default: Not Defined.
Vsc_Pkt_Threshold
Specifies the threshold for the number of IP packets received
with invalid headers within a 15 minute interval. Optional. The
minimum allowed value is 0, with a maximum of Not Defined.
Default: 0
Min_UDP_Port

Specifies the lowest value of the usable UDP port range for
RTP/RTCP. Optional. The minimum allowed value is 10000,
with a maximum of 65535. Default: 10000

Max_UDP_Port

Specifies the highest value of the usable UDP port range for
RTP/RTCP. Optional. The minimum allowed value is 10000,
with a maximum of 65535. Default: 65535

AAL1_Loopback

This is an optional parameter that specifies if the AAL1

Resource Loopback is to be Enabled or Disabled for TDM
calls on this node as follows:
Value

Meaning

0
1

Disabled (Default)
Enabled

Fax/Modem_Tone_Detection
This is an optional parameter that specifies if the Fax/Modem
Tone Detection is to be reported for calls on this node as
follows:
Value

Meaning

0
1

Tone Detection Off

Tone Detection On

Page 5-10

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Media Gateway

EXT-1

EXT-2

This is an optional parameter that specifies the Termination

Mode of the primary clock reference which is of type ext1 or
ext2 as follows:
Value

Meaning

0
1

Twist
Coax (Default)

This is an optional parameter that specifies the Termination

Mode of the secondary clock reference which is of type ext1
or ext2 as follows:
Value

Meaning

0
1

Twist
Coax (Default)

CM_Slot_7_CC_IP_1
IP Address of the Control Module Card in slot 7. This IP
Address is used for call control over Ethernet network.
Optional. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
CM_Slot_14_CC_IP_1
IP Address of the Control Module Card in slot 14. This IP
Address is used for call control over Ethernet network.
Optional. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
Ethernet_Subnet_Mask
Subnet mask of the ethernet subnet of this MSF Node.
Optional. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
CM_Slot_7_M_IP_2
IP Address of the Control Module Card in slot 7. This IP
Address is used for Management Control over an ATM
network. Optional. The minimum allowed value is 0.0.0.0, with
a maximum of 255.255.255.255.
CM_Slot_14_M_IP_2
IP Address of the Control Module Card in slot 14. This IP
Address is used for Management Control over an ATM
network. Optional. The minimum allowed value is 0.0.0.0, with
a maximum of 255.255.255.255.
CM_Slot_7_CC_IP_2
IP Address of the Control Module Card in slot 7. This IP
Address is used for Call Control over an ATM network.
Optional. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-11

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Media Gateway

CM_Slot_14_CC_IP_2
IP Address of the Control Module Card in slot 14. This IP
Address is used for Call Control over an ATM network.
Optional. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255.
ATM_Subnet_Mask
Subnet mask of the ATM (IPoverATM) subnet of this MSF
node. Optional. The minimum allowed value is 0.0.0.0, with a
maximum of 255.255.255.255. Default: Not defined.
PVC

SoftPVC

UBR

NrtVBR

RtVBR

This is an optional parameter that specifies the accounting

for PVC connections at the WMG Node level as follows:
Value

Meaning

1
2

On
Off (Default)

This is an optional parameter that specifies the accounting

for SoftPVC connections at the WMG Node level as follows:
Value

Meaning

1
2

On
Off (Default)

This is an optional parameter that specifies the cell count for

SVC UBR connections at the WMG node level as follows:
Value

Meaning

1
2
3

On (Default)
Off
Study

This is an optional parameter that specifies the cell count for

SVC NrtVBR connections at the WMG node level as follows:
Value

Meaning

1
2
3

On (Default)
Off
Study

This is an optional parameter that specifies the cell count for

SVC RtVBR connections at the WMG node level as follows:
Value

Meaning

1
2
3

On (Default)
Off
Study

Page 5-12

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Media Gateway

CPU_Low_Per_

Specifies the minimum threshold value for CPU load.

Optional. Valid values are 0-100. Default: 80.

CPU_High_Per_

Specifies the maximum threshold value for CPU load .

Optional. Valid values are 0-100. Default: 90.

Memory_Low_Per Specifies the minimum threshold value for memory usage.

Optional. Valid values are 0-100. Default: 80.
Memory_High_Per Specifies the maximum threshold value for memory usage.
Optional. Valid values are 0-100. Default: 90.
Interval_in_secondSpecifies the interval in seconds over which to compute the
average CPU and Memory utilization. Optional. Valid values
are 5-30. Default: 15.
PM_Card

Enable/Disable diagnostics for MSC chips on PM card.

Optional. Enter 0 for No, or 1 for Yes. Default: 0.

VS_Card

Enable/Disable diagnostics for Highways on VS card .

Optional. Enter 0 for No, or 1 for Yes. Default: 0.

Sync_Static_DB_Slot7
Specifies whether to synchronize static database or not for
the CM card at slot7. Optional. Enter 0 for No, or 1 for Yes.
Default: 1.
Sync_Dynamic_DB_Slot7
Specifies whether to synchronize the dynamic database or
not for the CM card at slot 7. Optional. Enter 0 for No, or 1 for
Yes. Default: 1.
Download_DB_Slot7
Specifies whether to download the database when the
database checksum fails for the CM card at slot 7. Optional.
Enter 0 for No, or 1 for Yes. Default: 1.
Force_Download_SW_Slot7
Specifies whether to download the software image to the
WMG regardless if the checksum passes or not for the CM
card at slot 7. Optional. Enter 0 for No, or 1 for Yes. Default: 0.
Software_File_Slot14
Specifies the software control file name for the CM card at
slot 14. Optional. Valid values are 0-33 alphanumeric
characters. Default: MsfSwControlFile.txt.
Database_File_Slot14
Specifies the Database control file name for the CM card at
slot 14. Optional. Valid values are 0-33 alphanumeric
characters. Default: MsfDbControlFile.txt
Sync_Static_DB_Slot14
Specifies whether to synchronize the static database or not
for the CM card at slot 14. Optional. Enter 0 for No, or 1 for
Yes. Default: 1.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-13

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Media Gateway

Sync_Dynamic_DB_Slot14
Specifies whether to synchronize the dynamic database or
not for the CM card at slot 14. Optional. Enter 0 for No, or 1 for
Yes. Default: 1.
Download_DB_Slot14
Specifies whether to download the database when the
database checksum fails for the CM card at slot 14. Optional.
Enter 0 for No, or 1 for Yes. Default: 1.
Force_Download_SW_Slot14
Specifies whether to download the software image to the
WMG regardless if the checksum passes or not for the CM
card at slot 14. Optional. Enter 0 for No, or 1 for Yes. Default:
0.
ALC

This is an optional parameter that specifies the Automatic

Level Control as follows:
Value

Meaning

0
1

Off (Default)
On

Sm_Pcm_Encoding
This is an optional parameter that specifies the PCM
Encoding format used by the SM Card as follows:
Value

Meaning

0
1

ALaw
MuLaw (Default)

VS_Pcm_Encoding
This is an optional parameter that specifies the PCM
Encoding format used by the VS Card as follows:

OTHER
COMMANDS

Value

Meaning

0
1

ALaw
MuLaw (Default)

From outside the resource context, use this format:

Del <n>-MSFNODE
Mod MSFNODE WMG_Node=value, {parameter1=value1, parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

Page 5-14

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Media Gateway

EXAMPLES

To enter the media gateway values from the command prompt, at the
System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway context:
add MSFNODE
WMG_Node:2
msfNodeType:0
Node_Group:0
CM_Slot_7_M_IP_1:10.100.1.202
CM_Slot_14_M_IP_1:10.100.1.200
CM_Slot_7_SN1_2:000007d549c9
CM_Slot_7_SN2_2:000007d53178
CM_Slot_14_SN1_2:000007d51db2
CM_Slot_14_SN2_2:00007d51a50
ATM_Call_Subnet_Mask:255.255.255.0
CC_Subnet_Mask:255.255.255.0
CC_IP:0.0.10.0
Mgmt_Intf_IP:1.0.0.0
Call_WSS_Router_IP:0.0.0.0
Mgmt_WMG_Router_IP:0.0.0.0
WMG_CC_Router_IP:0.0.0.0
Mgmt_NIC_IP:0.0.0.0
Call_NIC_IP:0.0.0.0
Sm_Span_Type:1
Pri_ReferenceType:1
Pri_Slot:1
Pri_Card:1
Pri_Facility:1
Sec_ReferenceType:1
Sec_Slot:1
Sec_Card:1
Sec_Facility:1
Switch_ID:123456
SVC=2, Software_Version_A:03.00.30.00
Software_Version_B:03.00.33.00
Time_Zone_Index:1

An add MSFNODE command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway; cd Spatial-Media-Gateway;
add MSFNODE WMG_Node=2, msfNodeType=0, Node_Group=0,
CM_Slot_7_M_IP_1=10.100.1.202, CM_Slot_14_M_IP_1=10.100.1.200,
CM_Slot_7_SN1_2=000007d549c9, CM_Slot_7_SN2_2=000007d53178,
CM_Slot_14_SN1_2=000007d51db2, CM_Slot_14_SN2_2=00007d51a50,
ATM_Call_Subnet_Mask=255.255.255.0, CC_Subnet_Mask=255.255.255.0,
CC_IP=0.0.10.0, Mgmt_Intf_IP=1.0.0.0, Call_WSS_Router_IP=0.0.0.0,
Mgmt_WMG_Router_IP=0.0.0.0, WMG_CC_Router_IP=0.0.0.0,
Mgmt_NIC_IP=0.0.0.0, Call_NIC_IP=0.0.0.0, Sm_Span_Type=1,
Pri_ReferenceType=1, Pri_Slot=1, Pri_Card=1, Pri_Facility=1,
Sec_ReferenceType=1, Sec_Slot=1, Sec_Card=1, Sec_Facility=1,
Switch_ID=123456, SVC=2, Software_Version_A=03.00.30.00,
Software_Version_B=03.00.33.00, Time_Zone_Index=1;
cd;

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-15

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Media Gateway

The following is an example of using the Mod command:

mod MSFNODE WMG_Node=1, alc=1
The following is an example of using the Del command:
del 1-msfnode

Page 5-16

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Cards

5.8

Cards
The Add T1CARD command establishes an instance of a T1 card to be administrated.
NAME

Add T1CARD

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots

ADD COMMAND
SYNTAX

Add T1CARD {parameter1=value1, parameter2=value2, . . .}

PARAMETERS

slot

Identifies the slot number of the card to be administered.

Required.

card

Identifies the card number to be administered. Required.

Group_1

Specifies the protection group in which this card is a

member. A value of zero (0) indicates the card is a standalone
card and does not participate in any protection switching.
Required.

Protecting_Card_1 This is an optional parameter that specifies if the card is a

redundant card as follows:
Value

Meaning

1
2

No (Default)
Yes

Card_Inhibit_Switchover
This is an optional parameter that specifies whether
protection switching is inhibited for this card as follows:

Priority

Revision 3.4

Meaning

1
2

No (Default)
Yes

This is an optional parameter that identifies the card

protection priority as follows:

Channel_Id

1/23/07

Value

Value

Meaning

0
1
2

Not Applicable
Low (Default)
High

Identifies the card protection channel ID.Optional. Valid

values are 1-14.

Proprietary and Confidential

Page 5-17

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Cards

Group_Inhibit_Switchover
This is an optional parameter that specifies whether
protection switching is inhibited for this group as follows:

OTHER
COMMANDS

Value

Meaning

0
2

No (Default)
Yes

From outside the resource context, use this format:

Del <n>-<n>-T1CARD
Mod T1CARD slot=value, card=value, {parameter1=value1, parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}
EXAMPLES

To enter the T1 card values from the command prompt, at the System/
Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1-MSFNODE/
Slots context:
add T1CARD
Slot:35
Card:1
Group_1:16
Prompt for Optional? (y/yes/n/no) : y
Protecting_Card_1 (Default:N) :n
Card_Inhibit_Switchover (Default:N) :n
Priority (Default:1) :1
Channel_Id (Default:0) :1
Group_Inhibit_Switchover (Default:N) :n
Command Successful

An add T1CARD command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway; cd Spatial-Media-Gateway; cd 1MSFNODE;
cd Slots;
add T1CARD Slot=35, Card=1, Group_1=16, Protecting_Card_1=y,
Card_Inhibit_Switchover=n, Priority=1, Channel_Id=1,
Group_Inhibit_Switchover=n;
cd;

The following is an example of using the Mod command:

Mod T1CARD slot=34, card=1, priority=2
The following is an example of using the Del command:
del 34-1-T1CARD

Page 5-18

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

T1 SPAN

5.9

T1 SPAN
The Add SPAN command establishes a span in the T1 card.
NAME

Add SPAN

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-T1CARD

ADD COMMAND
SYNTAX

Add SPAN {parameter1=value1, parameter2=value2, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-19

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

T1 SPAN

PARAMETERS

Facility_Number

Identifies the facility number in which the span resides.

Required. Valid values are 1-60.

Sonet_Path_Number
Identifies the SONET path number in which the span resides.
Required. Valid values are 1-number of defined SONET paths
available.
Sub-port_Number Identifies the facility number in which the span resides.
Required. Valid values are 1-number of defined facilities
available.
Line_Type

This is a required parameter that specifies the type of DS1

line to use as follows:

Send_Code

Value

Meaning

2
3
4
5
8
9
12
13
14
15

ESF
D4
E1 No CRC
E1 CRC
UNFRAMED
E1UNFRAMED
ESFBits
D4Bits
E1Bits
E1 CRCBits

This is a required parameter that specifies the type of code

that is sent across the DS1 interface as follows:
Value
1
2
3
4
9
10
11

Meaning
Send No Code
Send Line Code
Send Payload Code
Send Reset Code
Send AIS
Send Yellow Alarm
Send Idle Code

Facilities_Data_Link
This is a required parameter that specifies the use of the
facilities data link as follows:

Configurable

Value

Meaning

2
8

ANSIT1403
None

This is a required parameter that denotes whether its a

configurable span or not as follows:
Value

Meaning

0
1
2

Non Configurable
SPAN Configurable
Configuring SPAN

Page 5-20

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

T1 SPAN

Name

Name given by users. Optional. Valid values are 1-64

alphanumeric characters. Default: Not Defined

Channelization

This is an optional parameter that specifies whether the span

is channelized or not as follows:

Line_Coding

Value

Meaning

1
2

Disabled (Default)
Enabled

This is an optional parameter that specifies the type of zero

code suppression to use on this line as follows:

Line_Build_Out

Value

Meaning

1
2
3
5
8

JBZS
B8ZS
HDB3
AMI
DS1_LC_NA

This is an optional parameter that specifies the line length for

short hauls and attenuation for long hauls as follows:
Value

Meaning

0
1
2
3
4
5
6
7
8

SHORTHAUL0 (Default)
SHORTHAUL1
SHORTHAUL2
SHORTHAUL3
SHORTHAUL4
LONGHAULA
LONGHAULB
LONGHAULC
LONGHAULD

Status_Change_Trap
This is an optional parameter that specifies whether the
status change traps should be generated for this span as
follows:

Loopback_Type

1/23/07
Revision 3.4

Value

Meaning

0
1

No
Yes (Default)

This is an optional parameter that specifies the loopback type

as follows:
Value

Meaning

1
2
3
5

No Loop (Default)
Payload Loop
Line Loop
Inward Loop

Proprietary and Confidential

Page 5-21

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

T1 SPAN

Allow_Remote_Loop
This is an optional parameter that specifies whether the far
end is allowed to loop the interface as follows:
Value

Meaning

1
2

Yes
No (Default)

Use_System_Defaults
This is an optional parameter that specifies whether the
system default values are to be used for the threshold values
as follows:
0
1

No
Yes (Default)

ES_sec_per_15min
Specifies the threshold value for the number of Errored
Seconds per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 900. Default: 65.
SES_sec_per_15min
Specifies the threshold value for the number of Severely
Errored Seconds per 15 minute interval. Optional. The
minimum allowed value is 1, with a maximum value of 900.
Default: 10.
SEF_sec_per_15min
Specifies the threshold value for the number of Severely
Errored Framing Seconds per 15 minute interval. Optional.
The minimum allowed value is 1, with a maximum value of
900. Default: 2.
UAS_sec_per_15min
Specifies the threshold value for the number of Unavailable
Seconds per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 900. Default: 10.
CSS_sec_per_15min
Specifies the threshold value for the number of Controlled
Slip Seconds per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 900. Default: 1.
PCV_sec_per_15min
Specifies the threshold value for the number of Path Coding
Violations per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 100000. Default:
13296.
LES_sec_per_15min
Specifies the threshold value for the number of Line Errored
Seconds per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 900. Default: 65.

Page 5-22

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

T1 SPAN

BES_sec_per_15min
Specifies the threshold value for the number of Bursty
Errored Seconds per 15 minute interval. Optional. The
minimum allowed value is 1, with a maximum value of 900.
Default: 1.
DM_sec_per_15min
Specifies the threshold value for the number of Degraded
Minutes per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 15. Default: 1.
LCV_sec_per_15min
Specifies the threshold value for the number of Line Code
Violations per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 100000. Default:
13340.
PCM_Multiplex

Specifies the multiplex in use, refer to GSM08.08 . Optional.

The minimum allowed value is 0, with a maximum value of
Not Defined. Default: 0.

Monitor_Perform This is an optional parameter that specifies whether

performance monitoring has been enabled as follows:

OTHER
COMMANDS

Value

Meaning

1
2

Enabled
Disabled

From outside the resource context, use this format:

Del SPAN <n>-SPAN
Mod SPAN Span_Num=value, {parameter1=value1, parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-23

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

T1 SPAN

EXAMPLES

To enter the span values from the command prompt, at the System/Nodes/
Wireless-Media-Gateway/Spatial-Media-Gateway/1-MSFNODE/Slots/<n><n>-T1CARD context:
add span
Facility_Number:1
Sonet_Path_Number:1
Sub-port_Number:1
Line_Type:2
Line_Coding:2
Send_Code:2
Facilities_Data_Link:2
Configurable:1
Prompt for Optional? (y/yes/n/no) : y
Name (Default:Not Defined) :test1
Channelization (Default:1) :2
Line_Build_Out (Default:0) :0
Status_Change_Trap (Default:Y) :
Loopback_Type (Default:1) :1
Allow_Remote_Loop (Default:2) :1
Use_System_Defaults (Default:Y) :y
ES_sec_per_15min (Default:65) :
SES_sec_per_15min (Default:10) :
SEF_sec_per_15min (Default:2) :
UAS_sec_per_15min (Default:10) :
CSS_sec_per_15min (Default:1) :
PCV_sec_per_15min (Default:13296) :
LES_sec_per_15min (Default:65) :
BES_sec_per_15min (Default:1) :
DM_sec_per_15min (Default:1) :
LCV_sec_per_15min (Default:13340) :
PCM_Multiplex (Default:0) :
Monitor_Perform (Default:2) :1
Command Successful

An add SPAN command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots; cd 36-1-T1CARD;
add span Facility_Number=4, Sonet_Path_Number=1, Sub-port_Number=1,
Line_Type=2, Line_Coding=2, Send_Code=2, Facilities_Data_Link=2,
Configurable=1, Name=test1, Channelization=2, Line_Build_Out=0,
Loopback_Type=1, Allow_Remote_Loop=1, Use_System_Defaults=1,
Monitor_Perform=1;
cd;

The following is an example of using the Mod command:

Mod SPAN Span_Num=1, Monitor_Perform=1

The following is an example of using the Del command:

del span 2357-span

Page 5-24

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Voice Server Card (VS Card)

5.10

Voice Server Card (VS Card)

The Add VOICESERVERCARD command establishes an instance of a voice server card.
NAME

Add VOICESERVERCARD

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots

ADD COMMAND
SYNTAX

Add VOICESERVERCARD {parameter1=value1, parameter2=value2, . . .}

PARAMETERS

Slot

Identifies the slot number of the card to be administered.

Required. Valid values are dependent upon the number of
slots available.

Card

Identifies the card number to be administered. Required.

Card_Type

This is a required parameter that specifies the type of the

card as follows:

1/23/07
Revision 3.4

Value

Meaning

24
30
31

VSM4a_CARD
VSM4b_CARD
VSM4c_CARD

Card_Version

This is a required parameter that specifies the card version.

Group_1

This is a required parameter that specifies the protection

group in which this card is a member. A value of zero (0)
indicates the card is a standalone card and does not
participate in any protection switching.

Proprietary and Confidential

Page 5-25

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Voice Server Card (VS Card)

Protecting_Card_1 This is an optional parameter that identifies the card as a

redundant card, or a primary card.
Value

Meaning

0
1

No
Yes

Card_Inhibit_Switchover This is an optional parameter that identifies the if

protection switching is allowed.

Priority

Channel_Id

Value

Meaning

0
1

No
Yes

This is an optional parameter that identifies the card

protection priority as follows:
Value

Meaning

0
1
2

Not Applicable
Low
High

Identifies the card protection Channel. Optional. A value of 0

indicates Not Applicable.

vsm4cService_type This is an optional parameter that identifies the VSM4c

service type.
OTHER
COMMANDS

From outside the resource context, use this format:

Del <n>-<n>-VOICESERVERCARD
Mod VOICESERVERCARD slot=value, card=value, {parameter1=value1,
parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

Page 5-26

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Voice Server Card (VS Card)

EXAMPLES

To enter the channelized interface card values from the command prompt, at
the System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1msfnode/Slots context:
add VOICESERVERCARD
slot:35
card:1
Card_Type:30
Group_1:34
priority:0
Channel_Id:0
Command Successful

An add CHANINTFCARD command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots;
add VOICESERVERCARD
slot=35,card=1,Card_Type=6,Group_1=39,priority=0,Channel_Id=0,card_version
=2;
Cd;

The following is an example of using the Mod command:

mod VOICESERVERCARD slot=21, card=1, priority=1

The following is an example of using the Del command:

del 21-1-VOICESERVERCARD

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-27

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Gigabit Ethernet Card (GigE Card)

5.11

Gigabit Ethernet Card (GigE Card)

The Add GIGECARD command establishes an instance of a Gigabit Ethernet card in the Wireless
Media Gateway.
NAME

Add GIGECARD

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots

ADD COMMAND
SYNTAX

Add GIGECARD {parameter1=value1, parameter2=value2, . . .}

Page 5-28

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Gigabit Ethernet Card (GigE Card)

PARAMETERS

1/23/07
Revision 3.4

Slot

Identifies the slot number of the card to be administered.

Required. Valid values are dependent upon the number of
slots available.

Card

Identifies the card number to be administered. Required.

Card_Type

This is a required parameter that specifies the type of the

card as follows:
Value

Meaning

0
1
2
3
4
5
6
7
8
9
11
12
13
15
17
18
19
20
21
22
23
24
25
29
30
31
39
40
41
44
49
50
56
60
95
96
97
98
99
100
101
200
65535

CONTROL
PACKET_MATRIX
SERVICE_MATRIX
DATA_SERVER
VOICE_SERVER
ATM_INTERFACE
CHANNEL_INTERFACE
DS3_ATM_INTERFACE
OC3_ATM_INTERFACE
OC12_ATM_INTERFACE
T1_CHAN_INTERFACE
E1_CHAN_INTERFACE
T3_CHAN_INTERFACE
OC3_CHAN_INTERFACE
ECHO_SERVER
STM1_ATM_INTERFACE
STM4_ATM_INTERFACE
STM16_ATM_INTERFACE
STM1_CHAN_INTERFACE
STM4_CHAN_INTERFACE
VSM3_CARD
VSM4a_CARD
VSM5_CARD
VSM3b_CARD
VSM4b_CARD
VSM4c_CARD
CONTROL_MODULE_2
PACKET_MATRIX_2
SERVICE_MATRIX_2
GIGABIT_ETHERNET
CONTROL_MODULE_3
SERVICE_MATRIX_3
QOC3_CHAN_INTERFACE
ECHO_SERVER_4
EMS_DEF_VSM2t
EMS_DEF_VSM2a
EMS_DEF_VSM2
EMS_DEF_VSM1
CARD_TYPE_UNKNOW
EMS_DEF_VSM6
EMS_DEF_VSM6t
VE
EEPROM_CARD_TYPE_FF

Proprietary and Confidential

Page 5-29

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Gigabit Ethernet Card (GigE Card)

Group_1

This is a required parameter that specifies the protection

group in which this card is a member. A value of zero (0)
indicates the card is a standalone card and does not
participate in any protection switching.

Card_Inhibit_Switchover This is an optional parameter that identifies the if

protection switching is allowed.

Priority

OTHER
COMMANDS

Value

Meaning

0
1

No
Yes

This is an optional parameter that identifies the card

protection priority as follows:
Value

Meaning

0
1
2

Not Applicable
Low
High

Channel_Id

Identifies the card protection Channel. Optional. A value of 0

indicates Not Applicable.

Snoop_Port1

This is an optional parameter that specifies which facility/port

on this card is to be snooped by the snoop port:
Value

Meaning

0
1
2
3
4

SP1_SNOOP_NONE
SP1_SNOOP_ON_1
SP1_SNOOP_ON_2
SP1_SNOOP_ON_3
SP1_SNOOP_ON_4

From outside the resource context, use this format:

Del <n>-<n>-GIGECARD
Mod GIGECARD slot=value, card=value, {parameter1=value1,
parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

Page 5-30

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Gigabit Ethernet Card (GigE Card)

EXAMPLES

To enter the channelized interface card values from the command prompt, at
the System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1msfnode/Slots context:
add GIGECARD
slot:35
card:1
Card_Type:6
Group_1:39
priority:0
Channel_Id:0
Command Successful

An add GIGECARD command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots;
add GIGECARD
slot=35,card=1,Card_Type=6,Group_1=39,priority=0,Channel_Id=0,card_version
=2;
Cd;

The following is an example of using the Mod command:

mod GIGECARD slot=21, card=1, priority=1

The following is an example of using the Del command:

del 21-1-GIGECARD

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-31

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ATM Card

5.12

ATM Card
The Add ATMNICCARD command establishes an instance of an ATM card in the Wireless
Media Gateway (WMG).
NAME

Add ATMNICCARD

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots

ADD COMMAND
SYNTAX

Add ATMNICCARD {parameter1=value1, parameter2=value2, . . .}

Page 5-32

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

ATM Card

PARAMETERS

1/23/07
Revision 3.4

Slot

Identifies the slot number of the card to be administered.

Required. Valid values are dependent upon the number of
slots available.

Card

Identifies the card number to be administered. Required.

Card_Type

This is a required parameter that specifies the type of the card

as follows:
Value

Meaning

0
1
2
3
4
5
6
7
8
9
11
12
13
15
17
18
19
20
21
22
23
24
25
29
30
31
39
40
41
44
49
50
56
60
95
96
97
98
99
100
101
200
65535

CONTROL
PACKET_MATRIX
SERVICE_MATRIX
DATA_SERVER
VOICE_SERVER
ATM_INTERFACE
CHANNEL_INTERFACE
DS3_ATM_INTERFACE
OC3_ATM_INTERFACE
OC12_ATM_INTERFACE
T1_CHAN_INTERFACE
E1_CHAN_INTERFACE
T3_CHAN_INTERFACE
OC3_CHAN_INTERFACE
ECHO_SERVER
STM1_ATM_INTERFACE
STM4_ATM_INTERFACE
STM16_ATM_INTERFACE
STM1_CHAN_INTERFACE
STM4_CHAN_INTERFACE
VSM3_CARD
VSM4a_CARD
VSM5_CARD
VSM3b_CARD
VSM4b_CARD
VSM4c_CARD
CONTROL_MODULE_2
PACKET_MATRIX_2
SERVICE_MATRIX_2
GIGABIT_ETHERNET
CONTROL_MODULE_3
SERVICE_MATRIX_3
QOC3_CHAN_INTERFACE
ECHO_SERVER_4
EMS_DEF_VSM2t
EMS_DEF_VSM2a
EMS_DEF_VSM2
EMS_DEF_VSM1
CARD_TYPE_UNKNOW
EMS_DEF_VSM6
EMS_DEF_VSM6t
VE
EEPROM_CARD_TYPE_FF

Proprietary and Confidential

Page 5-33

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ATM Card

Priority

Channel_Id

OTHER
COMMANDS

This is an optional parameter that identifies the card

protection priority as follows:
Value

Meaning

0
1
2

Not Applicable
Low
High

Identifies the card protection Channel. Optional. A value of 0

indicates Not Applicable.

From outside the resource context, use this format:

Del <n>-<n>-ATMNICCARD
Mod ATMNICCARD slot=value, card=value, {parameter1=value1,
parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}
EXAMPLES

To enter the channelized interface card values from the command prompt, at
the System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1msfnode/Slots context:
add ATMNICCARD
slot:35
card:1
Card_Type:6
priority:0
Channel_Id:0
Command Successful

An add GIGECARD command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots;
add ATMNICCARD
slot=35,card=1,Card_Type=6,priority=0,Channel_Id=0,card_version=2;
Cd;

The following is an example of using the Mod command:

mod ATMNICCARD slot=21, card=1, priority=1

The following is an example of using the Del command:

del 21-1-ATMNICCARD

Page 5-34

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Channelized Interface Card (CI Card)

5.13

Channelized Interface Card (CI Card)

The Add CHANINTFCARD command establishes an instance of a channelized interface card in
the Wireless Media Gateway (WMG).
NAME

Add VOICESERVERCARD

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots

ADD COMMAND
SYNTAX

Add VOICESERVERCARD {parameter1=value1, parameter2=value2, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-35

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Channelized Interface Card (CI Card)

PARAMETERS

Slot

Identifies the slot number of the card to be administered.

Required. Valid values are dependent upon the number of
slots available.

Card

Identifies the card number to be administered. Required.

Card_Type

This is a required parameter that specifies the type of the

card as follows:
Value

Meaning

0
1
2
3
4
5
6
7
8
9
11
12
13
15
17
18
19
20
21
22
23
24
25
29
30
31
39
40
41
44
49
50
95
96
97
98
99
100
101
200
65535

CONTROL
PACKET_MATRIX
SERVICE_MATRIX
DATA_SERVER
VOICE_SERVER
ATM_INTERFACE
CHANNEL_INTERFACE
DS3_ATM_INTERFACE
OC3_ATM_INTERFACE
OC12_ATM_INTERFACE
T1_CHAN_INTERFACE
E1_CHAN_INTERFACE
T3_CHAN_INTERFACE
OC3_CHAN_INTERFACE
ECHO_SERVER
STM1_ATM_INTERFACE
STM4_ATM_INTERFACE
STM16_ATM_INTERFACE
STM1_CHAN_INTERFACE
STM4_CHAN_INTERFACE
VSM3_CARD
VSM4a_CARD
VSM5_CARD
VSM3b_CARD
VSM4b_CARD
VSM4c_CARD
CONTROL_MODULE_2
PACKET_MATRIX_2
SERVICE_MATRIX_2
GIGABIT_ETHERNET
CONTROL_MODULE_3
SERVICE_MATRIX_3
EMS_DEF_VSM2t
EMS_DEF_VSM2a
EMS_DEF_VSM2
EMS_DEF_VSM1
CARD_TYPE_UNKNOW
EMS_DEF_VSM6
EMS_DEF_VSM6t
VE
EEPROM_CARD_TYPE_FF

Page 5-36

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Channelized Interface Card (CI Card)

Priority

This is an optional parameter that identifies the card

protection priority as follows:

Channel_Id

OTHER
COMMANDS

Value

Meaning

0
1
2

Not Applicable
Low
High

Identifies the card protection Channel. Optional. A value of 0

indicates Not Applicable.

From outside the resource context, use this format:

Del <n>-<n>-CHANINTFCARD
Mod CHANINTFCARD slot=value, card=value, {parameter1=value1,
parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}
EXAMPLES

To enter the channelized interface card values from the command prompt, at
the System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1msfnode/Slots context:
add CHANINTFCARD
slot:35
card:1
Card_Type:6
priority:0
Channel_Id:0
Command Successful

An add CHANINTFCARD command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots;
add CHANINTFCARD
slot=35,card=1,Card_Type=6,priority=0,Channel_Id=0,card_version=2;
Cd;

The following is an example of using the Mod command:

mod CHANINTFCARD slot=21, card=1, priority=1

The following is an example of using the Del command:

del 21-1-CHANINTFCARD

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-37

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

OC3 Time Division Multiplex (TDM) CARD

5.14

OC3 Time Division Multiplex (TDM) CARD

The Add OC3TDMCARD command establishes an instance of an OC3 TDM card in the Wireless
Media Gateway (WMG).
NAME

Add OC3TDMCARD

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-CHANINTFCARD

ADD COMMAND
SYNTAX

Add OC3TDMCARD {parameter1=value1, parameter2=value2, . . .}

Page 5-38

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

OC3 Time Division Multiplex (TDM) CARD

PARAMETERS

1/23/07
Revision 3.4

Card

Identifies the card number to be administered. Required.

Card_Type

This is a required parameter that specifies the type of the

card as follows:
Value

Meaning

0
1
2
3
4
5
6
7
8
9
11
12
13
15
17
18
19
20
21
22
23
24
25
29
30
31
39
40
41
44
49
50
95
96
97
98
99
100
101
200
65535

CONTROL
PACKET_MATRIX
SERVICE_MATRIX
DATA_SERVER
VOICE_SERVER
ATM_INTERFACE
CHANNEL_INTERFACE
DS3_ATM_INTERFACE
OC3_ATM_INTERFACE
OC12_ATM_INTERFACE
T1_CHAN_INTERFACE
E1_CHAN_INTERFACE
T3_CHAN_INTERFACE
OC3_CHAN_INTERFACE
ECHO_SERVER
STM1_ATM_INTERFACE
STM4_ATM_INTERFACE
STM16_ATM_INTERFACE
STM1_CHAN_INTERFACE
STM4_CHAN_INTERFACE
VSM3_CARD
VSM4a_CARD
VSM5_CARD
VSM3b_CARD
VSM4b_CARD
VSM4c_CARD
CONTROL_MODULE_2
PACKET_MATRIX_2
SERVICE_MATRIX_2
GIGABIT_ETHERNET
CONTROL_MODULE_3
SERVICE_MATRIX_3
EMS_DEF_VSM2t
EMS_DEF_VSM2a
EMS_DEF_VSM2
EMS_DEF_VSM1
CARD_TYPE_UNKNOW
EMS_DEF_VSM6
EMS_DEF_VSM6t
VE
EEPROM_CARD_TYPE_FF

Card_Version

Specifies the card version. Required. The minimum allowed

value is 0, with a maximum of Not Defined. Default: 2.

Group_1

Specifies the protection group in which this card is a

member. A value of zero (0) indicates the card is a standalone
card and does not participate in any protection switching.
Required. Valid values are 0-14.

Proprietary and Confidential

Page 5-39

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

OC3 Time Division Multiplex (TDM) CARD

Protecting_Card_1 Specifies whether the card acts as a redundant or not.

Optional. Enter 0 for No, or 1 for Yes.
Priority

Channel_Id

This is an optional parameter that identifies the card

protection priority as follows:
Value

Meaning

0
1
2

Not Applicable
Low
High

Identifies the card protection Channel. Optional. A value of 0

indicates Not Applicable.

Group_Inhibit_Switchover
Specifies whether protection switching is inhibited for this
group. Optional. Enter 0 for No, or 1 for Yes.
OTHER
COMMANDS

From outside the resource context, use this format:

Del <n>-<n>OC3TDMCARD
Mod OC3TDMCARD slot=value, card=value, {parameter1=value1,
parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

Page 5-40

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

OC3 Time Division Multiplex (TDM) CARD

EXAMPLES

To enter the OC3 TDM card values from the command prompt, at the
System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1msfnode/Slots/21-1-CHANINTFCARD context:
add OC3TDMCARD
Card:1
Card_Type:15
Group_1:1
Prompt for Optional? (y/yes/n/no) : y
Protecting_Card_1 (Default:N) :1
Priority (Default:1) :0
Channel_Id (Default:0) :0
Group_Inhibit_Switchover (Default:N) :
Command Successful

An add OC3TDMCARD command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots; cd 38-1-CHANINTFCARD;
add OC3TDMCARD Card=1, Card_Type=15, Group_1=1, Protecting_Card_1=1,
Priority=0, Channel_Id=0;
Cd;

The following is an example of using the Mod command:

Mod OC3TDMCARD slot=21, card=1, priority=2

The following is an example of using the Del command:

del 21-1-OC3TDMCARD

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-41

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

TDM SONET Facility

5.15

TDM SONET Facility

The Add TDMSONETFACILITY command establishes a TDM SONET facility in the OC3 TDM
card.
NAME

Add TDMSONETFACILITY

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-CHANINTFCARD/<n>-<n>-OC3TDMCARD

ADD COMMAND
SYNTAX

Add TDMSONETFACILITY {parameter1=value1, parameter2=value2, . . .}

PARAMETERS

MsfCardNum

Identifies the card number to be administered. Required.

Facility

Identifies the facility number to administer. Required.

Medium_Type

This variable identifies whether a SONET or an SDH signal is

used across this interface as follows:
Value

Meaning

1
2

SONET
SDH

Sec_System_Defaults
This is a required parameter that specifies whether the MSF
nodes default values are to be used for the threshold values
as follows:
Value

Meaning

0
1

No
Yes

Line_System_Defaults
This is a required parameter that specifies whether the MSF
nodes default values are to be used for the threshold values
as follows:
Value
1
2

Meaning
No
Yes

sonmedmsfNode The minimum allowed value is 0, with a maximum of Not

defined. Required. Default: Not Defined
name

Name given by users. Optional. A valid value is 1-64

alphanumeric characters. Default: Not Defined.

Line_Coding

This variable describes the line coding for this interface. The
Non-Return to Zero (NRZ) and the Return to Zero are used for
optical SONET/SDH signals. Optional.

Page 5-42

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

TDM SONET Facility

Line_Type

This variable describes the line type for this interface.

Required. The only valid value you can enter is 2 for
ShortSingleMode.

Send_Code

This is a required parameter that indicates what type of code

is being sent across the SONET interface by the device as
follows:

Loopback_Type

Value

Meaning

1
2

Send No Code (Default)

Send AIS

This is an optional parameter that indicates the current

loopback state of the SONET/SDH interface as follows:
Value

Meaning

1
2

No Loop (Default)
Facility Loop

Sec_ES_sec_per_15min
Threshold value for number of Errored Seconds per 15
minutes. Required. The minimum allowed value is 1, with a
maximum value of 900.
Sec_SES_sec_per_15min
Threshold value for number of Severely Errored Second per
15 minutes. Required. The minimum allowed value is 1, with a
maximum value of 900.
SEFS_sec_per_15min
Threshold value for number of Severely Errored Framing
Seconds per 15 minutes. Required. The minimum allowed
value is 1, with a maximum value of 900.
Sec_CV_sec_per_15min
Threshold value for number of Code Violations per 15
minutes. Required. The minimum allowed value is 1, with a
maximum value of 900.
Line_ES_sec_per_15min
Threshold value for number of Errored Seconds per 15
minutes. Required. The minimum allowed value is 1, with a
maximum value of 900.
Line_SES_sec_per_15min
Threshold value for number of Severely Errored Second per
15 minutes. Required. The minimum allowed value is 1, with a
maximum value of 900.
Line_CV_sec_per_15min
Threshold value for number of Code Violations per 15
minutes. Required. The minimum allowed value is 1, with a
maximum value of 900.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-43

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

TDM SONET Facility

UAS_sec_per_15min
Threshold value for number of Unavailable Seconds per 15
minutes. Required. The minimum allowed value is 1, with a
maximum value of 900.
OTHER
COMMANDS

From outside the resource context, use this format:

Del TDMSONETFACILITY msffacility=value
Mod TDMSONETFACILITY facility=value, {parameter1=value1,
parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

Page 5-44

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

TDM SONET Facility

EXAMPLES

To enter the TDM SONET facility values from the command prompt, at the
System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1msfnode/Slots/21-1-CHANINTFCARD/21-1-OC3TDMCARD context:
Add TDMSONETFACILITY
Facility:1
Medium_Type:1
Sanx_Sonet_Medium_Admin_U:0
Sec_System_Defaults:y
Sec_ES_sec_per_15min:12
Sec_SES_sec_per_15min:2
SEFS_sec_per_15min:2
Sec_CV_sec_per_15min:382
Line_System_Defaults:1
Line_ES_sec_per_15min:12
Line_SES_sec_per_15min:3
Line_CV_sec_per_15min:15
UAS_sec_per_15min:10
MsfCardNum:1
Prompt for Optional? (y/yes/n/no) : y
Name (Default:Not Defined) :test6
Line_Type (Default:2) :
Line_Coding (Default:4) :
Send_Code (Default:1) :
Loopback_Type (Default:1) :
Command Successful

An add TDMSONETFACILITY command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots; cd 38-1-CHANINTFCARD; cd 38-1-OC3TDMCARD;
add TDMSONETFACILITY Facility=1, Medium_Type=1,
Sanx_Sonet_Medium_Admin_U=0, Sec_System_Defaults=y,
Sec_ES_sec_per_15min=12, Sec_SES_sec_per_15min=2,
SEFS_sec_per_15min=2, Sec_CV_sec_per_15min=382,
Line_System_Defaults=1, Line_ES_sec_per_15min=12,
Line_SES_sec_per_15min=3, Line_CV_sec_per_15min=15,
UAS_sec_per_15min=10, MsfCardNum=1, Name=test6;
Cd;

The following is an example of using the Mod command:

mod TDMSONETFACILITY facility=1, name=test

The following is an example of using the Del command:

del 1-TDMSONETFACILITY

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-45

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Enable DS3 SONETPATH

5.16

Enable DS3 SONETPATH

The Mod SONETPATH command enables DS3 in the OC3 TDM card.
NAME

Mod SONETPATH

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-CHANINTFCARD/<n>-<n>-OC3TDMCARD/<n>TDMSONETFACILITY

MOD COMMAND
SYNTAX

From outside the resource context, use this format:

mod SONETPATH path_id=value, {parameter1=value1, parameter2=value2, . . .}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

Page 5-46

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Enable DS3 SONETPATH

PARAMETERS

Channelization

Indicates whether this SONET path is channelized or

unchannelized as follows:
Value

Meaning

1
2
3

Disabled
EnabledDs3
EnabledVT

sonPathVTGrp1

Indicates the VT group type. Optional. 0 indicates Not

Applicable, 1 indicates VT1.5.

sonPathVTGrp2

Indicates the VT group type. Optional. 0 indicates Not

Applicable, 1 indicates VT1.5.

sonPathVTGrp3

Indicates the VT group type. Optional. 0 indicates Not

Applicable, 1 indicates VT1.5.

sonPathVTGrp4

Indicates the VT group type. Optional. 0 indicates Not

Applicable, 1 indicates VT1.5.

sonPathVTGrp5

Indicates the VT group type. Optional. 0 indicates Not

Applicable, 1 indicates VT1.5.

sonPathVTGrp6

Indicates the VT group type. Optional. 0 indicates Not

Applicable, 1 indicates VT1.5.

sonPathVTGrp7

Indicates the VT group type. Optional. 0 indicates Not

Applicable, 1 indicates VT1.5.

Send_Code

This required variable indicates what type of code is being

sent across the SONET Path interface by the device as
follows:
Value

Meaning

1
2

Send No Code
Send AIS

System_Defaults
Specifies whether to use the MSF nodes default values for the
threshold values as follows:
Value

Meaning

1
2

No
Yes

ES_sec_per_15min
Threshold value for number of Errored Seconds per 15
minutes. Optional. The minimum allowed value is 1, with a
maximum of 900. Default: 12.
SES_sec_per_15min
Threshold value for number of Severely Errored Second per
15 minutes. Optional. The minimum allowed value is 1, with a
maximum of 900. Default: 3.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-47

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Enable DS3 SONETPATH

CV_sec_per_15min
Threshold value for number of Code Violations per 15
minutes. Optional. The minimum allowed value is 1, with a
maximum of 900. Default: 15.
UAS_sec_per_15min
Threshold value for number of Unavailable Seconds per 15
minutes. Optional. The minimum allowed value is 1, with a
maximum of 900. Default: 10.
EXAMPLES

To modify the SONET facility values from the command prompt, at the
System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1msfnode/Slots/21-1-CHANINTFCARD/21-1-OC3TDMCARD/1TDMSONETFACILITY context:
mod sonetpath path_id=1, channelization=2
Command Successful

A mod command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots; cd 38-1-CHANINTFCARD; cd 38-1-OC3TDMCARD; cd 1TDMSONETFACILITY ;
cd 359695360-SONETPATH;
mod channelization=2;
Cd;

Page 5-48

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Enable DS1 Channelization for DS3

5.17

Enable DS1 Channelization for DS3

The Mod EMBEDDEDDSX3 command allows you to enable DS1 channelization for a DS3.
NAME

Mod EMBEDDEDDSX3

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-CHANINTFCARD/<n>-<n>-OC3TDMCARD/<n>TDMSONETFACILITY/<n>-SONETPATH

MOD COMMAND
SYNTAX

From outside the resource context, use this format:

Mod EMBEDDEDDSX3 ds3LineInd=value, {parameter1=value1,
parameter2=value2, . . .}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-49

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Enable DS1 Channelization for DS3

PARAMETERS

Line_Coding

Specifies the type of zero code suppression to use on this

line. Optional. The only valid value is 2 for B3ZS.

Loopback_Type

This is an optional parameter that specifies the loopback type

as follows:

Channelization

Line_Type

Meaning

1
3

No Loopback
Line Loopback

This is an optional parameter that specifies whether the DS3

is channelized or not as follows:
Value

Meaning

1
2

Disabled
Enabled DS1

This is a required parameter that specifies the type of DS3

line to use as follows:

Line_Build_Out

Send_Code

Value

Value

Meaning

2
4

M23
Cbit Parity

This is an optional parameter that specifies the line length

buildout as follows:
Value

Meaning

0
1

0-225 feet
225-450 feet

This is required parameter that specifies the type of code that

is sent across the DS3 interface as follows:
Value

Meaning

1
7
8

Send No Code
Send AIS
Send Yellow Alarm

Systems_Defaults Specifies whether to use the MSF nodes default values for the
threshold values. Optional. Enter 0 for No, or 1 for Yes.
PES_sec_per_15min
Threshold value for number of P-bit Errored Seconds per 15
minutes. Optional. The minimum allowed value is 0, with a
maximum of Not Defined. Default: 25.

Page 5-50

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Enable DS1 Channelization for DS3

PSES_sec_per_15min
Threshold value for number of P-bit Severely Errored
Seconds per 15 minutes. Optional. The minimum allowed
value is 0, with a maximum of Not Defined. Default: 4.
SEFS_sec_per_15min
Threshold value for number of Severely Errored Framing
Seconds per 15 minutes. Optional. The minimum allowed
value is 0, with a maximum of Not Defined. Default: 2.
UAS_sec_per_15min
Threshold value for number of Unavailable Seconds per 15
minutes. Optional. The minimum allowed value is 0, with a
maximum of Not Defined. Default: 10.
LES_sec_per_15min
Threshold value for number of Line Errored Seconds per 15
minutes. Optional. The minimum allowed value is 0, with a
maximum of Not Defined. Default: 25.
LCV_sec_per_15min
Threshold value for number of Line Coding Violations per 15
minutes. Optional. The minimum allowed value is 0, with a
maximum of Not Defined. Default: 387.
PCV_sec_per_15min
Threshold value for number of P-bit Coding Violations per 15
minutes. Optional. The minimum allowed value is 0, with a
maximum of Not Defined. Default: 382.
CCV_sec_per_15min
Threshold value for number of C-bit Coding Violations per 15
minutes. Optional. The minimum allowed value is 0, with a
maximum of Not Defined. Default: 382.
CES_sec_per_15min
Threshold value for number of C-bit Errored Seconds per 15
minutes. Optional. The minimum allowed value is 0, with a
maximum of Not Defined. Default: 25.
CSES_sec_per_15min
Threshold value for number of C-bit Severely Errored
Seconds per 15 minutes. Optional. The minimum allowed
value is 0, with a maximum of Not Defined. Default: 4.
OTHER
COMMANDS

From outside the resource context, use this format:

Del EMBEDDEDDSX3 ds3LineInd=value

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-51

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Enable DS1 Channelization for DS3

EXAMPLES

To modify the values from the command prompt, at the System/Nodes/

Wireless-Media-Gateway/Spatial-Media-Gateway/1-msfnode/Slots/21-1-C
HANINTFCARD/21-1-OC3TDMCARD/1-TDMSONETFACILITY/3sonetpath context:
Mod EMBEDDEDDSX3 ds3LineInd=1, channelization=2
Command Successful

A mod EMBEDDEDDSX3 command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots; cd 38-1-CHANINTFCARD; cd 38-1-OC3TDMCARD; cd 1TDMSONETFACILITY ;
cd 359695360-SONETPATH; cd 1-EMBEDDEDDSX3;
channelization=2;
Cd;

Page 5-52

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Enable DS0 Channelization for UNAS DS1

5.18

Enable DS0 Channelization for UNAS DS1

The Mod SPAN command enables DS0 channelization for a UNAS DS1.
NAME

Mod SPAN

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-CHANINTFCARD/<n>-<n>-OC3TDMCARD/<n>TDMSONETFACILITY/<n>-SONETPATH/<n>-EMBEDDEDDSX3

MOD COMMAND
SYNTAX

From outside the resource context, use this format:

Mod SPAN Span_Num=value, {parameter1=value1, parameter2=value2, . . .}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-53

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Enable DS0 Channelization for UNAS DS1

PARAMETERS

Allow_Remote_Loop
Specifies whether the far end is allowed to loop the interface.
Optional. Enter 2 for No, or 1 for Yes.
Line_Type

This is a required parameter that specifies the type of DS1

line to use as follows:

Line_Coding

Value

Meaning

2
3
4
5
8
9
12
13
14
15

ESF
D4
E1
E1 CRC
Unframed
E1 Unframed
ESFBits
D4Bits
E1Bits
E1CRC Bits

This is an optional parameter that specifies the type of zero

code suppression to use on this line as follows:

Send_Code

Value

Meaning

1
2
3
5
8

JBZS
B8ZS
HDB3
AMI
Not Applicable

This is a required parameter that specifies the type of code

that is sent across the DS1 interface as follows:

Loopback_Type

Value

Meaning

1
2
3
4
9
10
11

Send No Code
Send Line Code
Send Payload Code
Send Reset Code
Send AIS
Send Yellow Alarm
Send Idle Code

This is an optional parameter that specifies the loopback type

as follows:
Value

Meaning

1
2
3
5

No Loop
Payload Loop
Line Loop
Inward Loop

Facilities_Data_Link
Specifies the use of the facilities data link. Required. Enter 2
for ANSIT1403, or 8 for None.

Page 5-54

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Enable DS0 Channelization for UNAS DS1

Status_Change_Trap
This is an optional parameter that specifies whether the
status change traps should be generated for this span as
follows:
Value

Meaning

0
1

No
Yes (Default)

Monitor_Perform This is an optional parameter that specifies whether

performance monitoring has been enabled as follows:

Channelization

Value

Meaning

1
2

Enabled
Disabled

This is an optional parameter that specifies whether the span

is channelized or not as follows:
Value

Meaning

1
2

Disabled (Default)
Enabled

SES_sec_per_15min
Specifies the threshold value for the number of Severely
Errored Seconds per 15 minute interval. Optional. The
minimum allowed value is 1, with a maximum value of 900.
Default: 10.
SEF_sec_per_15min
Specifies the threshold value for the number of Severely
Errored Framing Seconds per 15 minute interval. Optional.
The minimum allowed value is 1, with a maximum value of
900. Default: 2.
ES_sec_per_15min
Specifies the threshold value for the number of Errored
Seconds per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 900. Default: 65.
UAS_sec_per_15min
Specifies the threshold value for the number of Unavailable
Seconds per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 900. Default: 10.
CSS_sec_per_15min
Specifies the threshold value for the number of Controlled
Slip Seconds per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 900. Default: 1.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-55

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Enable DS0 Channelization for UNAS DS1

PCV_sec_per_15min
Specifies the threshold value for the number of Path Coding
Violations per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 100000. Default:
13296.
LES_sec_per_15min
Specifies the threshold value for the number of Line Errored
Seconds per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 900. Default: 65.
BES_sec_per_15min
Specifies the threshold value for the number of Bursty
Errored Seconds per 15 minute interval. Optional. The
minimum allowed value is 1, with a maximum value of 900.
Default: 1.
DM_sec_per_15min
Specifies the threshold value for the number of Degraded
Minutes per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 15. Default: 1.
LCV_sec_per_15min
Specifies the threshold value for the number of Line Code
Violations per 15 minute interval. Optional. The minimum
allowed value is 1, with a maximum value of 100000. Default:
13340.
PCM_Multiplex

Specifies the multiplex in use, refer to GSM08.08 . Optional.

The minimum allowed value is 0, with a maximum value of
Not Defined. Default: 0.

Use_System_Defaults
Specifies whether the system default values are to be used
for the threshold values. Optional. Enter 0 for No, or 1 for Yes.
Line_Build_Out

OTHER
COMMANDS

This is an optional parameter that specifies the line length for

short hauls and attenuation for long hauls as follows:
Value

Meaning

0
1
2
3
4
5
6
7
8

SHORTHAUL0 (Default)
SHORTHAUL1
SHORTHAUL2
SHORTHAUL3
SHORTHAUL4
LONGHAULA
LONGHAULB
LONGHAULC
LONGHAULD

From outside the resource context, use this format:

Del <n>-SPAN

Page 5-56

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Enable DS0 Channelization for UNAS DS1

EXAMPLES

To modify the values from the command prompt, at the System/Nodes/

Wireless-Media-Gateway/Spatial-Media-Gateway/1-msfnode/Slots/21-1-C
HANINTFCARD/21-1-OC3TDMCARD/1-TDMSONETFACILITY/3sonetpath/1-EMBEDDEDDSX3 context:
mod SPAN Span_Num=3701, Channelization=2
Command Successful

A mod command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots; cd 38-1-CHANINTFCARD; cd 38-1-OC3TDMCARD; cd 1TDMSONETFACILITY ;
cd 359695360-SONETPATH; cd 1-EMBEDDEDDSX3; cd 3701-SPAN;
mod Channelization=2;
Cd;

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-57

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ISUP CIC Partitioning

5.19

ISUP CIC Partitioning

The Add ISUPCICPARTITION command adds ISUP CIC partitioning.
NAME

Add ISUPCICPARTITION

CONTEXT

System/Office-Parameters/ISUP-CIC/Static-ISUP-CIC

ADD COMMAND
SYNTAX

Add ISUPCICPARTITION {parameter1=value1, parameter2=value2, . . .}

PARAMETERS

WSS_Num

WSS Number. Required.

DPC

ISUP Destination Point Code. Required. The minimum

allowed value is 0-0-0, with a maximum of 255-255-255.

Start_CIC

Start CIC. Required. The minimum allowed value is 1, with a

maximum of 65535. Default: Not Defined.

End_CIC

End CIC. Optional. The minimum allowed value is 1, with a

maximum of 65535. Default: Not Defined.

Type

Specifies the type of partitioning. Optional. 1 indicates ISUP

and 2 indicates BICC. Default: 1.

OTHER
COMMANDS

From outside the resource context, use this format:

Del ISUPCICPARTITION WSS_Num=value, DPC=value, Start_CIC=value
Mod ISUPCICPARTITION WSS_Num=value, DPC=value, Start_CIC=value,
{parameter1=value1, parameter2=value2..}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}
EXAMPLES

To enter the ISUPCICPARTITION values from the command prompt, at the

System/Office-Parameters/ISUP-CIC/Static-ISUP-CIC context:
add ISUPCICPARTITION
WSS_Num:1
DPC:000-000-003
Start_CIC:1
End_CIC:1000
Type:2
Command Successful

An add ISUPCICPARTITION command as it might appear in a batch file:

Cd;
Cd Office-Parameters; cd ISUP-CIC;
add ISUPCICPARTITION WSS_Num=1, DPC=000-000-003, Start_CIC=1,
End_CIC=1000, Type=2;
cd;

Page 5-58

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Assign DS0 Channels to BSS

5.20

Assign DS0 Channels to BSS

The Mod BSSCHANNEL command allows you to assign DS0 channels to a BSS.
NAME

Mod BSSCHANNEL

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-CHANINTFCARD/<n>-<n>-OC3TDMCARD/<n>TDMSONETFACILITY/<n>-SONETPATH/<n>-EMBEDDEDDSX3/<n>-SPAN

MOD COMMAND
SYNTAX

From outside the resource context, use this format:

Mod BSSCHANNEL channel=value, {parameter1=value1, parameter2=value2, . .
.}

From inside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}
PARAMETERS

Trunk_Group_Number
Specifies the channels system trunk group number.
Optional. The minimum allowed value is 11, with a maximum
of 9999. Default: Not Defined.
circuit_Id

Specifies the Circuit ID for ordering trunks in the trunk group.

Optional. The minimum allowed value is 0, with a maximum of
65535. Default: Not Defined.

isup_CIC

Specifies the CIC for ISUP Circuits. Optional. The minimum

allowed value is 1, with a maximum of 65535. Default: Not
Defined.

loopbackType

This is an optional parameter that specifies the loopback type

of the DS0 channel as follows:

attenuation

Span_Type

1/23/07
Revision 3.4

Value

Meaning

0
1
2
3

None
Payload
Line
Local

This is an optional parameter that specifies the channel

attenuation as follows:
Value

Meaning

0
1
2
3

0 db
-3 db
-6 db
-12db

Indicates the span type. Optional. The minimum allowed

value is 0, with a maximum of Not Defined. Default: Not
Defined

Proprietary and Confidential

Page 5-59

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Assign DS0 Channels to BSS

OTHER
COMMANDS

From outside the resource context, use this format:

del <nnn>-BSSCHANNEL

EXAMPLES

To assign DS0 channels to a BSS values from the command prompt, at the
System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1msfnode/Slots/21-1-CHANINTFCARD/21-1-OC3TDMCARD/1TDMSONETFACILITY/3-sonetpath/1-EMBEDDEDDSX3/61-span
context:
mod bsschannel channel_number=2, trunk_group_number=45, circuit_id=2,
isup_cic=2, loopbacktype=0, attenuation=0, span_type=1

A mod bsschannel command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots; cd 38-1-CHANINTFCARD; cd 38-1-OC3TDMCARD; cd 1TDMSONETFACILITY ;
cd 359695360-SONETPATH; cd 1-EMBEDDEDDSX3; cd 3701-SPAN;
mod bsschannel channel_number=2, trunk_group_number=45, circuit_id=2,
isup_cic=2, loopbacktype=0, attenuation=0, span_type=1;
cd;

Page 5-60

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Assign DS0 Channels to ISUP

5.21

Assign DS0 Channels to ISUP

The Mod SS7CHANNEL command allows you to assign DS0 channels to ISUP.
NAME

Mod SS7CHANNEL

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-CHANINTFCARD/<n>-<n>-OC3TDMCARD/<n>TDMSONETFACILITY/<n>-SONETPATH/<n>-EMBEDDEDDSX3/<n>-SPAN

MOD COMMAND
SYNTAX

From outside the resource context, use this format:

Mod SS7CHANNEL channel=value, {parameter1=value1, parameter2=value2, . . .}

From outside the resource context, use this format:

Mod {parameter1=value1, parameter2=value2..}
PARAMETERS

Trunk_Group_Number
Specifies the channels system trunk group number.
Optional. The minimum allowed value is 11, with a maximum
of 9999. Default: Not Defined.
circuit_Id

Specifies the Circuit ID for ordering trunks in the trunk group.

Optional. The minimum allowed value is 0, with a maximum of
65535. Default: Not Defined.

isup_CIC

Specifies the CIC for ISUP Circuits. Optional. The minimum

allowed value is 1, with a maximum of 65535. Default: Not
Defined.

loopbackType

This is an optional parameter that specifies the loopback type

of the DS0 channel as follows:

attenuation

Span_Type

1/23/07
Revision 3.4

Value

Meaning

0
1
2
3

None
Payload
Line
Local

This is an optional parameter that specifies the channel

attenuation as follows:
Value

Meaning

0
1
2
3

0 db
-3 db
-6 db
-12db

Indicates the span type. Optional. The minimum allowed

value is 0, with a maximum of Not Defined. Default: Not
Defined

Proprietary and Confidential

Page 5-61

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Assign DS0 Channels to ISUP

OTHER
COMMANDS

From outside the resource context, use this format:

Del <nnn>-SS7CHANNEL

EXAMPLES

To assign DS0 channels to ISUP from the command prompt, at the System/
Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/1-msfnode/Slots/
21-1-CHANINTFCARD/21-1-OC3TDMCARD/1TDMSONETFACILITY/3-sonetpath/1-EMBEDDEDDSX3/61-span
context:
mod ss7channel channel_number=2, trunk_group_number=1, circuit_id=2,
isup_cic=2, loopbacktype=0, attenuation=0, span_type=1

A mod SS7CHANNEL command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots; cd 38-1-CHANINTFCARD; cd 38-1-OC3TDMCARD; cd 1TDMSONETFACILITY ;
cd 359695360-SONETPATH; cd 1-EMBEDDEDDSX3; cd 3702-SPAN;
mod ss7channel channel_number=2, trunk_group_number=1, circuit_id=2,
isup_cic=2, loopbacktype=0, attenuation=0, span_type=1;
cd;

Page 5-62

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Enable VT on DS3

5.22

Enable VT on DS3
The Mod allows you to enable VT on DS3.
NAME

Mod

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-CHANINTFCARD/<n>-<n>-OC3TDMCARD/<n>TDMSONETFACILITY/<n>-SONETPATH

MOD COMMAND
SYNTAX

Mod {parameter1=value1, parameter2=value2, . . .}

PARAMETERS

Channelization

EXAMPLES

Indicates whether this SONET path is channelized or

unchannelized as follows:
Value

Meaning

1
2
3

Disabled
EnabledDs3
EnabledVT

To enable VT on DS3 from the command prompt, at the System/Nodes/

Wireless-Media-Gateway/Spatial-Media-Gateway/1-msfnode/Slots/21-1CHANINTFCARD/21-1-OC3TDMCARD/1-TDMSONETFACILITY/3sonetpath context:
mod CHANNELIZATION=3
Command Successful

A mod command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots; cd 38-1-CHANINTFCARD; cd 38-1-OC3TDMCARD; cd 1TDMSONETFACILITY/1-SONETPATH;
mod CHANNELIZATION=3;
Cd;

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-63

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Enable DS0 Channelization (Under VT Group)

5.23

Enable DS0 Channelization (Under VT Group)

The Mod command allows you to enable DS0 channelization under the VT group.
NAME

Mod

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-CHANINTFCARD/<n>-<n>-OC3TDMCARD/<n>TDMSONETFACILITY/<n>-SONETPATH/<n>-VT_GROUP1/<n>-SONETVT/<n>SPAN

MOD COMMAND
SYNTAX

Mod {parameter1=value1, parameter2=value2, . . .}

PARAMETERS

Channelization

EXAMPLES

This is an optional parameter that specifies the

channelization as follows:
Value

Meaning

1
2

Disabled
Enabled DS0

To enable DS0 channelization under the VT group from the command

prompt, at the System/Nodes/Wireless-Media-Gateway/Spatial-MediaGateway/1-msfnode/Slots/25-1-CHANINTFCARD/25-1-OC3TDMCARD/
1-TDMSONETFACILITY/2-SONETPATH/1-VTGROUP/1-SONETVT/
1377-SPAN context:
mod Channelization=2
Command Successful

A mod command as it might appear in a batch file:

cd Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway;
cd 1-MSFNODE/Slots;
cd 25-1-CHANINTFCARD/25-1-OC3TDMCARD/1-TDMSONETFACILITY;
cd 2-SONETPATH/1-VTGROUP/1-SONETVT;
cd 1377-SPAN;
mod Channelization=2;
cd;

Page 5-64

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Assign DS0 Channels to CALEA

5.24

Assign DS0 Channels to CALEA

The Mod CALEACHANNEL command allows you to assign DS0 channels to CALEA.
NAME

Mod CALEACHANNEL

CONTEXT

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway/<n>-MSFNODE/
Slots/<n>-<n>-CHANINTFCARD/<n>-<n>-OC3TDMCARD/<n>TDMSONETFACILITY/<n>-SONETPATH/<n>-VT_GROUP1/<n>-SONETVT/<n>SPAN

MOD COMMAND
SYNTAX

From outside the resource context, use this format:

mod CALEACHANNEL channel=value, {parameter1=value1,
parameter2=value2..}

From inside the resource context, use this format:

mod {parameter1=value1, parameter2=value2..}
PARAMETERS

OTHER
COMMANDS

Trunk_Group_Number
Specifies the channels system trunk group number.
Optional. The minimum allowed value is 11, with a maximum
of 9999. Default: Not Defined.
circuit_Id

Specifies the Circuit ID for ordering trunks in the trunk group.

Optional. The minimum allowed value is 0, with a maximum of
65535. Default: Not Defined.

casProfId

Specifies CAS Profile Id. Optional. The minimum allowed

value is 0, with a maximum of Not Defined. Default: 0.

channelType

Indicates the channel type. Optional. The minimum allowed

value is 0, with a maximum of Not Defined. Default: Not
Defined.

span_type

Indicates the span type. Optional. The minimum allowed

value is 0, with a maximum of Not Defined. Default: Not
Defined.

From outside the resource context, use this format:

Del ISUPCICPARTITION wsIsupNum =value, isupDPC=value, startIsupCic=value

1/23/07
Revision 3.4

Proprietary and Confidential

Page 5-65

Software Release 3.0

Volume 7

Provisioning the Atrium Wireless Media Gateway

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Assign DS0 Channels to CALEA

EXAMPLES

To assign DS0 channels to CALEA from the command prompt, at the

System/Nodes/Wireless-Media-Gateway/Spatial-Media-Gateway context:
mod CALEACHANNEL channel=1, Trunk_Group_Number=20, circuit_Id=1,
casProfId=0, channelType=0, span_type=0

A mod CALEACHANNEL command as it might appear in a batch file:

Cd;
Cd Nodes; cd Wireless-Media-Gateway ; cd Spatial-Media-Gateway ; cd 1MSFNODE;
Cd Slots; cd 38-1-CHANINTFCARD; cd 38-1-OC3TDMCARD; cd 1TDMSONETFACILITY ;
cd 359696384-SONETPATH; cd 1-VT_GROUP1; cd 1-SONETVT; cd 3729-SPAN;
mod CALEACHANNEL channel=1, Trunk_Group_Number=20, circuit_Id=1,
casProfId=0, channelType=0, span_type=0;
cd;

Page 5-66

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
3HP700021015GUZZA

SECTION 6

Provisioning Atrium Routing and Translation

Command Line Interface Guide

PROVISIONING ATRIUM ROUTING AND TRANSLATION

This section of the Command Line Interface Guide explains how to set up routing and
translations in the Atrium Wireless Soft Switch (WSS).

6.1

Prefix Tree
The prefix tree commands are used to maintain the numeric identifiers for prefix translators and
to assign names to translators. The prefix translator recognizes and standardizes prefixes and
dialed numbers. Its main functions include:
Dialed digit recognition
Dialed digit classification
Call termination screening
Routing
Custom digit formatting and internationalization of numbers for HLR queries
MSISDN Routing and Translations functionDuring prefix translation, call control finds a
particular called number as an MSISDN that requires an HLR query. An analyzed info
message is automatically sent to the Subscriber Profile Manager (SPM) for making an SRI
query. (The system provides one translator, 203-PREFIX, that is used to route all HLR
traffic.)
MSRN Translations and Routing functionIf called number is MSRN, the call is terminated
to a mobile on a CCM card specified in the configuration.
Within each prefix tree are PREFIXFENCE resources that translate the digit strings within the
prefix tree. (See Prefix Translation.)
NAME

Prefix Tree

CONTEXT

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
Prefix-Translation>

ADD COMMAND
SYNTAX

add PREFIX Translator_id=<value>, [Name=<value>]

PARAMETERS

Translator_id

The number to assign to this translator. Required. Must be in

the range 1 through 255. For the standard prefix tree, this
must be 1. For the international prefix translator, it must be
202.

Name

Optional name or description to assign to the translator.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-1

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Prefix Tree

OTHER
COMMANDS

From outside the resource context:

Del <n>-PREFIX
Mod PREFIX Translator_id=<value>, [Name=<value>]

From inside the resource context you can only change the Name:
Mod Name=<value>
EXAMPLES

Adding a prefix translator at the command line:

System/Office-Parameters/Routing-and-Translation/ Wireless-Translation/
Prefix-Translation>add PREFIX Translator_id=1, Name=Prefix tree sample text

Batch file content:

cd;
cd Office-Parameters;
cd Routing-and-Translation;
cd Wireless-Translation;
cd Prefix-Translation;
add PREFIX Translator_id=1, Name= Prefix tree example description text;
cd;

Deleting a prefix translator that has a translator_identifier of 199:

System/Office-Parameters/Routing-and-Translation/ Wireless-Translation/
Prefix-Translation>del 199-PREFIX

Page 6-2

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Prefix Translation and HLR Considerations

6.2

Prefix Translation and HLR Considerations

This topic explains how to configure a Prefix Translation resource and provides information
about HLR prefix translations.

6.2.1 Configuring a Prefix Translation Resource (PREFIXFENCE)

For each prefix within a prefix tree translator, you must give the translation instructions for the
digit strings to be translated. To provision a digit prefix, the user must first complete the
following tasks:
Provision a feature carrier group ID
Provision a translation group
Provision a termination type
NAME

Prefix Translation

CONTEXT

System/Office-Parameters/Routing-and-Translation/
Wireless-Translation/Prefix-Translation/1-PREFIX

ADD COMMAND
SYNTAX
PARAMETERS

Add PREFIXFENCE {parameter1=value1, parameter2=value2,. . . }

Digit_String

Specifies a prefix digit string, up to 32 digits in length. This is

a required entry with a value in the range 1 through 32.

Translation_Group Specifies the national translation group number to use for

calls using this prefixfence. This is a required value in the
range of 1 through 65535. The default is 1.
Digit_String_Type This is a required value that denotes the type of string being
translated, as follows:

1/23/07
Revision 3.4

Value

Meaning

1
2
4
9
10
11
12
13
14
15
16

DT_SUBSCRIBER
DT_SUBSCRIBER_BARGE_IN
DT_NATIONAL
DT_INTERNATIONAL
DT_INTERNATIONAL_OPERATOR_REQ
DT_OPERATOR_REQ_NO_ADDRESS
DT_CUT_THRU_TO_CARRIER
DT_950_CAL
DT_TEST_LINE_TEST_CALL
DT_PUBLIC_FEATURE_CODE
DT_N11_SERVICE_CODE

Proprietary and Confidential

Page 6-3

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Prefix Translation and HLR Considerations

17
18
19
20
21
22
23
24
25
27
28
29
30
31
33
34
35
36
37

PARAMETERS
(CONT.)

Min_Digit_Cnt

DT_EMERGENCY_CODE
DT_SAC_TOLL_FREE
DT_SAC_700
DT_SAC_PC
DT_SAC_PREMIUM
DT_1_PLUS_PREFIX
DT_NATIONAL_OPERATOR_REQ
DT_LOCAL_DA
DT_TOLL_DA
DT_CARRIER_OPER_REQ_NO_ADDR
DT_INTERNATIONAL_OPER_REQ_NO_ADDR
DT_SPEED_CALL_CODE
DT_EXTENSION_NUMBER_CODE
DT_PUBLIC_ACCESS_CODE
DT_OPERATOR_REQ
DT_NATIONAL_OPER_NO_ADDR
DT_CUSTOMER_SUPPORT
DT_WPS
DT_GETS

The minimum number of digits expected. Required value, in

the range 1 through 32. Defaults to 10.

Termination_Type Specifies the termination type defined by the service provider

to be used for call screening. Required value in the range 1
through 19.
Service_Index

Specifies the service type. Required value that can be 1 for

SI_NONE or 101 for SI_NCSI.

Protocol_Type

Specifies type of protocol. Required. Must be 1 for CAMEL or

2 for INAP.

Add_Leading_Digits_Type
Indicates whether a system-defined or a calling party NXX is
used. If system-defined, the value is 0; for NPA-NXX enter 1.
Required.
Numbering_Plan

Specifies the numbering plan used. Required. Values are:

Value

Meaning

8
9

NDARD
NUM_PLAN_PRIVATE

Remove_Leading_Digits
Specifies the number of leading digits to remove from the
original digit string. Required value in the range 0 through 32.
Defaults to 0.

Page 6-4

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Prefix Translation and HLR Considerations

PARAMETERS
(CONT.)

Numbering_Type Specifies the numbering type used. Required. Values are:

Value

Meaning

0
1
2
3
4
6

NUM_TYPE_UNKNOWN
NUM_TYPE_INTERNATIONAL
NUM_TYPE_NATIONAL
NUM_TYPE_NETWORK
NUM_TYPE_SUBSCRIBER
NUM_TYPE_ABBREVIATED

Digits

Specifies the digits. Required value in the range 0 through 16.

Carrier_ID

Specifies the CIC assigned to this NPA-NXX or digit stream.

Required entry.

Networklistsindex Network list index. Required with a value of 0.

Route_Action

Max_Digit_Cnt

Specifies the type of action to be taken when processing this

digit string. Required. Values are:
Value

Meaning

0
1
2
6
7
8
9
10
11

INVALID_TYPE
ROUTE_INDEX
CAUSE_CODE
CALLING_PREFIX_TRANS
CALLING_IMSI_PREFIX_TRANS
NO_MOBILITY_ROUTE_INDEX
REPEAT_PREFIX_TRANS
VLR_CHECK_PREFIX_TRANS
NO_VLR_CHECK_PREFIX_TRANS

Maximum number of digits expected for this entry. Optional

value in the range from 1 through 32. The default is 11.

Default_Handling Default handling. Optional. Values are:

Value

Meaning

0
1

CONT_CALL
REL_CALL

Service_key

Service Key unique to a particular SCP. Optional. Values

must be in the range 0 through 2147483647. The default is 0.

Name

Optional user-defined numeric identifier for the prefix

translation. It can be a value in the range 1 through 32.

Add_Leading_Digits
Digit string to add after the number of leading digits has been
removed from the original digits. Optional.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-5

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Prefix Translation and HLR Considerations

Echo Cancellation
Indicates how echo cancellation processing will be
accomplished, as follows:

OTHER
COMMANDS

Value

Meaning

0
1
2

As trunk is configured.
Enabled
Disabled

Version

Optional value that can be used to document the version.

Route_Index

Optional value that gives the cause code or route index to use
to process the call based on the action type.

From outside its context:

Del PREFIXFENCE <n>-prefixfence
Mod PREFIXFENCE Digit_String=<value>, Translation_Group=<value>,
Digit_String_Type=<value>, { parameter1=value1, parameter2=value2, . . .}

From inside the resource context:

Mod {parameter1=value1, parameter2=value2, . . .}
EXAMPLES

To enter a PREFIXFENCE interactively while in the prefix context:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/PrefixTranslation/1-PREFIX>add PREFIXFENCE
Digit_String: 10
Translation_Group: 1
Digit_String_Type: 4
Min_Digit_Cnt: 11
Termination_Type: 1
Service_Index: 1
Protocol_Type: 1
Add_Leading_Digits_Type :0
Numbering_Plan: 1
Remove_Leading_Digits :0
Numbering_Type: 0
Digits: 0
Carrier_Id: 0002
networkListsIndex: 0
Route_Action: 0
Command Successful

Page 6-6

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Prefix Translation and HLR Considerations

EXAMPLES
(CONT.)

An add prefixfence command as it might appear in a batch file:

cd;
cd Office-Parameters; cd Routing-and-Translation;
cd Wireless-Translation; cd Prefix-Translation;
cd 1-PREFIX;
add PrefixFENCE Digit_String=10,
Translation_Group=1,
Digit_String_Type=4,
Min_Digit_Cnt=11,
Termination_Type=1,
Service_Index=1,
Protocol_Type=1,
Add_Leading_Digits_Type=0,
Numbering_Plan=1,
Remove_Leading_Digits=0,
Numbering_Type=0,
Digits=0, Carrier_Id=0002,
NetworkListsIndex=0,
Route_Action=0;
cd;

Deleting a Prefixfence resource:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/PrefixTranslation/3-PREFIX>Del 10-1-4-PREFIXFENCE

Changing the Route_Action to 1:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/PrefixTranslation/3-PREFIX>Mod PREFIXFENCE Digit_String=10,
Translation_Group=1, Digit_String_Type=4, Route_Action=1

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-7

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Prefix Translation and HLR Considerations

6.2.2 HLR Considerations for 203-PREFIX Resource

The system provides one translator, 203-PREFIX, that is used to route HLR traffic. Calls that
require HLR communications always use the HLR prefix tree.
For HLR prefix trees, only the parameters listed below are used. Please note that some
parameters are required for the 203-PREFIX resource used for HLR translation that are not
required for other PREFIXFENCE resources. Also note that some values are mandatory for the
HLR PREFIXFENCE resource.
Digit_String (required)
Digit_String_Type (required)
Min_Digit_Cnt (required)
Termination_Type (required)
Service_Index (required)
Protocol Type (required)
Numbering_Plan (must be ISDN)
Remove Leading Digits (optional)
Numbering_Type (must be International)
Digits (required)
Carrier ID (must be 0000)
Route Action (required)
Country Code is not used.
Max_Digit_Cnt (required)
Default_Handling (required)
Service Key (required)
Name (required)
Add Leading Digits (optional)
Echo Cancellation (required)
Version (required)
Route Index (required)

Page 6-8

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

National Translation Group

6.3

National Translation Group

To set up translations for domestic routing, you set up one or more national translation groups.
Within each national translation group, instructions for each area code or string to be translated
and routed is entered as a DIGITTRANSLATION resource.
Up to 11 national translation groups can be created.
NAME

National Translation Group

CONTEXT

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation

ADD COMMAND
SYNTAX

add TRANSLATIONGROUP Group_Number=<value>, Name=<value>

PARAMETERS

Group_Number

This is a unique number for the national translation group. It

becomes part of the translation groups name. (Example: 2TRANSLATIONGROUP.) This value is required and must be in
the range 1 through 65535.

Name

This is an optional user-defined name you can assign to the

national translation group.

OTHER
COMMANDS

Del <n>-TRANSLATIONGROUP
Mod Name=<value>

EXAMPLES

To create a national translation group interactively:

System>cd Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation
System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation>add translationgroup
Group_Number: 4
Prompt for Optional? (y/yes/n/no): y
Name (Default:Not Defined): Carltopia
Command Successful

Sample batch file content that adds two national translation groups:
cd;
cd Office-Parameters/Routing-and-Translation/Wireless-Translation/NationalTranslation;
add TRANSLATIONGROUP Group_Number=1, Name=Standard National;
add TRANSLATIONGROUP Group_Number=7, Name=Carltopia;
cd;

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-9

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

National Translation Group

EXAMPLES
(CONT.)

To change a translation groups number, you must delete the translation

group and add another one with a different number. You can change the
translation groups name by changing to the resources context and entering
a command similar to this one:
Mod Name=Test

To delete a national translation group numbered 10 interactively:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation>del 10-TRANSLATIONGROUP
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 6-10

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

National Digit Translation

6.4

National Digit Translation

To add digit translations for area codes (and other strings) within a national group, you add a
DIGTITRANSLATION resource for each string to be translated. The DIGITTRANSLATION
resources takes on the name nnn-DIGITTRANSLATION, where nnn is the numeric string
(Digit_String) to be translated.
NAME

National Digit Translation

CONTEXT

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation/n-TRANSLATIONGROUP

ADD COMMAND
SYNTAX

add DIGITTRANSLATION Digit_String=<value>, Route_Action=<value>,

Route_Index=<value>, [Description=<value>,] [Ported_Office=<value>]

PARAMETERS

Digit_String

Area code or other string to be translated. Required value

from 1 to 32 digits in length. This value becomes part of the
name of the DIGITTRANSLATION resource, such as 303DIGITTRANSLATION for a Digit_String value of 303.

Route_Action

Required indicator to denote whether to use a cause code or

a route index to process this string. Use 1 to indicate that the
Route_Index value is to be used; 2 to indicate that the
Cause_Code is to be used.

Route_Index

A value for this parameter is required. It can be a route index

or a cause code. It is the index value to be used to route the
call when 1 (Route_Index) is specified as the Route_Action,
or the cause code to be used to process the call when the
Route_Action is 2 to indicate cause code processing. The
values may be from 1 through 999999, but cause codes must
be valid cause codes.

Description

Optional description of the area code, up to 32 characters in

length.

Ported_Office

Optional value that indicates whether any office code in the

string is portable. It can be 1 for yes or 0 for no.

OTHER
COMMANDS

From outside the DIGITTRANSLATION context:

Del <n>-DIGITTRANSLATION
Mod DIGITTRANSLATIOND

To modify a digit translation resource in the resources context, then enter:

Mod {name1=<value1>, name2=<value2>, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-11

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

National Digit Translation

EXAMPLES

Adding a digittranslation resource at the command prompt:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation/1-TRANSLATIONGROUP>add DIGITTRANSLATION
Digit_String=214, Route_Action=1, Route_Index=1, Description=Dallas TX,
Ported_Office=0
Command Successful

Example of batch file content used to add digittranslation resources:

cd:
cd Office-Parameters/Routing-and-Translation;
cd Wireless-Translation/National-Translation/1-TRANSLATIONGROUP;
add DIGITTRANSLATION
Digit_String=213,
Route_Action=1,
Route_Index=1,
Description=LSAN LA01 CA,
Ported_Office=0;
add DIGITTRANSLATION
Digit_String=214,
Route_Action=1,
Route_Index=1,
Description=Dallas TX,
Ported_Office=0;
add DIGITTRANSLATION
Digit_String=215,
Route_Action=1,
Route_Index=1,
Description=Ambler PA,
Ported_Office=0;
cd;

To delete a digittranslation resource that has a digit_string value of 2999:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation/1-translationgroup>del 2999-digittranslation
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

To change contexts to a digit translation resource that has a digit_string

value of 299, then change its route index value to 2:
System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation/1-translationgroup>cd 299-digittranslation
Command Successful
System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
National-Translation/1-translationgroup/299-digittranslation>mod route_index=2
Command Successful

Page 6-12

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

International Country Code Translation

6.5

International Country Code Translation

The international country code functionality allows the user to provision country codes for
international and international operator-assisted calls. The user must specify the route index
used for the country code. To set up country code translations you must create a resource for
each country code. These resources are entered into the International-Translation context.
To provision an international country code, the user must first provision an originator route
descriptor.
NAME

International Country Code Translation

CONTEXT

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
International-Translation

ADD COMMAND
SYNTAX

add COUNTRYCODE Country_Code=<value>, Orig__Route_Descriptor=<value>,

[Name=<value>], [Min__Length=<value>], [Max__Length=<value>]

PARAMETERS

Country_Code

The number that will serve as the country code (and the
leading digits of this resources name). Entry in this field is
required. The country code can be any number two or threedigits in length.

Orig__Route_Descriptor
Required route descriptor identification. This can be any
number from 1 through 6.

OTHER
COMMANDS

Name

This is an optional name you can assign to the country code,

usually the name of the country. (Example:
Name=Switzerland and Liechtenstein.) The name can be up to
32 characters in length.

Min__Length

This optional value specifies the minimum length expected

for the combined country code and phone number. Values
can range from 1 to 32 digits. This length includes the length
of the country code (CC) plus the length of the National
Significant Number (NSN).

Max__Length

This optional value specifies the minimum length expected

for the combined country code and phone number. Values
can range from 1 to 32 digits. The current practice maximum
is 15. This length includes the length of the country code (CC)
plus the length of the National Significant Number (NSN).

Del COUNTRYCODE Country_Code=<value>

Mod {parameter1=<value>, parameter2=<value>, . . . }

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-13

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

International Country Code Translation

EXAMPLES

To create a country code resource interactively:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
International-Translation>add countrycode
Country_Code: 28
Orig__Route_Descriptor: 6
Prompt for Optional? (y/yes/n/no): Y
Name (Default:Not Defined): Carltopia
Min__Length (Default:7): 13
Max__Length (Default:7): 15
Command Successful

Sample command used to add a country code in a batch file:

cd;
cd Office-Parameters/Routing-and-Translation/Wireless-Translation/
International-Translation;
add COUNTRYCODE Country_Code=28, Orig__Route_Descriptor=6,
Name=Carltopia, Min__Length=13, Max__Length=15;
cd;

You can change the attributes of the country code resource by changing to
the resources context and entering a command like the one below used to
change the Name parameter:
Mod Name=Carltopia

To delete a country code numbered 28 interactively:

System/Office-Parameters/Routing-and-Translation/Wireless-Translation/
International-Translation>del 28-COUNTRYCODE
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 6-14

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Originator Route Descriptor

6.6

Originator Route Descriptor

The Originator Route Descriptors must each be added as a digitdescriptor resource.
NAME

Originator Route Descriptor

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/
Orig-Route-Descriptor

ADD COMMAND
SYNTAX

add Digitdescriptor Index=<value>, Name=<value>

PARAMETERS

Index

Required number that uniquely identifies the descriptor, in

the range 1 through 999999.

Name

Required information about the descriptor, such as Local

Operator Assistance or Emergency, up to 32 characters in
length.

OTHER
COMMANDS

To delete a DIGITDESCRIPTOR from the Orig-Route-Descriptor context:

Del <n>-DIGITDESCRIPTOR

In the above example, <n> is the Index value of the descriptor. To modify a
DIGITDESCRIPTOR, you must first delete it and then add a new one.
EXAMPLES

Adding a digit descriptor from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/OrigRoute-Descriptor>add digitdescriptor index=1, name=InterLata

Sample batch file entry to add a digitdescriptor:

cd;
cd Office-Parameters/Routing-and-Translation/Routing;
cd Orig-Routing/Orig-Route-Descriptor;
add digitdescriptor index=1, name=InterLata;
cd;

Deleting a digitdescriptor from the command line while in the Orig-RouteDescriptor context:
System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/OrigRoute-Descriptor>Del 1-digitdescriptor
-30065:Are you sure Yes/Y/No/N : ?Y
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-15

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Originator Route Modifier

6.7

Originator Route Modifier

The Originator Route Modifier context contains multiple ORIGROUTE resources.
NAME

Originator Route Modifier

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/OrigRoute-Modifier

ADD COMMAND
SYNTAX

add ORIGROUTEMODIFIER Profile_Identifier=<value>, Name=<value>

PARAMETERS

Profile_Identifier

Required number used to uniquely identify the group of

origination routes.

Name

Required alphanumeric name that you want to assign to the

originator route modifier.

OTHER
COMMANDS

Del Origroutemodifier

To modify an originator route modifier you must delete it first, and then add
a new one to replace it. You cannot use the mod command to change one.
Also, before deleting an originator route modifier, you must remove all of its
resources.
EXAMPLES

Adding an originator route modifier.

System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/OrigRoute-Modifier>add Origroutemodifier Profile_Identifier=2, Name=Originating
from WMG2

Deleting an originator route modifier:

System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/OrigRoute-Modifier>Del 2-Origroutemodifier

Page 6-16

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Originator Route

6.8

Originator Route
Multiple Originator Routes can be added for each Originator Route Modifier. Each route
includes a routing descriptor index value used to identify the route and routing action.The user
must specify the originator route parameters, including:
Originator route modifier
AMA index
Route action
Route index
To provision originator routing parameters, the user must first complete the following tasks:
Provision a CIC route descriptor
Provision a cause code
Provision a route list
Provision an originator route descriptor
Provision an originator route modifier.
NAME

Originator Route

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/OrigRoute-Modifier/n-ORIGROUTEMODIFIER

ADD COMMAND
SYNTAX

add ORIGROUTE Origroute_descriptor, Digit_type, Ama_index, Route_Action,

Route_Index

PARAMETERS

Origroute_descriptor
Required originator route descriptor for this resource. Valid
values are the indexes for the descriptors added to the Orig
Route Descriptor table as digitdescriptor resources. (These
values are used as indexes into this table in the NOA, Prefix
Translation, National Translation and International Country
Code tables.)
Digit_Type

You must specify an input string type, as follows:

Ama_Index

1/23/07
Revision 3.4

Value

Meaning

1
5
6
17
26

DT_SUBSCRIBER
DT_INTRALATA_NATIONAL
DT_INTERLATA_NATIONAL
DT_EMERGENCY_CODE
DT_DO_NOT_OVERRIDE

Specifies a required Automatic Message Accounting (AMA)

translation index value (range 1 - 255). This is used in
Bellcore AMA Format (BAF) record generation.

Proprietary and Confidential

Page 6-17

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Originator Route

PARAMETERS
(CONT.)

Route_Action

This is a required parameter used to specify the action to be

taken when processing this call, as follows:

Route_Index
OTHER
COMMANDS

Value

Meaning

0
2
4
6
7
8
3
5
12
13

INVALID_TYPE
ROUTE_BY_CARRIER
ROUTE_BY_CPC
ROUTE_BY_TOD
ROUTE_DIRECT
TREATMENT
ROUTE_BY_IMSI
ROUTE_BY_LAC
ROUTE_BY_OSSS
ROUTE_BY_OCSI

Required route index value.

From outside the resource context:

Del <n>-origroute
Mod origroute [idname=id], {parameter1=<value1>, parameter2=<value2>, . . . }

From inside the resource context:

Mod {parameter1=<value1>, parameter2=<value2>, . . . }
EXAMPLES

Adding a new origroute from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/OrigRoute-Modifier/2-ORIGROUTEMODIFIER>Add origroute origroute_descriptor=1,
digit_type=1, ama_index=1, route_action=0, route_index=0

An entry in a batch file used to add a new origroute:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/;
cd Orig-Routing/Orig-Route-Modifier/2-ORIGROUTEMODIFIER;
Add origrouteorigroute_descriptor=1, digit_type=1, ama_index=1,
route_action=0, route_index=0;
cd;

Modifying a route index to equal 1 using the command line:

System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/OrigRoute-Modifier/2-ORIGROUTEMODIFIER/1-ORIGROUTE>mod route_index=1

Deleting an originator route:

System/Office-Parameters/Routing-and-Translation/Routing/Orig-Routing/OrigRoute-Modifier/2-ORIGROUTEMODIFIER>Del 2-ORIGROUTE

Page 6-18

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

CIC Route Descriptor

6.9

CIC Route Descriptor

The CIC route descriptors must each be added as a cicdescriptor resource.
NAME

CIC Route Descriptor

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CICRoute-Descriptor

ADD COMMAND
SYNTAX

add CICDESCRIPTOR Index=<value>, Name=<value>

PARAMETERS

Index

Required number that uniquely identifies the descriptor, in

the range 1 through 999999.

Name

Required information about the descriptor, up to 32

characters in length.

OTHER
COMMANDS

To delete a CICDESCRIPTOR from the CIC-Route-Descriptor context:

Del <n>-CICDESCRIPTOR

In the above example <n> is the Index value for the descriptor.
To change a CICDESCRIPTOR, you cannot use the mod command. Instead,
delete the old CICDESCRIPTOR and add a new one that contains the
changes you want to make.
EXAMPLES

Adding a CICDESCRIPTOR from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CICRoute-Descriptor>add CICDESCRIPTOR index=1, name=CIC1

Example of an entry in a batch file to add a CICDESCRIPTOR resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CIC-RouteDescriptor;
add CICDESCRIPTOR index=1, name=CIC1;
cd;

Deleting a CICDESCRIPTOR:
System/Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CICRoute-Descriptor>del 1-CICDESCRIPTOR
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-19

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CIC Route Selector

6.10

CIC Route Selector

The CIC route selectors must each be added as a CARRIERID resource.
NAME

CIC Route Selector

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CICRoute-Selector

ADD COMMAND
SYNTAX

add CARRIERID Index=<value>, Name=<value>

PARAMETERS

Index

Required number that uniquely identifies the selector, in the

range 1 through 999999.

Name

Required information about the selector, up to 32 characters

in length.

OTHER
COMMANDS

To delete a CARRIERID from the CIC-Route-Selector context:

Del <n>-CARRIERID

In the above example <n> is the Index value for the selector.
To change a CARRIERID, you cannot use the mod command. Instead,
delete the old CARRIERID and add a new one that contains the changes you
want to make.
EXAMPLES

Adding a CARRIERID from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CICRoute-Selector>add CARRIERID index=1, name=CIC1

Example of an entry in a batch file to add a CARRIERID resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CIC-RouteSelector;
add CARRIERID index=1, name=CIC1;
cd;

Deleting a CARRIERID:
System/Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CICRoute-Selector>del 1-CARRIERID
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 6-20

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

CIC Route

6.11

CIC Route
To provision CIC carrier routing parameters, the user must first complete the following tasks:
Provision a cause code
Provision a route list
Provision a time of day route descriptor
Provision a CIC route descriptor
Provision a CIC route selector
NAME

CIC Routing

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CICRoute-Selector/<n>-Carrierid

ADD COMMAND
SYNTAX

add CICROUTING CIC_Route_Descriptor=<value>, Name=<value>

PARAMETERS

CIC_Route_Descriptor
Required CIC route descriptor for this resource. Valid values
are CIC route descriptors that are assigned in Originator
Routing.
Route_Action

Route_Index

OTHER
COMMANDS

Required to indicate how to route the call, as follows:

Value

Meaning

3
4
5
6
7
8
12
13

Route by IMSI
Route by CPC
Route by LAC
Route by ToD
Route Immediately
Intercept
Route by OSSS
Route by OCSI

Required to identify a resource within the routing table that

indicates where to route the call.

From outside the CICROUTING context:

Del <n>-CICROUTING
Mod CICROUTING CIC_Route_Descriptor=<value>, [Route_Action=<value>,]
[Route_Index=<value>]

From inside the CICROUTING context:

Mod [Route_Action=<value>,] [Route_Index=<value>]

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-21

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CIC Route

EXAMPLES

Adding a CICROUTING from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CIC
Route-Selector/1-CARRIERID>add CICROUTING CIC_Route_Descriptor=1,
Route_Action=6, Route_Index=1
Command Successful

Sample batch file entry to add a CICROUTING resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CIC RouteSelector/1-CARRIERID;
add CICROUTING CIC_Route_Descriptor=1, Route_Action=6, Route_Index=1;
cd;

Deleting a CICROUTING resource:

System/Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CICRoute-Selector/1-CARRIERID>del 1-CICROUTING
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Modifying a CICROUTING resource:

System/Office-Parameters/Routing-and-Translation/Routing/CIC-Routing/CICRoute-Selector/1-CARRIERID/1-CICROUTING>mod route_action=3

Page 6-22

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

IMSI Route Descriptor

6.12

IMSI Route Descriptor

The IMSI route descriptors must each be added as an imsidescriptor resource.
NAME

IMSI Route Descriptor

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Descriptor

ADD COMMAND
SYNTAX

add IMSIDESCRIPTOR Index=<value>, Name=<value>

PARAMETERS

Index

Required number that uniquely identifies the descriptor, in

the range 1 through 999999.

Name

Required information about the descriptor, up to 32

characters in length.

OTHER
COMMANDS

To delete a IMSIDESCRIPTOR from the IMSI-Route-Descriptor context:

Del <n>-IMSIDESCRIPTOR

In the above example <n> is the Index value for the descriptor.
To change a IMSIDESCRIPTOR, you cannot use the mod command.
Instead, delete the old IMSIDESCRIPTOR and add a new one that contains
the changes you want to make.
EXAMPLES

Adding an IMSIDESCRIPTOR from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Descriptor>add IMSIDESCRIPTOR index=1, name=IMSI1

Example of an entry in a batch file to add an IMSIDESCRIPTOR resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Descriptor;
add IMSIDESCRIPTOR index=1, name=IMSI1;
cd;

Deleting an IMSIDESCRIPTOR:
System/Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Descriptor>del 1-IMSIDESCRIPTOR
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-23

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

IMSI Route Modifier

6.13

IMSI Route Modifier

The IMSI route modifiers must each be added as an imsimodifier resource.
NAME

IMSI Route Modifier

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Modifier

ADD COMMAND
SYNTAX

add IMSIMODIFIER IMSI=<value>, IMSI_Modifier=<value>, Name=<value>

PARAMETERS

IMSI

Specifies IMSI digits.

IMSI_Modifier

Specifies the IMSI modifier.

Name

Description of this specific IMSI route modifier.

OTHER
COMMANDS

To delete a IMSIMODIFIER from the IMSI-Route-Modifier context:

Del <n>-IMSIMODIFIER

Mod IMSIMODIFIER IMSI=<value>, [Name=<value>]

From inside the CICROUTING context:
Mod [Name=<value>]
EXAMPLES

Adding a IMSIMODIFIER from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Modifier>add IMSIMODIFIER IMSI=2, IMSI_Modifier=255, Name=IMSI2

Example of an entry in a batch file to add a IMSIMODIFIER resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Modifier;
add IMSIMODIFIER IMSI=2, IMSI_Modifier=255, Name=IMSI2;
cd;

Deleting an IMSIMODIFIER:
System/Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Modifier>del 1-IMSIMODIFIER
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 6-24

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

IMSI Route

6.14

IMSI Route
To provision IMSI routing parameters, the user must first complete the following tasks:
Provision an originator route modifier
Provision a cause code
Provision a time of day route descriptor
Provision a route list
Provision an IMSI route descriptor
Provision an IMSI route modifier
NAME

IMSI Routing

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Modifier/<n>-IMSIMODIFIER

ADD COMMAND
SYNTAX

add IMSIROUTE IMSI_Route_Descriptor=<value>, IMSI_Route_Modifier=<value>,

Route_Action=<value>, Route_Index=<value>

PARAMETERS

IMSI_Route_Descriptor
Required IMSI route descriptor for this resource. Valid values
are IMSI route descriptors that are assigned in Originator
Routing.
IMSI_Route_Modifier
Required IMSI route modifier from the IMSI modifier table.
Route_Action

Route_Index

1/23/07
Revision 3.4

Required to indicate how to route the call, as follows:

Value

Meaning

4
5
6
7
8
12
13

Route by CPC
Route by LAC
Route by ToD
Route Immediately
Intercept
Route by OSSS
Route by OCSI

Required to identify a resource within the routing table that

indicates where to route the call.

Proprietary and Confidential

Page 6-25

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

IMSI Route

OTHER
COMMANDS

From outside the IMSIROUTE context:

Del <n>-IMSIROUTE
Mod IMSIROUTE IMSI_Route_Descriptor=<value>, [Route_Action=<value>,]
[Route_Index=<value>]

From inside the IMSIROUTE context:

Mod [Route_Action=<value>,] [Route_Index=<value>]
EXAMPLES

Adding a IMSIROUTE from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Modifier/1-IMSIMODIFIER>add IMSIROUTE IMSI_Route_Descriptor=2,
IMSI_Route_Modifier=255, Route_Action=6, Route_Index=2
Command Successful

Sample batch file entry to add a IMSIROUTE resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Modifier/1-IMSIMODIFIER;
add IMSIROUTE IMSI_Route_Descriptor=2, IMSI_Route_Modifier=255,
Route_Action=6, Route_Index=2;
cd;

Deleting a IMSIROUTE resource:

System/Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Modifier/1-IMSIMODIFIER>del 1-IMSIROUTE
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Modifying a IMSIROUTE resource:

System/Office-Parameters/Routing-and-Translation/Routing/IMSI-Routing/IMSIRoute-Modifier/1-IMSIMODIFIER>mod IMSIROUTE IMSI_Route_Descriptor=2,
Route_Action=7

Page 6-26

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

CPC Route Descriptor

6.15

CPC Route Descriptor

The CPC route descriptors must each be added as a CPCDESCRIPTOR resource.
NAME

CPC Route Descriptor

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Descriptor

ADD COMMAND
SYNTAX

add CPCDESCRIPTOR Index=<value>, Name=<value>

PARAMETERS

Index

Required number that uniquely identifies the descriptor, in

the range 1 through 999999.

Name

Required information about the descriptor, up to 32

characters in length.

OTHER
COMMANDS

To delete a CPCDESCRIPTOR from the CPC-Route-Descriptor context:

Del <n>-CPCDESCRIPTOR

In the above example <n> is the Index value for the descriptor.
To change a CPCDESCRIPTOR, you cannot use the mod command.
Instead, delete the old CPCDESCRIPTOR and add a new one that contains
the changes you want to make.
EXAMPLES

Adding a CPCDESCRIPTOR from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Descriptor>add CPCDESCRIPTOR index=1, name=CPC1

Example of an entry in a batch file to add a CPCDESCRIPTOR resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Descriptor;
add CPCDESCRIPTOR index=1, name=CPC1;
cd;

Deleting an CPCDESCRIPTOR:
System/Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Descriptor>del 1-CPCDESCRIPTOR
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-27

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CPC Route Modifier

6.16

CPC Route Modifier

The CPC route modifiers must each be added as a CPCMODIFIER resource.
NAME

CPC Route Modifier

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Modifier

ADD COMMAND
SYNTAX

add CPCMODIFIER Profile_Identifier=<value>, Name=<value>

PARAMETERS

Profile_Identifier

Name
OTHER
COMMANDS

Specifies a number that uniquely identifies the originator

routing profile. Valid values are as follows:
Value

Meaning

0
1
2
3
4
5
9
10
12
13
14
15
16
17
224
225
226
255

Unknown
French Operator
English Operator
German Operator
Russian Operator
Spanish Operator
National Operator
Ordinary Calling Subscriber
Calling Subscriber with Priority
Data Call
Test Call
Pay Phone
Mobile Terminal in Home PLMN
Mobile Terminal Visited PLMN
Emergency Call
High Priority Emergency Call
NS EP
All other CPC

Name of the originator routing profile.

To delete a CPCMODIFIER from the CPC-Route-Modifier context:

Del <n>-CPCMODIFIER

In the above example <n> is the Index value for the modifier.
To change a CPCMODIFIER, you cannot use the mod command. Instead,
delete the old CPCMODIFIER and add a new one that contains the changes
you want to make.

Page 6-28

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

CPC Route Modifier

EXAMPLES

Adding a CPCMODIFIER from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Modifier>add CPCMODIFIER Profile_Identifier=2, Name=CPC1

Example of an entry in a batch file to add a CPCMODIFIER resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Modifier;
add CPCMODIFIER Profile_Identifier=2, Name=CPC1;
cd;

Deleting an CPCMODIFIER:
System/Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Modifier>del 1-CPCMODIFIER
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-29

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CPC Route

6.17

CPC Route
To provision IMSI routing parameters, the user must first complete the following tasks:
Provision an originator route modifier
Provision a cause code
Provision a time of day route descriptor
Provision a route list
Provision an CPC route descriptor
Provision an CPC route modifier
NAME

CPC Routing

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Modifier/<n>-CPCMODIFIER

ADD COMMAND
SYNTAX

add CPCROUTE CPCRoute_Descriptor=<value>, Route_Action=<value>,

Route_Index=<value>

PARAMETERS

CPCRoute_Descriptor
Required CPC route descriptor for this resource. Valid values
are CPC route descriptors that are assigned in Orig Routing.
Route_Action

Route_Index

OTHER
COMMANDS

Required to indicate how to route the call, as follows:

Value

Meaning

5
6
7
8
12
13

Route by LAC
Route by ToD
Route Immediately
Intercept
Route by OSSS
Route by OCSI

Required to identify a resource within the routing table that

indicates where to route the call.

From outside the CPCROUTE context:

Del <n>-CPCROUTE
Mod CPCROUTE CPCRoute_Descriptor=<value>, [Route_Action=<value>,]
[Route_Index=<value>]

From inside the CPCROUTE context:

Mod [Route_Action=<value>,] [Route_Index=<value>]

Page 6-30

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

CPC Route

EXAMPLES

Adding a CPCROUTE from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Modifier/1-CPCMODIFIER>add CPCROUTE CPCRoute_Descriptor=2,
Route_Action=7, Route_Index=2
Command Successful

Sample batch file entry to add a CPCROUTE resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Modifier/1-CPCMODIFIER;
add CPCROUTE CPCRoute_Descriptor=2, Route_Action=7, Route_Index=2;
cd;

Deleting a CPCROUTE resource:

System/Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Modifier/1-CPCMODIFIER>del 1-CPCROUTE
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Modifying a CPCROUTE resource:

System/Office-Parameters/Routing-and-Translation/Routing/CPC-Routing/CPCRoute-Modifier/1-CPCMODIFIER>mod CPCROUTE CPCRoute_Descriptor=2,
Route_Action=8, Route_Index=3

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-31

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

LAC Route Descriptor

6.18

LAC Route Descriptor

The LAC route descriptors must each be added as a lacdescriptor resource.
NAME

LAC Route Descriptor

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Descriptor

ADD COMMAND
SYNTAX

add LACDESCRIPTOR Index=<value>, Name=<value>

PARAMETERS

Index

Required number that uniquely identifies the descriptor, in

the range 1 through 999999.

Name

Required information about the descriptor, up to 32

characters in length.

OTHER
COMMANDS

To delete a LACDESCRIPTOR from the LAC-Route-Descriptor context:

Del <n>-LACDESCRIPTOR

In the above example <n> is the Index value for the descriptor.
To change a LACDESCRIPTOR, you cannot use the mod command.
Instead, delete the old LACDESCRIPTOR and add a new one that contains
the changes you want to make.
EXAMPLES

Adding a LACDESCRIPTOR from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Descriptor>add LACDESCRIPTOR index=1, name=LAC1

Example of an entry in a batch file to add a LACDESCRIPTOR resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Descriptor;
add LACDESCRIPTOR index=1, name=LAC1;
cd;

Deleting an LACDESCRIPTOR:
System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Descriptor>del 1-LACDESCRIPTOR
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 6-32

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

LAC Route Modifier

6.19

LAC Route Modifier

The Location Area Code (LAC) route modifiers must each be added as a lacmodifier resource.
NAME

LAC Route Modifier

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Modifier

ADD COMMAND
SYNTAX

add LACMODIFIER Profile_Identifier=<value>, Name=<value>

PARAMETERS

LAC_Modifier

Define a LAC Route Modifier index to access the LAC Routing

table.

Name

Description of this specific Cell Id range within the specified

LAC.

Mcc_Mnc_Id

Indentifies the country code (MCC) and network code (/MNC)

for the LAC.

LAC_Unknown

If this field is set to 1, this is for routing by modifier when the

LAC anc Cell Begin/End values are set to zeros, meaning the
LAC is not known. Set this to 0 if the modifier will be used for
routing when theLAC is known and values are to be matched.

LAC

Local Area Code.

Cell_ID_Begin

Specifies the smallest of Cell Id range identifying the cells or

a subset of cells in this LAC.

Cell_ID_End

Specifies the largest of Cell Id range identifying the cells or a

subset of cells in this LAC.

OTHER
COMMANDS

To delete a LACMODIFIER from the LAC-Route-Modifier context:

Del <n>-<n>-<n>-<n>-<n>-LACMODIFIER
Mod LACMODIFIER LAC_Modifier=<value>, Mcc_Mnc_Id=<value>,
LAC=<value>, Cell_ID_Begin=<value>, Cell_ID_End=<value>, [Name=<value>]

From inside the LACMODIFIER context:

Mod [Name=<value>]

Modifying a LACMODIFIER resource:

System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Modifier>mod LACMODIFIER Mcc_Mnc_Id=1, LAC=3, Cell_ID_Begin=1,
Cell_ID_End=10, LAC_Modifier=1, Name=test

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-33

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

LAC Route Modifier

EXAMPLES

Adding a LACMODIFIER from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Modifier>add LACMODIFIER LAC_Modifier=1, Name=lac1, Mcc_Mnc_Id=1,
LAC=3, Cell_ID_Begin=1, Cell_ID_End=10

Example of an entry in a batch file to add a LACMODIFIER resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Modifier;
add LACMODIFIER LAC_Modifier=1, Name=lac1, Mcc_Mnc_Id=1, LAC=3,
Cell_ID_Begin=1, Cell_ID_End=10;
cd;

Deleting an LACMODIFIER:
System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Modifier>del 1-3-1-10-1-LACMODIFIER
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 6-34

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

LAC Route

6.20

LAC Route
To provision LAC routing parameters, the user must first complete the following tasks:
Provision an originator route modifier
Provision a cause code
Provision a time of day route descriptor
Provision a route list
Provision an LAC route descriptor
Provision an LAC route modifier
NAME

LAC Routing

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Modifier/<n>-<n>-<n>-<n>-<n>-LACMODIFIER

ADD COMMAND
SYNTAX

add LACROUTE LAC_Route_Descriptor=<value>, Route_Action=<value>,

Route_Index=<value>

PARAMETERS

LAC_Route_Descriptor
Required LAC route descriptor for this resource. Valid values
are LAC route descriptors that are assigned in Originator
Routing.
Route_Action

Route_Index

OTHER
COMMANDS

Required to indicate how to route the call, as follows:

Value

Meaning

6
7
8
12
13

Route by ToD
Route Immediately
Intercept
Route by OSSS
Route by OCSI

Required to identify a resource within the routing table that

indicates where to route the call.

From outside the LACROUTE context:

Del <n>-LACROUTE
Mod CPCROUTE LAC_Route_Descriptor=<value>, [Route_Action=<value>,]
[Route_Index=<value>]

From inside the CPCROUTE context:

Mod [Route_Action=<value>,] [Route_Index=<value>]

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-35

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

LAC Route

EXAMPLES

Adding a LACROUTE from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Modifier/1-3-1-10-1-LACMODIFIER>add LACROUTE
LAC_Route_Descriptor=1, Route_Action=7, Route_Index=1
Command Successful

Sample batch file entry to add a LACROUTE resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Modifier/1-3-1-10-1-LACMODIFIER;
add LACROUTE LAC_Route_Descriptor=1, Route_Action=7, Route_Index=1;
cd;

Deleting a LACROUTE resource:

System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Modifier/1-3-1-10-1-LACMODIFIER>del 1-LACROUTE
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Modifying a LACROUTE resource:

System/Office-Parameters/Routing-and-Translation/Routing/LAC-Routing/LACRoute-Modifier/1-3-1-10-1-LACMODIFIER>mod LACROUTE
LAC_Route_Descriptor=1, Route_Action=7, Route_Index=3

Page 6-36

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

ToD Route Descriptor

6.21

ToD Route Descriptor

The ToD route descriptors must each be added as a TIMEOFDAYROUTEDESCRIPTOR
resource.
NAME

ToD Route Descriptor

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToDRoute-Descriptor

ADD COMMAND
SYNTAX

add TIMEOFDAYROUTEDESCRIPTOR Index=<value>, Name=<value>

PARAMETERS

Index

Required number that uniquely identifies the descriptor, in

the range 1 through 999999.

Name

Required information about the descriptor, up to 32

characters in length.

OTHER
COMMANDS

To delete a TIMEOFDAYROUTEDESCRIPTOR from the ToD-RouteDescriptor context:

Del <n>-TIMEOFDAYROUTEDESCRIPTOR

In the above example <n> is the Index value for the descriptor.
To change a TIMEOFDAYROUTEDESCRIPTOR, you cannot use the mod
command. Instead, delete the old TIMEOFDAYROUTEDESCRIPTOR and
add a new one that contains the changes you want to make.
EXAMPLES

Adding a TIMEOFDAYROUTEDESCRIPTOR from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToDRoute-Descriptor>add TIMEOFDAYROUTEDESCRIPTOR index=1, name=TOD1

Example of an entry in a batch file to add a

TIMEOFDAYROUTEDESCRIPTOR resource:
cd;
cd Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToD-RouteDescriptor;
add TIMEOFDAYROUTEDESCRIPTOR index=1, name=TOD1;
cd;

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-37

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ToD Route Descriptor

EXAMPLES
(CONT.)

Deleting an TIMEOFDAYROUTEDESCRIPTOR:
System/Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToDRoute-Descriptor>del 1-TIMEOFDAYROUTEDESCRIPTOR
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 6-38

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

ToD Route Selector

6.22

ToD Route Selector

The ToD route selectors must each be added as a TIMERCLASS resource.
NAME

ToD Route Selector

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToDRoute-Selector

ADD COMMAND
SYNTAX

add TIMERCLASS Index=<value>, Classification=<value>

PARAMETERS

Index

Required number that uniquely identifies the selector, in the

range 1 through 999999.

Classification

Specifies a string that uniquely identifies a timer

classification.

OTHER
COMMANDS

To delete a TIMERCLASS from the ToD-Route-Selector context:

Del <n>-TIMERCLASS

In the above example <n> is the Index value for the selector.
To change a TIMERCLASS, you cannot use the mod command. Instead,
delete the old TIMERCLASS and add a new one that contains the changes
you want to make.
EXAMPLES

Adding a TIMERCLASS from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToDRoute-Selector>add Classification Index=1, Classification=TOD1

Example of an entry in a batch file to add a TIMERCLASS resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToD-RouteSelector;
add CARRIERID Index=1, Classification=TOD1;
cd;

Deleting a TIMERCLASS:
System/Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/TodRoute-Selector>del 1-TIMERCLASS
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-39

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ToD Route

6.23

ToD Route
To provision ToD routing parameters, the user must first complete the following tasks:
Provision an originator route modifier

Provision a cause code

Provision a time of day route descriptor
Provision a route list
Provision a ToD route descriptor
Provision a ToD route selector
NAME

ToD Routing

CONTEXT

System/Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToDRoute-Selector/<n>-TIMERCLASS

ADD COMMAND
SYNTAX

add TIMEOFDAYROUTE ToD_Route_Descriptor=<value>,

ToD_Route_Selector=<value>, Route_List=<value>

PARAMETERS

ToD_Route_Descriptor
Required ToD route descriptor for this resource. Valid values
are ToD route descriptors.
ToD_Route_Selector
Required ToD route selector for this resource. Valid values
are ToD route selectors.
Route_List

OTHER
COMMANDS

Required to identify a resource within the routing table that

indicates where to route the call.

From outside the TIMEOFDAYROUTE context:

Del <n>-TIMEOFDAYROUTE
Mod TIMEOFDAYROUTE ToD_Route_Descriptor=<value>,
[ToD_Route_Selector=<value>,] [Route_List=<value>]

From inside the TIMEOFDAYROUTE context:

Mod [ToD_Route_Selector=<value>,] [Route_List=<value>]

Page 6-40

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

ToD Route

EXAMPLES

Adding a TIMEOFDAYROUTE from the command line:

System/Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToDRoute-Selector/1-TIMERCLASS>add TIMEOFDAYROUTE
ToD_Route_Descriptor=2, ToD_Route_Selector=2, Route_List=1
Command Successful

Sample batch file entry to add a TIMEOFDAYROUTE resource:

cd;
cd Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToD-RouteSelector/1-TIMERCLASS;
add TIMEOFDAYROUTE ToD_Route_Descriptor=2, ToD_Route_Selector=2,
Route_List=1;
cd;

Deleting a TIMEOFDAYROUTE resource:

System/Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToDRoute-Selector/1-TIMERCLASS>del 1-TIMEOFDAYROUTE
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Modifying a TIMEOFDAYROUTE resource:

System/Office-Parameters/Routing-and-Translation/Routing/ToD-Routing/ToDRoute-Selector/1-TIMERCLASS>mod TIMEOFDAYROUTE
ToD_Route_Descriptor=2, Route_List=3

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-41

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Route List

6.24

Route List
The system uses the route list functionality to find where a call is terminated. The user can
provision up to eight route types for each route list. The route types supported:
Trunk group
Trunk group bundle
Disconnect
Queue
To provision a route list, the user must first complete the following tasks:
Provision trunk groups
Provision cause codes
Provision outpulse maps
Provision trunk group bundles
You can add multiple MSCROUTELIST resources, each identified by a Route_List_Id which
becomes part of the resources name. For example, 3-MSCROUTELIST has a 3 as its
Route_List_Id index value.
NAME

Route List

CONTEXT

System/Office-Parameters/Routing-and-Translation/Route-List

ADD COMMAND
SYNTAX

add MSCROUTELIST Route_List_Id=<value>, {Type_1=<value>, Type_2=<value>

. . . }, CliOutpulse=<value>, [Outpulse_1=<value>, Outpulse_2=<value>, . . . ]
[Value_1=<value>, Value_2=<value>, . . . ], [Name=<value>,] [Look_Ahead={1|0}]

PARAMETERS

Route_List_Id

Required number that uniquely identifies this instance of a

resource within the route list.

{Type_1=<value>, Type_2=<value> . . . }
These values are required to express the purpose of each of
up to eight routes. Valid values are:
Value

Meaning

0
1
2
3
4

Empty
Trunk Group
Bundle
Disconnect
Queue

Page 6-42

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Route List

PARAMETERS
(CONT.)

[Outpulse_1=<value>, Outpulse_2=<value>, . . . ]
These optional parameters correspond to each type defined
by the Type_n parameters. (For example, the Outpulse_3 and
Value_3 parameters corresponds to the Type_3 parameter.)
The Outpulse gives the outpulse map index for routing the
type.
[Value_1=<value>, Value_2=<value>, . . . ]
The Value parameters identify the SysGrpNum (trunk group),
trunk bundle or cause, or it is not used, depending upon its
corresponding Type_n value. For example, if Type_1 is a 1 for
Trunk Group, then Value_1 identifies the particular trunk
group used in the routing (see table).

OTHER
COMMANDS

Value

Meaning

0
1
2
3
4

EmptyNot used
Trunk GroupSysGrpNum
BundleTrunk group bundle number
DisconnectCause code
Queue Not used

Name

Optional user-defined name to describe the route list.

Look_Ahead

Optional indicator to denote whether look-ahead processing

is in effect for this trunk. 1 means Yes; 0 means No. This
feature is used for trunk routing. When a call is placed to a
remote node, the system will Look Ahead to the destination
system to determine if the called station is available.

From outside the context:

Del <n>-MSCROUTELIST
Mod MSCROUTELIST Route_List_Id=<value>, { parameter1=value1,
parameter2=value2, . . .}

From within the mscroutelist context:

Mod { parameter1=value1, parameter2=value2, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-43

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Route List

EXAMPLES

Adding an mscroutelist entry from the command line:

System/Office-Parameters/Routing-and-Translation/Route-List>
add MSCROUTELIST Route_List_Id=6, Type_1=1, Type_2=1, Type_3=1,
Type_4=1, Type_5=1, Type_6=1, Type_7=1, CliOutpulse=2, Outpulse_1=3,
Value_1=0, Outpulse_2=0, Value_2=4, Outpulse_3=0, Value_3=4 Outpulse_4=0,
Value_4=4 Outpulse_5=0, Value_5=4 Outpulse_6=0, Value_6=4, Outpulse_7=7,
Value_7=4, Outpulse_8=1, Value_8=4, Name=FRC78, Look_Ahead=0
Command Successful

Example of adding a mscroutelist resource in a batch file:

cd;
cd Office-Parameters/Routing-and-Translation/Route-List;
add MSCROUTELIST Route_List_Id=6,
Name=Operator,
Look_Ahead=0,
CliOutpulse=0,
Type_1=0, Outpulse_1=0, Value_1=1,
Type_2=0, Outpulse_2=0, Value_2=1,
Type_3=0, Outpulse_3=0, Value_3=1,
Type_4=0, Outpulse_4=0, Value_4=1,
Type_5=0, Outpulse_5=0, Value_5=1,
Type_6=0, Outpulse_6=0, Value_6=1,
Type_7=0, Outpulse_7=0, Value_7=1,
Type_8=0, Outpulse_8=0, Value_8=1;
cd;

To delete an mscroutelist with six as its index (Route_List_id) from the

command line:
System/Office-Parameters/Routing-and-Translation/Route-List>del 6mscroutelist
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Changes the Outpulse_5 value to 1 in the 6-MSCROUTELIST resource:

System/Office-Parameters/Routing-and-Translation/Route-List/
6-MSCROUTELIST>mod Outpulse_5=1

Page 6-44

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Base Station System (BSS) Trunk Groups

6.25

Base Station System (BSS) Trunk Groups

If your system uses BSS trunk groups, they must be defined within the System/Groups/BSS
context under Groups. To set up BSS trunk groups, you must create a BSSGROUP resource for
each trunk group.
NAME

BSS Trunk Groups

CONTEXT

System/Groups/BSS/Groups

ADD COMMAND
SYNTAX

add BSSGROUP {name1=value1, name2=value2, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-45

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Base Station System (BSS) Trunk Groups

PARAMETERS

User_Grp_Number Required identification number used to uniquely identify the

BSS trunk group, in the range 1 through 9999999.
Translation_Group Specifies the national translation group to use to translate
calls that originate on this trunk group. Required value in the
range 1 through 32,767. Default is 1. It must match an existing
translation group number.
Prefix_Translator Specifies the first prefix translator to use for calls originating
on this translation groups. If this is required for the
translation group specified, enter the index to the appropriate
prefix translator. Default is 1.
Network_Group

Specifies the Network Group to use for calls on this trunk

group. Required value in the range 1 through 32767. Default is
1.

Network_ID

Required value that indicates the standard used for traffic on

this trunk, as follows:
Value

Meaning

1
2
3
4
5
6

ANSI92
ITU_INTL
ITU_NAL
C
ITU_RES
ANSI96

Point_Code

Specifies the destination point code for this trunk group.

This must been entered in the format nnn-nnn-nnn, where
nnn can range from 1 to 255, but must match existing point
codes.

Circuit_Pool_ID

This is the Pool_ID of a group of mobile station roaming

numbers (MSRN) defined for this softswitch. It represents a
range of MSRNs used by this base station subsytem. (GSM
circuit pool identifiers are described in the 3GPP 48.008 R5
specification). Valid values are 1-50, except 11, 14, 16 and 17.
42-48 is for CTM. The default is 20. (See the MSRN HON
Distribution section of this manual where the MSRN ranges
are established.)

Screening_Class Specifies the screening class for a call terminating from the
trunk group. Required value in the range 1 through 1023.

Page 6-46

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Base Station System (BSS) Trunk Groups

PARAMETERS
(CONT.)

Orig_Route_Modifier
Specifies the originator routing profile used for calls
originated by trunks in this group. (These values are under
the Routing-and-Translation/Routing tables, under OrigRouting/Orig-Routing-Modifier.) The softswitch uses this
value to select the origination routing table that will be used
to route calls on this trunk group. Required.
Prim_Pool_Id

Specifies primary roaming number pool ID. Required.

Sec_Pool_Id

Specifies a secondary roaming number pool ID. Required.

Mobile_Type

Optional indicator to indicate the type of BSS Signaling

technology being used. Must be 1 for GSM or 2 for CDMA.

Name

Optional unique name to identify the trunk group, up to 64

characters in length.

NOA_Routing

Specifies whether NOA routing is enabled for this trunk.

Optional. If NOA routing is enabled, enter 1; otherwise, 0.

Critical Per

Threshold Percentage for Out of Service circuits in the

trunk group before a critical alarm is sent. Optional value
from 0 to 100 percent.

Minor_Per

Threshold Percentage for Out of Service circuits in the

trunk group before sending a minor alarm.Optional value
from 0 to 100 percent. Must be less than major percent.

Major_Per

Threshold Percentage for Out of Service circuits in the

trunk group before sending a major alarm. Optional value
from 0 to 100 percent. Must be less than critical percent.

Killer Trunk

Specifies whether to enable or disable killer trunk supervision

for this group. Enter 1 to enable monitoring; 0 to disable it.

B_Channel_Number
Optional value that specifies the first B channel in the PRI.
This value determines if channel numbering starts from 0 or
1. If it starts from 0, enter 0; otherwise, enter 1.
Direction

1/23/07
Revision 3.4

Specifies the trunk group direction, as follows:

Value

Meaning

0
1
2

Two way communications permitted.

Incoming communications only.
Outgoing communications only.

Proprietary and Confidential

Page 6-47

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Base Station System (BSS) Trunk Groups

PARAMETERS
(CONT.)

Selection_Order

Specifies the order to be used when selecting trunks from the

group. Values are:
Value

Meaning

0
1
2
3

Least idle.
Longest idle.
Ascending.
Descending.

Channel_Rate_Type
Specifies which channel rate types are available. Values are:
Value

Meaning

0
1
2
3
8
9
10
11
15
26
27
31
32
48
255

SDCCH_BM_LM
SDCCH
SDCCH_BM
SDCCH_LM
BM
LM
FULL_PREF_CHNG
HALF_PREF_CHNG
FULL_HALF_CHNG
FULL_PREF_NO_CHNG
HALF_PREF_NO_CHNG
FULL_HALF_NO_CHNG
FULL_MSLOT_CHNG
FULL_MSLOT_NO_CHNG
CRT_NONE

Jurisdiction_Info Specifies the Jurisdiction Information Parameter. Optional

value from 1 through 6.
Guard_Timer

Specifies the Guard Timer value in units of .25 seconds to

represent 0 to 2 seconds. Values are:
Value

Meaning

0
1
2
3
4
5
6
7
8

NO_GLARE
MSEC_250
MSEC_500
MSEC_750
MSEC_1000
MSEC_1250
MSEC_1500MSEC_1750
MSEC_2000

Page 6-48

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Base Station System (BSS) Trunk Groups

PARAMETERS
(CONT.)

ALC_Media_Stream
Media Stream Automatic Level Control type. Values are:

jitBufSize

Value

Meaning

0
1
2
3
4

alc_disable
alc_type0
alc_type1
alc_type2
alc_type3

Bearer type. Enter 0 for TDM or 1 for VOIP.

ANR_Media_Stream
The media streams Automatic Noise Control (ANR) type, as
follows:

OTHER
COMMANDS

Value

Meaning

0
1
2

ANC disabled
ANC type 0 enabled
ANC type 1 enabled

From outside the context:

Del <n>-BSSGROUP
Mod BSSGROUP User_Grp_Number=<value>, { parameter1=value1,
parameter2=value2, . . .}

From within the resource context

Mod { parameter1=value1, parameter2=value2, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-49

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Base Station System (BSS) Trunk Groups

EXAMPLES

Adding BSS group interactively from the command prompt:

System/Groups/BSS/Groups>add bssgroup
User_Grp_Number: 11
Translation_Group: 4
Translation_Group=>Prefix_Translator:2
Network_Group:1
Network_ID:2
Network_ID=>Point_Code:7-44-7
Circuit_Pool_ID:12
Screening_Class:5
Orig_Route_Modifier:1
Prim_Pool_Id:1
Sec_Pool_Id:2
Prompt for Optional? (y/yes/n/no) : Y
Mobile_Type (Default:1) :1
Name (Default:Not Defined) :Test BSS trunk group.
NOA_Routing (Default:1) :1
Critical_Per (Default:15) :30
Minor_Per (Default:5) :10
Major_Per (Default:10) :20
Killer_Trunk_Monitor (Default:0) :0
B_Channel_Number (Default:1) :5
Direction (Default:2) :2
Selection_Order (Default:1) :1
Channel_Rate_Type (Default:8) :8
Jurisdiction_Info (Default:Not Defined) :what
Guard_Timer (Default:3) :3

Page 6-50

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Base Station System (BSS) Trunk Groups

EXAMPLE
(CONT.)

ALC_Media_Stream (Default:0) :3
jitBufSize (Default:0) :0
ANR_Media_Stream (Default:0) :2
Command Successful

Example of entries in a batch file for adding a BSS group:

cd;
cd Groups/BSS/Groups;
add BSSGROUP
User_Grp_Number=11,
Translation_Group=4,
Prefix_Translator=2,
Network_Group=1,
Network_ID=2,
Point_Code=7-44-7,
Circuit_Pool_ID=12,
Screening_Class=5,
Orig_Route_Modifier=1,
Prim_Pool_Id=1,
Sec_Pool_Id=2,
Mobile_Type=1,
Name=Test BSS group data,
NOA_Routing=1,
Critical_Per=30,
Minor_Per=10,
Major_Per=20;
cd;

Deleting a BSS group that has a User_Grp_Number of 4 from the System/

Groups/BSS/Groups context:
System/Groups/BSS/Groups>Del 4-BSSGROUP

Modifying the Killer_Trunk_Monitor parameter of BSS group number 4

when in the System/Groups/BSS/Groups context:
System/Groups/BSS/Groups>Mod BSSGROUP User_Grp_Number=4,
Killer_Trunk_Monitor=1
Command Successful

Modifying the Point_Code parameter for BSS group number 4 from

within the resource context:
System/Groups/BSS/Groups/4-BSSGROUP>mod point_code=4-90-6
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-51

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ISUP Trunk Group

6.26

ISUP Trunk Group

ISUP trunk groups must be defined within the System/Groups/ISUP context under Groups. To
set up ISUP trunk groups, you must create an ISUPGROUP resource for each trunk group. To
provision an ISUP trunk group, the user must first complete the following tasks:
Configure a WMG Node.
Provision a Subscriber Group.
Provision a Translation Group.
Provision a Network Group.
Provision a Prefix Translator.
Provision an Originating Screening Class.
Provision an Orig Route Modifier.
Provision the destination point codes (DPC).
Provision the origination point codes (OPC).

NAME

ISUP Trunk Group

CONTEXT

System/Groups/ISUP/Groups

ADD COMMAND
SYNTAX

add SS7GROUP {parameter1=<value1>, parameter2=<value2>, . . . }

PARAMETERS

User_Grp_Number The system group number for this trunk. Required value in
the range 1 to 9999999.
Group_Type

The type of trunk group. Must be 0 for ISUP.

Translation_Group Specifies the national translation group to use to translate

calls that originate on this trunk group. Required value in the
range 1 through 32,767. Default is 1. It must match an existing
translation group number.
Prefix_Translator Specifies the first prefix translator to use for calls originating
on this translation groups. If this is required for the
translation group specified, enter the index to the appropriate
prefix translator. Default is 1.
Network_Group

Specifies the network group to use for calls that originate on

this trunk group. Required value in the range 1 through
32,767. Default is 1.

Page 6-52

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

ISUP Trunk Group

PARAMETERS
(CONT.)

Direction

The direction of message traffic allowed within the trunk

group. Required value, as follows:
Value

Meaning

0
1
2

Two-way communications.
Incoming only.
Outgoing only.

Out_IAM_MSG_Access_Transport
If the Direction specification was 0 or 2 (the two direction
choices that allow outgoing messages), you must specify
whether IAM messages will be used in the outbound
direction. Enter 1 to indicate they will be sent or 0 to indicate
that calls are not initiated in the outbound direction.
Orig_Screening_Class
The screening class for a call terminating from the trunk
group. Required value that must be within the range 1
through 1024.
Orig_Route_Modifier
Specifies the origination routing table to use to route calls
incoming on this trunk group. The value you use must match
a modifier configured for the system. (The input for these
tables are in the Routing-and-Translation/Routing section,
under Orig-Routing/Orig-Routing-Modifier.) Required.
Routing_Indicator Denotes how the trunk is connected to the destination (for
BAF AMA records). Required. Values are:

Sub_Type

1/23/07
Revision 3.4

Value

Meaning

0
1
2
3
4
5
6
7
8
9

DIRECT
TANDEM
CAP_DIRECT_EO
CAP_DIRECT_AP
TANDEM_TSP_CAP
TANDEM_LEC_EO
MOBILE_POSITION_CENTER
TANDEM_TO_CAMA
TO_SELECTIVE_ROUTE
TO_SELECTIVE_ROUTE_IWG.

Specifies whether the Telephone User Part (TUP) portion of

the ISUP protocol is used exclusively for this trunk. You must
enter 0 to indicate a NON_SPECIFIC protocol subtype is
used; 1 to indicate TUP is used.

Proprietary and Confidential

Page 6-53

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ISUP Trunk Group

PARAMETERS
(CONT.)

Release_Control_Mode
Used for sub_type specifications to indicate the release
control mode when TUP is used, as follows:
Value

Meaning

1
2
3

CgPartyCtrlRl
CgCdPartyCtrlRls
CdPartyCtrlRls

Outpulsing_CIC

Specifies the outpulsing Carrier Identification Code.

Required.

Mate_Trunk_Grp

Specifies the Emergency Call MPC Loop-back trunk group.

Bearer_Type

Required indicator to denote the type of traffic going over the

trunk group. If the trunk group supports clear channel 64K
transfer capability to the destination node then set it to
UDI_RDI. If the trunk group does not support clear channel
64K transfer capability, due to the type of trunk used (e.g.,
MF) or the transmission equipment in the path, do not set it to
UDI_RDI. Instead, consider setting it to 3.1KHz or voice.
If the trunk group supports MF channels, it can be set to
either 3.1 KHz or voice. UDI_RDI trunk groups can be used to
carry digital data, or Modem/FAX data or voice. The 3.1KHz
trunk groups can be used to carry Modem/FAX data or voice.
Trunk groups marked Voice can not be used to carry digital
data. Values are:
Value

Meaning

0
1
2

DATA_3_1KHZ
UDI_RDI
Voice

ANR_Media_Stream
The media streams Automatic Noise Control (ANR) type. This
specification is required only for bearer types 0
(DATA_3_1KHZ) and 2 (VOICE). Values are:
Value

Meaning

0
1
2

ANC disabled
ANC type 0 enabled
ANC type 1 enabled

Page 6-54

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

ISUP Trunk Group

PARAMETERS
(CONT.)

ALC_Media_Stream
This is the media streams Automatic Level Control (ALC)
type. This specification is required only for bearer types 0
(DATA_3_1KHZ) and 2 (VOICE). Values are:

Test_Type

Value

Meaning

0
1
2
3
4

alc_disable
alc_type0
alc_type1
alc_type2
alc_type3

Required code to indicate the type of trunk test to be

performed on this group, according to these values:
Value

Meaning

0
1
2
3
4
5
6
7
8
9
10
11
12

TRKTEST_NON
TRKTEST_COT
TRKTEST_MW
TRKTEST_MW_TDM
TRKTEST_TONEGEN
TRKTEST_SIGNALING
TRKTEST_OUTPULSIN
TRKTEST_ROUTINE
TRKTEST_T100
TRKTEST_T102
TRKTEST_T105
TRKTEST_T108
TRKTEST_MW_INTERNODE

Carrier_ID

Identification of the carrier for this trunk group.

CNA_Trunk

Required to indicate whether the trunk is configured as a

Connecting Network Access Trunk (CNAT). Enter 1, y or Y for
Yes or 0, n or N for No.

Record_BN_OptionEnter 0 to turn off the billing record number option for this
trunk; 1 to turn it on. Required.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-55

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ISUP Trunk Group

PARAMETERS
(CONT.)

Network_ID

The standard used for traffic on this trunk group, as follows:

Value

Meaning

1
2
3
4
5
6

ANSI92
ITU_INTL
ITU_NAL
C7
ITU_RES
ANSI96

DPC

This is the destination point code (DPC) for the trunk group,
and serves as an index into the signaling gateway table. This
must be entered in the format nnn-nnn-nnn, where nnn can
range from 1 to 255, but must match existing point codes in
the signaling gateway table.

OPC

This is the origination point code (OPC) for the trunk group,
and serves as an index into the signaling gateway table. This
must be entered in the format nnn-nnn-nnn, where nnn can
range from 1 to 255, but must match existing point codes in
the signaling gateway table.

Incoming_Half

Required to indicate whether echo cancellation will be used

on inbound calls on this trunk group. Enter 1, y or Y for Yes or
0, n or N for No.

Network_Data

Required to indicate whether to include Network Data

parameters in backward messages for incoming trunk. Enter
N, n or 0 for No; Y, y or 1 for Yes.

Carrier_Info

Set to 1 to indicate that the carrier ID code will be included in

the IAM or 0 to indicate it is not carried.

Name

Optional name you can assign to the trunk group.

Glare Control

Optional value that indicates what to do in the case of a glare

situation, as follows:
Value

Meaning

0
1
2

Release control
Take control
Use CIC numbering

Page 6-56

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

ISUP Trunk Group

PARAMETERS
(CONT.)

Guard_Timer

The Guard Timer value in units of .25 seconds to represent 0

to 2 seconds. Values are:
Value

Meaning

0
1
2
3
4
5
6
7
8

NO_GLARE
MSEC_250
MSEC_500
MSEC_750
MSEC_1000
MSEC_1250
MSEC_1500
MSEC_1750
MSEC_2000

Signaling_Forward_Path
Required to indicate whether the trunk group cuts a forward
path before the connect message. Enter N, n or 0 for No; Y, y
or 1 for Yes.
Dir_Term_Per_ACL1
Specifies the ACC direct termination percentage at ACL 1.
Optional value from 1 to 100.
Dir_Term_Per_ACL2
Specifies the ACC direct termination percentage at ACL 2.
Optional value from 1 to 100.
Alt_Term_Per_ACL1
Specifies the alternate ACC direct termination percentage at
ACL 1. Optional value from 1 to 100.
Alt_Term_Per_ACL2
Specifies the alternate ACC direct termination percentage at
ACL 2. Optional value from 1 to 100.
Control_Option

Critical Per

1/23/07
Revision 3.4

Required to indicate the Automatic Congestion Control (ACC)

option for this trunk group, as follows:
Value

Meaning

0
1
2
3

ACC invalid
ACC off
ACC on skip
ACC on cancel

Threshold Percentage for Out of Service circuits in the

trunk group before a critical alarm is sent. Optional value
from 0 to 100 percent.

Proprietary and Confidential

Page 6-57

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ISUP Trunk Group

PARAMETERS
(CONT.)

Minor_Per

Threshold Percentage for Out of Service circuits in the

trunk group before sending a minor alarm. Optional value
from 0 to 100 percent. Must be less than major percent.

NOA_Routing

Specifies whether Nature of Address (NOA) routing is

implemented for this trunk group. Enter 1 to indicate NOA
routing is enabled for this trunk group; 0 to indicate NOA
routing is not enabled for this trunk group. Defaults to 1.
Optional.

Major_Per

Threshold Percentage for Out of Service circuits in the

trunk group before sending a major alarm. Optional value
from 0 to 100 percent. Must be less than critical percent.

Killer Trunk

Specifies whether to enable or disable killer trunk supervision

for this group. Enter 1 to enable monitoring; 0 to disable it.

Connect_To

Specifies whether the trunk group is connected to an

interchanged carrier. 1 means it is connected directly to an
interchanged carrier; 2 indicates it is connected to a tandem
switch.

Selection_Order

Specifies the order to be used when selecting trunks from

this trunk group to use for transporting a call. Values are:

Search_Depth

Value

Meaning

0
1
2
3
4
5
6

In order by the least idle used first

In order by longest idle first.
Ascending numeric order
Descending numeric order.
No allocation strategy
Even CIC
Odd CID

Specifies the number of trunks at the top of idle list to search

in order to find a terminating trunk on the same WMG as the
trunk originating the call. Optional value from zero to 4095.
Default is 0.

Call_Hand_Jurisdiction_Info
Optional one to six character value used to provide
jurisdiction information.

Page 6-58

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

ISUP Trunk Group

PARAMETERS
(CONT.)

Dedicated_VPN

Specifies whether the trunk group is a virtual private network.

Enter 0, n or N for No or 1, y or Y for Yes. Defaults to No.

Trigger_Type

Optional value from 1 through 255 to indicate the trigger type.

Origination_ProfileOptional value from 1 through 255 that denotes the attributes

of the BAF AMA records for originating calls. Default is 1.
Termination_Profile Optional value from 1 through 255 to indicate the attributes
of the BAF AMA records for terminating calls. Default is 1.
Test_Call_IndicatorSpecifies whether a test call indication should be set in BAF
AMA records. Optional. Enter N, n or 0 for No; Y, y or 1 for
Yes. Defaults to No.
Network_Number Specifies an particular carrier or network for BAF AMA
records. Optional. Can enter up to six alphanumeric
characters.
Carrier_Type

Denotes whether the carrier supports certain features as

follows:
Value

Meaning

0
1
2

Feature group B
Feature group D
CAMA

MC164_CPN_Option
Optional indicator that shows whether the Module 164 Calling
Party Number option of this trunk group is on or off. Enter N,
n or 0 for No; Y, y or 1 for Yes.
InterNetwork_Code
Optional entry up to four digits in length to identify the interconnecting network for this trunk group.

1/23/07
Revision 3.4

COT_Frequency

An optional value used to indicate the frequency of continuity

tests on this trunk group. Enter 0 for no COT testing or a
value from 1 through 16.

Hop_Count

Optional value that specifies the initial value for the hop
counter. The hop count refers to the number of nodes it takes
a packet from its source to destination. Entry is optional.
Values are 0 for off, or 10 through 20.

Alternate_Route

Optional value that indicates whether alternate routing is

allowed when encountering SS7 congestion or when the
destination point (DPC) has paused. Values are:
Value

Meaning

0
1
2

No alternate routing
Alternate routing for congestion
Alternate routing for DPC pause

Proprietary and Confidential

Page 6-59

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ISUP Trunk Group

PARAMETERS
(CONT.)

LNP_GAP_Addr_Type
Optional specification that indicates whether the Generic
Address Ported Number is used. Enter N, n or 0 for No; Y, y or
1 for Yes.
Redirect_Info

Optional value that indicates whether the message includes a

redirection information parameter. Enter N, n or 0 for No; Y, y
or 1 for Yes.

Satellite

Optional specification that indicates whether there is a

satellite in the trunk groups path. Enter N, n or 0 for No; Y, y
or 1 for Yes.

Confusion_Message
Optional specification that indicates whether the confusion
message can be sent. Enter N, n or 0 for No; Y, y or 1 for Yes.

Incoming_Setting Optional specification that indicates whether echo

cancellation is always applied in both directions or adheres
to GR-317. Enter N, n or 0 for No if echo cancellation is always
applied in both directions; Y, y or 1 for GR-317.
Include_ST_Digit Specifies whether to include the ST digit at the end of the
called party number. Optional. Enter N, n or 0 for No; Y, y or 1
for Yes. Optional.
Outgoing_Half

Optional value that indicates whether outgoing half echo

cancellation for outbound calls on this trunk in accordance
with GR-317. Enter N, n or 0 for No; Y, y or 1 for Yes.

COT_Local_SwitchOptional specification that indicates whether the local switch

is involved in the continuity test. Enter N, n or 0 for No; Y, y or
1 for Yes.
COT_Distant_Switch
Specifies whether the distant switch is involved in the
continuity test. Enter N, n or 0 for No; Y, y or 1 for Yes.
Optional.
Far_End_ACL_Levels
Specifies the switch congestion levels supported by far end
switch. Optional value, as follows:

Force_Answer

Value

Meaning

1
2
3

ACL1
ACL2
ACL3

Specifies whether to send Forced Answer Signal to the

gateway. Enter N, n or 0 for No; Y, y or 1 for Yes. Optional.

Page 6-60

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

ISUP Trunk Group

PARAMETERS
(CONT.)

Remote_Exg_Type Optional value that indicates the remote gateway type, as

follows:
Value

Meaning

1
2
3

RET_LOCAL
RET_TOLL
RET_MSC

Chrg_Num/Orig_Line_Info
Optional specification that indicates whether the IAM
includes the charge number and originating line information.
Enter N, n or 0 for No; Y, y or 1 for Yes. Optional.
Out_IAM_Cont_Jurisdiction_Info
Optional specification that indicates whether Jurisdiction
Information parameter is to be included in the IAMN. Enter N,
n or 0 for No; Y, y or 1 for Yes.
Original_Called_Num
Specifies whether the Original Called Number is to be
included in the IAM. Enter N, n or 0 for No; Y, y or 1 for Yes.
Optional.
Redirecting_Number
Specifies whether Redirecting Number is to be included in
IAM. Enter N, n or 0 for No; Y, y or 1 for Yes. Optional.
Non_LNP_GAP

Specifies whether non-Local Number Portability Generic

Address Parameter is to be included in IAM. Optional. Enter
N, n or 0 for No; Y, y or 1 for Yes.

Generic_Name

Optional Yes or No value to indicate whether Generic Name is

to be included in IAM. Enter N, n or 0 for No; Y, y or 1 for Yes.

Redirect_Capability
Optional Yes or No value to indicate whether the Redirect
Capability is to be included in IAM. Enter N, n or 0 for No; Y, y
or 1 for Yes.
Redirect_Counter Optional Yes or No value to indicate whether Redirect
Counter will appear in IAM. Enter N, n or 0 for No; Y, y or 1 for
Yes. Optional.
Carrier_Selection Optional Yes or No value to indicate whether the Carrier
Selection information will be in the IAM. Enter N, n or 0 for No;
Y, y or 1 for Yes.
Precedence

1/23/07
Revision 3.4

Specifies whether to pass precedence in outgoing IAM. Enter

N, n or 0 for No; Y, y or 1 for Yes.

Proprietary and Confidential

Page 6-61

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ISUP Trunk Group

OTHER
COMMANDS

From outside the SS7GROUP resource context:

Del SS7GROUP User_Grp_Number=<value>
Mod SS7GROUP User_Grp_Number=value, { parameter1=value1,
parameter2=value2, . . .}

From inside the SS7GROUP resource:

Mod { parameter1=value1, parameter2=value2, . . .}

EXAMPLES

Adding an ISUP trunk group interactively:

System/Groups/ISUP/Groups>add ss7group
User_Grp_Number: 010
Translation_Group: 1
Prefix_Translator: 1
Network_Group: 1
Direction: 1
Orig_Screening_Class: 1
Orig_Route_Modifier: 1
Routing_Indicator: 1
Outpulsing_CIC: 0009
Bearer_Type: 1
Test_Type: 1
Carrier_ID: 0011
Record_BN_Option: 0
DPC: 000-000-002
OPC: 000-008-210
Bk_Msg_Cont_Access_Transport: 1
Incoming_Half: 1
Network_Data: 1
Network_Data=>Ntwk_Data_w/_Trk_Membr: 1
Carrier_Info: 1
Added ISUP Group : 1010-SS7GROUP Successfully.

Page 6-62

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

ISUP Trunk Group

EXAMPLES
(CONT.)

To add the ISUP trunk group in a batch file:

:cd;
cd Groups/ISUP/Groups;
add ss7group
User_Grp_Number=1010,
Translation_Group=1,
Translation_Group=1,
Prefix_Translator=1,
Network_Group=1,
Direction=1,
Orig_Screening_Class=1,
Orig_Route_Modifier=1,
Routing_Indicator=1,
Outpulsing_CIC=0009,
Bearer_Type=1,
Test_Type=1,
Carrier_ID=0011,
Record_BN_Option=0,
DPC=000-000-002,
OPC=000-008-210,
Bk_Msg_Cont_Access_Transport=1,
Incoming_Half=1,
Network_Data=1,
Ntwk_Data_w/_Trk_Membr=1,
Carrier_Info=1;
cd;

Changing the carrier identification for an SS7GROUP resource

interactively:
System/Groups/ISUP/Groups>mod ss7group user_grp_number=010,
carrier_id=0002
Completed Successfully

Deleting an SS7GROUP resource:

System/Groups/ISUP/Groups>del ss7group user_grp_number=010
Completed Successfully

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-63

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Trunk Group Bundle

6.27

Trunk Group Bundle

A trunk group bundle is multiple trunk groups identified by an index number. Each of these
must be added to the system as a TRUNKGROUPBUNDLE resource.
NAME

Trunk Group Bundle

CONTEXT

System/Office-Parameters/Routing-and-Translation/Trunk-Group-Bundle

ADD COMMAND
SYNTAX

add TRUNKGROUPBUNDLE TRK2BundleNumber=<value>, [TRK2Name,]

[TRK1Order,] [TRK1Group_Number,] , [TRK1Weigh,] [TRK1routeToMSF]

PARAMETERS

TRK2BundleNumber
Required number used to uniquely identify the
group of trunks. The value must be in the range from 1
through 255.
TRK2Name

An optional alphanumeric parameter used to provide a

description of the trunk group bundle, up to 32 characters in
length.

TRK1Order

Optional number that can be used to define the ordering of

groups for a bundle, in the range 1 through 65,535.

TRK1TrunkGroup_Number
Uniquely identifies a trunk in the trunk group. Optional value
in the range from 1 through 65535. Defaults to 1.
TRK1weight

Optional value that denotes the traffic load factor of each

member in the bundle. Calls are proportionally distributed
across all trunk groups in the same bundle based on this
value. Defaults to 0.

TRK1Route_to_same_MSF
Optional value to indicate whether to route to the same MSF.
Enter N, n or 0 for No; Y, y or 1 for Yes. Defaults to N.

OTHER
COMMANDS

From outside the trunk group bundle context:

Del <n>-TRUNKGROUPBUNDLE
Mod TRUNKGROUPBUNDLE TRK2Bundle_number=<value>,
{parameter1=<value1>, parameter2=<value2>, . . . }

From inside the trunk group bundle context:

Mod {parameter1=<value1>, parameter2=<value2>, . . . }

Page 6-64

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Trunk Group Bundle

EXAMPLES

Adding a trunk group bundle interactively:

System/Office-Parameters/Routing-and-Translation/Trunk-Group-Bundle>add
trunkgroupbundle, TRK2BundleNumber=4, TRK2bundleDesc=Test Trunk

Example of an entry in a batch file to add a trunk group:

cd;
cd Office-Parameters/Routing-and-Translation/Trunk-Group-Bundle;
add trunkgroupbundle, trk2bundlenumber=4,trk2name=Test Trunk,
trk1trunkgroup_number=4;
cd;

Deleting a trunk group bundle:

Del 4-trunkgroupbundle

Changing a trunk group bundle:

Mod TRUNKGROUPBUNDLE TRK2Bundle_number=4, TRK1Order=5

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-65

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

BICC Trunk Group

6.28

BICC Trunk Group

Bearer Independent Call Control (BICC) feature provides a support for narrow band services
over broadband transport without impacting the existing end-to-end service.
BICC protocol is an adaptation of the ISUP protocol definition, but it is not peer-to-peer
compatible with ISUP. ISUP is extended to provide additional messages to transport BNC-ID
and CODEC information needed for the ATM connections.
To provision a BICC trunk group, the user must first complete these tasks:
Provision a Network Group.
Provision routing parameters:

Provision a Prefix Translator.

Provision a Translation Group.

Provision an Orig Route Modifier.

Provision Carrier ID Codes.

Provision a Signaling Gateway.

Provision Destination Point Codes (DPCs)
Provision Origination Point Codes (OPCs)
Provision a Subscriber Group.
Any Barrier Independent Call Control (BICC) trunk groups in the system must be defined
within the System/Groups/BICC context under Groups. To set up BICC trunk groups, you must
create an BICCGROUP resource for each trunk group.
NAME

BICC Trunk Group

CONTEXT

System/Groups/BICC/Groups

ADD COMMAND
SYNTAX

add BICCGROUP {parameter1=<value1>, parameter2=<value2>, . . . }

PARAMETERS

User_Grp_NumberThe system group number for this trunk. Required value in

the range 1 to 9999999. Required.
WMG_Node_Number
This is the node number assigned to the wireless media
gateway (WMC) to which this trunk is attached. Available
options are WMG nodes configured within the system.
Required.
Translation_Group Specifies the national translation group to use to translate
calls that originate on this trunk group. Required value in the
range 1 through 32,767. Default is 1. It must match an existing
translation group number.

Page 6-66

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

BICC Trunk Group

PARAMETERS
(CONT.)

Network_Group

Specifies the network group to use for calls that originate on

this trunk group. Required value in the range 1 through
32,767. Default is 1.

Direction

The direction of message traffic allowed within this trunk

group. Required value, as follows:
Value

Meaning

0
1
2

Two-way communications.
Incoming only.
Outgoing only.

Orig_Screening_Class
The screening class for a call terminating from the trunk
group. Required value that must be within the range 1
through 1024.
Bearer_Type

Required indicator to denote the type of traffic going over the

trunk group. If the trunk group supports clear channel 64K
transfer capability to the destination node then set it to
UDI_RDI. If the trunk group does not support clear channel
64K transfer capability, due to the type of trunk used (e.g.,
MF) or the transmission equipment in the path, do not set it to
UDI_RDI. Instead, consider setting it to 3.1KHz or voice.
If the trunk group supports MF channels, it can be set to
either 3.1 KHz or voice. UDI_RDI trunk groups can be used to
carry digital data, or Modem/FAX data or voice. The 3.1KHz
trunk groups can be used to carry Modem/FAX data or voice.
Trunk groups marked Voice can not be used to carry digital
data. Values are:
Value

Meaning

0
1
2

DATA_3_1KHZ
UDI_RDI
Voice

Originator_Profile Specifies the originator routing profile used for calls

originating on this trunk group. Available options are based
on the originator profiles provisioned in the system.
Required.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-67

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

BICC Trunk Group

PARAMETERS
(CONT.)

Routing_Indicator Denotes how the trunk is connected to the destination (for

BAF AMA records). Required. Values are:
Value

Meaning

0
1
2
3
4
5
6
7

DIRECT
TANDEM
CAP_DIRECT_EO
CAP_DIRECT_AP
TANDEM_TSP_CAP
TANDEM_LEC_EO
MOBILE_POSITION_CENTER
TANDEM_TO_CAMA

DPC

This is the destination point code (DPC) for the trunk group,
and serves as an index into the signaling gateway table. It
must be entered in the format nnn-nnn-nnn, where nnn can
range from 1 to 255, but must match existing point codes in
the signaling gateway table. Required.

Min_CIC

The smallest value for a CIC in the range of CICs provisioned

for this trunk group. Required.

Max_Provisioned_CIC
The largest value for a CIC in the range of CICs provisioned
for this trunk group. Required.
Max_Used_CIC

The largest value for a CIC currently used by this trunk group.
Required.

OPC

This is the origination point code (OPC) for the trunk group,
and serves as an index into the signaling gateway table. This
must be entered in the format nnn-nnn-nnn, where nnn can
range from 1 to 255, but must match existing point codes in
the signaling gateway table. Required.

In_Echo_Suppression
Specifies whether echo suppression will be in effect for this
trunk group. Enter N, n or 0 for No; Y, y or 1 for Yes. Required.
Codec_Profile

Specifies the profile type for this BICC trunk group, The only
value for this is 1 for ituPCM64. Required.

Codec_Profile_Source
Specifies the source of the codec. The only valid value here is
1 for ITU_CODE. Required.

Page 6-68

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

BICC Trunk Group

PARAMETERS
(CONT.)

Name

Optional user-defined name for the trunk group.

Glare_Control

Optional value that denotes what action to take in the event

that signals are being received in both direction on a
bidirectional trunk. Defaults to 2. Valid value are:

Guard_Timer

Forward_Path

Value

Meaning

0
1
2

Release control
Take control
Use CIC numbering

The Guard Timer value in units of .25 seconds to represent 0

to 2 seconds. Defaults to 3. Values are:
Value

Meaning

0
1
2
3
4
5
6
7
8

NO_GLARE
MSEC_250
MSEC_500
MSEC_750
MSEC_1000
MSEC_1250
MSEC_1500
MSEC_1750
MSEC_2000

Required to indicate whether the trunk group cuts a forward

path before the connect message. Enter N, n or 0 for No; Y, y
or 1 for Yes. Default is N.

Dir_Term_Per_ACL1
Specifies the ACC direct termination percentage at ACL 1.
Optional value from 1 to 100. Default is 0.
Dir_Term_Per_ACL2
Specifies the ACC direct termination percentage at ACL 2.
Optional value from 1 to 100. Default is 0.
Alt_Term_Per_ACL1
Specifies the alternate ACC direct termination percentage at
ACL 1. Optional value from 1 to 100. Default is 0.
Alt_Term_Per_ACL2
Specifies the alternate ACC direct termination percentage at
ACL 2. Optional value from 1 to 100. Default is 0.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-69

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

BICC Trunk Group

PARAMETERS
(CONT.)

Control_Option

Required to indicate whether the Automatic Congestion

Control (ACC) option is used for this trunk group. Defaults to
1. Valid values are:
Value

Meaning

0
1
2
3

ACC is not enabled for this trunk group.

ACC is enabled for this trunk group.
ACC on skip.
ACC on cancel.

NOA_Routing

Specifies whether Nature of Address (NOA) routing is

implemented for this trunk group. Enter 1 to indicate NOA
routing is enabled for this trunk group; 0 to indicate NOA
routing is not enabled for this trunk group. Defaults to 1.
Optional.

Connect_To

Specifies whether the trunk group is connected to an

interchanged carrier. 1 means it is connected directly to an
interchanged carrier; 2 indicates it is connected to a tandem
switch. Defaults to 1. Optional.

Critical Per

Threshold Percentage for Out of Service circuits in the

trunk group before a critical alarm is sent. Optional value
from 0 to 100 percent. Defaults to 15. Optional.

Selection_Order

Specifies the order to be used when selecting trunks from

this trunk group to use for transporting a call. Defaults to 1.
Optional. Values are:
Value

Meaning

0
1
2
3
4
5
6

In order by the least idle used first.

In order by longest idle first.
Ascending numeric order
Descending numeric order.
No allocation strategy
Even CIC
Odd CID

Search_Depth

Specifies the number of trunks at the top of idle list to search

in order to find a terminating trunk on the same WMG as the
trunk originating the call. Optional value from zero to 4095.
Default is 0. Optional.

Jurisdiction

Optional one to six character value used to provide

jurisdiction information. Optional.

Minor_Per

Threshold Percentage for Out of Service circuits in the

trunk group before sending a minor alarm. Optional value
from 0 to 100 percent. Must be less than major percent.
Defaults to 5. Optional.

Page 6-70

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

BICC Trunk Group

PARAMETERS
(CONT.)

Major_Per

Threshold Percentage for Out of Service circuits in the

trunk group before sending a major alarm. Optional value
from 0 to 100 percent. Must be less than critical percent.
Defaults to 10. Optional.

Killer Trunk

Specifies whether to enable or disable killer trunk supervision

for this group. Enter 1 to enable monitoring; 0 to disable it.
Default is 0. Optional.

Dedicated_VPN

Specifies whether the trunk group is a virtual private network.

Default is N. Optional.

HPC_Capable

Specifies whether this trunk is capble of high probability call

completion as used with GETS. Enter 1, y or Y for Yes or 0, n
or N for No. Default is 0. Optional.

Origination_ProfileOptional value from 1 through 255 that denotes the attributes

of the BAF AMA records for originating calls. Default is 2.
Optional.
Termination_Profile
Optional value from 1 through 255 to indicate the attributes of
the BAF AMA records for terminating calls. Default is 2.
Optional.
Test_Call_Indicator
Specifies whether a test call indication should be set in BAF
AMA records. Enter 1, y or Y for Yes or 0, n or N for No.
Defaults to No.
Network_Number Specifies an particular carrier or network for BAF AMA
records. Optional. Can enter up to six alphanumeric
characters. Optional.

1/23/07
Revision 3.4

Carrier_Type

Optional value to denotes whether the carrier supports

certain features. Must be set to 1 to indicate Feature group D
is supported.

Hop_Count

Optional value that specifies the initial value for the hop
counter. The hop count refers to the number of nodes it takes
a packet from its source to destination. Entry is optional.
Values are 0 for off, or 10 through 20. Default is 20. Optional.

Proprietary and Confidential

Page 6-71

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

BICC Trunk Group

PARAMETERS
(CONT.)

Alternate_Route

Optional value that indicates whether alternate routing is

allowed when encountering SS7 congestion or when the
destination point (DPC) has paused. Default is 0. Optional.
Values are:
Value

Meaning

0
1
2

No alternate routing
Alternate routing for congestion
Alternate routing for DPC pause

User_Service_Info Specifies whether bits EDCBA of the first octet of the user
service info parameter shall be coded 00000 for speech or
10000 for 3.1 KHz. Enter 1, y or Y for speech or 0, n or N for
3.1 Khz. Defaults to No. Optional.
Include_ATP

Specifies whether a message is to include Access Transport

Parameter. Enter 1, y or Y for Yes or 0, n or N for No. Defaults
to No.

Include_RIP

Specifies whether a message is to include Redirection

Information Parameter. Enter 1, y or Y for Yes or 0, n or N for
No. Defaults to No. Optional.

Satellite

Specifies whether there is a satellite in the path. Enter 1, y or

Y for Yes or 0, n or N for No. Defaults to No. Optional.

Echo_SuppressionSpecifies whether echo suppression is to be used. Enter 1, y

or Y for Yes or 0, n or N for No. Defaults to No. Optional.
Confusion_Message
Specifies whether the confusion message can be sent. Enter
1, y or Y for Yes or 0, n or N for No. Defaults to Yes.
FGD_Access_NodeSet to 1, y or Y to indicate the FGD Access Node generic digit
is expected in the IAM for the incoming trunk. Set to 0, n or N
to indicate it is not. Defaults to No. Optional.
Switch_ID_RoutingSet to 1, y or Y to indicate the switch ID routing parameter is
expected in the IAM for the incoming trunk. Set to 0, n or N to
indicate it is not. Defaults to No. Optional.
Include_ST_Digit Set to 1, y or Y to indicate the network data parameter with
trunk member is expected in backward messages for the
incoming trunk. Set to 0, n or N to indicate it is not. Defaults
to No. Optional.
NDP_with_Trunk Member
Set to 1, y or Y to indciate the network data parameter with
trunk member is expected in backward messages for the
incoming trunk. Set to 0, n or N to indicate it is not. Defaults
to No. Optional.

Page 6-72

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

BICC Trunk Group

PARAMETERS
(CONT.)

COT_Distant_Switch
Specifies whether the distant switch is involved in the
continuity test. Enter 0, n or N for No; 1, y or Y for Yes.
Defaults to Yes. Optional.
Far_End_ACL_Levels
Enter one of the folloiwng to indicate the ACL congetions
level supported. Defaults to 2. Optional.
Value

Meaning

Select this option if you wish the system to

support the least severe congestion
level.

(Default) Select this option if you want the

system to support a more severe
congestion level.

Select this option if you wish the system

to support the most severe congestion level.

CN/OLIP

Specifies whether the IAM should include the Charge Number

(CN) parameter and Originating Line Information Parameter
(OLIP) as a pair in the outgoing message. Enter 1, y or Y for
Yes or 0, n or N for No. Defaults to No. Optional.

CIP

Specifies whether the Carrier Identification Parameter (CIP)

should be included in the outgoing IAM message. Enter 1, y
or Y for Yes or 0, n or N for No. Defaults to No. Optional.

JIP

Specifies whether the Jurisdiction Information Parameter

(JIP) should be included in the outgoing IAM message. Enter
1, y or Y for Yes or 0, n or N for No. Defaults to No. Optional.

OCN

Specifies whether the Original Called Number (OCN) should

be included in the outgoing IAM message. Enter 1, y or Y for
Yes or 0, n or N for No. Defaults to No. Optional.

RN

Specifies whether the redirecting number should be included

in the outgoing IAM message. Enter 1, y or Y for Yes or 0, n or
N for No. Defaults to No. Optional.

GAP

Specifies whether the Generic Access Parameter should be

included in the outgoing IAM message. Enter 1, y or Y for Yes
or 0, n or N for No. Defaults to No. Optional.

GN

Specifies whether Generic Name is to be included in IAM.

Enter 1, y or Y for Yes or 0, n or N for No. Defaults to Yes.
Optional.

Redirect_Capability
Optional Yes or No value to indicate whether the Redirect
Capability is to be included in IAM. Enter N, n or 0 for No; Y, y
or 1 for Yes. Defaults to No.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-73

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

BICC Trunk Group

PARAMETERS
(CONT.)

Redirect_Counter Optional Yes or No value to indicate whether Redirect

Counter will appear in IAM. Enter N, n or 0 for No; Y, y or 1 for
Yes. Defaults to No.
Carrier_Selection Optional Yes or No value to indicate whether the Carrier
Selection information will be in the IAM. Enter N, n or 0 for No;
Y, y or 1 for Yes. Defaults to No.
TNS

Specifies whether Transmit Network Selection is to be

included in IAM. Enter N, n or 0 for No; Y, y or 1 for Yes.
Optional.

Signal_Ported_Number
Specifies whether a Generic Address Parameter for Local
Number Portability is to be included in IAM. Enter N, n or 0 for
No; Y, y or 1 for Yes. Optional.
Accept_TNS

Specifies whether Transmit Network Selection should be

included in the outgoing IAM message. Enter N, n or 0 for No;
Y, y or 1 for Yes. Defaults to No.

Outpulse_FGD_Access_Node
Specifies whether to include the Feature Group D Access
Node Parameter in the outgoing IAM. Enter N, n or 0 for No; Y,
y or 1 for Yes. Defaults to No.
Pass_Precedence Specifies whether to pass precedence inthe outgoing IAM.
Enter N, n or 0 for No; Y, y or 1 for Yes. Defaults to No.
Connection_Type Connection type for a BICC trunk group. (Not used or CISCO
MGX.) Default is 1. Valid values are:

Incoming_Echo

Value

Meaning

0
1
2

ConnectNoInd
ConnectBackward
onnectForward

Indicates whether incoming echo suppression is implemente

for this trunk group. Enter N, n or 0 for No; Y, y or 1 for Yes.
Defaults to No.

Page 6-74

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

BICC Trunk Group

OTHER
COMMANDS

To delete a BICC trunk group, change to the System/Groups/BICC/Groups

context and enter the following:
<n>-BICCGROUP

Where, in the above example, <n> is the User_Grp_Number for the BICC
trunk to be deleted.
To modify a BICC trunk, first change to the System/Groups/BICC/Groups/
<n>-BICCGROUP context, where <n> is the User_Grp_Number of the
trunk you want to modify. Then, enter a command having the following
syntax:
mod {parameter1=<value1>, parameter1=<value1>, . . . }

EXAMPLES

Example of adding a BICC trunk group from the command prompt:

System/Groups/BICC/Groups>ADD BICCGROUP User_Grp_Number=24,
Prefix_Translator=1, Originator_Profile=1, Carrier_ID=0015,
Origination_Profile=2, Termination_Profile=2, Carrier_Type=1,
Network_Number=22, Test_Call_Indicator=1, Bearer_Type=1, Selection_Order=0,
Routing_Indicator=1, Connect_To=1, Orig_Screening_Class=1,
Jurisdiction_Info=Goldenvillia, Dedicated_VPN=0, Search_Depth=0,
Connection_Type=1, Direction=1, HPC_Capable=0
Command Successful
System/Groups/BICC/Groups>

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-75

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

BICC Trunk Group

EXAMPLES
(CONT.)

Batch entry used to add a BICC trunk group:

cd;
cd Groups/BICC/Groups;
Add BICCGROUP
User_Grp_Number=24,
Prefix_Translator=1,
Originator_Profile=1,
Carrier_ID=0015,
Origination_Profile=2,
Termination_Profile=2,
Carrier_Type=1,
Network_Number=10,
Test_Call_Indicator=1,
Bearer_Type=1,
Selection_Order=0,
Routing_Indicator=1,
Connect_To=1,
Orig_Screening_Class=1
Jurisdiction_Info=Goldenvillia,
Dedicated_VPN=0,
Search_Depth=0,
Connection_Type=1,
Direction=1,
HPC_Capable=0;
cd;

Page 6-76

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

CAS Trunk Group

6.29

CAS Trunk Group

With Channel Associated Signalling (CAS) trunk groups each traffic channel has a dedicated
signalling channel. The signalling for a particular traffic circuit is permanently associated with
that circuit. To provision a CAS trunk group, the user must first complete the following tasks:
Configure an MSF node.
Provision a subscriber group.
Provision a network group.
Provision a prefix translator.
Provision a screening class.
Provision a national translation group.
Provision an originator route modifier.
Provision a CIC route descriptor.
Provision an outpulse map.
Provision a feature group.
Provision a CAS profile.
Provision Screening Class.

NAME

CAS Trunk Group

CONTEXT

System/Groups/CAS-Trunk/Groups

ADD COMMAND
SYNTAX

add CASTRUNKGROUP {parameter1=<value1>, parameter2=<value2>, . . . }

PARAMETERS

User_Grp_NumberThe group number for this trunk. Required value in the range
1 to 9999999.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-77

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CAS Trunk Group

PARAMETERS
(CONT.)

Group_Type

The type of trunk group. Select an entry valid for CAS trunks.
Required. Valid values are:
Value

Meaning

0
1
2
3
4
5
6
7
8
9
10
11
12
13

ISUP
PRI
GR303
CASTRK
CASLN
ATM
CASDAL
BICC
CALEA
VOIP
TDM_INT
BSSID
SIP
UTRAN

Translation_Group Specifies the national translation group to use to translate

calls that originate on this trunk group. Required value in the
range 1 through 32,767. Default is 1. It must match an existing
translation group number.
Prefix_Translator Specifies the first prefix translator to use for calls originating
on this translation groups. If this is required for the
translation group specified, enter the index to the appropriate
prefix translator. Default is 1.
Network_Group

Specifies the network group to use for calls that originate on

this trunk group. Required value in the range 1 through
32,767. Default is 1.

Direction

The direction of message traffic allowed within this trunk

group. Required value, as follows:
Value

Meaning

Two-way communications. (The associated

CAS profile must be provisioned with the
Glare Control as Two Way Controller or Two
Way Release.)

Incoming only. (The associated CAS profile must

be provisioned with the Glare Control as
Incoming.)

Outgoing only. (The associated CAS profile must

be provisioned with the Glare Control as Outgoing.)

Page 6-78

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

CAS Trunk Group

PARAMETERS
(CONT.)

CNA_Trunk

If the direction is two-way or incoming traffic only, you

must specify whether this is a Connecting Network Access
(CNA) trunk. Enter N, n or 0 for No; Y, y or 1 for Yes. Defaults
to No.

Incoming_Recording
If the direction specified for this trunk was two-way or
incoming traffic only, and you indicated in the CNA_Trunk
parameters that this is a CNA trunk, you must specify the
recording option here, as follows:
Value

Meaning

Do not enable Chargeable Account Number

Recording (CNAR).

Record full CNAR data.

Record limited CNAR data.

Screening_Class Specify the call screening class for calls on this trunk group.
Valid screening classes are based upon those already
provisioned in the system.
Orig_Route_Modifier
Specifies the origination routing table to use to route calls
incoming on this trunk group. The value you use must match
a modifier configured for the system. (The input for these
tables are in the Routing-and-Translation/Routing section,
under Orig-Routing/Orig-Routing-Modifier.) Required.
Output_Pulse

This is a value to outpulse for milliwatt tests on this trunk

group. Required.

Carrier_ID

Identification of the carrier for this trunk group. Required.

CAS_Profile

Specifies the trunk group number the MSFs use. Required.

Record_BN_OptionIndicates whether the billing number is to be stored as part of

the billing data for calls on this trunk. Enter N, n or 0 for No; Y,
y or 1 for Yes. Required. Defaults to No.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-79

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CAS Trunk Group

PARAMETERS
(CONT.)

Name

Optional user-defined name for the trunk group.

Guard_Timer

The Guard Timer value in units of .25 seconds to represent 0

to 2 seconds. Defaults to 3. Values are:
Value

Meaning

0
1
2
3
4
5
6
7
8

NO_GLARE
MSEC_250
MSEC_500
MSEC_750
MSEC_1000
MSEC_1250
MSEC_1500
MSEC_1750
MSEC_2000

Forward_Path

Required to indicate whether the trunk group cuts a forward

path before the connect message. Enter N, n or 0 for No; Y, y
or 1 for Yes. Default is N.

NOA_Routing

Specifies whether Nature of Address (NOA) routing is

implemented for this trunk group. Enter 1 to indicate NOA
routing is enabled for this trunk group; 0 to indicate NOA
routing is not enabled for this trunk group. Defaults to 1.
Optional.

Connect_To

Specifies whether the trunk group is connected to an

interchanged carrier. 1 means it is connected directly to an
interchanged carrier; 2 indicates it is connected to a tandem
switch. Defaults to 1. Optional.

Critical Per

Threshold Percentage for Out of Service circuits in the

trunk group before a critical alarm is sent. Optional value
from 0 to 100 percent. Defaults to 15. Optional.

Minor_Per

Threshold Percentage for Out of Service circuits in the

trunk group before sending a minor alarm. Optional value
from 0 to 100 percent. Must be less than major percent.
Defaults to 5. Optional.

Major_Per

Threshold Percentage for Out of Service circuits in the

trunk group before sending a major alarm. Optional value
from 0 to 100 percent. Must be less than critical percent.
Defaults to 10. Optional.

Killer_Trunk

Specifies whether to enable or disable killer trunk supervision

for this group. Enter 1 to enable monitoring; 0 to disable it.
Default is 0. Optional.

Page 6-80

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

CAS Trunk Group

PARAMETERS
(CONT.)

Selection_Order

Search_Depth

Specifies the order to be used when selecting trunks from

this trunk group to use for transporting a call. Defaults to 0.
Optional. Values are:
Value

Meaning

0
1
2
3
4
5
6

In order by the least idle used first.

In order by longest idle first.
Ascending numeric order
Descending numeric order.
No allocation strategy
Even CIC
Odd CID

Specifies the number of trunks at the top of idle list to search

in order to find a terminating trunk on the same WMG as the
trunk originating the call. Optional value from zero to 4095.
Default is 0. Optional.

Jurisdiction_Info Optional one to six character value used to provide

jurisdiction information. Optional.
Busy_Verification Specifies whether call originations on this trunk group are
allowed to perform busy verication. Enter N, n or 0 for No; Y, y
or 1 for Yes. Required. Defaults to No.
Routing_Indicator Denotes how the trunk is connected to the destination for
BAF AMA records. Required. Values are:

1/23/07
Revision 3.4

Value

Meaning

0
1
2
3
4
5
6
7

DIRECT
TANDEM
CAP_DIRECT_EO
CAP_DIRECT_AP
TANDEM_TSP_CAP
TANDEM_LEC_EO
MOBILE_POSITION_CENTER
TANDEM_TO_CAMA

Dedicated_VPN

Indicates whether this trunk group is used only for a virtual

private network (VPN). Enter N, n or 0 for No; Y, y or 1 for Yes.
Required. Defaults to No.

Trigger_Type

Optional value from 1 through 255 to indicate the trigger type.

Proprietary and Confidential

Page 6-81

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CAS Trunk Group

PARAMETERS
(CONT.)

Bearer_Type

Required indicator to denote the type of traffic going over the

trunk group. Valid values are:
Value

Meaning

0
2

DATA_3_1KHZ
Voice

X-NPA_digit_ID

0-9 digits used for Centralized Automatic Message

Accounting (CAMA) signaling to identify the trunk group.
Enter 10 to indicate that CAMA is not provisioned for this
trunk group. Optional. Defaults to 10.

Test_Type

Required code to indicate the type of trunk test to be

performed on this group. Optional. Defaults to 0. Valid values
are:
Value

Meaning

0
1
2
3
4
5
6
7
8
9
10
11
12

TRKTEST_NON
TRKTEST_COT
TRKTEST_MW
TRKTEST_MW_TDM
TRKTEST_TONEGEN
TRKTEST_SIGNALING
TRKTEST_OUTPULSIN
TRKTEST_ROUTINE
TRKTEST_T100
TRKTEST_T102
TRKTEST_T105
TRKTEST_T108
TRKTEST_MW_INTERNODE

Milliwatt_DN

The the directory number to use for milliwatt tone test calls
from this trunk group. Optional.

Connect_To

Connect_ToSpecifies whether the trunk group is connected

to an interchanged carrier. 1 means it is connected directly to
an interchanged carrier; 2 indicates it is connected to a
tandem switch. Optional. Defaultst o 1.

Origination_Profile
Optional value from 1 through 255 that denotes the attributes
of the BAF AMA records for originating calls. Optional.
Default is 1.
Termination_Profile
Optional value from 1 through 255 to indicate the attributes of
the BAF AMA records for terminating calls. Optional. Default
is 1.

Page 6-82

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

CAS Trunk Group

PARAMETERS
(CONT.)

Orig_Line_Info_Digits
Specifies the originating line information digits for the IAM
messages from this trunk group. Used to indicate the class of
service for this trunk group. Default is 8. Valid values are:
Value

Meaning

0
1
2
6
7
8
10
20
23
24
27
68
70
78
93
255

POTS
Multiparty line
ANI failure
Station-level rating
Special operator handling required
Inter-LATA restricted
Test call
AIOD-listed DN sent
Coin or noncoin on calls using database access
800 service call
Payphone using coin control signaling
Inter-LATA restricted hotel
Private paystations
Inter-LATA restricted coinless
Private virtual network
No OLI

Test_Call_IndicatorSpecifies whether a test call indication should be set in BAF

AMA records. Optional. Enter N, n or 0 for No; Y, y or 1 for
Yes. Defaults to No.
Network_Number Specifies a particular carrier or network for BAF AMA
records, up to six digits in length. Optional.
Carrier_Type

Indicates the type of carrier for this trunk group, as follows:

Value

Meaning

0
1
2

Feature Group B
Feature Group D
CAMA

MC164_CPN_Option
Specifies whether the Module 164 Calling Party Number
option will be implemented for this trunk group.Optional.
Enter N, n or 0 for No; Y, y or 1 for Yes. Defaults to No.
InterNetwork_Code
This is an optional value up to four digits in length that
identifies the interconnecting network for this trunk group.
Defaults to zero.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-83

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CAS Trunk Group

OTHER
COMMANDS

To delete a CAS trunk group, change to the System/Groups/CAS-Trunk/

Groups context and enter the following:
<n>-CASTRUNKGROUP

Where, in the above example, <n> is the User_Grp_Number for the CAS
trunk to be deleted.
To modify a CAS trunk, first change to the System/Groups/CAS-Trunk/
Groups/<n>-CASTRUNKGROUP context, where <n> is the
User_Grp_Number of the the trunk you want to modify. Then, enter a
command having the following syntax:
mod {parameter1=<value1>, parameter1=<value1>, . . . }

EXAMPLES

Entering a CAS trunk interactively at the system command prompt:

System/Groups/CAS-Trunk/Groups>ADD CASTRUNKGROUP
User_Grp_Number=1, Group_Type=3, Translation_Group=1,
Prefix_Translator=119, Network_Group=1, Direction=2,CNA_Trunk=Y,
Incoming_Recording=1, Screening_Class=0, Orig_Route_Modifier=4,
Output_Pulse=1, Carrier_ID=0015, CAS_Profile=0, Record_BN_Option=Y,
Name=Test Trunk 7 CAS
Command Successful
System/Groups/CAS-Trunk/Groups>

Example of a batch file entry used to add a CAS trunk:

cd;
cd Groups/CAS-Trunk/Groups;
add CASTRUNKGROUP
User_Grp_Number=1,
Group_Type=3,
Translation_Group=1,
Prefix_Translator=119,
Network_Group=1,
Direction=2,CNA_Trunk=Y,
Incoming_Recording=1,
Screening_Class=0,
Orig_Route_Modifier=4,
Output_Pulse=1,
Carrier_ID=0015,
CAS_Profile=0,
Record_BN_Option=Y,
Name=Test Trunk 7 CAS;
cd;

Page 6-84

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

UTRAN Trunk Group

6.30

UTRAN Trunk Group

UTRAN trunk groups are not currently supported in the Command Line Interface.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-85

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

UTRAN Trunk Group

Page 6-86

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

LRN List

6.31

LRN List

NAME

LRN List

CONTEXT

System/Office-Parameters/Network-Parameters/<n>-LRNLISTKEY

ADD COMMAND
SYNTAX

add LRNLIST LRN=<value>, HLR_Number=<value>

PARAMETERS

LRN

Required local routing number up to 15 digits in length that

serves as the index to the resource.

HLR_Number

The entry here is a required HLR number. Valid HLR numbers

are based upon previously provisioned HLR entries found
under Office-Parameters/mobility-config-parameters/networkparameters as MSCNETWORK node resources. This is the
Home Location Registry to search when this LRN is matched.

OTHER
COMMANDS

From outside the LRNLIST context:

Del <n>-LRNLIST
Mod LRN=<value>, HLR_Number=<value>

From inside the LRNLIST context:

Mod HLR_Number=<value>

EXAMPLES

Adding a LRNLIST interactively:

System/Office-Parameters/Network-Parameters/1-LRNLISTKEY>add LRNLIST
LRN=1, HLR_Number=1

Example of an entry in a batch file to add an LRNLIST:

cd;
cd Office-Parameters/Network-Parameters/1-LRNLISTKEY;
add LRNLIST LRN=1, HLR_Number=1;
cd;

Deleting an LRNLIST:
System/Office-Parameters/Network-Parameters/1-lrnlistkey>del 2-lrnlist
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-87

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

LNP Order

6.32

LNP Order

NAME

LNP Order

CONTEXT

System/Office-Parameters/Network-Parameters/<n>-LNPLISTKEY

ADD COMMAND
SYNTAX

add LNPLIST MSISDN_Pattern__with_CC=<value>, LNP_Order=<value>

PARAMETERS

MSISDN_Pattern__with_CC
Required LNP digit pattern, up to 15 digits in length. This is
the digit prefix representing a set of possible portable
numbers.
LNP_Order

OTHER
COMMANDS

Optional indicator to supply the LNP order, as follows:

Value

Meaning

0
1
2

Not Portable
Portable. Search HLR frist, then NPDB.
Portable. Search NPDB first, then HLR.

From outside the LNPLIST context:

Del <n>-LNPLIST
Mod MSISDN_Pattern__with_CC=<value>, LNP_Order=<value>

From inside the LNPLIST list context:

Mod LNP_Order=<value>
EXAMPLES

Adding a LNPLIST interactively:

System/Office-Parameters/Network-Parameters/1-LNPLISTKEY>add LNPLIST
MSISDN_Pattern__with_CC=45, LNP_Order=2

Example of an entry in a batch file to add an LNPLIST:

cd;
cd Office-Parameters/Network-Parameters/1-LNPLISTKEY;
add LNPLIST MSISDN_Pattern__with_CC=45, LNP_Order=2;
cd;

Deleting an LNPLIST:
System/Office-Parameters/Network-Parameters/1-lrnlistkey>del 45-lnplist
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 6-88

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Call Screening

6.33

Call Screening

NAME

Call Screening

CONTEXT

System/Office-Parameters/Routing-and-Translation/Call-Screening/ScreeningClass

ADD COMMAND
SYNTAX

add SCREENCLASS Class_Identifier=<value>, Name=<value>

PARAMETERS

Class_Identifier

Specifies a number that uniquely identifies the screening

class. Required value up to 255 digits in length.

Name

Provides a freeform entry for recording an optional name for

the screening class, up to 32 characters in length.

OTHER
COMMANDS

From outside the SCREENCLASS context:

Del <n>-SCREENCLASS
Mod SCREENCLASS=<value>, Name=<value>

From inside the SCREENCLASS context:

Mod Name=<value>

EXAMPLES

Adding a SCREENCLASS interactively:

System/Office-Parameters/Routing-and-Translation/Call-Screening/ScreeningClass>add SCREENCLASS Class_Identifier=2, Namer=Test1

Example of an entry in a batch file to add an SCREENCLASS:

cd;
cd Office-Parameters/Routing-and-Translation;
cd Call-Screening/Screening-Class;
add SCREENCLASS Class_Identifier=2, Name=TestClass;
cd;

Deleting an SCREENCLASS:
System/Office-Parameters/Network-Parameters/1-lrnlistkey>del 2SCREENCLASS
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-89

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Termination Type

6.34

Termination Type
The termination type functionality allows the user to specify the types of calls a subscriber can
originate.
NAME

Termination Type

CONTEXT

System/Office-Parameters/Routing-and-Translation/Call-Screening/TerminationType

ADD COMMAND
SYNTAX

add TERMINATIONTYPE Termination_Type=<value>, Name=<value>

PARAMETERS

Type_Identifier

Specifies a number that uniquely identifies the termination

type. Required value up to 255 digits in length.

Name

Optional name for the termination type, up to 32 characters in

length.

OTHER
COMMANDS

From outside the TERMINATIONTYPE context:

Del <n>-TERMINATIONTYPE
Mod TERMINATIONTYPE Type_Identifier=<value>, Name=<value>

From inside the TERMINATIONTYPE context:

Mod Name=<value>
EXAMPLES

Adding a TERMINATIONTYPE interactively:

System/Office-Parameters/Routing-and-Translation/Call-Screening/TerminationType>add TERMINATIONTYPE Type_Identifier=45, Name=Test2

Example of an entry in a batch file to add a TERMINATIONTYPE resource:

cd;
cd Office-Parameters/Routing-and-Translation;
cd Call-Screening/Termination-Type>;
add TERMINATIONTYPE Type_Identifier=2, Name=TestType;
cd;

Deleting a TERMINATIONTYPE:
System/Office-Parameters/Network-Parameters/1-lrnlistkey>del 45TERMINATIONTYPE
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 6-90

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

MSISDN to HLR

6.35

MSISDN to HLR
To map a range of Mobile Subscriber numbers to their respective Home Location Register
(HLR) database, you enter an SPMMSISDNHLR resource.
NAME

MSISDN to HLR

CONTEXT

System/Office-Parameters/Routing-and-Translation/MSISDN-to-HLR

ADD COMMAND
SYNTAX

add SPMMSISDNHLR MSISDN_Begin=<value>, MSISDN_End=<value>,

HLR_Number=<value>

PARAMETERS

MSISDN_Begin

Required beginning MSISDN value, up to 15 characters in

length. The beginning and ending MSISDN values become
part of the resources name.

MSISDN_End

Required ending MSISDN value, up to 15 characters in

length.The beginning and ending MSISDN value become part
of the resources name.

HLR_Number

Required HLR Number.Valid HLR numbers are based upon

previously provisioned HLR entries found under OfficeParameters/Mobility-Config-Parameters/Network-Parameters
as MSCNETWORK node resources.

OTHER
COMMANDS

From outside the SPMMSISDNHLR context:

Del <n>-SPMMSISDNHLR
Mod SPMMSISDNHLR MSISDN_Begin=<value>, MSISDN_End=<value>,
{parameter1=<value1>, parameter2=<value2>, . . . }

From inside the SPMMSISDNHLR context:

Mod {parameter1=<value1>, parameter2=<value2>, . . . }

1/23/07
Revision 3.4

Proprietary and Confidential

Page 6-91

Software Release 3.0

Volume 7

Provisioning Atrium Routing and Translation

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

MSISDN to HLR

EXAMPLES

Adding a SPMMSISDNHLR interactively:

System/Office-Parameters/Routing-and-Translation/MSISDN-to-HLR>add
SPMMSISDNHLR MSISDN_Begin=4501, MSISDN_End=4600, HLR_Number=12

Example of an entry in a batch file to add a SPMMSISDNHLR resource:

cd;
cd Office-Parameters/Routing-and-Translation/MSISDN-to-HLR;
add SPMMSISDNHLR, MSISDN_Begin=4501, MSISDN_End=4600,
HLR_Number=12;
cd;

Deleting a SPMMSISDNHLR from the CLI:

System/Office-Parameters/Routing-and-Translation/MSISDN-to-HLR>
del 4-SPMMSISDNHLR
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 6-92

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel-Lucent
Command Line Interface Guide

SECTION 7

CLI Mobility Configuration

3HP700021015GUZZA

CLI MOBILITY CONFIGURATION

Mobility resources identify network nodes to the softswitch. They identify the home network
and the networks the softswitch communicates with. The mobility resources also control switch
usage and identify the base station subsystems and other network elements in the softswitch.
Provisioning mobility parameters involves provisioning these resources:
Network Nodes
Own MSC/VLR
Neighboring MSC/VLR
Equivalent MSC/PLMN
MSC/PLMN
RAN/BSS Entity
GSM LAC/CELL
Mobile Global Title/Allowed Roaming
MSRN Distribution
PLMN Restrictions
LAC/CELL Restrictions
Daylight Savings
Time Zones
HPLMN Network Codes
IMEI Checking
GSM Trace
This section explains how to set up the mobility configuration resources.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-1

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Mobility Configuration Query Commands

7.1

Mobility Configuration Query Commands

Commands used to perform queries from within the mobility configuration section of the
wireless softswitch database are described below.

7.1.1

Showservices

NAME

Showservices

DESCRIPTION

Used to display the services associated with an IMSI.

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/Subscriber-Query-byIMSI-or-MSISDN

SYNTAX

showservices imsi=<value>, basic_services=<value>, features=<value>

OPTIONS

imsi

The subscribers International Mobile Subscriber Identity

(IMSI). This is the number hardcoded in the SIM of
subscribers mobile phone to uniquely identify the user
assigned to that particular device.

basic_services

A code representing a set of features.

features

A code representing the features to display.

EXAMPLES

The following command displays the features for basic service group 1,
feature group 1:
System/Office-Parameters/Mobility-Config-Parameters/Subscriber-Query-byIMSI-orMSISDN>showservices imsi=310910400000650
Basic_Service:1
Feature:1
VLRSUBQUERY:Line Identification:
Override_Mode [Override Mode].......OVR_ENABLE_WITH_PLMN -> 0
eMLPP Info:
Max_Entitle_Priority [Max Entitle Priority].......maxPrio_0 -> 0
Default_Priority [Default Priority].......defPrio_0 -> 0

Page 7-2

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Mobility Configuration Query Commands

EXAMPLE
(CONT.)

Features:
Registered [Registered].......Y->1
Basic_Service [Basic Service].......BS_SPEECH -> 1
Provisioned [Provisioned].......Y->1
Feature [Feature].......SS_CFB -> 1
Active/Operative [Active/Operative].......Y->1
Quiscent [Quiscent].......N->0
Call Forwarding:
Numbering_Plan [Numbering Plan].......NUM_PLAN_ISDN -> 1
Notify_Forwarding_Party [Notify Forwarding Party].......N->0
No_Reply_Timer [No Reply Timer].......0
Forward_To_Number [Forward To Number].......15615614000
Notify_Calling_Party [Notify Calling Party].......N->0
Redirect_Presentation [Redirect Presentation].......N->0
Numbering_Type [Numbering Type].......NUM_TYPE_INTERNATIONAL -> 1
Command Successful

7.1.2

FILES

None.

SEE ALSO

VLRSubquery, VLRSubdel.

VLRSubdel
NAME

VLRSubdel

DESCRIPTION

Used to purge the data for a subscriber from the vistor location registry
(VLR) by entering the subscribers IMSI.

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/Subscriber-Query-byIMSI-or-MSISDN

SYNTAX

vlrsubquery imsi=<value>

OPTIONS

imsi

EXAMPLES

The following command deletes a subscriber from the registry:

The subscribers International Mobile Subscriber Identity

(IMSI). This is the number hardcoded in the SIM of
subscribers mobile phone to uniquely identify the user
assigned to that particular device.

System/Office-Parameters/Mobility-Config-Parameters/Subscriber-Query-byIMSI-or-MSISDN>vlrsubdel imsi=3101502144688431
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful
FILES

None.

SEE ALSO

VLRSubquery, Showservices.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-3

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

VLRSubquery

7.2

VLRSubquery
NAME

VLRSubquery

DESCRIPTION

Used to display a subscriber record from the vistor location registry (VLR)
by entering the subscribers IMSI or MSISDN.

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/Subscriber-Query-byIMSI-or-MSISDN

SYNTAX

vlrsubquery {imsi=<value>|msisdn=<value>}

OPTIONS

imsi

The subscribers International Mobile Subscriber Identity

(IMSI). This is the number hardcoded in the SIM of
subscribers mobile phone to uniquely identify the user
assigned to that particular device.

msisdn

The subscribers Mobile Station Integrated Services Digital

Network (MSISDN). This is the number one would dial to call
the subscriber.

EXAMPLE

The following command queries the registry for the subscriber information:
System/Office-Parameters/Mobility-Config-Parameters/Subscriber-Query-byIMSI-or-MSISDN>vlrsubquery imsi=310910400000510
Reformatting Page. Please wait ...
VLRSUBQUERY:eMLPP Info:
eMLPP Info:
Max_Entitle_Priority [Max Entitle Priority].......-1
Default_Priority [Default Priority].......-1
Subscription Info:
O-CSI [O-CSI].......-1
D-CSI [D-CSI].......-1
SMS-CSI [SMS-CSI].......-1
TIF_CSI [TIF-CSI].......Y->1
VT-CSI [VT-CSI].......-1
MM_CSI [SS-CSI].......Y->1
IMSI Flags:
Non-Dormant [Non-Dormant].......Y->1
SM_Not_Reachable [SM Not Reachable].......N->0
IMSI_Detached_2 [IMSI Detached].......Y->1
Not_Purged [Not Purged].......Y->1

Page 7-4

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

VLRSubquery

EXAMPLE
(CONT.)

General Data:
Int__Out_Calls [Int. Out Calls].......N->0
Double_Chargeable_ECT [Double Chargeable ECT].......N->0
SS_Access [SS Access].......N->0
PRE_Outgoing_Calls [PRE Outgoing Calls].......N->0
Iz/Int__Non-HPLMN_Out_Calls [Iz/Int. Non-HPLMN Out Calls].......N->0
Interzonal_Outgoing_Calls [Interzonal Outgoing Calls].......N->0
Interzonal_ECT [Interzonal ECT].......N->0
Iz_Non-HPLMN_Out_Calls [Iz Non-HPLMN Out Calls].......N->0
Int__ECT [Int. ECT].......N->0
Int__Non-HPLMN_Out_Calls [Int. Non-HPLMN Out Calls].......N->0
All_Out_Calls [All Out Calls].......N->0
Chargeable_ECT [Chargeable ECT].......N->0
All_ECT [All ECT].......N->0
Multiple_ECT [Multiple ECT].......N->0
PRI_Out_Calls [PRI Out Calls].......N->0

Features:
Registered [Registered].......Y->1
Feature [Feature].......-1
Active/Operative [Active/Operative].......Y->1
Quiscent [Quiscent].......Y->1
Basic_Service [Basic Service].......-1
Provisioned [Provisioned].......Y->1
Tele Services:
SMS_PTP-MT [SMS PTP-MT].......N->0
SMS_PTP-MO [SMS PTP-MO].......N->0
Press Enter for More Output :
Command Successful
FILES

None.

SEE ALSO

VLRSubdel, Showservices.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-5

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

MSC Network Nodes

7.3

MSC Network Nodes

The Mobile Switching Center (MSC) node definitions identify the nodes in the network to the
local MSC. These include nodes acting as an MSC, Visitor Location Register (VLR), Home
Location Register (HLR), and all other node types. These nodes become the nodes known to
the local wireless softswitch.
Some other resource types cannot reference nodes until they are added to the Network-Nodes
context. This topic explains how to set up the Network-Nodes resources.
NAME

MSC Network Nodes

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/Network-Nodes

ADD COMMAND
SYNTAX

add MSCNETWORKNODE Dual_HLR=<value>, Node_ID=<value>,

Node_Type_1=<value>, Local=<value>, Standard=<value>,
Routing_Choice=<value>, Network_ID=<value>, [parameter1=<value1>,
parameter2=<value2>, . . .]

PARAMETERS

Dual_Hlr

Required Dual Home Location Register (HLR) value.

Node_ID

Required value to establish a unique identifier for this

network node. This becomes the index into the table of
network nodes. (Example: 5-MSCNETWORKNODE, where 5 is
the Node ID of the network node.) Values can range from 1
through 65535.

Node_Type_1

Required code that indicates the type of node, as follows:

Value

Meaning

0
1
2
3
4
5
6
7
8
9
10

Mobile Switching Center (MSC).

Visitor Location Register (VLR)
GSM Home Location Register (HLR)
Service Control Point (SCP)
Short Message Service Center (SMS-C)
Equipment Identification Register (EIR)
Number Portability Database (NPDB)
Gateway Mobile Location Center (GMLC)
ANSI-41 HLR
NSS Serving Mobile Location Center (SMLC)
Serving GPRS Support Node MSC (SGSN MSC)

Local

Required indicator that specifies whether the node is local,

meaning it is within the Public LAN Mobile Network (PLMN) or
remote, meaning it is outside of the PLMN. Values are N, n or
0 for No; Y, y or 1 for Yes.

Standard

Required indicator that specifies whether the node is

standard or customized. Values are N, n or 0 for No; Y, y or 1
for Yes.

Page 7-6

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

MSC Network Nodes

PARAMETERS
(CONT.)

Routing_Choice

Required value that indicates the type of routing used at the

node. It gives the rules for the various types of network nodes
and their routing strategy, as follows:
Value

Meaning

Global Title Translation (GTT). Called number is

sent to GTT for conversion of the E.164
address to the point code of the node. This is the
most used option.

Point Code (PC). Route by point code.

2
and

GTT PC. Route by sending both the E.164 address

the point code; if the GTT is not available, the
point code is used.

PC/ADDR. Route by sending both the E.164 address

and the point code; if the point code routing fails,
the call is sent to the GTT.

Called Number. Route using the called number.

Uses the called number first, then the GTT.

Uses the called number first, then the point code.

Network_ID

Required network identifier.

Description

Optional alphanumeric description of the node.

MAP_Version

Optional value that specifies the MAP version used for the
MSC/VLR, as follows:
Value

Meaning

0
1
2
3
4

Use MAP stack

MAP version 1
MAP version 2
MAP version 3
MAP version 4

Intl_Fmt_Addr_E_164
Optional value that specifies the International
Telecommunications Union -- Telecom Section (ITU-T) E.164
address for the node, up to 15 digits in length.
Nature_of_AddressOptional value that specifies the nature of the address, in the
range 0 through 127.
Digit_Translation_Type
Optional value that specifies the digit translation type, in the
range 0 through 255.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-7

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

MSC Network Nodes

PARAMETERS
(CONT.)

CAMEL_Ph1

Optional indicator that specifies whether Customized

Applications for Mobile Enhanced Logic (CAMEL) Phase1 is
supported. Values are N, n or 0 for No; Y, y or 1 for Yes.

CAMEL_Ph2

Optional indicator that specifies whether CAMEL Phase 2 is

supported. Values are N, n or 0 for No; Y, y or 1 for Yes.

CAMEL_Ph3

Optional indicator that specifies whether CAMEL Phase 3 is

supported. Values are N, n or 0 for No; Y, y or 1 for Yes.

GTT_Coding_Format
Optional value that specifies the GTT coding format, as
follows:

Point_Code

OTHER
COMMANDS

Value

Meaning

0
1
2
3
4

Non-standard
ITU ANSI1
ANSI
ITU3
ITU

Optional value that gives the point code of the network node.

From outside the resource context:

Del <n>-MSCNETWORKNODE
Mod MSCNETWORKNODE Node_ID=<n>, [parameter1=<value1>,
parameter2=<value2>, . . .]

In the above example, <n> is the Node_Id value for the resource. From
inside the resource context you dont have to give the Node_Id, as follows:
Mod [parameter1=<value1>, parameter2=<value2>, . . . ]

EXAMPLES

Adding an MSCNETWORKNODE resource at the command prompt:

System/Office-Parameters/Mobility-Config-Parameters/Network-Nodes>add
MSCNETWORKNODE Dual_HLR=0, Node_ID=4, Node_Type_1=2, Local=Y,
Standard=Y, Routing_Choice=0, Network_ID=1
Command Successful

Page 7-8

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

MSC Network Nodes

EXAMPLES
(CONT.)

Batch file content:

cd;
cd Office-Parameters/Mobility-Config-Parameters/Network-Nodes;
add MSCNETWORKNODE
Dual_HLR=0,
Node_ID=4,
Node_Type_1=2,
Local=Y,
Standard=Y,
Routing_Choice=0,
Network_ID=1,
GTT_Coding_Format=3;
cd;

Deleting the MSCNETWORKNODE resource from the command prompt:

System/Office-Parameters/Mobility-Config-Parameters/Network-Nodes>
del 4-MSCNETWORKNODE
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Modifying the MSCNETWORKNODE resource at the command prompt

while outside the resource context:
System/Office-Parameters/Mobility-Config-Parameters/Network-Nodes>
mod MSCNETWORKNODE Node_ID=4, GTT_Coding_Format=2
Command Successful

From inside the resource context:

System/Office-Parameters/Mobility-Config-Parameters/Network-Nodes/4MSCNETWORKNODE>mod GTT_Coding_Format=2
Command Successful

Fields used as keys, such as the Node_ID, may not be modified. To change
these values, you must delete the resource and add a new one.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-9

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Own MSC/VLR

7.4

Own MSC/VLR
The MSCCFGMSCSYSTABLE resource is used to identify the Mobile Switching Center
(MSC) and Visitor Location Register (VLR) combinations that represent the local wireless
softswitch. It also supplies the mobile country code (MCC) and mobile network code (MNC)
associated with each MSC/VLR combination.
The MSC node and its VLR node must be provisioned in the Network-Nodes section before its
MSCCFGMSCSYSTABLE resource can be provisioned. (See MSC Network Nodes for
more information.)
NAME

Own MSC/VLR

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/Own-MSC-or-VLR

ADD COMMAND
SYNTAX

add MSCCFGMSCSYSTABLE MSC_ID= <value>, VLR_ID= <value>,

Description= <value>, Mobile_Country_Code= <value>,
Mobile_Network_Code=<value>, [Phase_1=<value>,] [Phase_2=<value>,]
[Phase_3=<value>]

PARAMETERS

MSC_ID

The MSC identifier for the switch. It must match a Node_Id

value defined for an MSC in the Network-Nodes section. This
is required.

VLR_ID

This is the identifier for the VLR to associate with this MSC. It
must match a Node_Id value defined for a VLR node in the
Network-Nodes section. This is required.

Description

Radio network name or other free format description for the

node. Optional.

Mobile_Country_Code
A required Mobile Country Code for the node. It must be three
digits in length.
Mobile_Network_Code
Specifies the required Mobile Network Code for the node,
identifying the owner of the network. It must be at least two
digits in length, but no more than three.
Phase_1

Indicates whether CAMEL phase 1 is supported. Optional.

Values are N, n or 0 for No; Y, y or 1 for Yes.

Phase_2

Indicates whether CAMEL phase 2 is supported. Optional.

Values are N, n or 0 for No; Y, y or 1 for Yes.

Phase_3

Indicates whether CAMEL phase 3 is supported. Optional.

Values are N, n or 0 for No; Y, y or 1 for Yes.

Page 7-10

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Own MSC/VLR

OTHER
COMMANDS

From outside the resource context:

Del <n>-MSCCFGMSCSYSTABLE
Mod MSCCFGMSCSYSTABLE MSC_Id=<n>, [parameter1=<value1>,
parameter2=<value2>, . . .]

In the above example, <n> is the value of the MSC_Id for the resource.
From inside the resource context you dont have to give the MSC_Id, as
follows:
Mod [parameter1=<value1>, parameter2=<value2>, . . . ]

EXAMPLES

Adding an MSCCFGMSCSYSTABLE resource at the command line:

System/Office-Parameters/Mobility-Config-Parameters/Own-MSC-or-VLR>add
MSCCFGMSCSYSTABLE MSC_ID= 1, VLR_ID=2, Description=Local MSC,
Mobile_Country_Code=310, Mobile_Network_Code=150, Phase_3=Y
Command Successful

Batch file content:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd Own-MSC-or-VLR;
ADD MSCCFGMSCSYSTABLE
MSC_ID= 1,
VLR_ID=2,
Description=Local MSC,
Mobile_Country_Code=310,
Mobile_Network_Code=150,
Phase_3=Y;
cd;

Deleting a MSCCFGMSCSYSTABLE resource at the command prompt

with an MSC_Id equal to 4:
System/Office-Parameters/Mobility-Config-Parameters/Own-MSC-or-VLR>
del 4-MSCCFGMSCSYSTABLE
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-11

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Own MSC/VLR

EXAMPLES
(CONT.)

Modifying the MSCCFGMSCSYSTABLE resource from the command

prompt while outside the resource context:
System/Office-Parameters/Mobility-Config-Parameters/Own-MSC-or-VLR>
mod MSCCFGMSCSYSTABLE MSC_ID= 1, Mobile_Network_Code=10,
Phase_3=N;
Command Successful

From inside the resource context:

System/Office-Parameters/Mobility-Config-Parameters/Own-MSC-or-VLR/4MSCCFGMSCSYSTABLE>mod Mobile_Network_Code=10, Phase_3=N
Command Successful

Fields used as keys may not be modified. To change these values, you must
delete the resource and add a new one.

Page 7-12

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Neighboring MSC/VLR

7.5

Neighboring MSC/VLR
The neighboring MSC/VLR resources, called MSCCFGNEIGHBHOOD resources, are used to
define the remote Mobile Switch Center (MSC) termination points where the local MSC can
hand off a call. The Visitor Location Register (VLR) for the MSC must be specified in the
MSCCFGNEIGHBHOOD resource. An MSC node and a VLR node for this resource must be
provisioned in the Network-Nodes section before this resource can be provisioned.(See
Network Nodes in this document for more information.)
NAME

Neighboring MSC/VLR

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/Neighborhood-MSC-orVLR

ADD COMMAND
SYNTAX

add MSCCFGNEIGHBHOOD Location_Area_Code=<value>, MSC_ID=<value>,

VLR_ID=<value>, Mobile_Country_Code=<value>,
Mobile_Network_Code=<value>, [Description=<value>,] [Availability=<value>]

PARAMETERS

Location_Area_Code
This is the area code of the neighboring MSC where the local
MSC can hand off a call. Required
MSC_ID

MSC identifier of the neighboring MSC. It must match a

Node_Id value defined for an MSC in the Network-Nodes
section. Required.

VLR_ID

VLR identifier for the neighboring MSC. It must match a

Node_Id value defined for a VLR type of node in the NetworkNodes section. Required.

Mobile_Country_Code
Required Mobile Country Code (MCC) for the node. It must be
three digits in length.
Mobile_Network_Code
Specifies a required Mobile Network Code (MNC) for the
node, identifying the owner of the network. It must be at least
two digits in length, but no more than three.

1/23/07
Revision 3.4

Description

Required radio network name, or other free-form description,

for the node.

Availability

Indicates whether the resource is locked or unlocked.

Proprietary and Confidential

Page 7-13

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Neighboring MSC/VLR

OTHER
COMMANDS

From outside the resource context:

Del <mcc>-<mnc>-<lac>-MSCCFGNEIGHBHOOD
Mod MSCCFGNEIGHBHOOD Location_Area_Code=<lac>,
Mobile_Country_Code=<mcc>, Mobile_Network_Code=<value>,
[parameter1=<value1>, parameter2=<value2>, . . .]

In the above example, <mcc> is the value of the Mobile_Country_Code,

<mnc> is the Mobile_Network_Code and <lac> is the
Location_Area_Code. Together, these make a unique key for the resource.
From inside the resource context you dont have to give the keys, as follows:
Mod [parameter1=<value1>, parameter2=<value2>, . . . ]

EXAMPLES

Adding an MSCCFGNEIGHBHOOD resource at the command line:

System/Office-Parameters/Mobility-Config-Parameters/Neighborhood-MSC-orVLR>add MSCCFGNEIGHBHOOD Location_Area_Code=214, MSC_ID= 1,
VLR_ID=2, Description=Local MSC, Mobile_Country_Code=310,
Mobile_Network_Code=150
Command Successful

Batch file content:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd Neighborhood-MSC-or-VLR;
ADD MSCCFGNEIGHBHOOD
Location_Area_Code=214,
MSC_ID= 1,
VLR_ID=2,
Description=Neighborhood MSC,
Mobile_Country_Code=310,
Mobile_Network_Code=150;
cd;

Deleting a MSCCFGNEIGHBHOOD resource:

System/Office-Parameters/Mobility-Config-Parameters/Neighborhood-MSC-orVLR>del 310-150-214-MSCCFGNEIGHBHOOD
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Page 7-14

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Neighboring MSC/VLR

EXAMPLES
(CONT.)

Modifying the MSCCFGNEIGHBHOOD resource from the command

prompt while outside the resource context:
System/Office-Parameters/Mobility-Config-Parameters/Own-MSC-or-VLR>
mod MSCCFGNEIGHBHOOD Location_Area_Code=214,
Mobile_Network_Code=150, MSC_ID= 1, Mobile_Network_Code=149;
Command Successful

From inside the resource context:

System/Office-Parameters/Mobility-Config-Parameters/Own-MSC-or-VLR/4MSCCFGNEIGHBHOOD>mod Mobile_Network_Code=150
Command Successful

Fields used as keys may not be modified. To change these values, you must
delete the resource and add a new one.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-15

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

MSC Equivalent PLMN List

7.6

MSC Equivalent PLMN List

The PLMNLIST resource is used to specify alternate networks where calls can be redirected as
required.
NAME

MSC Equivalent PLMN List

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/MSC-Equivalent-PLMNList

ADD COMMAND
SYNTAX

add PLMLIST Equivalent_PLMN_List_Id=<value>, Equivalent_MCC=<value>,

Equivalent_MNC=<value>, [Description=<value>]

PARAMETERS

Equivalent_PLMN_List_Id
Automatically generated equivalent PLMN list identifier.
Required.

OTHER
COMMANDS

Equivalent_MCC

Specifies the equivalent mobile country code. Must be three

digits in length. Required.

Equivalent_MNC

Specifies the equivalent mobile network code. Must be two or

three digits in length. Required.

Description

Optional user-defined description of the PLMLIST.

From outside the resource context:

Del <n>-<mcc>-<mnc>-PLMNLIST
Mod PLMNLIST Equivalent_PLMN_List_Id=<n>, Equivalent_MCC=<mcc>,
Equivalent_MNC=<mnc>, Description=<value>

In the above example, <n> is the Equivalent_PLMN_List_Id, <mcc> is the

Equivalent_MCC and <mnc> is the Equivalent_MNC. Together, these make
a unique key for the resource. You may not modify the key values, only the
description. If you need to change the key values, you must first delete the
resource then re-add it with the correct values. From inside the resource
context you dont have to give the keys:
Mod Description=<value>

Page 7-16

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

MSC Equivalent PLMN List

EXAMPLES

Adding an PLMNLIST resource at the command line:

System/Office-Parameters/Mobility-Config-Parameters/MSC-Equivalent-PLMNList>add PLMNLIST Equivalent_PLMN_List_Id=1, Equivalent_MCC=011,
Equivalent_MNC=150, Description=Test Alternative Network
Command Successful

Batch file content:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd MSC-Equivalent-PLMN-List;
ADD PLMNLIST
Equivalent_PLMN_List_Id=1,
Equivalent_MCC=011,
Equivalent_MNC=150,
Description=Test Alternative Network;
cd;

Deleting a PLMNLIST resource:

System/Office-Parameters/Mobility-Config-Parameters/MSC-Equivalent-PLMNList>del 1-011-150-PLMNLIST
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-17

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

MSC PLMN

7.7

MSC PLMN
The Mobile Switching Center (MSC) Public Land Mobile Network (PLMN) resource provides
descriptive information about the public networks. Before creating this resource, you must set
up the MSC Equivalent PLMN List. (See MSC Equivalent PLMN List.)
NAME

MSC PLMN

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/MSC-PLMN

ADD COMMAND
SYNTAX

add PLMN PLMN_Id=<value>, Equivalent_PLMN_List_Id=<value>,

Description=<value>, [Short_Network_Name=<value>,]
[Full_Network_Name=<value>]

PARAMETERS

PLMN_Id

Automatically generated PLMN identifier. The valid value is

the next integer in sequence.

Equivalent_PLMN_List_Id
This is a required index into the MSC Equivalent PLMN list. It
is used to locate alternate networks in the list where calls can
be redirected as required. (See MSC Equivalent PLMN List.)
Description

Required description of the PLMN, up to 32 characters in

length.

Short_Network_Name
Optional user-defined short name for the PLMN, up to 32
characters in length.
Full_Network_Name
Optional user-defined full name for the PLMN, up to 32
characters in length.

OTHER
COMMANDS

From outside the resource context:

Del <n>-PLMN
Mod PLMN PLMN_Id=<n>, {parameter1=<value1>, parameter2=<value2>, . . . }

In the above example, <n> is the PLMN_Id. From inside the resource
context you dont have to give the PLMN_Id:
Mod {parameter1=<value1>, parameter2=<value2>, . . . }

Page 7-18

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

MSC PLMN

EXAMPLES

Adding a PLMN resource at the command line:

System/Office-Parameters/Mobility-Config-Parameters/MSC-PLMN>add PLMN
PLMN_Id=2, Equivalent_PLMN_List_Id=0, Description=Tropical Network,
Short_Network_Name=TropNet, Full_Network_Name=Tropical Network Systems,
Inc.
Command Successful

Batch file content:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd MSC-PLMN;
ADD PLMN
PLMN_Id=2,
Equivalent_PLMN_List_Id=0,
Description=Tropical Network,
Short_Network_Name=TropNet,
Full_Network_Name=Tropical Systems Network , Inc.;
cd;

Deleting a PLMN resource:

System/Office-Parameters/Mobility-Config-Parameters/MSC-PLMN>del 2-PLMN
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Changing a PLMN resource:

System/Office-Parameters/Mobility-Config-Parameters/MSC-PLMN>MOD
PLMN,PLMN_Id=2, Equivalent_PLMN_List_Id=32
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-19

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

MSC MCC/MNC

7.8

MSC MCC/MNC
The MCCMNC resource is used to establish the country codes and network codes for the
Public Land Mobile Networks (PLMN) that will be recognized by the local Mobile Switching
Center (MSC).
To create the MCCMNC resource, you must first set up the PLMNLIST and PLMN resources.
(See MSC Equivalent PLMN List and MSC PLMN in this document.) You may then
create the MCCMNC resource to assign the country and network codes to the MSC PLMN.
NAME

MSC MCC/MNC

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/MSC-MCC-and-MNC

ADD COMMAND
SYNTAX

add MCCMNC Mcc_Mnc_Id=<value>, PLMN_Id=<value>,

Mobile_Country_Code=<value>, Mobile_Network_Code=<value>,
Description=<value>

PARAMETERS

Mcc_Mnc_Id

Required identifier for this instance of an MCCMNC resource.

It is an automatically generated value one higher than the last
MCCMNC resource added.

PLMN_Id

Required identifier of an existing PLMN resource for which

you are assigning country codes and network codes. You
may select only the PLMN_Id of existing PLMN resources.
(See MSC PLMN in this document)

Mobile_Country_Code
This is the required numeric country code you are assigning
to the PLMN. This code should be three digits in length.
Mobile_Network_Code
This is the required numeric network code you are assigning
to the PLMN. It can be two or three digits in length.
Description

A description of the PLMN/MCC/MNC relationship is required,

up to 32 characters in length.

Access Type

Indicates whether the network is accessed using Unlicensed

Mobile Access (UMA) or GSM. Enter 0 for GSM or 1 for UMA.
Defaults to 0 for GSM.

Page 7-20

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

MSC MCC/MNC

OTHER
COMMANDS

From outside the resource context:

Del <n>-MCCMNC
Mod MCCMNC Mcc_Mnc_Id=<n>, {parameter1=<value1>,
parameter2=<value2>, . . . }

In the above example, <n> is the Mcc_Mnc_Id. From inside the resource
context you dont have to give the Mcc_Mnc_Id:
Mod {parameter1=<value1>, parameter2=<value2>, . . . }

EXAMPLES

Adding an MCCMNC resource at the command line:

System/Office-Parameters/Mobility-Config-Parameters/MSC-MCC-and-MNC>add
MCCMNC Mcc_Mnc_Id=3, PLMN_Id=3, Mobile_Country_Code=011,
Mobile_Network_Code=44, Description=Test PLMN/MCC/MNC
Command Successful

Batch file content:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd MSC-MCC-and-MNC;
ADD MCCMNC
Mcc_Mnc_Id=3,
PLMN_Id=3,
Mobile_Country_Code=011,
Mobile_Network_Code=44,
Description=Test PLMN/MCC/MNC,
Access_Type=0;
cd;

Deleting a MCCMNC resource:

System/Office-Parameters/Mobility-Config-Parameters/MSC-MCC-and-MNC>del
3-MCCMNC
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Changing a MCCMNC resource:

System/Office-Parameters/Mobility-Config-Parameters/MSC-MCC-andMNC>MOD MCCMNC Mcc_Mnc_Id=3, Description=Test Change to Description
89012
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-21

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

RAN/BSS Entity

7.9

RAN/BSS Entity
A RAN/BSS Entity resource, named EMSVLRCFGRADIONETWORK, is used to identify
each base station subsystem associated with the local softswitch. An SS7 configuration must
already exist in the Signaling Gateway before a BSS can be added. In addition, a BSS Group
will need to be added for the BSS entities.
NAME

RAN/BSS Entity

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/RAN-or-BSS-Entity

ADD COMMAND
SYNTAX

add EMSVLRCFGRADIONETWORK Radio_Network_Id=<value>,

Network_ID=<value>, Point_Code=<value>, Lata_Num=<value>,
Version=<value>, RNC_Id=<value>, SMLC_Type=<value>,
SMLC_Node_Num=<value>, [Description=<value>,]
[ANSI_or_ETSI_CIC_Coding=<value>]

PARAMETERS

Radio_Network_Id Radio network identification unique to each base station. This

is a required value that can range from 0 through 32767.
Network_ID

Required value that identifies the network.

Point_Code

Specifies the destination point code for this base station.

This must be entered in the format nnn-nnn-nnn, where nnn
can range from 1 through 255.

Lata_Number

This is a required local access and transport area (LATA)

number for the base station.This is a three-digit value used in
the United States to indicate the area for local calls. Defaults
to 0.

Version

Required number that indicates the version of the base

station, as follows:
Value

Meaning

Indicates it is a 2G station, using the Base Station

Subsystem Application specification (BSSAP) for
GSM.

Indicates it is a 3G station, using the Radio

Network Application specification (RNAP) for UMTS.

Indicates the base station is a Voice-over-IP (VOIP)

station.

Page 7-22

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

RAN/BSS Entity

PARAMETERS
(CONT.)

RNC_Id

If the Version is RNAP, you must enter the RNC identifier. It

can be from 0 through 4095. Default is 0.

Smlc_Type

Required number that indicates the type of serving mobile

location center (SMLC) that the base station uses. It is the
kind of server in the radio network that handles requests for
the location of a mobile user, as follows:
Value

Meaning

0
1

BSS SMLC
NSS SMLC

SMLC_Node_Num If the SML_Type specified is NSS SMLC, you must give the
identity of the SMLC node. This value can range from 0
through 999.
Description

This is an optional user-defined description of the RAN or

BSS entity, up to 32 characters in length.

ANSI_or_ETSI_CIC_Coding
Optional indicator that tells whether the RAN or BSS entity
uses ANSI or ETSI standards for their CIC coding. If it uses T1
ANSI standards, the value is 0; for ETSI, or the E1 standard, it
is 1.

OTHER
COMMANDS

To delete or change the RAN/BSS resource from outside its context:

del EMSVLRCFGRADIONETWORK
mod EMSVLRCFGRADIONETWORK Radio_Network_Id=<n>,
{parameter1=<value1>, parameter1=<value1>, . . . }

In the above example, <n> is the Radio_Network_Id. From inside the

resource context you do not have to give the Radio_Network_Id:
mod EMSVLRCFGRADIONETWORK {parameter1=<value1>,
parameter1=<value1>, . . . }

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-23

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

RAN/BSS Entity

EXAMPLES

Adding an EMSVLRCFGRADIONETWORK resource at the command

line:
System/Office-Parameters/Mobility-Config-Parameters/RAN-or-BSS-Entity>
add EMSVLRCFGRADIONETWORK Radio_Network_Id=967, Network_ID=6,
Point_Code=192-22-68, Lata_Num=704, Version=1, SMLC_Type=0
Command Successful

Batch file content:

cd;
cd Office-Parameters/Mobility-Config-Parameters/RAN-or-BSS-Entity;
ADD EMSVLRCFGRADIONETWORK
Radio_Network_Id=967,
Network_ID=6,
Point_Code=192-22-68,
Lata_Num=704,
Version=1,
SMLC_Type=0;
cd;

Deleting a EMSVLRCFGRADIONETWORK resource:

System/Office-Parameters/Mobility-Config-Parameters/RAN-or-BSS-Entity>
del 967-EMSVLRCFGRADIONETWORK
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Modifying the EMSVLRCFGRADIONETWORK resource from the

command prompt while outside the resource context:
System/Office-Parameters/Mobility-Config-Parameters/RAN-or-BSS-Entity>mod
EMSVLRCFGRADIONETWORK Radio_Network_Id=967, SMLC_Type=1
Command Successful

From inside the resource context:

System/Office-Parameters/Mobility-Config-Parameters/RAN-or-BSS-Entity>967EMSVLRCFGRADIONETWORK>mod SMLC_Type=1
Command Successful

Page 7-24

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

GSM LAC Cell Range

7.10

GSM LAC Cell Range

The MSCCFGGSMLACCELL resource is used to set up the GSM Location Area Code (LAC)
and cell information for each group of cells to be recognized by the MSC. It is used to link these
cell groups to the Radio Access Network (RAN) identifier or Base Station Subsystem identifier
to which they belong. Consequently, the RAN or BSS must be set up in the system before
creating the MSCCFGGSMLACCELL. (See RAN/BSS Entity in this document for more
information.)
Additionally, the MSCFGGSMLACCELL resources link the cell groups to their respective
country codes and network codes. Because the MCCMNC resources are where the country
codes and network codes are defined to the MSC, this means you will must add the MCCMNC
resources before creating the MSCCFGGSMLACCELL resources. (See MSC MCC/MNC in
this document for more information.)
Finally, time zones must be set up in TIMEZONEDIS resources before you can specify time
zones for the cells, if they differ from the local MSCs time zone. (See Time Zone
Distribution for more information.)

NAME

GSM LAC CELL

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/GSM-LAC-or-CELL

ADD COMMAND
SYNTAX

Add MSCCFGGSMLACCELL Mcc_Mnc_Id=<value>,

Location_Area_Code=<value>, Radio_Network_ID=<value>,
Description=<value>, TimeZone_Index=<value>, Single_BSC=<value>,
Sector=<value>, Begining_Cell=<value>, Ending_Cell=<value>,
Prod_Descriminator=<value>

PARAMETERS

Mcc_Mnc_Id

This is a required country code and network code identifier.

The value you enter must match an Mcc_Mnc_Id from the
MCCMNC resources listed under the MSC-MCC-and-MNC
context. (See MSC MCC/MNC in this document for more
informations.)

Location_Area_Code
Required location area code (LAC). It must be a value in the
range 0 through 65535.
Radio_Network_ID This is a required radio network identifier. It must match a
Radio_Network_ID listed under the RAN-or-BSS-Entity
context as defined in the EMSVLRCFGRADIONETWORK
resources. (See RAN/BSS Entity in this document for more
information.)

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-25

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

GSM LAC Cell Range

PARAMETERS
(CONT.)

Description

Required description of the LAC/CELL, up to 32 characters in

length.

TimeZone_Index

Required time zone index that gives the time zone for the
cells. Time zones must be pre-configured before their indexes
can be used to specify the time zone for the cell group. (See
Time Zone Distribution for more information.)

Single_BSC

Required to indicate whether this location uses a single base

station controller (BSC) or more than one. Values can be 0 to
indicate more than one BSC is used or 1 to indicate only one
BSC is used.

Sector

Required numeric user-defined sector identifier or type code

for the group of cells, up to 15 digits in length.

Begining_Cell

Required numeric cell identifier in the range 0 to 65535 that

specifies the starting cell in the group of cells being defined.
The Begining_Cell value must be less than the Ending_Cell
value.

Ending_Cell

Required numeric cell identifier in the range 0 to 65535 that

specifies the ending cell in the group of cells being defined.
The Begining_Cell value must be less than the Ending_Cell
value.

Prod_Descriminator
Required numeric product discriminator.

OTHER
COMMANDS

To delete or change the MSCCFGGSMLACCELL resource from outside its

context:
del <mccmncid>-<lac>-<beg>-<end>-MSCCFGGSMLACCELL
mod MSCCFGGSMLACCELL Mcc_Mnc_Id=<mccmncid>,
Location_Area_Code=<lac>, Begining_Cell=<beg>, Ending_Cell=<end>,
{parameter1=<value1>, parameter1=<value1>, . . . }

In the above example, <mccmncid> is the MCC_MNC_Id, <lac> is the

Location_Area_Code, <beg> is the Begining_Cell and <end> is the
Ending_Cell value. Together, these are the keys to the resource and must be
entered to delete or modify the resource. From inside the resource context,
though, you do not have to specify the keys to make changes.
mod MSCCFGGSMLACCELL {parameter1=<value1>, parameter1=<value1>, . . . }

You cannot modify the keys using the mod command. If you need to change
them, you must first delete the resource then re-enter it using different key
values.

Page 7-26

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

GSM LAC Cell Range

EXAMPLES

Adding an MSCCFGGSMLACCELL resource at the command line:

System/Office-Parameters/Mobility-Config-Parameters/GSM-LAC-or-CELL>Add
MSCCFGGSMLACCELL Mcc_Mnc_Id=12, Location_Area_Code=432,
Radio_Network_ID=967, Description=Cell Group Test, TimeZone_Index=0,
Single_BSC=1, Sector=12, Begining_Cell=450, Ending_Cell=599,
Prod_Descriminator=1
Command Successful

Batch file content:

cd;
cd Office-Parameters/Mobility-Config-Parameters/GSM-LAC-or-CELL;
ADD MSCCFGGSMLACCELL
Mcc_Mnc_Id=12,
Location_Area_Code=432,
Radio_Network_ID=967,
Description=Cell Group Test,
TimeZone_Index=0,
Single_BSC=1,
Sector=12,
Begining_Cell=450,
Ending_Cell=599,
Prod_Descriminator=1;
cd;

Deleting an MSCCFGGSMLACCELL resource from outside its context:

del 12-432-450-599-MSCCFGGSMLACCELL

Modifying an MSCCFGGSMLACCELL from inside the resource context:

mod MSCCFGGSMLACCELL {parameter1=<value1>, parameter1=<value1>, . . . }

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-27

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Global Title Allowed Roaming

7.11

Global Title Allowed Roaming

The CFGIMSIGLOBALTITLE resources are used to control whether the calls from certain
subscribers are processed by the local, or home, softswitch. Each of these resources contains
the first few digits, or the prefix, of International Mobile Subscriber Identity (IMSI) phone
numbers. The home softswitch will process IMSIs that have the given prefix.
Each prefixes that the softswitch will process must also contain a flag set to active. Active
IMSI prefixes include those from the softswitchs home network as well as those from other
Public Land Mobile Networks (PLMN) that the local softswitch agrees to process.
You can include prefixes that you do not want to route by setting their active flag to No.
The softswitch will not route calls containing prefixes that have their active flag set to No.
Before creating these resources the Home Location Directory nodes must be added to the
Network-Nodes section. (See MSC Network Nodes in this document for more information.)
NAME

Global Title Allowed Roaming

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/Mobile-Global-Title-orAllowed-Roaming-Number

ADD COMMAND
SYNTAX

Add CFGIMSIGLOBALTITLE E212_IMSI_Prefix Specifies=<value>,

E214_GTT_Prefix=<value>, Active=<value>, Network_Node=<value>

PARAMETERS

E212_IMSI_Prefix Required numeric prefix conforming to the E.212 ITU

standard for International Mobile Subscriber Identity (IMSI)
phone numbers. This prefix represents the first part of IMSIs
accepted by this switch for roaming. It can range from 5 to 10
digits in length.
E214_GTT_Prefix Required numeric prefix conforming to the E.214 ITU
standard for converting International Mobile Subscriber
Identity (IMSI) telephone numbers into numbers used
international routing of SS7 messages. (E.214 provides a
method for converting the IMSI into a number that can be
used for routing to international SS7 switches.) This number
is required and can range from zero to 10 digits in length.
Active

The softswitch call processor requires this indicator to

determine whether to process calls that have the given prefix.
Set to 0 to block call processing for IMSIs that have this
prefix, or 1 to allow processing of the calls.

Network_Node

Gives the network node identifier of the Home Location

Register (HLR) for the given prefix. This numeric value must
match a Network Node ID for a Home Location Registry (HLR)
defined in the Network-Nodes section if the HLR will be used.
Set this to 0 for GTT routing.

Page 7-28

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Global Title Allowed Roaming

OTHER
COMMANDS

From outside the context:

del <imsi>-<gtt>-<network>-CFGIMSIGLOBALTITLE

In the above example, <imsi> is the E212_IMSI_Prefix value for the

resource, <gtt> is the E214_GTT_Prefix value, and <network> is the
Network_Node identifier.
You cannot modify the CFGMSIGLOBALTITLE resource from outside its
context. You can only modify its active flag from inside the
CFGIMSIGLOBALTITLE resource context:
mod CFGIMSIGLOBALTITLE active={0|1}

EXAMPLES

Adding a CFGIMSIGLOBALTITLE resource at the command line prompt:

System/Office-Parameters/Mobility-Config-Parameters/Mobile-Global-Title-orAllowed-Roaming-Number>Add CFGIMSIGLOBALTITLE E212_IMSI_Prefix
Specifies=3101501, E214_GTT_Prefix=2149724, Active=1, Network_Node=22

Sample batch entry to add a CFGIMSIGLOBALTITLE resource:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd Mobile-Global-Title-or-Allowed-Roaming-Number;
ADD CFGIMSIGLOBALTITLE
E212_IMSI_Prefix Specifies=3101501,
E214_GTT_Prefix=2149724,
Active=1,
Network_Node=22;
cd;

Deleting a CFGIMSIGLOBALTITLE resource:

System/Office-Parameters/Mobility-Config-Parameters/Mobile-Global-Title-orAllowed-Roaming-Number>del 3101501-2149724-22-CFGIMSIGLOBALTITLE

Modifying a CFGIMSIGLOBALTITLE resource:

System/Office-Parameters/Mobility-Config-Parameters/Mobile-Global-Title-orAllowed-Roaming-Number/3101501-2149724-22-CFGIMSIGLOBALTITLE>
mod CFGIMSIGLOBALTITLE active=0

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-29

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

MSRN HON Distribution

7.12

MSRN HON Distribution

Mobile Station Roaming Numbers (MSRN) are used as temporary telephone call
identifications. They are used to set up mobile phone calls and route setup messages from a
Gateway Mobile Switching Center (GMSC) to the target Mobile Switching Center. They are
assigned to telephone calls and are used in the setup messages for the call. After an MSRN is
used for a call, it is released back into a pool of MSRNs for use in other phone calls.
The SPMPCARDCALLTYPE resource is used to set up the MSRN ranges for the home switch
pools.
NAME

MSRN HON Distribution

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/MSRN-HON-Distribution

ADD COMMAND
SYNTAX

Add SPMPCARDCALLTYPE Called_Pty_Begin=<value>,

Called_Pty_End=<value>, Pool_ID=<value>

PARAMETERS

Called_Pty_Begin This is the starting number for the range of numbers in this
pool. Values can be up to 15 digits in length.

OTHER
COMMANDS

Called_Pty_End

This is the ending number for the range of numbers in this

pool. Values can be up to 15 digits in length.

Pool_ID

This is a pool identifier which uniquely identifies this pool of

MSRN ranges.

Del <beg>-<end>-SPMPCARDCALLTYPE

In the above example, <beg> is the Called_Pty_Begin value and <end> is

the Called_Pty_End value for the pool. You cannot change any values in the
SPMPCARDCALLTYPE resource using the mod command. To change any
of the parameters, you must first delete the resource and then re-add it using
new values.

Page 7-30

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

MSRN HON Distribution

EXAMPLES

To add an SPMPCARDCALLTYPE resource at the command prompt:

System/Office-Parameters/Mobility-Config-Parameters/MSRN-HONDistribution>Add SPMPCARDCALLTYPE Called_Pty_Begin=2212000,
Called_Pty_End=2212099, Pool_ID=22

Example of a batch file entry used to add an SPMPCARDCALLTYPE

resource:
cd;
cd System/Office-Parameters/Mobility-Config-Parameters;
cd MSRN-HON-Distribution;
ADD SPMPCARDCALLTYPE
Called_Pty_Begin=2212000,
Called_Pty_End=2212099,
Pool_ID=22;
cd;

Deleting an SPMPCARDCALLTYPE resource:

System/Office-Parameters/Mobility-Config-Parameters/MSRN-HONDistribution>Del 2212000-2212099-SPMPCARDCALLTYPE

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-31

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

ODB Configuration

7.13

ODB Configuration
The HPLMODBMAP resource is used to set up Operator Determined Barring (ODP).
NAME

ODB Configuration

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/ODB-Config/PLMN-ODBMapping

ADD COMMAND
SYNTAX

Add HPLMODBMAP PLMN_ODB_ID=<value>, Service_Key=<value>

PARAMETERS

PLMN_ODB_ID

Service_Key

OTHER
COMMANDS

PLMNP ODB mapping identifier. Values are:

Value

Meaning

0
1
2
3

DB_0
PLM_ODB_1
PLMN_ODB_2
PLMN_ODB_3

Service key. Values are:

Value

Meaning

0
1
2
3

ServKey_0
ServKey_1
ServKey_2
ServKey_3

Del <n>-HPLMODBMAP

In the above example, <n> is the PLMN_ODB_ID. You cannot change any
values in the HPLMODBMAP resource using the mod command. To change
any of the parameters, you must first delete the resource and then re-add it
with new values.

Page 7-32

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

ODB Configuration

EXAMPLES

To add an HPLMODBMAP resource at the command prompt:

System/Office-Parameters/Mobility-Config-Parameters/ODB-Config/PLMN-ODBMapping>Add HPLMODBMAP PLMN_ODB_ID=3, Service_Key=1

Example of a batch file entry used to add an HPLMODBMAP resource:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd ODB-Config/PLMN-ODB-Mapping;
ADD HPLMODBMAP
PLMN_ODB_ID=3,
Service_Key=1;
cd;

Deleting an HPLMODBMAP resource:

System/Office-Parameters/Mobility-Config-Parameters/ODB-Config/PLMN-ODBMapping>Del 3-HPLMODBMAP

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-33

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

IMSI to CCM Mapping

7.14

IMSI to CCM Mapping

This feature allows a mobile phone to be registered exclusively to a CCM for testing purposes.
After creating the resource, turn off the mobile phone used for the CCM test for 20 seconds and
then turn it back on. The phone is now registered to the target CCM. The target CCM is now
ready to accept calls from the phone.
NAME

IMSI to CCM Mapping

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/IMSI-To-CCM-Mapping

ADD COMMAND
SYNTAX

Add IMSICCMMAP IMSI=<value>, CCM=<value>

PARAMETERS

IMSI

This is required numeric International Mobile Subscriber

identifier (IMSI) OF the mobile phone to be used in the test, up
to 15 digits in length.

CCM

Required identifier of a protected CCM Node which this

subscriber is being moved to, up to 64 digits in length.

OTHER
COMMANDS

Del <n>-IMSICCMMAP

In the above example, <n> is the IMSI.

You cannot modify an IMSICCMMAP resource.
EXAMPLES

To add an IMSICCMMAP resource at the command prompt:

System/Office-Parameters/Mobility-Config-Parameters/IMSI-To-CCMMapping>Add IMSICCMMAP IMSI=3, CCM=1

Example of a batch file entry used to add an IMSICCMMAP resource:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd IMSI-To-CCM-Mapping;
ADD HPLMODBMAP
IMSI=3,
CCM=1;
cd;

Deleting an IMSICCMMAP resource:

System/Office-Parameters/Mobility-Config-Parameters/IMSI-To-CCMMapping>Del 9875674362-IMSICCMMAP

Page 7-34

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

MAP Message IE Sets

7.15

MAP Message IE Sets

The SPMREQMAPMSGIESET resource is used to configure MAP message sets.
NAME

MAP Message IE Sets

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/MAP-Message-IE-Sets

ADD COMMAND
SYNTAX

Add SPMREQMAPMSGIESET HLR_Number=<value>, Message_Index=<value>,

IE_Index=<value>, [Default_Value=<value>]

PARAMETERS

HLR_Number

Required numeric Home Location Registry (HLR) identifier.

The HLR identifier must match the identifier of an HLR node
defined in the Network-Nodes section of the Office
Parameters. (See MSC Network Nodes.)

Message_Index

Required request-map message index. Values may range

from 1 to 100.

IE_Index

This is a required IE map message index that denotes the

type of Send Routing Information (SRI) message:

1/23/07
Revision 3.4

Value

Meaning

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

SRI MSISDN
SRI Closed User Group (CUG) Interlock
SRI CUG Outgoing Access
SRI CUG Extension Container
SRI Num of Forwarding
SRI Interrogation Type
SRI OR Interrogation
SRI OR Capability
SRI GMSC Address
SRI Call Reference Number
SRI Forwarding Reason
SRI Basic Service Group
SRI Network Signal Protocol ID
SR Network Signal Info
SRI Network Signal Extension Container
SRI CAMEL Info Support CAMEL Phase
SRI Suppression of Announcement
SRI Extension Container
SRI Alerting Pattern
SRI CCBS Call
SRI Supported CCBS Phase
SRI Additional Signal Info Protocol ID
SRI Additional Signal Info

Proprietary and Confidential

Page 7-35

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

MAP Message IE Sets

PARAMETERS
(CONT.)

Default_Value

OTHER
COMMANDS

Value

Meaning

24
25
26
27
28

SRI Additional Signal Extension Container

SRI IST Support Indicator
SRI Pre-Paging Supported
SRI Call Diversion Treatment Indicator
SRI Long FTN Supported

Optional request-map message default value.

From outside the SPMREQMAPMSGIESET context:

Del <n>-SPMREQMAPMSGIESET
Mod SPMREQMAPMSGIESET Message_Index=<n>, [parameter1=<value1>,
parameter2=<value2>, . . . }

In the above example, <n> is the Message_Index value. If you change to the
<n>-SPMREQMAPMSGIESET context, you do not have to specify the
Message_Index value:
Mod SPMREQMAPMSGIESET Message_Index=<n>, [parameter1=<value1>,
parameter2=<value2>, . . . }

EXAMPLES

To add a SPMREQMAPMSGIESET resource at the command prompt:

System/Office-Parameters/Mobility-Config-Parameters/MAP-Message-IE-Sets>
Add SPMREQMAPMSGIESET HLR_Number=22, Message_Index=1, IE_Index=1

Example of a batch file entry used to add a SPMREQMAPMSGIESET

resource:
cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd MAP-Message-IE-Sets;
ADD SPMREQMAPMSGIESET
HLR_Number=22,
Message_Index=1,
IE_Index=1;
cd;

Deleting an SPMREQMAPMSGIESET resource:

System/Office-Parameters/Mobility-Config-Parameters/MAP-Message-IE-Set>Del
1-SPMREQMAPMSGIESET

Page 7-36

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

CAP Message IE Sets

7.16

CAP Message IE Sets

The SPMREQCAPMSGIESET resource is used to configure CAP message sets.
NAME

CAP Message IE Sets

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/CAP-Message-IE-Sets

ADD COMMAND
SYNTAX

Add SPMREQCAPMSGIESET SCP_Msg_Set=<value>, Message_Index=<value>,

IE_Index=<value>

PARAMETERS

SCP_Msg_Set

Specify a pre-configure SCP node. Required SCP message

set number.

Message_Index

Required request-CAP message index. This value can range

from 1 to 100.

IE_Index

Required request-CAP message IE index:

Value Meaning

1/23/07
Revision 3.4

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

INITDP_SERVICE_KEY
INITDP_CALLED_PARTY_NUMBER
INITDP_CALLING_PARTY_NUMBER
INITDP_CALLING_PARTY_CATEGORY
INITDP_CG_ENCOUNTERED
INITDP_IPSSP_CAPABILITIES
INITDP_LOCATION_NUMBER
INITDP_ORIGINAL_CALLED_PARTY_ID
INITDP_HIGH_LAYER_COMPATIBILITY
INITDP_ADDITIONAL_CALLING_PARTY_NUMBER
INITDP_BEARER_CAPABILITY
INITDP_EVENT_TYPE_BCSM
INITDP_REDIRECTING_PARTY_ID
INITDP_REDIRECTION_INFORMATION
INITDP_CAUSE
INITDP_SVC_INT_IND_2_FWD_SVC_CONF_TREAT_IND
INITDP_SVC_INT_IND_2_FWD_SVC_CALL_DIVE_TREAT_IND
INITDP_SVC_INT_IND_2_FWD_SVC_CGRTY_RESTRICT_IND
INITDP_SVC_INT_IND_2_BKWD_SVC_CONF_TREAT_IND

20

INITDP_SVC_INT_IND_2_BKWD_SVC_CALL_COMP_TREAT_IND

21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

INITDP_SVC_INT_IND_2_BOTHWAY_THRU_CONNECT_IND
INITDP_SVC_INT_IND_2_CONNECT_NUM_TREAT_IND
INITDP_SVC_INT_IND_2_NON_CUG_CALL
INITDP_SVC_INT_IND_2_HOLD_TREAT_IND
INITDP_SVC_INT_IND_2_CW_TREAT_IND
INITDP_SVC_INT_IND_2_ECT_TREAT_IND
INITDP_CARRIER
INITDP_CUG_INDEX
INITDP_CUG_INTERLOCK
INITDP_CUG_OUTGOING_ACCESS
INITDP_IMSI
INITDP_SUBSCRIBER_STATE
INITDP_LOC_INFO_AGE_OF_LOCATION_INFO
INITDP_LOC_INFO_GEOGRAPHICAL_INFO
INITDP_LOC_INFO_VLR_NUMBER
INITDP_LOC_INFO_LOCATION_NUMBER
INITDP_LOC_INFO_CGI_SAI_LAI

Proprietary and Confidential

Page 7-37

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

CAP Message IE Sets

PARAMETERS
(CONT.)

OTHER
COMMANDS

Value Meaning
38
39
40
41
42
43
44
45

INITDP_LOC_INFO_EXTENSION_CONTAINER
INITDP_LOC_INFO_LSA_ID
INITDP_LOC_INFO_MSC_NUMBER
INITDP_LOC_INFO_GEODETIC_INFO
INITDP_LOC_INFO_CURRENT_LOCATION_RETRIEVED
INITDP_EXT_BASIC_SVC_CODE
INITDP_CALL_REFERENCE_NUMBER
INITDP_MSC_ADDRESS

From outside the SPMREQCAPMSGIESET context:

Del <n>-SPMREQCAPMSGIESET
Mod SPMREQCAPMSGIESET Message_Index=<n>, {parameter1=<value1>,
parameter2=<value2>, . . . }

In the above example, <n> is the Message_Index value. If you change to the
<n>-SPMREQCAPMSGIESET context, you do not have to specify the
Message_Index value:
Mod {parameter1=<value1>, parameter2=<value2>, . . . }

EXAMPLES

To add a SPMREQCAPMSGIESET resource at the command prompt:

System/Office-Parameters/Mobility-Config-Parameters/CAP-Message-IE-Sets>
Add SPMREQCAPMSGIESET SCP_Msg_Set=1, Message_Index=1, IE_Index=1

Example of a batch file entry used to add a SPMREQCAPMSGIESET

resource:
cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd CAP-Message-IE-Sets;
ADD SPMREQCAPMSGIESET
SCP_Msg_Set=1,
Message_Index=1,
IE_Index=1
cd;

Deleting an SPMREQCAPMSGIESET resource:

System/Office-Parameters/Mobility-Config-Parameters/CAP-Message-IE-Set>Del
1-SPMREQCAPMSGIESET

Page 7-38

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Restricted PLMN

7.17

Restricted PLMN
The RESTRICTEDPLMN resource is used to specify Public Land Mobile Networks (PLMN)
that are restricted.
NAME

Restricted PLMN

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/Restricted-PLMN

ADD COMMAND
SYNTAX

Add RESTRICTEDPLMN Restriction_List_Id=<value>,

Mobile_Country_Code=<value>, Mobile_Network_Code=<value>,
Description=<value>

PARAMETERS

Restriction_List_Id Index into the restricted PLMN list. This is a required value in
the range 0 through 32767.
Mobile_Country_Code
Required numeric country code for the restricted network.
This value must be three digits in length.
Mobile_Network_Code
A required identification of the restricted mobile network.
This value must be two or three digits in length.
Description

OTHER
COMMANDS

This is a required alphanumeric description of the restriction,

up to 32 characters in length.

From outside the RESTRICTEDPLMN resource:

Del <n>-RESTRICTEDPLMN
Mod RESTRICTEDPLMN Restriction_List_Id=<n>, {parameter1=<value1>,
parameter2=<value2>, . . .}

In the above example, <n> represents the Restricted_List_Id value for the
resource. From inside the RESTRICTEDPLMN resource, you do not have to
enter the Restricted_List_Id:
Mod {parameter1=<value1>, parameter2=<value2>, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-39

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Restricted PLMN

EXAMPLES

Example of adding the restriction interactively at the command prompt:

System/Office-Parameters/Mobility-Config-Parameters/Restricted-PLMN>Add
RESTRICTEDPLMN
Restriction_List_Id: 44
Mobile_Country_Code: 31
-30031:Length is short. Minimum length of field MCC is 3.
Mobile_Country_Code: 310
Mobile_Network_Code: 150
Description: offline
No Optional Parameters for this Resource
Command Successful

Example of a batch file entry to add the RESTRICTEDPLMN resource:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd Restricted=PLMN;
ADD RESTRICTEDPLMN
Restriction_List_Id=44,
Mobile_Country_Code=310,
Mobile_Network_Code=150,
Description=Offline;
cd;

Deleting the RESTRICTEDPLMN resource from outside the RestrictedPLMN context:

System/Office-Parameters/Mobility-Config-Parameters/Restricted-PLMN>Del 44RESTRICTEDPLMN

Changing the RESTRICTEDPLMN resource Description parameter from

inside its context:
Mod Description=Test Description

Page 7-40

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Restricted LAC/Cell Range

7.18

Restricted LAC/Cell Range

The RESTRICTEDLACCELL resource is used to set up a restriction on a range of cells within
an existing Location Area Code (LAC) or set up the restriction on all the cells in an LAC.
Before you can set up the restriction, the cell range must be defined to the softswitch using the
MSCCFGGSMLACCELL resource. (See GSM LAC Cell Ranges for more information
about creating the MSCCFGGSMLACCELL resource.)
NAME

Restricted LAC Cell Range

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/LAC-RestrictionProvisioning

ADD COMMAND
SYNTAX

Add RESTRICTEDLACCELL Mcc_Mnc_Id=<value>, LAC=<value>,

RESTRICTION_LIST=<value>, RESTRICTED_LAC=<value>,
CELLID_END=<value>, CELLID_BEGIN=<value>, Sector=<value>,
Prod_Descriminator=<value>, [DESCRIPTION=<value>]

PARAMETERS

Mcc_Mnc_Id

This is an index into the Mobile Switching Center (MSC)

mobile country code and mobile network code table. It
identifies the network where the cell range you are restricting
is located. This value is required and must match an
Mcc_Mnc_id in an MCCMNC resource in the MSC-MCC-andMNC section of the office parameters.

LAC

Specifies the location area code (LAC) being restricted.

RESTRICTION_LIST Required user-defined restriction list identifier.

RESTRICTED_LACIndicates whether the entire LAC is restricted. This value
must be 1 to indicate the entire LAC is restricted or 0 to
indicate only groups of cells within it are restricted.
CELLID_END

The ending cell identifier of the range of cells being

restricted. Required only if RESTRICTED_LAC is 0.

CELLID_BEGIN

The starting cell identifier of the range of cells being

restricted. Required only if RESTRICTED_LAC is 0.

Sector

Sector identifier for the cells being restricted. Required.

Prod_Descriminator
Product descriminator of the cells being restricted. Required.
DESCRIPTION

1/23/07
Revision 3.4

Optional description for the restriction.

Proprietary and Confidential

Page 7-41

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Restricted LAC/Cell Range

OTHER
COMMANDS

From outside the RESTRICTEDLACCELL resource:

Del <lac>-<beg>-<end>-RESTRICTEDLACCELL

In the above example, <lac> is the location area code (LAC) being restricted,
<beg> represents the first cell in the range and <end> represents the last.
From inside the RESTRICTEDLACCELL resource, you do not have to
enter the range:
Mod {parameter1=<value1>, parameter2=<value2>, . . .}

EXAMPLES

Adding a RESTRICTEDLACCELL resource at the command prompt:

System/Office-Parameters/Mobility-Config-Parameters/LAC-RestrictionProvisioning>Add RESTRICTEDLACCELL Mcc_Mnc_Id=2, LAC=44,
RESTRICTION_LIST=1, RESTRICTED_LAC=1, Sector=<0, Prod_Descriminator=1

Example of batch file entries to add a RESTRICTEDLACCELL resource:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd LAC-Restriction-Provisioning;
ADD RESTRICTEDLACCELL
Mcc_Mnc_Id=2,
LAC=44,
RESTRICTION_LIST=1,
RESTRICTED_LAC=1,
Sector=0,
Prod_Descriminator=1;
cd;

Deleting a RESTRICTEDLACCELL resource:

System/Office-Parameters/Mobility-Config-Parameters/LAC-RestrictionProvisioning>DEL 44-0-99-RESTRICTEDLACCELL

Page 7-42

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Daylight Savings Time

7.19

Daylight Savings Time

The DAYLIGHTSAVING resource is used to specify when daylight savings time starts and
ends if applicable.
NAME

Daylight Savings Time

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/Day-Light-Saving-TimeProvisioning

ADD COMMAND
SYNTAX

Add DAYLIGHTSAVING DST_Key=<value>, Start_Month=<value>,

Start_Order=<value>, Start_Day=<value>, Start_Hour=<value>,
End_Month=<value>, End_Order=<value>, End_Day=<value>,
End_Hour=<value>

PARAMETERS

DST_Key

Time zone index.

Start_Month

Month that daylight savings time starts. Valid values are as

follows:

Start_Order

1/23/07
Revision 3.4

Value

Meaning

1
2
3
4
5
6
7
8
9
10
11
12

January
February
March
April
May
June
July
August
September
October
November
December

The specified day of the month to start daylight savings time.

Valid values are as follows:
Value

Meaning

1
2
3
4
5

1st day of the month

2nd day of the month
3rd day of the month
4th day of the month
Last day of the month

Proprietary and Confidential

Page 7-43

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Daylight Savings Time

PARAMETERS
(CONT.)

Start_Day

Specifies the starting day of daylight savings time. Valid

values are as follows:
Value

Meaning

0
1
2
3
4
5
6

Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

Start_Hour

Designates the starting hour of daylight savings time. Valid

values are 0-23.

End_Month

Month that daylight savings time ends. Valid values are as

follows:

End_Order

Value

Meaning

1
2
3
4
5
6
7
8
9
10
11
12

January
February
March
April
May
June
July
August
September
October
November
December

The specified day of the month to end daylight savings time.

Valid values are as follows:
Value

Meaning

1
2
3
4
5

1st day of the month

2nd day of the month
3rd day of the month
4th day of the month
Last day of the month

Page 7-44

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Daylight Savings Time

PARAMETERS
(CONT.)

End_Day

End_Hour

OTHER
COMMANDS

Specifies the ending day of daylight savings time. Valid

values are as follows:
Value

Meaning

0
1
2
3
4
5
6

Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

Designates the ending hour of daylight savings time. Valid

values are 0-23.

From outside the DAYLIGHTSAVING resource:

Del <n>-DAYLIGHTSAVING
Mod <n>-DAYLIGHTSAVING DST_Key=<n>, {parameter1=<value1>,
parameter2=<value2>, . . .}

In the above example, <n> represents the DST_Key value for the resource.
From inside this, you do not have to enter the DST_Key:
Mod {parameter1=<value1>, parameter2=<value2>, . . .}

EXAMPLES

Example of adding the daylight saving resource interactively at the

command prompt:
System/Office-Parameters/Mobility-Config-Parameters/Day-Light-Saving-TimeProvisioning>add DAYLIGHTSAVING
DST_Key:1
Start_Month:1
Start_Order:1
Start_Day:1
Start_Hour:0
End_Month:2
End_Order:1
End_Day:1
End_Hour:0
No Optional Parameters for this Resource
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-45

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Daylight Savings Time

EXAMPLES
(CONT.)

Example of a batch file entry to add the DAYLIGHTSAVING resource:

cd;
cd Office-Parameters/Mobility-Config-Parameters/Day-Light-Saving-TimeProvisioning;
ADD DAYLIGHTSAVING DST_Key=1, Start_Month=1, Start_Order=1,
Start_Day=1, Start_Hour=0, End_Month=2, End_Order=1, End_Day=1,
End_Hour=0;
cd;

Deleting the DAYLIGHTSAVING resource from outside its context:

System/Office-Parameters/Mobility-Config-Parameters/Day-Light-Saving-TimeProvisioning>Del 1-DAYLIGHTSAVING

Modifying the DAYLIGHTSAVING resource from inside its context:

Mod End_Month=3

Page 7-46

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Time Zone Distribution

7.20

Time Zone Distribution

The TIMEZONEDIS resource is used to add time zone distribution information.
NAME

Time Zone Distribution

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/TimeZone-Distribution

ADD COMMAND
SYNTAX

Add TIMEZONEDIS TimeZone_Index=<value>, Time_Zone=<value>,

DST=<value>, TimeZone_Name=<value>

PARAMETERS

TimeZone_Index

Time zone index.

Time_Zone

The offset between universal time and the local time. Valid
values are as follows:

1/23/07
Revision 3.4

Value

Meaning

180
179
178
177
176
175
174
173
172
171
170
169
168
167
166
165
164
163
162
161
160
159
158
157
156
155
154
153
152
151
150
149
148
147
146
145

GMT - 13 hr
GMT - 12 hr 45 min
GMT - 12 hr 30 min
GMT - 12 hr 15 min
GMT - 12 hr
GMT - 11 hr 45 min
GMT - 11 hr 30 min
GMT - 11 hr 15 min
GMT - 11 hr
GMT - 10 hr 45 min
GMT - 10 hr 30 min
GMT - 10 hr 15 min
GMT - 10 hr
GMT - 9 hr 45 min
GMT - 9 hr 30 min
GMT - 9 hr 15 min
GMT - 9 hr
GMT - 8 hr 45 min
GMT - 8 hr 30 min
GMT - 8 hr 15 min
GMT - 8 hr
GMT - 7 hr 45 min
GMT - 7 hr 30 min
GMT - 7 hr 15 min
GMT - 7 hr
GMT - 6 hr 45 min
GMT - 6 hr 30 min
GMT - 6 hr 15 min
GMT - 6 hr
GMT - 5 hr 45 min
GMT - 5 hr 30 min
GMT - 5 hr 15 min
GMT - 5 hr
GMT - 4 hr 45 min
GMT - 4 hr 30 min
GMT - 4 hr 15 min

Proprietary and Confidential

Page 7-47

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Time Zone Distribution

PARAMETERS
(CONT.)

Value

Meaning

144
143
142
141
140
139
138
137
136
135
134
133
132
131
130
129
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

GMT - 4 hr
GMT - 3 hr 45 min
GMT - 3 hr 30 min
GMT - 3 hr 15 min
GMT - 3 hr
GMT - 2 hr 45 min
GMT - 2 hr 30 min
GMT - 2 hr 15 min
GMT - 2 hr
GMT - 1 hr 45 min
GMT - 1 hr 30 min
GMT - 1 hr 15 min
GMT - 1 hr
GMT - 45 min
GMT - 30 min
GMT - 15 min
GMT
GMT + 15 min
GMT + 30 min
GMT + 45 min
GMT + 1 hr
GMT + 1 hr 15 min
GMT + 1 hr 30 min
GMT + 1 hr 45 min
GMT + 2 hr
GMT + 2 hr 15 min
GMT + 2 hr 30 min
GMT + 2 hr 45 min
GMT + 3 hr
GMT + 3 hr 15 min
GMT + 3 hr 30 min
GMT + 3 hr 45 min
GMT + 4 hr
GMT + 4 hr 15 min
GMT + 4 hr 30 min
GMT + 4 hr 45 min
GMT + 5 hr
GMT + 5 hr 15 min
GMT + 5 hr 30 min
GMT + 5 hr 45 min
GMT + 6 hr
GMT + 6 hr 15 min
GMT + 6 hr 30 min
GMT + 6 hr 45 min
GMT + 7 hr
GMT + 7 hr 15 min
GMT + 7 hr 30 min
GMT + 7 hr 45 min
GMT + 8 hr
GMT + 8 hr 15 min
GMT + 8 hr 30 min
GMT + 8 hr 45 min

Page 7-48

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Time Zone Distribution

PARAMETERS
(CONT.)

DST

Meaning

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

GMT + 9 hr
GMT + 9 hr 15 min
GMT + 9 hr 30 min
GMT + 9 hr 45 min
GMT + 10 hr
GMT + 10 hr 15 min
GMT + 10 hr 30 min
GMT + 10 hr 45 min
GMT + 11 hr
GMT + 11 hr 15 min
GMT + 11 hr 30 min
GMT + 11 hr 45 min
GMT + 12 hr
GMT + 12 hr 15 min
GMT + 12 hr 30 min
GMT + 12 hr 45 min
GMT + 13 hr

Daylight savings time adjustment (in hours). Valid values are

as follows:

TimeZone_Name
OTHER
COMMANDS

Value

Value

Meaning

0
1
2

No Adjustment
1 hrs Adjust
2 hrs Adjust

Description of the time zone.

From outside the TIMEZONEDIS resource:

Del <n>-TIMEZONEDIS
Mod TIMEZONEDIS TimeZone_Index=<n>, {parameter1=<value1>,
parameter2=<value2>, . . .}

In the above example, <n> represents the TimeZone_Index value for the
resource. From inside the TIMEZONEDIS resource, you do not have to
enter the TimeZone_Index:
Mod {parameter1=<value1>, parameter2=<value2>, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-49

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Time Zone Distribution

EXAMPLES

Example of adding the time zone distribution resource interactively at the

command prompt:
System/Office-Parameters/Mobility-Config-Parameters/TimeZoneDistribution>add TIMEZONEDIS
TimeZone_Index:1
Time_Zone:1
DST:1
TimeZone_Name:lab1
No Optional Parameters for this Resource
Command Successful

Example of a batch file entry to add the TIMEZONEDIS resource:

cd;
cd Office-Parameters/Mobility-Config-Parameters/TimeZone-Distribution;
ADD TIMEZONEDIS TimeZone_Index=1, Time_Zone=1, DST=1,
TimeZone_Name=lab1;
cd;

Deleting the TIMEZONEDIS resource from outside its context:

System/Office-Parameters/Mobility-Config-Parameters/TimeZoneDistribution>Del 1-TIMEZONEDIS

Modifying the TIMEZONEDIS resource from inside its context:

Mod TimeZone_Name=lab2

Page 7-50

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

Home Public Land Mobile Network (HPLMN) Codes

7.21

Home Public Land Mobile Network (HPLMN) Codes

The HPLMNETWORKCODE resource is used to specify the HPLMN network codes.
NAME

HPLMN Network Codes

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/HPLMN-Network-Codes

ADD COMMAND
SYNTAX

Add HPLMNETWORKCODE MCC=<value>, MNC=<value>, Description=<value>

PARAMETERS

MCC

Mobile Country Code. Three digit number that uniquely

identifies a given country. Default: Not Defined.

MNC

Mobile Network Code. Two or three digit number that

uniquely identifies a given network from within a specified
country (MCC). Default: Not Defined.

Description

Optional description for the network code resource.

OTHER
COMMANDS

From outside the HPLMNETWORKCODE resource:

Del <n>-<n>-HPLMNETWORKCODE
Mod HPLMNETWORKCODE MCC=<n>, MNC=<n>, {parameter1=<value1>,
parameter2=<value2>, . . .}

In the above example, <n> represents the MCC and MNC values
respectively for this resource. From inside this resource, you do not have to
enter the MCC and MNC values:
Mod {parameter1=<value1>, parameter2=<value2>, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-51

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

Home Public Land Mobile Network (HPLMN) Codes

EXAMPLES

Example of adding the HPLMN network codes interactively at the command

prompt:
System/Office-Parameters/Mobility-Config-Parameters/HPLMN-NetworkCodes>add HPLMNETWORKCODE
MCC:100
MNC:200
Prompt for Optional? (y/yes/n/no) : y
Description (Default:Not Defined) :lab1
Command Successful

Example of a batch file entry to add the HPLMNETWORKCODE resource:

cd;
cd Office-Parameters/Mobility-Config-Parameters/HPLMN-Network-Codes;
ADD HPLMNETWORKCODE MCC=100, MNC=200, Description=lab1;
cd;

Deleting the HPLMNETWORKCODE resource from outside its context:

System/Office-Parameters/Mobility-Config-Parameters/HPLMN-NetworkCodes>Del 100-200-HPLMNETWORKCODE

Modifying the DAYLIGHTSAVING resource from inside its context:

Mod Description=lab1

Page 7-52

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

International Mobile Equipment Identity (IMEI) Checking

7.22

International Mobile Equipment Identity (IMEI) Checking

The IMEICHECK resource is used to specify IMEI checking values.
NAME

IMEI Checking

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/IMEI-Checking

ADD COMMAND
SYNTAX

Add IMEICHECK Service=<value>, Black_Listed=<value>, Gray_Listed=<value>,

Unknown_Equip_In_Eir=<value>, Map_User_Err=<value>,
Map_Provider_Err=<value>, Activation=<value>

PARAMETERS

Service

Specifies service identification. Required. Valid values are as

follows:

Black_Listed

Gray_Listed

1/23/07
Revision 3.4

Value

Meaning

0
1
2
3
4
5
6
7
8
9
10
11
12
13

General
Attach
Inter-VLR Loc Update
Intra-VLR Loc Update
Periodic Loc Update
Mobile CC Orig
Mobile CC Term
Mobile SMS Orig
Mobile SMS Term
Mobile CISS Orig
Mobile CISS Term
Mobile LCS Orig
Mobile LCS Term
Provide Subs Info

Specifies weather the service is granted or if it is on a black

list. Optional. Valid values are as follows:
Value

Meaning

0
1

Service Granted
Illegal Equipment

Specifies weather the service is granted or if it is on a gray

list. Optional. Valid values are as follows:
Value

Meaning

0
1

Service Granted
Illegal Equipment

Proprietary and Confidential

Page 7-53

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

International Mobile Equipment Identity (IMEI) Checking

PARAMETERS
(CONT.)

Unknown_Equip_In_Ei
Specifies unknown equipment in Equipment Identity Register
(EIR). Optional. Valid values are as follows:

Map_User_Err

Value

Meaning

0
1
2

Service Granted
Illegal Equipment
Network Failure

Specifies map user error. Optional. Valid values are as

follows:
Value

Meaning

0
2

Service Granted
Network Failure

Map_Provider_Er Specifies map provider error. Optional. Valid values are as

follows:

Activation

OTHER
COMMANDS

Value

Meaning

0
2

Service Granted
Network Failure

Enables IMEI checking. Optional. Valid values are as follows:

Value

Meaning

0
1

Disable
Enable

From outside the IMEICHECK resource:

Del <n>-IMEICHECK
Mod IMEICHECK Service=<n>, {parameter1=<value1>,
parameter2=<value2>, . . .}

In the above example, <n> represents the Service value for the resource.
From inside this resource, you do not have to enter the Service value:
Mod {parameter1=<value1>, parameter2=<value2>, . . .}

Page 7-54

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

International Mobile Equipment Identity (IMEI) Checking

EXA MPLES

Example of adding the IMEI Checking resource interactively at the

command prompt:
System/Office-Parameters/Mobility-Config-Parameters/IMEI-Checking>add
IMEICHECK
Service:1
Prompt for Optional? (y/yes/n/no) : y
Black_Listed (Default:1) :1
Gray_Listed (Default:0) :0
Unknown_Equip_In_Eir (Default:1) :1
Map_User_Err (Default:2) :2
Map_Provider_Err (Default:2) :2
Activation (Default:0) :0
Command Successful

Example of a batch file entry to add the IMEICHECK resource:

cd;
cd Office-Parameters/Mobility-Config-Parameters/IMEI-Checking;
ADD IMEICHECK Service=1, Black_Listed=1, Gray_Listed=0,
Unknown_Equip_In_Eir=1, Map_User_Err=2, Map_Provider_Err=2, Activation=0;
cd;

Deleting the IMEICHECK resource from outside its context:

System/Office-Parameters/Mobility-Config-Parameters/IMEI-Checking>Del 1IMEICHECK

Modifying the IMEICHECK resource from inside its context:

Mod Black_Listed=0

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-55

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

GSM Trace

7.23

GSM Trace
The GSMTRACE resource is used to specify the values for a GSM trace.
NAME

GSM Trace

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/GSM-Trace

ADD COMMAND
SYNTAX

Add GSMTRACE Identity_Type=<value>, Invoking_Event=<value>,

BSS_Record_Type=<value>, OMC_Identity=<value>, Start_Time=<value>,
Stop_Time=<value>, Delete_Time=<value>

PARAMETERS

Mobile_Identity

Specifies the mobile identity. 1-16 alphanumeric characters.

Identity_Type

Specifies the identity type. Valid values are as follows:

Invoking_Event

Value

Meaning

0
1
2

MSI
IMEI
IMEISV

Specifies the invoking event. Valid values are as follows:

Value

Meaning

0
1
2

All
MO & MT
LU

BSS_Record_Type Specifies the BSS record type. Valid values are as follows:
Value

Meaning

0
1
2

Basic
Handover
Radio

OMC_Identity

Specify the OMC identity. 1-20 alphanumeric characters.

Default: Not Defined.

Start_Time

Specifies the start time. Format is: yyyy/-MM/-dd/ HH/:mm/:ss.

Stop_Time

Specifies the stop time. Format is: yyyy/-MM/-dd/ HH/:mm/:ss.

Delete_Time

Specifies the delete time. Format is: yyyy/-MM/-dd/ HH/:mm/

:ss.

Page 7-56

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Mobility Configuration

3HP700021015GUZZA

GSM Trace

OTHER
COMMANDS

From outside the GSMTRACE resource:

Del <n>-<n>-GSMTRACE
Mod GSMTRACE Mobile_Identity=<n>, Identity_Type=<n>,
{parameter1=<value1>, parameter2=<value2>, . . .}

In the above example, <n> represents the Mobile_Identity and

Identity_Type values for the resource. From inside the <n>-GSMTRACE
resource, you do not have to enter these values.
Mod {parameter1=<value1>, parameter2=<value2>, . . .}
EXAMPLES

Example of adding the daylight saving resource interactively at the

command prompt:
System/Office-Parameters/Mobility-Config-Parameters/GSM-Trace>add
GSMTRACE
Mobile_Identity:0
Identity_Type:0
Invoking_Event:0
BSS_Record_Type:0
OMC_Identity:0
Start_Time:2005-01-01 01:00:00
Stop_Time:2005-12-01 01:00:00
Delete_Time:2005-12-02 01:00:00
No Optional Parameters for this Resource
Command Successful

Example of a batch file entry to add the GSMTRACE resource:

cd;
cd Office-Parameters/Mobility-Config-Parameters/GSM-Trace;
ADD GSMTRACE Mobile_Identity=0, Identity_Type=0, Invoking_Event=0,
BSS_Record_Type=0, OMC_Identity=0, Start_Time=2005-01-01 01:00:00,
Stop_Time=2005-12-01 01:00:00, Delete_Time=2005-12-02 01:00:00;
cd;

Deleting the GSMTRACE resource from outside the GSMTRACE context:

System/Office-Parameters/Mobility-Config-Parameters/GSM-Trace>Del 0-0GSMTRACE

Modifying the GSMTRACE resource from inside its context:

Mod BSS_Record_Type=0

1/23/07
Revision 3.4

Proprietary and Confidential

Page 7-57

Software Release 3.0

Volume 7

CLI Mobility Configuration

3HP700021015GUZZA

Alcatel-Lucent
Command Line Interface Guide

GSM Trace

Page 7-58

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

SECTION 8

Provisioning CALEA
3HP700021015GUZZA

PROVISIONING CALEA

This section of the CLI Guide explains how to provision the Atrium softswitch to meet the
requirements of the Communications Assistance for Law Enforcement Act (CALEA). These
requirements allow law enforcement access to subscriber calls.

8.1

Overview of CALEA Support

To set up the softswitch to allow law enforcement to monitor a subscriber, you must first
configure a connection for law enforcement. This is accomplished by adding a
LEATCPCONNECTION resource for each connection you want to make between the
softswitch and a law enforcement agency.
Next, you must set up cases. A case is a softswitch resource that allows law enforcement
agencies to monitor a particular subscribers phone calls for a particular duration of time. Cases
are stored as LASECASE resources for each law enforcement agency. For each agency you can
set up multiple cases. The cases can be modified and removed as necessary to meet legal
requirements.

8.1.1

Configuring the TCP Connection for Law Enforcement

A prerequisite to provisioning the softswitch for CALEA is to configure a TCP connection.
This provides a communications link between the switch and the law enforcement agency.
Configuration of the TCP connection is accomplished by adding a LEATCPCONNECTION
resource to the system for each law agency.

8.1.2

Locking and Unlocking Resources

Certain resources must be locked before they can be changed. Locking a resource takes it outof-service. After it is changed, it must be unlocked so it can go back into service with its new
configuration. The LEATCPCONNECTION and LASECASE resources are two that must be
locked before they can be modified. By default, these resources are locked upon creation. You
must unlock them to put them into service.
If you want to modify a LEATCPCONNECTION or LASECASE resource, you must first lock
it. After making changes you must unlock it to put it back into service.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 8-1

Software Release 3.0

Volume 7

Provisioning CALEA
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Overview of CALEA Support

8.1.3 Using the Query Command to See if a Resource is Locked

You cannot delete, nor perform maintenance upon, a LEATCPCONNECTION or LASECASE
resource unless it is locked. It is important, then, to know whether these resources are locked or
unlocked before you attempt to delete or modify them. You can find out whether a resource is
locked by using the query command. Below is an example of using the query command to
determine the lock status of an LEATCPCONNECTION resource:
System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode>query 2-LEATCPCONNECTION
LEATCPCONNECTION:Properties:
Msc_Node_Id [Msc Node Id].......1
Connection_Id [Connection Id].......2
IP [IP].......192.168.7.7
Port [Port].......51
State:
adminState [Admin State].......leaTcpConnectionAdminState_locked -> 1
Command Successful

8.1.4

Unlocking a Resource
Note that in the above example the Admin State is 1. This means the resource is locked. Issuing
the following command changes the state to unlocked, which has a value of 2:
System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode>cd 2-LEATCPCONNECDTION
System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode/2-LEATCPCONNECDTION>unlock
Command Successful
System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode/2-LEATCPCONNECDTION>query
LEATCPCONNECTION:Properties:
Msc_Node_Id [Msc Node Id].......1
Connection_Id [Connection Id].......2
IP [IP].......192.168.7.7
Port [Port].......51
State:
adminState [Admin State].......leaTcpConnectionAdminState_unlocked ->2
Command Successful

8.1.5 Protection
When the LEATCPCONNECTION resource is provisioned, it establishes two TCP connections
to a Law Enforcement Agency (LEA) server. One of these connections is from the Atrium
System Administration Module (SAM) and the other is from its backup module (protecting
module). These connections share the same traffic simultaneously. If one of the connections
fails, all traffic is handled immediately by the other connection.
If one TCP connection resource is locked, both connections become inactive at the same time.
If the LEA server goes down, both connections become inactive and traffic is queued until the
LEA server comes back, at which time the connections become active (provided there are
pending messages).

Page 8-2

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

Provisioning CALEA
3HP700021015GUZZA

Configuring the Connection to the LEA Server

8.2

Configuring the Connection to the LEA Server

As mentioned earlier, you must set up a TCP connection the LEA Server before you can add
cases to the system. The connection is maintained in the LEATCPCONNECTION resource. If a
LEATCPCONNECTION does not already exist, you must add one to implement CALEA
support.
NAME

LEA TCP Connection Resource

CONTEXT

System/Nodes/Wireless-Soft-Switch/Wss-Cards/<n>-mscnode

ADD COMMAND
SYNTAX

add LEATCPCONNECTION Msc_Node_Id=<value>, Connection_Id=<value>,

Port=<value>, IP=<value>

PARAMETERS

Msc_Node_Id

Required logical identifier of the SAM card, where the TCP

connection will be added.

Connection_Id

This is a required number in the range 1 through 255 that

identifies the TCP connection in this SAM card that will be
used by the CALEA case provisioning port.

Port

Required port number of the far end law enforcement agency

system for the TCP connection. Can range form 1 through
65535. Together with the IP address, this identifies the far end
connection.

IP

This is the TCP/IP address of the far end law enforcement

agency system for the TCP connection, in the format
nnn.nnn.nnn.nnn, where nnn is a number that can range from
0 through 255. Together with the Port number, this identifies
the far end connection.

OTHER
COMMANDS

From outside the resource context:

Del <n>-LEATCPCONNECTION
Mod LEATCPCONNECTION Msc_Node_Id=<value>, Connection_Id=<value>,
[Port=<value>,] [IP=<value>]

In the above example, n is the logical connection_id which is used for

deletes and is part of the LEATCPCONNECTION resource name.
From inside the resource context you can only change the remote (far-end)
Port and IP values:
Mod [Port=<value>,] [IP=<value>]

1/23/07
Revision 3.4

Proprietary and Confidential

Page 8-3

Software Release 3.0

Volume 7

Provisioning CALEA
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Configuring the Connection to the LEA Server

EXAMPLES

Adding a law enforcement agency TCP connection from the <n>-mscnode

context (where the SAM card is 1-mscnode):
System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode>add
LEATCPCONNECTION msc_node_id=1, connection_id=1, port=50,
ip=192.168.5.5

Batch file example to add a LEATCPCONNECTION resource:

cd;
cd nodes/wireless-soft-switch/wss-cards/1-mscnode;
add LEATCPCONNECTION
msc_node_id=1,
connection_id=1,
port=50,
ip=192.168.5.5;
cd;

Deleting an LEATCPCONNECTION that has a connection_id value of 2:

System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode>2LEATCPCONNECTION>lock
Command Successful
System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode>del 2LEATCPCONNECTION
-30065:Are you sure Yes/Y/No/N : ? Y
Command Successful

Modifying an LEATCPCONNECTION to change the port number to 51:

System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode>2LEATCPCONNECTION>lock
Command Successful
System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode>2LEATCPCONNECTION>mod port=51
Command Successful
System/Nodes/Wireless-Soft-Switch/Wss-Cards/1-mscnode>2LEATCPCONNECTION>unlock
Command Successful

Page 8-4

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

Provisioning CALEA
3HP700021015GUZZA

Setting up CALEA Cases

8.3

Setting up CALEA Cases

A LASECASE resource must be set up for each subscriber targeted for surveillance by the law
enforcement agency.
NAME

LASECASE Resource

CONTEXT

System/Subscriber-Options/Wireless-CALEA

ADD COMMAND
SYNTAX

Add LASECASE Case_Name=<value>, Case_ID=<value>,

AcctMgmnt_ID=<value>, ID_Type=<value>, ID=<value>,
Start_Date_Time=<value>, End_Date_Time
=<value>, Name=<value>, Connection_Break=<value>, Connection=<value>,
Conf_Party_Change=<value>, CDC_Protocol=<value>, Connection_Id=<value>,
Agency_DN1=<value>, {parameter1=<value1>, parameter2=<value2>, . . . }

PARAMETERS

Case_Name

Unique identifier up to 35 characters in length. The name you

enter becomes part of the resource name. The name will be
<n>-LASECASE, where <n> is the Case_Name.

Agency

Required user-defined name for the agency making the

surveillance, up to 30 characters in length.

Case_ID

A required Lawfully Authorized Electronic Surveillance

(LAES) case identity, up to 25 characters in length.

Acct__Mgmnt_ID An Accounting Management Id for the Call Content

Channel (CCC) source, up to 15 characters in length.

1/23/07
Revision 3.4

ID_Type

This is required to indicate the kind of ID used to uniquely

identify the subscriber. Options are 1 for MSISDN or 2 if you
are using the subscribers IMS.

ID

Enter a required identifier for the subscriber. It must be of the

type specified under ID_Type. It can be up to 16 digits in
length and must be all numerals. (Note: This value is
encrypted in the database for security purposes.)

Start_Date_Time

This is a required value to specify the starting date and time

for the surveillance to begin, in the format yyyy-mm-dd
hh:mm:ss. The Start_Date_Time must be less than the
End_Date_Time or an error will occur. (Example: 2005-11-02
09:30:00)

End_Date_Time

This is a required value to specify the starting date and time

for the surveillance to begin, in the format yyyy-mm-dd
hh:mm:ss. The End_Date_Time must be greater than the
Start_Date_Time or an error will occur. In batch file, this value
must be supplied in quotes. (Example: 2006-02-09 14:30:00)

Name

Required name up to 29 characters in length to provide a text

description for the Lawfully Authorized Electronic
Surveillance (LAES) Profile.

Proprietary and Confidential

Page 8-5

Software Release 3.0

Volume 7

Provisioning CALEA
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Setting up CALEA Cases

PARAMETERS
(CONT.)

Connection_Break Required value that specifies whether the Connection Break

CDC message is to be sent to the Law Enforcement agent.
This parameter is mutual exclusive with Conference Party
parameter, meaning that if this parameter is set to Y, the
Conf_Party_Change must be set to N.)
Connection

Required value that specifies whether Connection CDC

message is to be sent to the Law Enforcement agent. This
parameter is mutually exclusive with Conference Party
parameters, meaning that if this parameter is set to Y, the
Conf_Party_Change must be set to N.)

Conf_Party_Change
Required value that specifies whether a Conference Party
Change CDC message is to be sent to the law enforcement
agency server. This parameter is mutual exclusive with
Connection and Connection Break parameters. That is to say,
if this parameter is set to Y, the Connection_Break must be
set to N. Valid values for the Conf_Party_Change are Y, y or 1
to indicate Yes; N, n or 0 to indicate No. The default is Y (Yes).
CDC_Protocol

This is a required value that must be set to 1 to indicate that

TCP/IP is the protocol over this connection used for
communications with the law enforcement agent server.

Connection_Id

This is a required identifier to identify the connection to the

law enforcement agency. It must match the Connection_Id
value in one of the connections established by a
LEATCPCONNECTION resource. (See the instructions for
creating the LEATCPCONNECTION connection resources
found earlier in this section of the manual.)

Incld_Loc_in_CDC_Msg
Optional parameter that determines whether location
information will be included in the CDC messages.
GMSC_Basic_Call_Montr
Optional value that indicates whether to monitor GMSC
Roaming Numbers. Values are Y, y or 1 to indicate Yes; N, n or
0 to indicate No. The default is 0 (No).
Agency_DN1-5

These parameters are the directory numbers of the

surveillance agents. Each is from 0 to 30 digits. The first one,
Agency_DN1, is required when the IAP_Options has any
value other than No Deliver. The remaining Agency_DNs
are always optional. Duplicate agency directory numbers are
allowed in these five fields.

Page 8-6

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

Provisioning CALEA
3HP700021015GUZZA

Setting up CALEA Cases

PARAMETERS
(CONT.)

IAP_Option

This is an optional value to denote to the call content. If this

value is set to 1 or 2, then the Agency_DN1 field is required.
Values are:
Value

Meaning

0
1
2

No deliver (default)
Deliver subject content
Deliver all content

Subject_Signal

Optional value that specifies whether the Subject Signal CDC

message is to be sent to the law enforcement agency server.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

Network_Signal

Optional value that specifies whether the Network Signal CDC

message is to be sent to the law enforcement agency server.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

Term__Attempt

Optional value that specifies whether the Termination Attempt

CDC message is to be sent to the law enforcement agency
server. Values are Y, y or 1 to indicate Yes; N, n or 0 to
indicate No. The default is 1 (Yes).

Serving_System

Optional value that specifies whether the Serving System

CDC message is to be sent to the law enforcement agency
server. Values are Y, y or 1 to indicate Yes; N, n or 0 to
indicate No. The default is 1 (Yes).

Release

Optional value that specifies whether the Release CDC

message is to be sent to the law enforcement agency server.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

Redirection

Optional value that specifies whether the Redirection CDC

message is to be sent to the law enforcement agency server.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

Packet_Envelope Optional value that specifies whether the Packet Envelope

CDC message is to be sent to the law enforcement agency
server. Values are Y, y or 1 to indicate Yes; N, n or 0 to
indicate No. The default is 0 (No).

1/23/07
Revision 3.4

Origination

Optional value that specifies whether the Origination CDC

message is to be sent to the law enforcement agency server.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

Change

Optional value that specifies whether the Change CDC

message is to be sent to the law enforcement agency server.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

Proprietary and Confidential

Page 8-7

Software Release 3.0

Volume 7

Provisioning CALEA
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Setting up CALEA Cases

PARAMETERS
(CONT.)

CC_Open

Optional value that specifies whether the CC Open CDC

message is to be sent to the law enforcement agency server.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

CC_Close

Optional value that specifies whether the CC Close CDC

message is to be sent to the law enforcement agency server.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

Answer

Optional value that specifies whether the Answer CDC

message is to be sent to the law enforcement agency server.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

Bearer_Capability Optional value that specifies whether the Bearer Capability is

to be sent in the Answer message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Location

Optional value that specifies whether the location is to be

sent in the Answer message. Values are Y, y or 1 to indicate
Yes; N, n or 0 to indicate No. The default is 1 (Yes).

Answer_Party_Id Optional value that specifies whether the Answering Party ID

is to be sent in the Answer message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Ans_Param_IAP_System_Id
Optional value that specifies whether the IAP System ID is to
be sent in the Answer message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Close_Param_IAP_System_Id
Optional value that specifies whether the IAP System ID is to
be sent in the Close message. Values are Y, y or 1 to indicate
Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Open_Param_IAP_System_Id
Optional value that specifies whether the IAP System ID is to
be sent in the Open message. Values are Y, y or 1 to indicate
Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Change_Param_IAP_System_Id
Optional value that specifies whether the IAP System ID is to
be sent in the Change message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Change_Param_CCCId
Optional value that specifies whether the CCC ID is to be sent
in the Change message. Values are Y, y or 1 to indicate Yes;
N, n or 0 to indicate No. The default is 1 (Yes).

Page 8-8

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

Provisioning CALEA
3HP700021015GUZZA

Setting up CALEA Cases

PARAMETERS
(CONT.)

Orig_Param_Bearer_Capability
Optional value that specifies whether the Bearer Capability is
to be sent in the Origination message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Orig_Param_Trans__Carrier_Id
Optional value that specifies whether the Transit Carrier ID is
to be sent in the Origination message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Orig_Param_Location
Optional value that specifies whether the location is to be
sent in the Origination message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Called_Id

Optional value that specifies whether the Called Party ID is to

be sent in the Origination message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).

Calling_Id

Optional value that specifies whether the Calling Party ID is to

be sent in the Origination message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).

Orig_Param_IAP_System_Id
Optional value that specifies whether the IAP System ID is to
be sent in the Origination message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Pkt_Envlp_Location
Optional value that specifies whether the location is to be
sent in the Packet Envelope message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Pkt_Envlp_Call_Id Optional value that specifies whether the Call ID is to be sent
in the Packet Envelope message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Pkt_Envlp_IAP_System_Id
Optional value that specifies whether the IAP System ID is to
be sent in the Packet Envelope message. Values are Y, y or 1
to indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Intercept_GSM_SMS
Optional value that specifies whether the Intercepted GSM
SMS Packet is to be sent in the Packet Envelope message.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).
Redirect_Param_Bearer_Capability
Optional value that specifies whether the Bearer Capability is
to be sent in the Redirection message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).

1/23/07
Revision 3.4

Proprietary and Confidential

Page 8-9

Software Release 3.0

Volume 7

Provisioning CALEA
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Setting up CALEA Cases

PARAMETERS
(CONT.)

Trans_Carrier_Id

Optional value that specifies whether the Transit Carrier ID is

to be sent in redirection messages. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).

Redirect_Param_IAP_System_Id
Optional value that specifies whether the IAP System ID is to
be sent in redirection messages. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Rel_Param_Location
Optional value that specifies whether the location is to be
sent in the Release message. Values are Y, y or 1 to indicate
Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Rel_Param_IAP_System_Id
Optional value that specifies whether the IAP System ID is to
be sent in the Release message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
System_ID

Optional value that specifies whether the System ID is to be

sent in the Serving System message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).

SerSys_Param_IAP_System_ID
Optional value that specifies whether the IAP System ID is to
be sent in the Serving System message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Redirected_From_Info
Optional value that specifies whether the Redirected From
Info is to be sent in the Termination Attempt message. Values
are Y, y or 1 to indicate Yes; N, n or 0 to indicate No. The
default is 1 (Yes).
Attemp_Param_Bearer_Capability
Optional value that specifies whether the Bearer Capability is
to be sent in the Termination Attempt message. Values are Y,
y or 1 to indicate Yes; N, n or 0 to indicate No. The default is 1
(Yes).
Called_Party_Id

Optional value that specifies whether the Called Party ID is to

be sent in the Termination Attempt message. Values are Y, y
or 1 to indicate Yes; N, n or 0 to indicate No. The default is 1
(Yes).

Attemp_Param_IAP_System_Id
Optional value that specifies whether the IAP System ID is to
be sent in the Termination Attempt message. Values are Y, y
or 1 to indicate Yes; N, n or 0 to indicate No. The default is 1
(Yes).
Communicating

Optional value that specifies whether the Communicating

Indicator is to be sent in the Conference Party Change
message. Values are Y, y or 1 to indicate Yes; N, n or 0 to
indicate No. The default is 1 (Yes).

Page 8-10

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

Provisioning CALEA
3HP700021015GUZZA

Setting up CALEA Cases

PARAMETERS
(CONT.)

Dropped

Optional value that specifies whether the Dropped Indicator is

to be sent in the Conference Party Change message. Values
are Y, y or 1 to indicate Yes; N, n or 0 to indicate No. The
default is 1 (Yes).

Removed

Optional value that specifies whether the Removed Indicator

is to be sent in the Conference Party Change message.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

Joined

Optional value that specifies whether the Joined Indicator is

to be sent in the Conference Party Change message. Values
are Y, y or 1 to indicate Yes; N, n or 0 to indicate No. The
default is 1 (Yes).

ConfPtyChg_IAP_System_ID
Optional value that specifies whether the IAP System ID is to
be sent in the Conference Party Change message. Values are
Y, y or 1 to indicate Yes; N, n or 0 to indicate No. The default is
1 (Yes).
Connected_PartiesOptional value that specifies whether the Connected Parties
indicator is to be sent in the Connection message. Values are
Y, y or 1 to indicate Yes; N, n or 0 to indicate No. The default is
1 (Yes).
New_Parties

Optional value that specifies whether the New Parties

Indicator is to be sent in the Connection message. Values are
Y, y or 1 to indicate Yes; N, n or 0 to indicate No. The default is
1 (Yes).

Conn_Param_IAP_System_ID
Optional value that specifies whether the IAP System ID is to
be sent in the Connection message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Removed_Parties Optional value that specifies whether the Removed Parties
Indicator is to be sent in the Connection Break message.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).
Remaining_PartiesOptional value that specifies whether the Remaining Parties
Indicator is to be sent in the Connection Break message.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).
Dropped_Parties

Optional value that specifies whether the Dropped Parties

Indicator is to be sent in the Connection Break message.
Values are Y, y or 1 to indicate Yes; N, n or 0 to indicate No.
The default is 1 (Yes).

ConnBrk_Param_IAP_System_ID0
Optional value that specifies whether the IAP System ID is to
be sent in the Connection Break message. Values are Y, y or 1
to indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).

1/23/07
Revision 3.4

Proprietary and Confidential

Page 8-11

Software Release 3.0

Volume 7

Provisioning CALEA
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Setting up CALEA Cases

PARAMETERS
(CONT.)

Dialed_Dig_IAP_System_ID
Optional value that specifies whether the IAP System ID is to
be sent in the Dialed Digit Extraction message. Values are Y, y
or 1 to indicate Yes; N, n or 0 to indicate No. The default is 1
(Yes).
Nw_Signal_Param_Call_ID
Optional value that specifies whether the Call ID is to be sent
in the Network Signal message. Values are Y, y or 1 to indicate
Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Alerting_Signal

Optional value that specifies whether the Alerting Signal is to

be sent in the Network Signal message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).

Subject_Audible_Signal
Optional value that specifies whether the Subject Audible
Signal is to be sent in the Network Signal message. Values
are Y, y or 1 to indicate Yes; N, n or 0 to indicate No. The
default is 1 (Yes).
Terminal_Display_Info
Optional value that specifies whether the Terminal Display
Info is to be sent in the Network Signal message. Values are Y,
y or 1 to indicate Yes; N, n or 0 to indicate No. The default is 1
(Yes).
Other

Optional value that specifies whether the Other info is to be

sent in the Network Signal message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).

Nw_Signal_Param_IAP_System_ID
Optional value that specifies whether the IAP System ID is to
be sent in the Network Signal message.
SubSig_Param_Call_ID
Optional value that specifies whether the Call ID is to be sent
in the Subject Signal message. Values are Y, y or 1 to indicate
Yes; N, n or 0 to indicate No. The default is 1 (Yes).
SubSig_Param_IAP_System_ID
Optional value that specifies whether the IAP System ID is to
be sent in the Subject Signal message. Values are Y, y or 1 to
indicate Yes; N, n or 0 to indicate No. The default is 1 (Yes).
Dialed_Digit_Extract
Optional value that specifies whether Dialed Digit Extraction
CDC message is to be sent to the Law Enforcement agent.

Page 8-12

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

Provisioning CALEA
3HP700021015GUZZA

Setting up CALEA Cases

OTHER
COMMANDS

From outside the resource context:

Del <n>-LASECASE
Mod LASECASE Case_Name=<value>, {parameter1=<value1>,
paremeter2=<value2>, . . . }

In the above examples, <n> is the Case_Name assigned to the LASECASE

resource. From inside the resource context, a mod can be performed:
Mod {parameter1=<value1>, paremeter2=<value2>, . . . }

Except for the Case_Name, ID, Start_Date_Time and End_Date_Time

parameters, the user can alter any parameter using mod. The others can only
be changed by deleting the case and creating a new one.
EXAMPLES
(CONT.)

Adding a LASECASE resource interactively using the command line:

System/Subscriber-Options/Wireless-CALEA>add lasecase
Case_Name: 040BX90z
Agency: South Cliff Police Department
Case_Id: SCPD002005116D
Acct__mgmt_Id: Smith
ID_Type: 1
ID: 9724711817
Start_Date_Time: 2006-11-02 14:00:00
End_Date_Time: 2006-11-15 09:30:00
Name: Test Name
Connection_Id: 2
Prompt for Optional? (y/yes/n/no) : N
Command Successful

1/23/07
Revision 3.4

Proprietary and Confidential

Page 8-13

Software Release 3.0

Volume 7

Provisioning CALEA
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Setting up CALEA Cases

EXAMPLES

Example of batch entry to add LASECASE, showing several optional

parameter specifications:
cd;
cd Subscriber-Options/Wireless-CALEA;
add LASECASE
Case_Name=040BX90z,
Agency=South Cliff Police Department,
Case_Id=SCPD002005116D,
Acct__mgmt_Id=Smith,
ID_Type=1,
ID=9724711817,
Start_Date_Time=2006-11-02 14:00:00,
End_Date_Time=2006-11-15 09:30:00,
Name=Test Name,
Connection_Id=2,
Communicating=N,
Removed=N,
ConfPtyChg_IAP_System_ID;
cd;

Modifying a LASECASE resource:

System/Subscriber-Options/Wireless-CALEA/LASECASE/040BX90zLASECASE>mod Case_ID=SCPD0020061102D
Command Successful

Deleting a LASECASE resource:

System/Subscriber-Options/Wireless-CALEA/LASECASE> DEL 040BX90zLASECASE
Command Successful

Page 8-14

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

SECTION 9

CLI Provisioning for E911

3HP700021015GUZZA

CLI PROVISIONING FOR E911

Two resources are required to configure the softswitch for E911 support. The
EMERGENCYZONE resources are required for routing emergency calls to the proper public
service access point. For each cell you must also provide information that will be used to
establish the cell and mobile user location. This data is maintained in EMERGENCYCALL
resources.This section explains how to create and maintain the EMERGENCYZONE and
EMERGENCYCALL resources for E911 processing.

9.1

Emergency Zone
The EMERGENCYZONE resource provides routing information that the softswitch uses to
route calls to the proper emergency responders. It also provides the softswitch with information
about how to process the call.
NAME

Emergency Zone

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/Emergency-ServiceZone-Provisioning

ADD COMMAND
SYNTAX

add EMERGENCYZONE Emer_Srvc_Zone_ID=<value>,

Emer_Srvc_Zone_Name=<value>, PSAP_Zone_DN_Type=<value>,
[parameter1=<value1>, parameter2=<value2>, . . . ]

PARAMETERS

Emer_Srvc_Zone_ID
Required number to assign to the emergency zone as an
identifier. Defaults to 1.
Emer_Srvc_Zone_Name
Required alphanumeric emergency service zone name.
PSAP_Zone_DN_Type
Required value to indicate whether to use the Public Safety
Access Point (PSAP) directory number to process the call:

PSAP_Zone_DN

1/23/07
Revision 3.4

Type

Meaning

Play announcement

Do not use Public Safety Access Point (PSAP)

Directory Number (DN)

Use PSAP Directory Number (DN)

If you select 2 as the PSAP_Zone_DN_Type, you must provide

the directory number for the Public Safety Access Point
(PSAP). You can enter up to ten digits to provide the directory
number here.

Proprietary and Confidential

Page 9-1

Software Release 3.0

Volume 7

CLI Provisioning for E911

3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Emergency Zone

PARAMETERS
(CONT.)

GMLC_Address

Optional Gateway Mobile Location Center (GMLC) for the

service zone being defined, identifyijng the gateway to the
PSAP. This can be up to 15 digits in length. Defaults to 1.

Begin_ESRK_Pool_n
You can enter up to three Emergency Service Routing Key
(ESRK) ranges for this emergency zone, where n represents a
value from 1 through 3 to identify each. These keys can be up
to ten digits in length, but must be the same length as their
corresponding End_ESRK_Pool_n values. In addition, the
Begin_ESRK_Pool_n value must be less than or equal to its
corresponding ending ESRK value. Defaults to 1.
End_ESRK_Pool_n This is the ending value for a range of emergency service
routing keys, where n matches its corresponding starting
specification identifier for this zone (Begin_ESRK_Pool_n).
The key can be up to ten digits in length, but it must be the
same length as its corresponding Begin_ESRK_Pool_n value.
In addition, the End_ESRK_Pool_n value must be greater
than or equal to its corresponding beginning ESRK value.
Defaults to 1.
Loc_Service_Option
Optional value that specifies the location service options:

Routing_Option

Value

Meaning

0
1
2
3
4
5

None (default)
Enable PLR
Enable PLR, Send INIT-DP
Disable PLR, Send INIT-DP
Disable PLR send SLR
Enable PLR XY Routing

Optional value that indicates the emergency call routing

method used to route the call to the public safety point for
this zone, as follows:
Value

Meaning

0
1
2
3

Use the PSAP directory number.

Use the Emergency Service Routing Digit (ESRD).
Use the ESRK pool numbers.
Use the INAP Service Control Point (SCP).

SCP_Address

This is the service address for the E911 service, up to 15

digits in length used for Intelligent Network Application
Protocol (INAP) SPC processing. This optional value can be
up to 15 digits in length.

SCP_INAP_SSN

This optional value is the INAP Subsystem Number (SSN) for

the E911 service. Can range from 0 to 255. Default is 0.

Page 9-2

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Provisioning for E911

3HP700021015GUZZA

Emergency Zone

OTHER
COMMANDS

From outside the resource context:

Del <n>-EMERGENCYZONE
Mod EMERGENCYZONE Emer_Srvc_Zone_ID=<value>, {parameter1=<value1>,
parameter2=<value2>, . . .}

In the above example, <n> is the Emer_Srvc_Zone_ID value for the

resource. From inside the resource context you dont have to give the
Emer_Srvc_Zone_ID, as follows:
Mod {parameter1=<value1>, parameter2=<value2>, . . .}

EXAMPLES

Adding an EMERGENCYZONE resource at the command line:

System/Office-Parameters/Mobility-Config-Parameters/Emergency-ServiceZone-Provisioning>add EMERGENCYZONE Emer_Srvc_Zone_ID=1,
Emer_Srvc_Zone_Name=East Region Emergency Center,
PSAP_Zone_DN_Type=2, PSAP_Zone_DN=2185661817
Command Successful

Batch file content:

cd;
cd Office-Parameters/Mobility-Config-Parameters;
cd Emergency-Service-Zone-Provisioning;
add EMERGENCYZONE
Emer_Srvc_Zone_ID=1,
Emer_Srvc_Zone_Name=East Region Emergency Center,
PSAP_Zone_DN_Type=1,
Begin_ESRK_Pool_1=2185661800,
End_ESRK_Pool_1=2185661899,
Routing_Option= 2;
cd;

Deleting the EMERGENCYZONE resource from the command prompt:

System/Office-Parameters/Mobility-Config-Parameters/Emergency-ServiceZone-Provisioning>Del 1-EMERGENCYZONE

1/23/07
Revision 3.4

Proprietary and Confidential

Page 9-3

Software Release 3.0

Volume 7

CLI Provisioning for E911

3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Emergency Zone

EXAMPLES
(CONT.)

Modifying the EMERGENCYZONE resource from the command prompt

while outside the resource context:
System/Office-Parameters/Mobility-Config-Parameters/Emergency-ServiceZone-Provisioning>Mod EMERGENCYZONE Emer_Srvc_Zone_ID=1,
PSAP_Zone_DN_Type=2, PSAP_Zone_DN=2185661817
Command Successful

From inside the resource context:

System/Office-Parameters/Mobility-Config-Parameters/Emergency-ServiceZone-Provisioning/1-EMERGENCYZONE>MOD PSAP_Zone_DN_Type=2,
PSAP_Zone_DN=2185661817
Command Successful

Page 9-4

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Provisioning for E911

3HP700021015GUZZA

Emergency Call

9.2

Emergency Call
The EMERGENCYCALL resource supplies the softswitch with information about how to
handle emergency calls for a set of cells in a network.
NAME

Emergency Call

CONTEXT

System/Office-Parameters/Mobility-Config-Parameters/LAC-or-CELLEmergency-Call-Provisioning

ADD COMMAND
SYNTAX

add EMERGENCYCALL MCC_MNC_ID=<value>, Location_Area_Code=<value>,

Cell_ID_Begin=<value>, Cell_ID_End=<value2>, E911_Solution_Type=<value>,
ESRK_Assn_Method=<value>, [ESRD=<value>,]
[Location_Delivery_Method=<value>]

1/23/07
Revision 3.4

Proprietary and Confidential

Page 9-5

Software Release 3.0

Volume 7

CLI Provisioning for E911

3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Emergency Call

MCC_MNC_ID

This is a combination of the Mobile Country Code (MCC) plus

the Mobile Network Code (MNC) that identifies the country
and service provider network for the cells. Valid values are
UNKW (Unknown) or any user-defined MCC/MNC. The UNKW
provides for the ability to enable access to a specific E911
entry when an unknown CGI is received. An unknown CGI
occurs when a CGI is not configured in the system. When the
Unknown CGI option is selected, you must also specify a
corresponding emergency service zone to use for all calls
received with an unknown CGI. This parameter is required.

Location_Area_Code
This is a required parameter that specifies the Location Area
Code (LAC) for the emergency call. The options are based on
pre-defined location area codes. A Location Area Code must
have been defined in GSM LAC or CELL. Minimum value
allowed is 0, with the maximum value of Not Defined. Default:
Not Defined.
Cell_ID_Begin

For the group of cells within the MCC_MNC that these E911
parameters affect, this is the starting cell number of the
range. It is a required numeric value from 1 through 65535.

Cell_ID_End

For the group of cells within the MCC_MNC that these E911
parameters affect, this is the ending cell number of the range.
It is a required numeric value from 1 through 65535.

E911_Solution_Type
This required value indicates the implementation of E911
support that is used by the network. It is used by the
softswitch to determine how to process emergency calls for
this cell group: Valid values are:
Value

Meaning

Phase 0 implementation, which provides only

the capability to make a 911 call and provides at
most the callers return phone number as
location data.

Phase 1 implementation, which provides Phase

0 data plus identifies the cell location where
the call originates.

Phase 2 implementation, which pinpoints the

caller's location.

Page 9-6

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Provisioning for E911

3HP700021015GUZZA

Emergency Call

PARAMETERS

ESRK_Assn_Method
Required indicator that tells whether an Emergency Services
Routing Key (ESRK) assignment method is used or what
ESRK method is used to process the E911 call, as follows:
Value

Meaning

0
1

No ESRK (Applies to Phase 2 E911 Type)

MPC ISUP query (Applies to both Phase 1 & Phase
2 E911 Type)
WSS ESRK (Applies to both Phase 1 & Phase 2
E911 Type)
GMLC query (Applies to Phase 2 E911 Type)
MSC ESRD (Applies to Phase 2 E911 Type)
SCP INAP ESRK (Applies to both Phase 1 & Phase
2 E911 Type)

2
3
4
5

ESRD

Optional Emergency Service Routing Digits (ESRD), up to 10

digits in length. Identifies the cell site and sector of the call
origination.

Emer_Srvc_Zone_ID
This is an optional parameter that specifies the identifier for
the emergency service zone. This is an index whose function
is to group multiple emergency call service parameters.
Available options are based on pre-defined Emergency
Service Zone IDs. An Emer Srve Zone ID must have been
provisioned in Emergency Service Zone Provisioning.
Location_Delivery_Method
Optional value to indicate how locations are determined and
delivered to the PSAP, as follows:

OTHER
COMMANDS

Value

Meaning

0
2
2
3
4

Hybrid
CAS
NCAS
None
NCAS with delay.

From outside the EMERGENCYCALL context:

Del <n>-<n>-<n>-<n>-EMERGENCYCALL
Mod MCC_MNC_ID=<value>, Location_Area_Code=<value>,
Cell_ID_Begin=<value>, Cell_ID_End=<value2>, {parameter1=<value1>,
parameter2=<value2>, . . .}

From inside the EMERGENCYCALL context:

Mod {parameter1=<value1>,parameter2=<value2>, . . .}

1/23/07
Revision 3.4

Proprietary and Confidential

Page 9-7

Software Release 3.0

Volume 7

CLI Provisioning for E911

3HP700021015GUZZA

Alcatel
Command Line Interface Guide

Emergency Call

EXAMPLES

Entering the EMERGENCY call parameters interactively at the CLI prompt:

System/Office-Parameters/Mobility-Config-Parameters/LAC-or-CELLEmergency-Call-Provisioning>add emergencycall
Mcc_Mnc_Id: 31002
Cell_Id_End: 999
Cell_Id_Begin: 900
Mcc_Mnc_Id=>Location_Area_Code: 433
E911_Solution_Type: 2
ESRK_Assn_Method: 2
Prompt for Optional? (y/yes/n/no) : Y
Esrd (Default:Not Defined): 2143212222
Emer_Srvc_Zone_ID:1
Location_Delivery_Method (Default:0): 2
Command Not Completed :
add emergencycall
^
-99999:Errors in Application Program.
System/Office-Parameters/Mobility-Config-Parameters/LAC-or-CELLEmergency-Call-Provisioning>

Page 9-8

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

SECTION 10

CLI Errors
3HP700021015GUZZA

CLI ERRORS

Some errors that may occur during Command Line Interface operations are described below.

-30000 PARAMETER_NEEDED
Parameter is needed for this operation.

-30001 COMMAND_MISSING
Command name is missing. Please enter the command name.

-30002 EXTRA_PARAM
Extra parameter given.

-30003 IO_MISSING
Terminal IO is missing.

-30004 NO_PRIVILEGE
User does not have privilege for <variable> operation.

-30005 CONTEXT_MISSING
Context name is missing.""MSG""N/A""Context name is missing."

-30006 INVALID_OPERATION
Invalid operation $operation under this context.

-30007 INVALID_CONTEXT
Invalid context $context.

-30008 MISSING_PARAM
Mandatory parameter $param is missing

1/23/07
Revision 3.4

Proprietary and Confidential

Page 10-1

Software Release 3.0

Volume 7

CLI Errors
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

-30009 INVALID_SESSIONID
Invalid session id $sessionId.

-30010 ERROR_INSCHEMA
Error in Field schema of $field.

-30012 INVALID_VALUE
Invalid value for $field.

-30013 INVALID_PARAM
Invalid parameter $field.

-30014 NO_PARAMS_FOUND
No parameters found for this operation.

-30015 NO_SCHEMA_FOUND
No schema found for this MO/field.

-30016 INVALID_COMMANDNAME
nvalid command $command.

-30017 INVALID_SYNTAX
Invalid syntax for the command.

-30018 INVALID_VALUE_PARAM
Invalid syntax for the command.$string.

Page 10-2

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Errors
3HP700021015GUZZA

-30019 STOPTEST
Existing test in progress.

-30020 EXEC_HANDLER
Failure in executing command handler.

-30023 INVALID_DATEFORMAT
Invalid date format $date.

-30024 INVALID_MINDATEVALUE
Minimum date allowed is $date.

-30025 INVALID_MAXDATEVALUE
Maximum date allowed is $date.

-30026 INVALID_ENUMVALUE
Invalid boolean Value. Valid values are N->0,Y->1.

-30027 ERROR_INCONVERSION
Error in converting to integer $field.

-30028 INVALID_MINVALUE
Minimum value allowed is $field for $name.

-30029 INVALID_MAXVALUE
Maximum value allowed is $field for $name.

-30030 TOO_LONG
Maximum length of field $field is $length.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 10-3

Software Release 3.0

Volume 7

CLI Errors
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

-30031 TOO_LESS
Length is short. Minimum length of field $field is $length.

-30032 INVALID_IPADDRESS
Invalid IP Address $field. It should be like [0..255].[0..255].[0..255].[0..255].

-30033 INVALID_PC
Invalid Point Code. It should be [0..255]-[0..255]-[0..255].

-30034 CLI_OPERATION_FAILED
Operation $operation Failed. $errorDesc.

-30035 CLI_FILE_READ_ERROR
Error in reading $file.

-30036 CLI_FILE_NOT_FOUND
File $file not found.

-30037 CLI_HELP_INVALID_PARAM
Invalid Parameters. Maximum two allowed.

-30038 UNKNOWN_PRIVILEGE
Unknown $prev Assignment .

-30039 CLI_INVALID_DATA_FIELD
Unsupported Command Field.

-30040 CLI_INVALID_DATA_VALUE
Unsupported Command Value.

Page 10-4

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Errors
3HP700021015GUZZA

-30041 CLI_INVALID_ENTITY
Unsupported Cli Entity.

-30042 CLI_UNABLE_TO_LOCATE_CORBAIMPL
Unable to locate corba impl.

-30043 CLI_UNSUPPORTED_OPERATION
Unsupported operation $operation.

-30044 CLI_INVALID_FID
Invalid fid for entity $entity.

-30045 UNKNOWN_COMMAND_EXEC
Unknown command received.

-30046 UNKNOWN_STARTSERVER_ERROR
Exception occurred at start of the CLI Server.

-30047 ERROR_INIT_CMDTREE
Exception occurred tring to initiliaze the Command Tree.

-30048 UNABLE_CLIENT_CONN
Unable to receive the client connection.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 10-5

Software Release 3.0

Volume 7

CLI Errors
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

-30049 LOGIN_ERROR
Error occurred when logging in to the EMS server.

-30050 SESSIONMGR_ERROR
Error occurred when Session Manager is starting up.

-30051 INVALID_EVENTTYPE
Invalid Event Type received : $eventtype.

-30052 INVALID_GROUPID
Invalid Group id $groupId.

-30053 INVALIDDATA
Invalid Data found.

-30054 HISTORY_DATA_REQUIRED
For query history events, Query Current Data flag should not be checked.

-30055 INVALIDSEARCH
Invalid Search Criteria.

-30056 NOIDS
No IDs found for this MO.

-30057 NOTHING_TO_LOG
Nothing to log.

-30058 INVALID_SEARCH_VAL
Enter string patters seperated by comma.Use * as wildcard and put (-i) in front of the string for
case insensitive matching.

Page 10-6

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Errors
3HP700021015GUZZA

-30059 INFO LOAD_COMPLETED

Executed Load Command.

-30060 CONTAINED_RES_LESS_THAN_MIN
Contained Resources are less than miminum allowed.

-30061 INFO NO_ACTIVE_TEST

No active test running that can be aborted.

-30062 CONTAINED_RES_MORE_THAN_MAX
Contained Resources are more than maximum allowed.

-30063 INFO TEST_ABORTED

Test aborted.

-30064 INVALID_FLDVALUE
Invalid value: $value.

-30065 CONFIRMSTRING
Are you sure Yes/Y/No/N.

-30066 NORECORDS_FOUND
Failed to retrieve any records with the specified criteria.

-30067 NOACTIVEUSERS
No active users found.

-30068 NOALIASFOUND
Alias not found.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 10-7

Software Release 3.0

Volume 7

CLI Errors
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

-30069 NOALIASESFOUND
No aliases found.

-30070 NOCMDSFOUND
No commands found.

-30071 EVTHISTINPROCESS
Events History request is being processed Please wait..

-30072 HUGEAMTOFDATA
The amount of data is very huge. Cannot process the command in non interactive mode.

-30073 DONE_OPPARAMS
Completed Optional Parameters.

-30074 NO_OPPARAMS
No Optional Parameters for this Resource.

-30075 NO_DATASETRETRIEVE
No Data sets to retrieve.

-30076 PERF_INPROGRESS
Performance request is being processed Please wait.

-30077 INVALID_VALUE_FIELD
Invalid value for field.Valid values are $field.

-30078 DISPPOLL_STATUS
Polling Status : $field".

Page 10-8

Proprietary and Confidential

Volume 7

Software Release 3.0

1/23/07
Revision 3.4

Alcatel
Command Line Interface Guide

CLI Errors
3HP700021015GUZZA

-30079 UNABLE_TO_CLEAR_ALARM
Unable to clear alarm(s).

-30080 UNABLE_TO_ACK_ALARM
Unable to acknowledge alarm(s).

-30081 UNABLE_TO_UNACK_ALARM
Unable to Unacknowledge alarm.

-30082 INVALID_ALARM_ID
Invalid alarm id : $field.

-30083 INVALID_HISTORY_REFERENCE
Invalid history reference.

-30084 INVALID_VALUE_FOR_HISTORY
Invalid value for $field. Valid values are for example OrigTrafSepIdx=val1;
TermTrafSepIdx=val2 | OrigTrafSepIdx=val3,val4; TermTrafSepIdx=val2.

-30085 INVALID_VALUE_ON_DEMAND
Invalid value for $field. Valid values are for example OrigTrafSepIdx=val1;
TermTrafSepIdx=val2.

-30086 EQUAL_DATES
Start and End Dates cannot be equal Start and End Dates cannot be equal.

-30087 UNEQUAL_PASSWORDS
Confirm password should be same as New Password.

1/23/07
Revision 3.4

Proprietary and Confidential

Page 10-9

Software Release 3.0

Volume 7

CLI Errors
3HP700021015GUZZA

Alcatel
Command Line Interface Guide

-30088 INVALID_PASSWORD
Password has to be one of these values: 0-9,a-z,A-Z. Password has to be one of these values: 09,a-z,A-Z.

-30089 PASSWORD_MISMATCH
NewPassword is same as OldPassword. Password has to be one of these values: 0-9,a-z,A-Z.

-30090 CDRQUERY_INVALID_WILDCARD_SEARCH
Invalid wild card search for $field, * should be the last character. Invalid wild card search for
$field, * should be the last character.""String field."

-30091 NOT_LOCKED
The Resource is unLocked. This Test cannot be performed under this context, when the
resource is unlocked.

-30092 INVALID_ITU_PC
Invalid Point Code. It should be [0..7]-[0..255]-[0..7].

-30093 NO_CELL_CONFIGURED
No Cell Configured.

-30094 BEGIN_CELL_CHECK
Begining Cell Id sould be less than Ending Cell Id.

-30095 WRONG_CALEA_NAME
Name can not be ALL or having.

Page 10-10
Volume 7

Proprietary and Confidential

Software Release 3.0

1/23/07
Revision 3.4