0% found this document useful (0 votes)
7 views250 pages

3gsim Command Descriptions Rev AF

This document provides detailed descriptions of commands and scripts for the 3Gsim product, including various command categories such as generic, alias, SGSN, MSC, and more. It outlines the conventions used in the document, prerequisites for readers, and includes a comprehensive table of contents for easy navigation. The document is intended for users with a basic understanding of the 3Gsim User's Guide and is subject to updates and revisions.

Uploaded by

luopi12
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
7 views250 pages

3gsim Command Descriptions Rev AF

This document provides detailed descriptions of commands and scripts for the 3Gsim product, including various command categories such as generic, alias, SGSN, MSC, and more. It outlines the conventions used in the document, prerequisites for readers, and includes a comprehensive table of contents for easy navigation. The document is intended for users with a basic understanding of the 3Gsim User's Guide and is subject to updates and revisions.

Uploaded by

luopi12
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 250

3Gsim

Command Descriptions
3/1553-LZT 123 7595 Rev. AF

2014-01-31
Perceptual Evaluation of Speech Quality (PESQ) measurement technology included in this product
is protected by copyright and by European, US and other patents and is provided under license from
Opticom Dipl.-Ing M. Keyhl GmbH, Erlangen, Germany, 2002 - www.opticom.de.
For further information please refer to www.pesq.org.

© Ericsson AB 2004-2014. All rights reserved. No part of this document may be reproduced in any
form without the written permission of the copyright owner.
The contents of this document are subject to revision without notice due to continued progress in
methodology, design and manufacturing. Ericsson shall have no liability for any error or damage of
any kind resulting from the use of this document.
3Gsim Command Descriptions

Conventions
The following typographical and syntactical conventions are used in this document:
file name File names are indicated in italics.
path Paths are indicated in italics.
parameter Parameters are indicated in italics.
command Commands are indicated in italics.
script Scripts are indicated in italics.
system input Input you give to system is indicated in monostyle.
system printout Printouts from the system are indicated in monostyle.
<> Parameter values within angle brackets must be replaced with actual
values.
[] Parameters within square brackets are optional.
{} Parameters within curly braces are conditional.
| A vertical line indicates that you make a selection among alternatives.

3
3Gsim Command Descriptions

About

Contents
This document describes the 3Gsim commands and 3Gsim scripts. It is available for download
from the 3Gsim web page for SW release information at https://ericoll.internal.ericsson.com/
SITES/3GSIM_PRODUCT/default.aspx
The command descriptions in this document are also available through the 3Gsim command line
interface (CLI).

Prerequisites
It is assumed that the reader of this document has a basic knowledge corresponding to the contents
of the 3Gsim User's Guide 1553-LZT 123 7595.

Scope
All 3Gsim product versions contain functionality that has passed different levels of tests, from basic
test to system test. The help information about commands and parameters is continuously updated
through all test phases, which means that this document contains information about functions that
have not yet passed system test.

4
Table of Contents

Table of Contents
1 Generic commands ............................................................................................................... 10
1.1 Help ..................................................................................................................................... 10
1.2 Read file ............................................................................................................................. 10
1.3 List installation .................................................................................................................... 11
1.4 List resources ..................................................................................................................... 14
1.5 List process status .............................................................................................................. 16
1.6 Heapinfo .............................................................................................................................. 17

2 Alias commands .................................................................................................................... 18


2.1 Set alias .............................................................................................................................. 18
2.2 List alias .............................................................................................................................. 18
2.3 Delete alias ......................................................................................................................... 19

3 SGSN commands ................................................................................................................... 20


3.1 Create SGSN node ............................................................................................................. 20
3.2 List SGSN node .................................................................................................................. 23

4 MSC commands ..................................................................................................................... 24


4.1 Create MSC node ............................................................................................................... 24
4.2 List MSC node .................................................................................................................... 27

5 SS7 signaling link commands .............................................................................................. 29


5.1 Create SS7 signaling link .................................................................................................... 29
5.2 List SS7 signaling link ......................................................................................................... 30
5.3 Delete SS7 signaling link .................................................................................................... 31

6 HLR commands ..................................................................................................................... 32


6.1 Create subscription ............................................................................................................. 32
6.2 List subscription .................................................................................................................. 34
6.3 Delete subscription ............................................................................................................. 36
6.4 Copy subscription data ....................................................................................................... 37
6.5 Modify subscription data ..................................................................................................... 37
6.6 List subscription data .......................................................................................................... 38
6.7 Delete subscription data ..................................................................................................... 38
6.8 Dump subscriber ................................................................................................................. 39

7 Subscription data .................................................................................................................. 40


7.1 Subscription data parameters ............................................................................................. 40

5
Table of Contents

8 SAS commands ..................................................................................................................... 54


8.1 Create SAS node ................................................................................................................ 54
8.2 List SAS node ..................................................................................................................... 55
8.3 Delete SAS node ................................................................................................................ 55

9 Iur loopback commands ....................................................................................................... 57


9.1 Create Iur loopback ............................................................................................................ 57
9.2 Modify Iur loopback ............................................................................................................. 58
9.3 List Iur loopback ................................................................................................................. 59
9.4 Delete Iur loopback ............................................................................................................. 59

10 RBS commands ................................................................................................................... 60


10.1 Create RBS ....................................................................................................................... 60
10.2 Modify RBS ....................................................................................................................... 67
10.3 List RBS ............................................................................................................................ 71
10.4 Delete RBS ....................................................................................................................... 73

11 LTE RBS commands ........................................................................................................... 74


11.1 Create LTE RBS ............................................................................................................... 74
11.2 Modify LTE RBS ............................................................................................................... 76
11.3 List LTE RBS .................................................................................................................... 78
11.4 Delete LTE RBS ............................................................................................................... 79

12 UE commands ...................................................................................................................... 80
12.1 Create UE ......................................................................................................................... 80
12.2 Modify UE ......................................................................................................................... 84
12.3 List UE .............................................................................................................................. 90
12.4 Stop UE ............................................................................................................................ 96
12.5 Start UE ............................................................................................................................ 98
12.6 Delete UE ....................................................................................................................... 101
12.7 Dump UE ........................................................................................................................ 103
12.8 Order UE ......................................................................................................................... 105

13 GSM cell commands .......................................................................................................... 112


13.1 Create GSM cell ............................................................................................................. 112
13.2 List GSM cell .................................................................................................................. 112

14 LTE cell commands ........................................................................................................... 114


14.1 Create LTE cell ............................................................................................................... 114
14.2 Modify LTE cell ............................................................................................................... 115
14.3 List LTE cell .................................................................................................................... 116
14.4 Delete LTE cell ............................................................................................................... 116

6
Table of Contents

15 WCDMA cell commands .................................................................................................... 118


15.1 Modify WCDMA cell ........................................................................................................ 118
15.2 List WCDMA cell ............................................................................................................. 119

16 Logging commands ........................................................................................................... 120


16.1 Modify log ....................................................................................................................... 120
16.2 List log points .................................................................................................................. 121

17 Trace commands ............................................................................................................... 122


17.1 List trace objects ............................................................................................................. 122

18 Statistics commands ......................................................................................................... 124


18.1 List statistics .................................................................................................................... 124
18.2 Start performance monitoring .......................................................................................... 129
18.3 List performance monitoring ............................................................................................ 131
18.4 Stop performance monitoring .......................................................................................... 131

19 Behavior commands .......................................................................................................... 132


19.1 List behavior .................................................................................................................... 132
19.2 Copy behavior ................................................................................................................. 132
19.3 Modify behavior ............................................................................................................... 133
19.4 Delete behavior ............................................................................................................... 134

20 UE mobility behaviors ....................................................................................................... 135


20.1 Single_cell mobility behavior parameters ........................................................................ 135
20.2 Cells_in_sequence mobility behavior parameters ........................................................... 135
20.3 Random_cells mobility behavior parameters ................................................................... 138
20.4 External control mobility behavior ................................................................................... 142

21 UE traffic behaviors ........................................................................................................... 143


21.1 Classic traffic behavior parameters ................................................................................. 143
21.2 External control traffic behavior ....................................................................................... 169

22 UE equipment behaviors ................................................................................................... 170


22.1 Equipment behavior parameters ..................................................................................... 170

7
Table of Contents

23 CN behaviors ...................................................................................................................... 180


23.1 RANAP CL behavior parameters .................................................................................... 180
23.2 RANAP CO behavior parameters ................................................................................... 183
23.3 MM behavior parameters ................................................................................................ 186
23.4 CC behavior parameters ................................................................................................. 189
23.5 GMM behavior parameters ............................................................................................. 191
23.6 SM behavior parameters ................................................................................................. 194
23.7 LCS behavior parameters ............................................................................................... 196
23.8 PCAP CO behavior parameters ...................................................................................... 199

24 RBS cell behaviors ............................................................................................................ 204


24.1 RBS cell behavior parameters ........................................................................................ 204

25 LTE RBS behaviors ........................................................................................................... 208


25.1 LTE RBS behavior parameters ....................................................................................... 208

26 Capabilities commands ..................................................................................................... 210


26.1 List capabilities ................................................................................................................ 210
26.2 Copy capabilities ............................................................................................................. 210
26.3 Modify capabilities ........................................................................................................... 211
26.4 Delete capabilities ........................................................................................................... 212

27 UE capabilities ................................................................................................................... 213


27.1 UE capability parameters ................................................................................................ 213

28 Cell capabilities .................................................................................................................. 224


28.1 Cell capability parameters ............................................................................................... 224

29 LTE RBS capabilities ......................................................................................................... 232


29.1 LTE RBS capability parameters ...................................................................................... 232

30 RAB state group commands ............................................................................................ 233


30.1 Create RAB group .......................................................................................................... 233
30.2 List RAB group ............................................................................................................... 233
30.3 Modify RAB group ........................................................................................................... 234
30.4 Delete RAB group ........................................................................................................... 234

31 Packet Data Generator (PDG) commands ....................................................................... 236


31.1 Create Packet Data Generator ........................................................................................ 236
31.2 List Packet Data Generator ............................................................................................. 238

8
Table of Contents

32 Packet Data Forwarder (PDF) commands ........................................................................ 240


32.1 Create Packet Data Forwarder ....................................................................................... 240
32.2 List Packet Data Forwarder ............................................................................................ 241

33 RIM association commands .............................................................................................. 243


33.1 Create RIM association ................................................................................................... 243
33.2 List RIM association ........................................................................................................ 244
33.3 Delete RIM association ................................................................................................... 245

34 Scripts ................................................................................................................................. 246


34.1 3Gsim_update.pl ............................................................................................................. 246
34.2 3gsim_clean.pl ................................................................................................................ 249

9
Generic commands

1 Generic commands

1.1 Help
Function:
This command lists all 3Gsim commands or displays the syntax description of a specified
command, including allowed values.

3gsim [<command>] ? | help

1.2 Read file


Function:
This command reads and executes commands from a command file.

3gsim rf | read file

{-f | -file <file path> | <file name>}

{-s | -startup}

[-d | -delay <time>]

[-sc | -syntax_check]

[-fp | -force_proceed]

[-a | -abort all | current | <sequence number>]

[-l | -list]

-file
The full or relative path to or the name of the command
file to execute. When a file name is given, 3Gsim
searches for the file in the current directory. If the file
is not found, 3Gsim searches for the file in the default
directory /c/3gsim/cmdfiles/. When a path is given, 3Gsim
searches for the file in the specified directory.
Conditional:
If file is used, then startup must be omitted.

-startup
Uses the startup.ini as command file. The startup.ini
file is automatically executed after startup of the 3Gsim
hardware. The execution of this file cannot be interrupted
(Ctrl-C is not available).
Conditional:
If startup is used, then file must be omitted. The
startup.ini file must be present in /c/3gsim/cmdfiles.

10
Generic commands

-delay
Inserts a delay after the execution of each command in
the file.
Unit: milliseconds (ms)
Default value: 20

-syntax_check
Checks the syntax of the commands in the command file
without executing them.

-force_proceed
Forces the execution of the command file to proceed even
if a command in the file has failed.

-abort
Stops the execution of current ongoing read files.
all stops the execution of all currently ongoing readfiles
and cancels the queued readfiles.
current stops the execution of the oldest read file
command not yet completed.
sequence number stops the execution of the read file
commands with the specified sequence number.
Default value: current

-list
Lists the read file commands waiting in queue.

Use the * delay <time> command in the command file to insert extra delays between selected
commands, in addition to the default delay specified in the delay parameter.
If any of the commands in the command file fails, the execution of the command file terminates. The
force_proceed option can be used to force the execution to proceed despite failing commands.
The command 3gsim read file cannot be used in a command file. For more information about the
command file format, see the 3Gsim User's Guide 1553-LZT 123 7595.
Example:
Execute the commands stored in the file /c/3gsim/cmdfiles/create4ues.cmd:
3gsim read file -f create4ues.cmd

Execute the commands stored in the file /c/3gsim/cmdfiles/createues.cmd and wait 1 second
between each command:
3gsim read file -f create4ues.cmd -delay 1000

1.3 List installation


Function:
This command lists the processes that have started in the current 3Gsim installation.

3gsim li | list installation

{-bb | -by_board}

11
Generic commands

{-bm | -by_module}

{-bl | -board_list}

{-sl | -subrack_list}

{-hp | -hunt_path}

{-ar | -abnormal_registration}

{-s | -state}

[-pn | -product_number]

[-sr | -subrack <subrack>[,<subrack 2>,...] | all]

[-bp | -board_position <board>]

[-proc | -process_name <name part>]

-by_board
Lists the installed processes sorted on board number. If
no option is given, by_board is used.
Conditional:
Use either by_board, by_module, board_list,
subrack_list, hunt_path, abnormal_registration or
state.

-by_module
Lists the installed processes sorted per module.
Conditional:
Use either by_board, by_module, board_list,
subrack_list, hunt_path, abnormal_registration or
state.

-board_list
Displays a list of all boards used by the installation.
Conditional:
Use either by_board, by_module, board_list,
subrack_list, hunt_path, abnormal_registration or
state.

-subrack_list
Displays a list of all subracks used by the installation.
Conditional:
Use either by_board, by_module, board_list,
subrack_list, hunt_path, abnormal_registration or
state.

12
Generic commands

-hunt_path
Displays a list of OSE process hunt paths to the 3Gsim
processes.
Conditional:
Use either by_board, by_module, board_list,
subrack_list, hunt_path, abnormal_registration or
state.

-abnormal_registration
Displays a list of 3Gsim processes that has restarted
or started too late. Too late means after 3Gsim has
responded '3Gsim ready' and has started to execute
commands.
Conditional:
Use either by_board, by_module, board_list,
subrack_list, hunt_path, abnormal_registration or
state.

-state
Displays the current 3Gsim execution state. Indicates if
3Gsim has reached state READY, which means that 3Gsim
is ready to run simulations.
Conditional:
Use either by_board, by_module, board_list,
subrack_list, hunt_path, abnormal_registration or
state.

-product_number
Displays the installation with CXC number for each
module. Use with by_board or by_module.

-subrack
Displays a restricted view for the given subracks. It is
possible to view one subrack, a list of subracks or all
subracks. If this parameter is excluded from the command
all subracks are displayed. Use together with one of the
parameters by_board, by_module or board_list.
Allowed values: List of subracks or all
Default value: all

-board_position
Displays only processes running on the specified board.
Allowed values: Board position

-process_name
Displays only processes with names containing the given
name part.
Allowed values: A process name, or a part of a process
name

The following information is displayed if the command is given without parameters:

13
Generic commands

PU Processor unit where the process executes and, if a multi core system is
used, program instance
PROCESS Process name
REV Revision number
MODULE Module name
REGISTRATION Date and time of the process registration in the control interface. If a
registration time of a process is more than 10 minutes later than the
registration time of the control interface this process is marked by a "*".
This makes it easier to notice that a process has restarted.
This is an example printout of the 3gsim list installation command:

Figure: Printout of the 3gsim list installation command.

1.4 List resources


Function:
This command lists the processor unit usage in 3Gsim.

3gsim lres | list resources

[-pu | -processor_unit <board>[/<instance>] | all]

-processor_unit
Lists the resources for one processor unit (PU) or all
configured processor units. Omitting the parameter is
equal to -processor_unit all.
It is optional to give a program instance (used for multi
core systems) to only list resources on a specific core.

14
Generic commands

Instance 1 means a program instance that executes in


the first core; instance 2 means a program instance that
executes in the second core and so on.
The program instance must match the configuration of the
node being used. Board number and program instance
are separated by a slash (/).
Example:
-processor_unit 0011000
-processor_unit 0016000/2

Allowed values: all, or processor unit: a 6-digit or 7-digit


number, and program instance: 1 to 8.

The calculation of the estimated values are based on the worst case resource usage for each UE.
This means that it is a snapshot based on UEs that currently execute on the PU.
The worst case resource usage for a UE, however, is not a snapshot. Instead it is calculated based
on the traffic behavior parameters for the UE.
The following information is displayed for the UE-side when 3Gsim is run on a 3810 or 3820 system:
• PU ID (board number) and, if a multi core system is used, program instance
• PU board type
• Maximum number of CEPs
• Number of allocated CCH CEPs
• Maximum estimated number of DCH CEPs
• Maximum estimated CEP utilization
• Maximum estimated UDP UL traffic
• Maximum estimated UDP DL traffic
• Maximum estimated bandwidth utilization
The following information is displayed for the UE-side when 3Gsim is run on an EVO system:
• PU ID (board number) and, if a multi core system is used, program instance
• PU board type
• Maximum number of sockets
• Number of allocated CCH sockets
• Maximum estimated number of DCH sockets
• Maximum estimated socket utilization
• Maximum estimated UDP UL traffic
• Maximum estimated UDP DL traffic
• Maximum estimated bandwidth utilization
Note:
No data for the CN-side is displayed, only for the UE-side.

15
Generic commands

1.5 List process status


Function:
This command lists the status of the processes that have started in the current 3Gsim
installation.
Prerequisites:
3Gsim must have responded '3gsim ready'.

3gsim lps | list process_status

[-sr | -subrack <subrack>[,<subrack 2>,...] | all]

[-bp | -board_position <board>]

[-proc | -process_name <name part>]

[-to | -timeout <value in ms>]

-subrack
Displays only processes running on the specified
subracks. It is possible to view one subrack, a list of
subracks or all subracks. If this parameter is excluded
from the command all subracks are displayed.
Example:
-subrack 00,01

Allowed values: A list of 2-digit values, or all


Default value: all

-board_position
Displays only processes running on the specified board.
Example:
-board_position 000800

Allowed values: A 6 digit number

-process_name
Displays only processes with names containing the given
name part.
Allowed values: A process name, or a part of a process
name

-timeout
The maximum time in milliseconds to wait for answers
from the boards before presenting the result.
Allowed values: An integer value greater than 0
Default value: 3000

The following information is displayed if the command is given without parameters:


PU Processor unit where the process executes and, if a multi core system is
used, program instance.
PROCESS Process name.

16
Generic commands

LATENCY The response time for the process.


PU LOAD The load of the processor unit.
PROCESS LOAD The load contribution by the process on the processor unit.
HEAP USED The amount of heap used by the process.
HEAP FREE Free heap for the process.
SIGNAL QUEUE The number of signals in the signal queue for the process.
LENGTH
STATUS A status message free of choice for the process. A status message left
blank by the process is normal.

1.6 Heapinfo
Function:
This command displays heapinfo for the specified processes.

3gsim hi | heapinfo

[<board>[/<instance>]/
<process> [<board>[/<instance>]/
<process> ...]]

<board>[/<instance>]/<process>
[<board>[/<instance>]/ Specifies which process on a board for which to print
<process> ...] information. Use '/' as separator. If no board/instance/
process is specified, all processes are displayed.
If a multi core system is used, you can optionally add an
instance number indicating which core of the board to use.
Instance 1 means a program instance executing in the
first core; instance 2 means a program instance executing
in the second core. Using a multi core system and not
specifying a program instance means that program
instance 1 will be used. If using a single core system,
program instance 1 can optionally be specified. The
program instance must match the configuration of the
node being used. Board number and program instance
are separated by a slash (/).
Example:
$ 3gsim heapinfo 001400/tgs_ue_bg_proc
$ 3gsim heapinfo 0016001/2/tgs_uestack_proc

Allowed values: Processor unit: 6-digit or 7-digit number.


Program instance: 1 to 8.

17
Alias commands

2 Alias commands

2.1 Set alias


Function:
This commands creates an alias (a macro expansion).

3gsim sa | set alias

<alias name>

<string>

<alias name>
The name of the alias.

<string>
A string for which the alias name is a replacement.
<string> is what is executed when the <alias name> is
given as a command.

Aliases are non-recursive, that is, an alias cannot contain another alias.
An alias is available in 3Gsim until the next reboot. To save your alias definitions, use an external
editor and save them in a text file.
Some short commands are protected and cannot be used for an alias: sa (set alias), la (list alias) and
dela (delete alias).
Example:
Set an alias for a list of cells to be used when creating UEs:
3gsim set alias MyCellList rbs_1:30101,rbs_1:31102,rbs_1:31103,rbs_2:31201

Set an alias that creates 10 speech UEs:


3gsim set alias TenSpeechUEs -imsi 123456789 -quantity 10 -cell 30101 -traffic_behavior
speech_20s

2.2 List alias


Function:
This command displays a list of one or all defined aliases.

3gsim la | list alias

[[<alias name>]]

[<alias name>]
The name of the alias.

If no alias name is given, all existing aliases are listed.

18
Alias commands

2.3 Delete alias


Function:
This command deletes a specified alias.
Prerequisites:
The specified alias must have been set with the 3gsim set alias command. However, the
command finishes successfully also when the alias is not found.

3gsim dela | delete alias

[<alias name>]

{-all}

<alias name>
Specifies an alias to delete.
Allowed values: alias name

-all
Deletes all defined aliases.
Conditional:
Cannot be used together with any other parameter.

Example:
3gsim delete alias MyCellList

19
SGSN commands

3 SGSN commands

3.1 Create SGSN node


Function:
This command creates a simulated SGSN.
Prerequisites:
PDGs must be created with the 3gsim create packet_data_generator command before the
SGSN node is created in a simulated Core Network.

3gsim csn | create sgsn_node

-i | -id <SGSN ID>

-pu | -processor_unit <processor>[/<instance>]


[,<processor 2>[/<instance>],...]

[-ui | -ue_ip <base IP address>]

-spc <SPC>

-sf | -sccp_fro <FRO ID>

{-pi | -plmn_id <MCC>-<MNC> | 0x<Hex value>}

{-ci | -cn_id <CN ID>}

{-nril | -nri_length <NRI length>}

{-nri <NRI value>[,...,<NRI value 32>]}

-id
A unique name of the SGSN node to be created.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-processor_unit
Specifies the processors where the simulated node
executes, and optionally program instances (used for
multi core systems). The first value in the list is the master
instance.
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
You can find the processor number and the program
instance number by running the command 3gsim list
installation -process_name tgs_cn and look for the result
displayed in the PU column.

20
SGSN commands

Program instance 1 means a program instance that


executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
The mp option is deprecated. It can still be used for
compatibility reasons.
Example:
-processor_unit 000800/1
-processor_unit 000800,000900

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

-ue_ip
Specifies a base UE IP address. The address must differ
enough from the IP addresses of other SGSN nodes
within the 3Gsim node to guarantee that all addresses are
unique.
If this parameter is omitted, 3Gsim automatically
generates IP addresses that are unique within the 3Gsim
node.
Allowed values: A dot notation IP address

-spc
Specifies the signaling point code of the SGSN. Use either
the ITU-T or the ANSI format.
A value in ANSI format is 24 bits wide and is written in
8-8-8 format.
Example:
-spc 100-126-44

A value in ITU-T format is specified by 14 bits and is


written in decimal format.
Example:
-spc 2300

Allowed values: ANSI format: decimal numbers


separated by '-'. ITU-T format: a decimal number.

-sccp_fro
The FRO identity that specifies the SCCP resourse.
Allowed values: decimal numbers

21
SGSN commands

-plmn_id
The mobile network ID.
Example:
235-19

or
0x32F591

Allowed values: <MMC> - <MNC> or a 0x <hexadecimal


value>
Conditional:
Both or none of plmn_id and cn_id must be used.

-cn_id
The Core Network ID.
Example:
304

Allowed values: An integer


Conditional:
Both or none of plmn_id and cn_id must be used.

-nri_length
The NRI has a flexible length. 0 bits means the NRI is
not used and the feature IuFlex is not applied. The NRI
length shall be configured to be the same in all nodes of a
specific domain in one pool area.
Unit: bits
Allowed values: 0-10
Default value: 0
Conditional:
Both or none of nri_length and nri must be used.

-nri
Specifies one or several NRIs that uniquely identify an
individual node in CN out of all CN nodes. NRI values
of the CS and PS domain are independent of each
other as the CS and PS domain nodes are addressed
independently.
Allowed values: 1-32 NRI values
Conditional:
Only applicable if nri_length is greater than 0.

Example:
Create a simulated SGSN node:
3gsim create sgsn_node -id sgsn_1 -spc 2810 -sccp_fro 2 -processor_unit 000800

Example:
Create a simulated SGSN node distributed on two boards:
3gsim create sgsn_node -id sgsn_2 -spc 2811 -sccp_fro 5 -processor_unit 000900,000800

22
SGSN commands

3.2 List SGSN node


Function:
This command lists one or all created SGSN nodes.
Prerequisites:
SGSN nodes must have been created with the 3gsim create sgsn_node command.

3gsim lsn | list sgsn_node

[-i | -id <SGSN ID> | all]

-id
Specifies the name of the SGSN node to list. Use all to list
all defined SGSN nodes.
Allowed values: SGSN ID or all
Default value: all

The following SGSN properties are displayed:


ID The ID of the SGSN node
STATUS The status of the SGSN node
SPC The originating point code for the SCCP protocol, that is the SPC of the
MSC
SCCP_FRO The FRO identity that specifies the SCCP resource
PLMN_ID The mobile network ID, either in the form <MMC>-<MNC> or in
hexadecimal form depending on input method
CN_ID The Core Network ID
PU The address or the list of addresses of the processor units where CN
SG instances of simulated node executes and, if multi core system is
used, the program instance. The order of the list of addresses of the
processor units is obtained from the create sgsn_node command
UE_IP The base IP address for the UEs
NRI_LENGTH The NRI length in number of bits
NRI_VALUE List of NRI values for this node

23
MSC commands

4 MSC commands

4.1 Create MSC node


Function:
This command creates a simulated MSC.

3gsim cmn | create msc_node

-i | -id <name>

[-a | -aesa <AESA number>]

-pu | -processor_unit <processor>[/<instance>]


[,<processor 2>[/<instance>],...]

-pu_payload | -processor_unit_ <processor>[/<instance>]


payload [,<processor 2>[/<instance>],...]

-spc <SPC>

-sf | -sccp_fro <FRO ID>

{-pi | -plmn_id <MCC>-<MNC> | 0x<Hex value>}

{-ci | -cn_id <CN ID>}

[-ip | -ip_host <FRO ID>[,<FRO ID 2>,...]]

{-nril | -nri_length <NRI length>}

{-nri <NRI>[,...,<NRI 32>]}

-id
A unique name of the MSC node to be created.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-aesa
The ATM end system address of the node that controls
the RNC peer user plane connection endpoint (usually the
simulated MSC itself).
Allowed values: 7-15 digits

-processor_unit
Specifies the processors on which the simulated node
executes, and optionally program instances (used for multi
core systems). The first processor in the list is the master
instance.
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).

24
MSC commands

You can find the processor number and the program


instance by running the command 3gsim list installation -
process_name tgs_cn and look for the result displayed in
the PU column.
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
The mp option is deprecated. It can still be used for
compatibility reasons.
Example:
-processor_unit 000400/1
-processor_unit 000800,000900/6

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

-processor_unit_payload
Specifies one or several processors where the payload
traffic is terminated, and optionally program instances
(used for multi core systems).
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
You can find the processor number and the program
instance number by running the 3gsim list installation -
process_name tgs_mscxc_proc command and look for
the result displayed in the PU column.
If running 3Gsim on Evo boards, the following conditions
must be fulfilled:
• The given number of values must be a multiple of the
number of processor_unit values. For example, if 6
PU payload locations and 3 PUs are specified, then
the first two PU payload locations are assigned to the
first PU, the next two are assigned to the second PU,
and the last two are assigned to the third PU.
• The PU payload locations must be specified on
the same processor unit as the processor they are
assigned to.
The payload_spm option is deprecated. It can still be used
for compatibility reasons.
Example:
-processor_unit_payload 0011000
-processor_unit_payload 0011000,0011001,0011002
-processor_unit_payload 0016000/2,0017001/1

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

25
MSC commands

-spc
The signaling point code (SPC) of the MSC. The value
must match the node configuration. Use either the ITU-T
or the ANSI format.
A value in ANSI format is specified by 24 bits and is
written in 8-8-8 format.
Example:
-spc 100-126-44

A value in ITU-T format is specified by 14 bits and is


written in decimal format.
Example:
-spc 2300

Allowed values: ANSI format: decimal numbers


separated by '-'. ITU-T format: a decimal number.

-sccp_fro
The FRO identity that specifies the SCCP resource. This
must match the node configuration.
Allowed values: decimal number

-plmn_id
The mobile network ID, either in the form <MCC> -
<MNC> or in hexadecimal form 0x <Hex value> .
Example:
235-19
0x32F591

Conditional:
Both or none of plmn_id and cn_id must be used.

-cn_id
The core network ID, for example 304.
Conditional:
Both or none of plmn_id and cn_id must be used.

-ip_host
A list of IP host FRO identities to be used for an IP
connected MSC. If this parameter is given the MSC
supports IP in the user plane.
If running 3Gsim on classic CPP boards, only 1 IP host
can be specified.
If running 3Gsim on Evo boards, the number of IP hosts
must be equal to the number of PU payload locations
specified in the processor_unit_payload parameter.
Allowed values: decimal numbers

26
MSC commands

-nri_length
The NRI has a flexible length. If NRI is not used and the
feature IuFlex is not applied. The NRI length shall be
configured to be the same in all nodes of the specific
domain in one pool area.
Unit: bits
Allowed values: 1-10
Conditional:
Both or none of nri_length and nri must be used.

-nri
NRI uniquely identifies an individual node in CN out of all
CN nodes. NRI values of the CS and PS domain nodes
are addressed independently. One or more NRI values
are assigned to a CN node.
Allowed values: 1-32 NRI values
Conditional:
Both or none of nri_length and nri must be used. This
parameter is only applicable if nri_length is set.

Example:
Create a simulated MSC node.
3gsim create msc_node -id msc_1 -processor_unit 000900 -sccp_fro 1 -
processor_unit_payload 0016004,0017000,0017001

Example:
In a 3Gsim running on Evo boards, create an MSC node in slots 4 and 5 in subrack 0. Specify 8
PU payload locations, where the first 4 are assigned to the first PU and the last 4 are assigned
to the second PU. Also, specify 8 IP host values, that is, 1 per PU payload location.
$ 3gsim create msc_node -id msc_1 -processor_unit 000400,000500
-processor_unit_payload
000400/5,000400/6,000400/7,000400/8,000500/5,000500/6,000500/7,000500/8,
-sccp_fro 3 -spc 2400 -ip_host 12,12,12,12,13,13,13,13

4.2 List MSC node


Function:
This command lists one or all created MSCs.

3gsim lmn | list msc_node

-i | -id <MSC ID> | all

-id
The identity of the MSC. Use all to list all simulated MSCs.
Allowed values: MSC ID or all

The following MSC properties are displayed:


ID The ID of the MSC node
STATUS

27
MSC commands

SPC The originating point code for the SCCP protocol, that is the SPC of the
MSC
SCCP_FRO The FRO identity that specifies the SCCP resource
AESA The aesa value of the MSC node
PLMN_ID The mobile network ID, either in the form <MMC>-<MNC> or in
hexadecimal form, depending on input method
CN_ID The Core Network ID
PU The address or the list of addresses of the processor units where CN
SG instances of simulated node executes and, if a multi core system
is used, the program instance.The order of the list of addresses of the
processor units is obtained from create msc_node command
PU_FOR_PAYLOAD_ A list of processor units where the MSC Cross Connect is located, and,
GENERATION if a multi core system is used, program instance
IPHOST The IP host FRO ID to be used for an IP-connected MSC
NRI_LENGTH The NRI length in number of bits
NRI_VALUE List of NRI values for this node

28
SS7 signaling link commands

5 SS7 signaling link commands

5.1 Create SS7 signaling link


Function:
This command creates an SS7 signaling link that is connected to a simulated SGSN or MSC.
Prerequisites:
SGSN and MSC nodes with support of multiple RANAP links must have been created. To allow
multiple RANAP links, the SGSN and MSC nodes must have been created without the opc and
dpc parameters.

3gsim cssl | create ss7_signaling_link

-i | -id <name>

-n | -node <name>

-d | -dpc <DPC>

[-rclb | -ranap_cl_behavior <behavior name>]

{-lac | -location_area_codes <LAC>[,<LAC 2>,...]}

{-ri | -rnc_id <RNC ID>}

{-pdg | -packet_data_generators <PDG ID>[,<PDG ID 2>,...]}

-id
Specifies a unique name of the SS7 signaling link to be
created.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-node
Specifies the name of the MSC or SGSN node that the
SS7 signaling link shall be connected to.
Allowed values: An MSC or SGSN ID

-dpc
Specifies signaling point code of the RNC. Use either the
ITU-T or the ANSI format.
A value in ANSI format is 24 bits wide and is written in
8-8-8 format.
Example:
-dpc 100-126-44

29
SS7 signaling link commands

A value in ITU-T format is specified by 14 bits and is


written in decimal format.
Example:
-dpc 2300

Allowed values: ANSI format: decimal numbers


separated by '-'. ITU-T format: a decimal number.

-ranap_cl_behavior
The name of the RANAP CL behavior to use.
Allowed values: Any predefined or customized behavior
of type cn-ranap-cl.
Default value: ranap_cl_default

-location_area_codes
Lists the identities of the location areas that are reserved
by the connected RNC (needed for IRAT handover).
Conditional:
Use this parameter when creating an SS7 signaling
link connected to a simulated MSC node.

-rnc_id
Specifies the RNC ID part of the global RNC ID (needed
for IRAT handover).
Conditional:
Use this parameter when creating an SS7 signaling
link connected to a simulated MSC node.

-packet_data_generators
Specifies which PDGs that can be used for a given DPC
(Destination Point Code) in Core Networks with PS traffic.
Allowed values: A comma-separated list of PDG names
Conditional:
Use this parameter only when creating an SS7
signaling link to a simulated SGSN node. If omitted,
PDGs are automatically selected.

The 3Gsim simCN nodes support SS7 signaling with multiple RNCs. Create one link for each RNC
node that the SGSN or MSC shall communicate with.

5.2 List SS7 signaling link


Function:
This command lists one or all defined SS7 signaling links.

3gsim lssl | list ss7_signaling_link

[-i | -id <name> | all]

30
SS7 signaling link commands

-id
Specifies the name of the SS7 signaling link to list. Use all
to list all defined SS7 signaling links.

The following information is listed:


ID Specifies the ID of the SS7 signaling link.
NODE Specifies the simulated SGSN or MSC node that the SS7 signaling link
is connected to.
STATUS Shows the status of the SS7 signaling link, either defined or
create_rejected.
RCL BEHAVIOR Specifies the RANAP CL behavior that is used.
OPC Originating Point Code. Specifies the signalling point code of the MSC
or the SGSN.
DPC Destination Point Code. Specifies the signaling point code of the RNC.
RNC_ID Specifies the RNC ID part of the global RNC ID.
LAC Location Area Code. Specifies the location areas that are reserved by
the connected RNC.
PDG ID list Specifies a list of PDGs that the SS7 signaling link is connected to.

5.3 Delete SS7 signaling link


Function:
This command removes one or all defined SS7 signaling links.

3gsim delssl | delete ss7_signaling_link

-i | -id <name> | all

-id
Specifies the name of the SS7 signaling link to be deleted.
The value all is also valid and deletes all defined SS7
signaling links.
Allowed values: The name of an SS7 signaling link or all

31
HLR commands

6 HLR commands

6.1 Create subscription


Function:
This command creates subscriptions in the HLR for one or several UEs.

3gsim csub | create subscription

-i | -imsi <IMSI number>

-subd | -subscription_data <subscription data name>

[-q | -quantity <number of subscriptions>]

[-csrb | -cs_ranap_co_behavior <behavior name>]

[-psrb | -ps_ranap_co_behavior <behavior name>]

[-mmb | -cn_mm_behavior <behavior name>]

[-ccb | -cn_cc_behavior <behavior name>]

[-gmmb | -cn_gmm_behavior <behavior name>]

[-smb | -cn_sm_behavior <behavior name>]

[-cslb | -cs_cn_lcs_behavior <behavior name>]

[-pslb | -ps_cn_lcs_behavior <behavior name>]

[-el | -enable_log <logpoint>[,<logpoint 2>,...] | all]

[-dl | -disable_log <logpoint>[,<logpoint 2>,...] | all]

-imsi
A unique IMSI number for the new subscription, or the first
subscription when the specified quantity is more than one.
The IMSI number is then incremented for each new UE
until the specified quantity is met.
Allowed values: 6 to 15 digits

-subscription_data
The subscription data for the subscriber or subscribers.
The predefined subscription data record is named default.

-quantity
The number of subscriptions to create with the command.
Allowed values: 1-1000
Default value: 1

32
HLR commands

-cs_ranap_co_behavior
The name of the RANAP CO behavior to use for CS
traffic.
Allowed values: Any predefined or customized behavior
of type cn-ranap-co.
Default value: ranap_co_default

-ps_ranap_co_behavior
The name of the RANAP CO behavior to use for PS
traffic.
Allowed values: Any predefined or customized behavior
of type cn-ranap-co.
Default value: ranap_co_default

-cn_mm_behavior
The name of the MM behavior to use.
Allowed values: Any predefined or customized behavior
of type cn-mm.
Default value: cn_mm_default

-cn_cc_behavior
The name of the CC behavior to use.
Allowed values: Any predefined or customized behavior
of type cn-cc.
Default value: cn_cc_default

-cn_gmm_behavior
The name of the GMM behavior to use.
Allowed values: Any predefined or customized behavior
of type cn-gmm.
Default value: cn_gmm_default

-cn_sm_behavior
The name of the SM behavior to use.
Allowed values: Any predefined or customized behavior
of type cn-sm.
Default value: cn_sm_default

-cs_cn_lcs_behavior
Specifies the name of the LCS behavior to use for CS
traffic.
Allowed values: Any predefined or customized behavior
of type cn-lcs.
Default value: cn_lcs_default

33
HLR commands

-ps_cn_lcs_behavior
Specifies the name of the LCS behavior to use for PS
traffic.
Allowed values: Any predefined or customized behavior
of type cn-lcs.
Default value: cn_lcs_default

-enable_log
The CN log points for which to enable logging.

-disable_log
The CN log points for which to disable logging. This
parameter may be used after the parameter enable_log to
override values.

6.2 List subscription


Function:
This command lists one or more subscriptions.

3gsim lsub | list subscription

[-i | -imsi <IMSI>[-<IMSI>] | all]

[-b | -behavior]

[-cn | -core_network [<Node ID>]]

[-pu | -processor_unit [<processor>[/<instance>]]]

{-instances per_cn | per_pu}

[-log]

[-q | -quantity]

-imsi
Specifies the IMSI number for the UE to be listed, or a
range with the first and last IMSI numbers. Only the last
few digits of the last IMSI in the range are needed. The
value all is also valid and lists all defined subscriptions.
Example:
Specify the range 123089, 123090, 123091, and
123092:
imsi 123089-92

Allowed values: IMSI numbers or all


Default value: all

-behavior
Lists the CN behaviors associated with each subscriber.

34
HLR commands

-core_network
Lists all subscribers that are attached to the specified CN
node. If no value is given, all subscribers in CN are listed
with CN information.

-processor_unit
Lists information about the subscriptions that are
associated with the currently used processor unit (PU). If
no value is given, information is listed about all PUs with
which the subscriber is associated. The processor number
and the program instance number are separated by a
slash (/).
You can find the processor number and the program
instance number by using the pu parameter without
argument.
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
Example:
-processor_unit 0011000
-processor_unit 0016000/2

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

-instances
Lists the number of instances, where an instance
corresponds to:
• a GMM generator for an SGSN node,
• an MM generator for an MSC node,
• an MSC Cross Connection or a PDG for a resource
PU (depending on which type of processes that are
executing on the listed PU).
The instances are presented either per PU or per CN
node. If distributed CN nodes are used, each instance
of the CN node is presented together with the number of
instances that are allocated on each resource PU for each
CN node.
Allowed values: per_cn, per_pu
Conditional:
This parameter cannot be used together with any
other parameter.

-log
Lists all active log points.

-quantity
Lists the total number of subscribers matching the filter
criteria. If no filter criteria is given the total number of
subscriptions are listed.

35
HLR commands

The following columns can be displayed when running the command; if no parameters are specified,
only the IMSI and SubD ID columns are displayed:
IMSI The IMSI number of the UE
SubD ID The ID of the subscription data record
Node ID The ID of the CN node
SGSN PU The ID of the SGSN processor unit and, if a multi core system is used,
program instance
MSC PU The ID of the MSC processor unit and, if a multi core system is used,
program instance
PDG PU The ID of the PDG processor unit and, if a multi core system is used,
program instance
MSCXC PU The ID of the MSC XC processor unit
RANAP CO CS The name of the RANAP CO CS behavior
RANAP CO PS The name of the RANAP CO PS behavior
MM The name of the MM behavior
CC The name of the CC behavior
GMM The name of the GMM behavior
SM The name of the SM behavior
LCS CS The name of the LCS CS behavior
LCS PS The name of the LCS PS behavior
Instances The number of GMM generators, MM generators, MSC XCs or PDGs.
If no parameter is given to the command, the SubD ID and IMSI columns are displayed.

6.3 Delete subscription


Function:
This command deletes the subscriptions for the specified UEs.

3gsim delsub | delete subscription

[-imsi <IMSI>[-<IMSI>] | all]

-imsi
Specifies the IMSI number for the UE, or a range with the
first and last IMSI numbers. Only the last few digits of the
last IMSI in the range are needed. The value all is also
valid and deletes all defined subscriptions.
Example:
Specify the range 123089, 123090, 123091, and
123092:
imsi 123089-92

Allowed values: IMSI numbers or all


Default value: all

36
HLR commands

6.4 Copy subscription data


Function:
This command copies an old subscription data record to a new subscription data record.

3gsim csubd | copy subscription_data

<subscription data record name>

<new name>

<subscription data record name>


The name of the subscription data record to make a copy
of.

<new name>
The name of the new subscription data record to create.

6.5 Modify subscription data


Function:
This command modifies the specified subscription data record.
Prerequisites:
A customized subscription data record must have been created. Predefined subscription data
records cannot be modified.

3gsim msubd | modify subscription_data

<subscription data record>

-<parameter name> <new value>

[-<parameter name 2> <new value>]

...

[-<parameter name N> <new value>]

<subscription data record>


The name of the subscription data record to modify.

-<parameter name>
Specifies which parameter to modify and the new value to
use.
Allowed values: Any parameter listed with the 3gsim list
subscription_data command.

-<parameter name 2>


Specifies the next parameter to modify, and the new
values to assign to the parameter.
Allowed values: Any parameter listed with the 3gsim list
subscription_data command.

37
HLR commands

-<parameter name N>


Specifies the last parameter to modify, and the new
values that will be assigned to the parameter.
Allowed values: Any parameter listed with the 3gsim list
subscription_data command.

6.6 List subscription data


Function:
This command lists the parameters of the specified subscription data record.

3gsim lsubd | list subscription_data

{-l | -long}

[<subscription data record>]

{-all}

-long
Lists the parameters and their values for a specified
subscription data record.
Conditional:
When used, a subscription data record name must be
specified.

<subscription data record>


Specifies a subscription data record to list.
Allowed values: subscription data record name

-all
Lists all subscription data records, but excludes their
parameters.
Conditional:
Cannot be used together with the any other
parameter.

If no parameters are specified the names of all existing subscription data are listed.

6.7 Delete subscription data


Function:
This command deletes the specified subscription data record.

3gsim delsubd | delete subscription_data

<subscription data record>

{-all}

38
HLR commands

<subscription data record>


Specifies a subscription data record to delete.
Allowed values: The name of a subscription data record.

-all
Deletes all user-defined subscription data records.
Conditional:
Cannot be used together with any other parameter.

6.8 Dump subscriber


3gsim dus | dump subscriber

[-i | -imsi <IMSI number>[-<IMSI number>] | all]

[-node <node ID>[,<node ID 2>,...]]

-imsi
An IMSI number for the subscriber to be dumped or a
range with the first and last IMSI numbers. Only the last
few digits of the last IMSI in the range are needed.
Example:
imsi 123089-92

gives the range of 123089, 123090, 123091, and


123092.
Default value: all

-node
Filter option to specify one or more CN nodes to match. A
subscriber needs to match all specified filter options to get
dumped.

39
Subscription data

7 Subscription data

7.1 Subscription data parameters


Function:
The subscription data record controls the UE subscription attributes.

-cs_conv_speech_nb_guaranteed_bit_rate_ul <rate>

-cs_conv_speech_wb_guaranteed_bit_rate_ul <rate>

-cs_conv_unknown_guaranteed_bit_rate_ul <rate>

-ps_conv_speech_guaranteed_bit_rate_ul <rate>

-ps_conv_unknown_guaranteed_bit_rate_ul <rate>

-cs_streaming_guaranteed_bit_rate_ul <rate>

-ps_streaming_guaranteed_bit_rate_ul <rate>

-cs_conv_speech_nb_guaranteed_bit_rate_dl <rate>

-cs_conv_speech_wb_guaranteed_bit_rate_dl <rate>

-cs_conv_unknown_guaranteed_bit_rate_dl <rate>

-ps_conv_speech_guaranteed_bit_rate_dl <rate>

-ps_conv_unknown_guaranteed_bit_rate_dl <rate>

-cs_streaming_guaranteed_bit_rate_dl <rate>

-ps_streaming_guaranteed_bit_rate_dl <rate>

-cs_conv_speech_nb_maximum_bit_rate_ul <rate>

-cs_conv_speech_wb_maximum_bit_rate_ul <rate>

-cs_conv_unknown_maximum_bit_rate_ul <rate>

-ps_conv_speech_maximum_bit_rate_ul <rate>

-ps_conv_unknown_maximum_bit_rate_ul <rate>

-cs_streaming_maximum_bit_rate_ul <rate>

-ps_streaming_maximum_bit_rate_ul <rate>

-interactive_maximum_bit_rate_ul <rate>

-background_maximum_bit_rate_ul <rate>

-cs_conv_speech_nb_maximum_bit_rate_dl <rate>

40
Subscription data

-cs_conv_speech_wb_maximum_bit_rate_dl <rate>

-cs_conv_unknown_maximum_bit_rate_dl <rate>

-ps_conv_speech_maximum_bit_rate_dl <rate>

-ps_conv_unknown_maximum_bit_rate_dl <rate>

-cs_streaming_maximum_bit_rate_dl <rate>

-ps_streaming_maximum_bit_rate_dl <rate>

-interactive_maximum_bit_rate_dl <rate>

-background_maximum_bit_rate_dl <rate>

-cs_conv_speech_nb_transfer_delay <delay>

-cs_conv_speech_wb_transfer_delay <delay>

-cs_conv_unknown_transfer_delay <delay>

-ps_conv_speech_transfer_delay <delay>

-ps_conv_unknown_transfer_delay <delay>

-cs_streaming_transfer_delay <delay>

-ps_streaming_transfer_delay <delay>

-interactive_traffic_handling_priority <level>

-cs_conv_speech_nb_priority_level <level>

-cs_conv_speech_wb_priority_level <level>

-cs_conv_unknown_priority_level <level>

-ps_conv_speech_priority_level <level>

-ps_conv_unknown_priority_level <level>

-cs_streaming_priority_level <level>

-ps_streaming_priority_level <level>

-interactive_priority_level <level>

-background_priority_level <level>

-cs_conv_speech_nb_preemption_capability shall_not_trigger_preemption |
may_trigger_preemption

-cs_conv_speech_wb_preemption_capability shall_not_trigger_preemption |
may_trigger_preemption

-cs_conv_unknown_preemption_capability shall_not_trigger_preemption |
may_trigger_preemption

-ps_conv_speech_preemption_capability shall_not_trigger_preemption |
may_trigger_preemption

41
Subscription data

-ps_conv_unknown_preemption_capability shall_not_trigger_preemption |
may_trigger_preemption

-cs_streaming_preemption_capability shall_not_trigger_preemption |
may_trigger_preemption

-ps_streaming_preemption_capability shall_not_trigger_preemption |
may_trigger_preemption

-interactive_preemption_capability shall_not_trigger_preemption |
may_trigger_preemption

-background_preemption_capability shall_not_trigger_preemption |
may_trigger_preemption

-cs_conv_speech_nb_preemption_vulnerability not_preemptable | preemptable

-cs_conv_speech_wb_preemption_vulnerability not_preemptable | preemptable

-cs_conv_unknown_preemption_vulnerability not_preemptable | preemptable

-ps_conv_speech_preemption_vulnerability not_preemptable | preemptable

-ps_conv_unknown_preemption_vulnerability not_preemptable | preemptable

-cs_streaming_preemption_vulnerability not_preemptable | preemptable

-ps_streaming_preemption_vulnerability not_preemptable | preemptable

-interactive_preemption_vulnerability not_preemptable | preemptable

-background_preemption_vulnerability not_preemptable | preemptable

-security security_off | security_on

-additional_allowed_plmn - | * | <PLMN ID list>

-subscriber_profile_id - | <ID>

-cs_conv_speech_nb_guaranteed_bit_rate_ul
Specifies the guaranteed UL bit rate for CS
conversational speech narrowband.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 4750

-cs_conv_speech_wb_guaranteed_bit_rate_ul
Specifies the guaranteed UL bit rate for CS
conversational speech wide-band.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 6600

42
Subscription data

-cs_conv_unknown_guaranteed_bit_rate_ul
Specifies the guaranteed UL bit rate for CS
conversational unknown.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 64000

-ps_conv_speech_guaranteed_bit_rate_ul
The guaranteed UL bit rate for PS
conversational speech.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 31000

-ps_conv_unknown_guaranteed_bit_rate_ul
The guaranteed UL bit rate for PS
conversational unknown.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 63000

-cs_streaming_guaranteed_bit_rate_ul
Specifies the guaranteed UL bit rate for CS
streaming.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 14400

-ps_streaming_guaranteed_bit_rate_ul
Specifies the guaranteed UL bit rate for PS
streaming.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 8000

-cs_conv_speech_nb_guaranteed_bit_rate_dl
Specifies the guaranteed DL bit rate for CS
conversational speech narrowband.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 4750

43
Subscription data

-cs_conv_speech_wb_guaranteed_bit_rate_dl
Specifies the guaranteed DL bit rate for CS
conversational speech wide-band.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 6600

-cs_conv_unknown_guaranteed_bit_rate_dl
Specifies the guaranteed DL bit rate for CS
conversational unknown.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 64000

-ps_conv_speech_guaranteed_bit_rate_dl
The guaranteed DL bit rate for PS
conversational speech.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 31000

-ps_conv_unknown_guaranteed_bit_rate_dl
The guaranteed DL bit rate for PS
conversational unknown.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 63000

-cs_streaming_guaranteed_bit_rate_dl
Specifies the guaranteed DL bit rate for CS
streaming.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 14400

-ps_streaming_guaranteed_bit_rate_dl
Specifies the guaranteed DL bit rate for PS
streaming.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 64000

44
Subscription data

-cs_conv_speech_nb_maximum_bit_rate_ul
Specifies the maximum UL bit rate for CS
conversational speech narrow-band.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 12200

-cs_conv_speech_wb_maximum_bit_rate_ul
Specifies the maximum UL bit rate for CS
conversational speech wide-band.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 12650

-cs_conv_unknown_maximum_bit_rate_ul
Specifies the maximum UL bit rate for CS
conversational unknown.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 64000

-ps_conv_speech_maximum_bit_rate_ul
The maximum UL bit rate for PS conversational
speech.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 39000

-ps_conv_unknown_maximum_bit_rate_ul
The maximum UL bit rate for PS conversational
unknown.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 74000

-cs_streaming_maximum_bit_rate_ul
Specifies the maximum UL bit rate for CS
streaming.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 57600

45
Subscription data

-ps_streaming_maximum_bit_rate_ul
Specifies the maximum UL bit rate for PS
streaming.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 8000000

-interactive_maximum_bit_rate_ul
Specifies the maximum UL bit rate for
interactive.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 8000000

-background_maximum_bit_rate_ul
Specifies the maximum UL bit rate for
background.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 8000000

-cs_conv_speech_nb_maximum_bit_rate_dl
Specifies the maximum DL bit rate for CS
conversational speech narrow-band.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 12200

-cs_conv_speech_wb_maximum_bit_rate_dl
Specifies the maximum DL bit rate for CS
conversational speech wide-band.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 12650

-cs_conv_unknown_maximum_bit_rate_dl
Specifies the maximum DL bit rate for CS
conversational unknown.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 64000

46
Subscription data

-ps_conv_speech_maximum_bit_rate_dl
The maximum DL bit rate for PS conversational
speech.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 39000

-ps_conv_unknown_maximum_bit_rate_dl
The maximum DL bit rate for PS conversational
unknown.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 74000

-cs_streaming_maximum_bit_rate_dl
Specifies the maximum DL bit rate for CS
streaming.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 57600

-ps_streaming_maximum_bit_rate_dl
Specifies the maximum DL bit rate for PS
streaming.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 256000000

-interactive_maximum_bit_rate_dl
Specifies the maximum DL bit rate for
interactive.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 256000000

-background_maximum_bit_rate_dl
Specifies the maximum DL bit rate for
background.
Unit: bits/s
Allowed values: 0-256000000
Predefined value: 256000000

47
Subscription data

-cs_conv_speech_nb_transfer_delay
Transfer delay for CS conversational speech
narrow-band.
Unit: milliseconds (ms)
Allowed values: 0-65535
Predefined value: 80

-cs_conv_speech_wb_transfer_delay
Transfer delay for CS conversational speech
wide-band.
Unit: milliseconds (ms)
Allowed values: 0-65535
Predefined value: 80

-cs_conv_unknown_transfer_delay
Transfer delay for CS conversational unknown.
Unit: milliseconds (ms)
Allowed values: 0-65535
Predefined value: 160

-ps_conv_speech_transfer_delay
Transfer delay for PS conversational speech.
Unit: milliseconds (ms)
Allowed values: 0-65535
Predefined value: 100

-ps_conv_unknown_transfer_delay
Transfer delay for PS conversational unknown.
Unit: milliseconds (ms)
Allowed values: 0-65535
Predefined value: 100

-cs_streaming_transfer_delay
Transfer delay for CS streaming.
Unit: milliseconds (ms)
Allowed values: 0-65535
Predefined value: 250

-ps_streaming_transfer_delay
Transfer delay for PS streaming.
Unit: milliseconds (ms)
Allowed values: 0-65535
Predefined value: 4000

48
Subscription data

-interactive_traffic_handling_priority
Traffic handling priority for interactive.
Unit: priority level
Allowed values: 0-15
Predefined value: 1

-cs_conv_speech_nb_priority_level
Specifies the priority level for CS conversational
speech narrow-band.
Unit: priority level
Allowed values: 0-15
Predefined value: 1

-cs_conv_speech_wb_priority_level
Specifies the priority level for CS conversational
speech wide-band.
Unit: priority level
Allowed values: 0-15
Predefined value: 1

-cs_conv_unknown_priority_level
Specifies the priority level for CS conversational
unknown.
Unit: priority level
Allowed values: 0-15
Predefined value: 1

-ps_conv_speech_priority_level
The priority level for PS conversational speech.
Unit: priority level
Allowed values: 0-15
Predefined value: 1

-ps_conv_unknown_priority_level
The priority level for PS conversational
unknown.
Unit: priority level
Allowed values: 0-15
Predefined value: 1

-cs_streaming_priority_level
Specifies the priority level for CS streaming.
Unit: priority level
Allowed values: 0-15
Predefined value: 1

49
Subscription data

-ps_streaming_priority_level
Specifies the priority level for PS streaming.
Unit: priority level
Allowed values: 0-15
Predefined value: 1

-interactive_priority_level
Specifies the priority level for interactive.
Unit: priority level
Allowed values: 0-15
Predefined value: 1

-background_priority_level
Specifies the priority level for background.
Unit: priority level
Allowed values: 0-15
Predefined value: 1

-cs_conv_speech_nb_preemption_capability
Specifies the preemption capability for CS
conversational speech narrowband.
Allowed values: shall_not_trigger_preemption,
may_trigger_preemption
Predefined value:
shall_not_trigger_preemption

-cs_conv_speech_wb_preemption_capability
Specifies the preemption capability for CS
conversational speech wide-band.
Allowed values: shall_not_trigger_preemption,
may_trigger_preemption
Predefined value:
shall_not_trigger_preemption

-cs_conv_unknown_preemption_capability
Specifies the preemption capability for CS
conversational unknown.
Allowed values: shall_not_trigger_preemption,
may_trigger_preemption
Predefined value:
shall_not_trigger_preemption

50
Subscription data

-ps_conv_speech_preemption_capability
The preemption capability for PS conversational
speech.
Allowed values: shall_not_trigger_preemption,
may_trigger_preemption
Predefined value:
shall_not_trigger_preemption

-ps_conv_unknown_preemption_capability
The preemption capability for PS conversational
unknown.
Allowed values: shall_not_trigger_preemption,
may_trigger_preemption
Predefined value:
shall_not_trigger_preemption

-cs_streaming_preemption_capability
Specifies the preemption capability for CS
streaming.
Allowed values: shall_not_trigger_preemption,
may_trigger_preemption
Predefined value:
shall_not_trigger_preemption

-ps_streaming_preemption_capability
Specifies the preemption capability for PS
streaming.
Allowed values: shall_not_trigger_preemption,
may_trigger_preemption
Predefined value:
shall_not_trigger_preemption

-interactive_preemption_capability
Specifies the preemption capability for
interactive.
Allowed values: shall_not_trigger_preemption,
may_trigger_preemption
Predefined value:
shall_not_trigger_preemption

-background_preemption_capability
Specifies the preemption capability for
background.
Allowed values: shall_not_trigger_preemption,
may_trigger_preemption
Predefined value:
shall_not_trigger_preemption

51
Subscription data

-cs_conv_speech_nb_preemption_vulnerability
Specifies the preemption vulnerability for CS
conversational speech narrowband.
Allowed values: not_preemptable,
preemptable
Predefined value: not_preemptable

-cs_conv_speech_wb_preemption_vulnerability
Specifies the preemption vulnerability for CS
conversational speech wideband.
Allowed values: not_preemptable,
preemptable
Predefined value: not_preemptable

-cs_conv_unknown_preemption_vulnerability
Specifies the preemption vulnerability for CS
conversational unknown.
Allowed values: not_preemptable,
preemptable
Predefined value: not_preemptable

-ps_conv_speech_preemption_vulnerability
The preemption vulnerability for PS
conversational speech.
Allowed values: not_preemptable,
preemptable
Predefined value: not_preemptable

-ps_conv_unknown_preemption_vulnerability
The preemption vulnerability for PS
conversational unknown.
Allowed values: not_preemptable,
preemptable
Predefined value: not_preemptable

-cs_streaming_preemption_vulnerability
Specifies the preemption vulnerability for CS
streaming.
Allowed values: not_preemptable,
preemptable
Predefined value: not_preemptable

-ps_streaming_preemption_vulnerability
Specifies the preemption vulnerability for PS
streaming.
Allowed values: not_preemptable,
preemptable
Predefined value: not_preemptable

52
Subscription data

-interactive_preemption_vulnerability
Specifies the preemption vulnerability for
interactive.
Allowed values: not_preemptable,
preemptable
Predefined value: not_preemptable

-background_preemption_vulnerability
Specifies the preemption vulnerability for
background.
Allowed values: not_preemptable,
preemptable
Predefined value: not_preemptable

-security
Indicates if the RANAP security mode control
procedure shall be initiated by simCN.
Allowed values: security_off, security_on
Predefined value: security_on

-additional_allowed_plmn
Specifies additional PLMNs where the UE is
allowed to roam. A PLMN ID is given as <MCC>
- <MNC> . The value '*' means that the UE is
allowed in all PLMNs. The value '-' means that
the UE is only allowed in its home PLMN.
Allowed values: *, -, MCC: 3 digits, MNC: 2 or
3 digits
Predefined value: *

-subscriber_profile_id
Specifies SPID. The value '-' means that this
value is undefined and it is not send in RANAP
messages.
Allowed values: -, 1-256
Predefined value: -

53
SAS commands

8 SAS commands

8.1 Create SAS node


Function:
This command creates one simulated SAS node in 3Gsim.

3gsim csan | create sas_node

-i | -id <SAS ID>

-pu | -processor_unit <processor>[/<instance>]

-spc <SPC>

-sf | -sccp_fro <SCCP FRO ID>

-id
A unique name of the SAS node to be created.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-processor_unit
Specifies the processor where the simulated node
executes, and optionally a program instance (used for
multi core systems).
The specified processor and program instance must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
You can find the processor number and the program
instance number by running the command 3gsim list
installation -process_name tgs_sas and look for the result
displayed in the PU column.
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
The mp option is deprecated. It can still be used for
compatibility reasons.
Example:
-processor_unit 000300
-processor_unit 000500/3

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

54
SAS commands

-spc
The signaling point code for the SAS node. Use either the
ITU-T or the ANSI format.
A value in ANSI format is 24 bits wide and is written in
8-8-8 format.
Example:
-spc 100-126-44

A value in ITU-T format is specified by 14 bits and is


written in decimal format.
Example:
-spc 2300

Allowed values: ANSI format: decimal numbers


separated by '-'. ITU-T format: a decimal number.

-sccp_fro
The FRO identity that specifies the SCCP resource.
Allowed values: decimal number

8.2 List SAS node


Function:
This command lists one or all created SAS nodes.

3gsim lsan | list sas_node

[-i | -id <SAS ID> | all]

-id
The name of the SAS node to list. Use all to list all defined
SAS nodes.

The following properties are displayed:


ID The name of the SAS node
PU The address of the processor unit where the simulated node executes
and, if a multi core system is used, the program instance
SPC The originating point code for the SCCP protocol, that is the SPC of the
SAS
SCCP_FRO The FRO identity that specifies the SCCP resource

8.3 Delete SAS node


Function:
This command deletes the specified SAS node.

3gsim delsan | delete sas_node

-i | -id <SAS ID> | all

55
SAS commands

-id
The name of the SAS node to delete. Use all to delete all
defined SAS nodes.
Allowed values: SAS node name or all

56
Iur loopback commands

9 Iur loopback commands

9.1 Create Iur loopback


Function:
This command creates one Iur loopback in 3Gsim.

3gsim ciurlb | create iur_loopback

-id <name>

-pu | -processor_unit <processor>[/<instance>]

-spc <SPC>

-sf | -sccp_fro <FRO ID>

-ri | -rnc_id <number>

-id
Specifies the ID of the Iur loopback to be created.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-processor_unit
Specifies the processor where the Iur loopback executes,
and optionally a program instance (used for multi core
systems).
The specified processor and program instance must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
Example:
-processor_unit 0016000/1
-processor_unit 000800,000900/6

You can find the processor number and the program


instance number by running the command 3gsim list
installation -process_name tgs_iur_loopback and look for
the result displayed in the PU column.
Program instance 1 means a program instance executing
in the first core; program instance 2 means a program
instance executing in the second core, and so on.
Allowed values: Processor: a 6-digit or 7-digit number.
Program instance: positive number.

-spc
Specifies the signaling point code for the Iur loopback
instance. The value must match the node configuration.
Use either the ANSI or the ITU-T format.

57
Iur loopback commands

A value in ANSI format is 24 bits wide and is written in


8-8-8 format.
Example:
-spc 100-126-44

A value in ITU-T format is specified by 14 bits and is


written in decimal format.
Example:
-spc 2300

Allowed values: ANSI format: decimal numbers


separated by '-'. ITU-T format: a decimal number.

-sccp_fro
Specifies the FRO identity that defines the SCCP
resource. The value must match the node configuration.
Allowed values: A decimal number.

-rnc_id
Specifies the RNC ID that is used in the modified RNSAP
RADIO LINK SETUP REQUEST message.
Allowed values: 0-4095

9.2 Modify Iur loopback


Function:
This command modifies one Iur loopback.

3gsim miurlb | modify iur_loopback

-id <name>

-ri | -rnc_id <number>

-id
Specifies the ID of the Iur loopback to be modified.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-rnc_id
Specifies the RNC ID that is used in the modified RNSAP
RADIO LINK SETUP REQUEST message.
Allowed values: 0-4095

58
Iur loopback commands

9.3 List Iur loopback


Function:
This command lists one or all defined Iur loopbacks.

3gsim liurlb | list iur_loopback

[-id <name> | all]

-id
Specifies the ID of the Iur loopback to list. Use all to list all
defined Iur loopback instances.
Allowed values: The name of an Iur loopback or all
Default value: all

The following information is listed:


ID The ID of the Iur loopback
PU The processor unit
SCCP FRO The SCCP AP FRO-ID for the Iur loopback in 3Gsim
SPC The signaling point code of the Iur loopack instance in 3Gsim
RNC_ID The RNC ID that is used in the modified RNSAP RADIO LINK SETUP
REQUEST message

9.4 Delete Iur loopback


Function:
This command deletes one or all defined Iur loopback instances.

3gsim deliurlb | delete iur_loopback

-id <name> | all

-id
Specifies the ID of the Iur loopback to be deleted. Use all
to delete all defined Iur loopback instances.
When deleting an Iur loopback all associated SCCP
connections are dropped.
Allowed values: The name of an Iur loopback or all

59
RBS commands

10 RBS commands

10.1 Create RBS


Function:
This command creates one RBS in 3Gsim.

3gsim cr | create rbs

-i | -id <RBS ID>

[-a | -aesa <AESA-number>]

-pu | -processor_unit <processor>[/<instance>]

-pu_ctc | -processor_unit_ctc <processor>[/<instance>]


[,<processor 2>[/<instance>],...]

{-nc | -nbap_common <channel>[,<channel 2>,...]}

[-nd | -nbap_dedicated <channel>[,<channel 2>,...]]

[-s | -sync <FRO ID>/<TU board slot>[,...,<FRO ID 4>/<TU board


slot 4>]]

-c | -cell <local Cell ID>[/<RNS cell ID>][,...,<local Cell ID


24>[/<RNS cell ID 24>]]

[-el | -enable_log <log point>[,<log point 2>,...] | all]

[-dl | -disable_log <log point>[,<log point 2>,...] | all]

[-dpo | -dl_power_offset <value>]

[-dpu | -dl_power_per_ue <value>]

[-dpu_hs | -dl_power_per_ue_hs <value>]

{-ip | -ip_host <FRO ID>}

{-sc | -sctp <FRO ID>}

{-ncp | -nbap_common_port <port>}

{-ndp | -nbap_dedicated_port <port>}

[-scmc | -sec_cell_mc <local cell ID>[,<local cell ID>,...]]

{-scdbmc | -sec_cell_dbmc <local cell ID>[,<local cell ID>,...]}

[-cg | -cell_group <cell group ID>[,<cell group ID>,...]]

[-rtt | -round_trip_time on|off]

[-cap | -capabilities <capability set>[,<capability set 2>,...]]

60
RBS commands

[-cb | -cell_behavior <cell behavior>[,<cell behavior 2>,...]]

[-si | -suppress_indication on|off[,on|off,...]]

[-rnc <RNC ID>]

[-lbl | -label <description>]

-id
A unique name for the RBS to be created.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-aesa
The AESA number of the created RBS. Must be unique
within 3Gsim. If AESA is specified the RBS supports ATM
for the user plane. If both AESA number and IP-host are
given the RBS is Dual stack.
Allowed values: 7-15 digits

-processor_unit
Specifies the processor where the simulated node
executes, and optionally a program instance (used for
multi core systems).
The slot position and the program instance must match
the configuration of the node being used. Slot position and
program instance are separated by a slash (/).
You can find the processor number and the program
instance number by running the command 3gsim list
installation -process_name tgs_rbs and look for the result
displayed in the PU column.
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
The mp option is deprecated. It can still be used for
compatibility reasons.
Example:
-processor_unit 000500
-processor_unit 000400/5

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

-processor_unit_ctc
Processor Unit Common Transport Channel. Specifies
one or several processors to use for the UE stack, and
optionally program instance (used for multi core systems).
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).

61
RBS commands

You can find the slot position by running the command


3gsim list installation -process_name tgs_uestack_proc
and look for the result displayed in the PU column.
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
If more than one processor unit is specified, the number
of specified cells and the number of specified processor
units must be the same. If a single value is given, it is
used for all cells.
Restriction: A processor_unit_ctc program instance
can only be combined with one processor_unit instance.
This means that once a combination of a processor_unit
program instance and a processor_unit_ctc instance is
specified, this particular program instance cannot be used
together with other processor unit instances. However, the
processor_unit program instance can be used together
with other program instances, and the combinations of
processor_unit and processor_unit_ctc program instance
can be reused in other RBSs.
The spm option is deprecated. It can still be used for
compatibility reasons.
Example:
-processor_unit_ctc 0005000/1,0005000/4

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

-nbap_common
Specifies the USAAL CEP FRO-identity or identities
for the NBAP Common channel when using ATM. If
nbap_common is specified the RBS will use ATM for the
control plane.
Conditional:
It is not possible to use the nbap_common parameter
and the sctp parameter at the same time. If the
nbap_common parameter is used toghether with the
ip_host parameter the user gets a warning.

-nbap_dedicated
Specifies the USAAL CEP FRO-identity or identities for
the NBAP Dedicated channel when using ATM.

-sync
Specifies the AAL0 CEP FRO-identity for the sync
channel and the slot of the TU board where the FRO is
installed. Use '/' as FRO ID and slot value separator. The
sync value must match the MO scripts. If the MO scripts

62
RBS commands

delivered with 3Gsim are used, the supported FROId is


1. This parameter is only needed when node sync over
AAL0 is used.
Allowed values: 1-4 pairs of FRO IDs and TU board
slots. The FRO ID is a number between 1 and 9999.

-cell
The local cell ID and optionally the RNS cell ID of the cells
in this RBS. The local cell ID must match the localCellId
attribute within an RNC UtranCell MO.
Allowed values: 1-24 cells

-enable_log
Turns on logging for one or more RBS log points.
Allowed values: see below

-disable_log
Turns off logging for one or more log points.
Allowed values: see below

-dl_power_offset
Specifies the transmitted carrier power to report in the
common measurement report when no UE is in the cell.
Unit: percent (%)
Allowed values: 0-100

-dl_power_per_ue
Specifies the contribution from each UE in the cell to the
transmitted carrier power.
Unit: percent (%)
Allowed values: 0-100

-dl_power_per_ue_hs
Specifies the contribution from each HS-UE in the
cell to the HS DSCH required power. The parameter
dl_power_per_ue_hs shall be specified when the RBS
is created otherwise the periodic measurement will not
be started and it is not possible to modify the parameter
afterwards.
Unit: percent (%)
Allowed values: 0-100

-ip_host
Specifies the IP host FRO-identity to use for an IP
connected RBS. If ip_host is specified the RBS supports
user plane over IP. If both AESA number and IP-host are
given the RBS is Dual stack.
Conditional:
If ip_host is used toghether with nbap_common the
user will get a warning.

63
RBS commands

-sctp
Provides the SCTP FRO ID for the NBAP channels for an
IP connected RBS. If this parameter is used the RBS will
use IP for the control plane.
Conditional:
It is not possible to use the sctp parameter and the
nbap_common parameter at the same time.

-nbap_common_port
Specifies the SCTP port number to use for NBAP
common channel over IP.
Conditional:
Required for IP RBS, ignored otherwise.

-nbap_dedicated_port
Specifies the SCTP port to use for NBAP dedicated
channel over IP.
Conditional:
Required for IP RBS, ignored otherwise.

-sec_cell_mc
Specifies which cells that are secondary local cells to
the local cells set by the cell parameter. The list must
have the same number of entries as the cell parameter.
A hyphen (-) indicates that there is no secondary local
cell for the corresponding local cell. If the list of local cell
IDs begins with a hyphen, then the string must be quoted
(single quotes).
Example:
-scmc '-,1,1'
-scmc 3,3,-

For the cells to be Multi Carrier capable, they must use a


cell capability set where Multi Carrier is enabled.
Allowed values: secondary cell ID or '-'

-sec_cell_dbmc
Specifies which cells that are secondary local cells to
the local cells set by the cell parameter. The list must
have the same number of entries as the cell parameter.
A hyphen (-) indicates that there is no secondary local
cell for the corresponding local cell. If the list of local cell
IDs begins with a hyphen, then the string must be quoted
(single quotes).
Example:
-scdbmc '-,1,1'
-scdbmc 3,3,-

64
RBS commands

For the cells to be dual-band HSDPA Multi Carrier


capable, they must use a cell capability set where dual-
band HSDPA Multi Carrier is enabled.
Allowed values: secondary cell IDs or hyphens (-)
Conditional:
Do not use in combination with the sec_cell_mc
parameter. If both parameters are used, an exception
will be logged and only Multi Carrier will be reported.

-cell_group
Defines the local cell group for each cell in the RBS. If
a single value is given, it is used for all cells in the RBS.
If a list of values is used, the list must have the same
number of entries as the parameter cell. If the parameter
is omitted, all local cells in the RBS belong to the same
implicit cell group. All cells in the same parameter
group must have the same values on the parameters
dch_consumption_law and edch_consumption_law.

-round_trip_time
Specifies whether the RBS is capable of RTT
measurements or not.
Allowed values: on, off
Default value: on

-capabilities
Specifies one cell capability set or a list of capability sets.
If a single value is given, all cells in the list of cells use
the same capability set. If a list of values is given, it must
contain one capability set for each cell in the cell list. The
first capability set is used for the first cell in the RBS, the
second capability set for the second cell and so on.
Default value: hs_cell

-cell_behavior
Specifies the name of a cell behavior or a list of names
of cell behaviors. If a single value is given, all cells in the
list of cells use the same cell behavior. If a list of values is
given, it must contain one cell behavior for each cell in the
cell list. The first cell behavior is used for the first cell in
the RBS, the second cell behavior for the second cell and
so on.
Allowed values: The name of a predefined or customized
cell behavior of type rbs-cell.
Default value: rbs_cell_default

-suppress_indication
Specifies whether the Resource Status Indication
message is suppressed or not. Off means that all changes
to the cell capability set are reported to the RNC. When a

65
RBS commands

change is made to a cell capability set and the suppress


state is on in that cell, the Resource Status Indication
message is suppressed.
Allowed values: on, off
Default value: off

-rnc
Specifies an RNC that the RBS is connected to. By default
no RNC is specified.
Allowed values: A string

-label
Specifies a label for the RBS. Keep it as short as possible
to fit into one row. By default the RBS has no label.
Several RBSs can use the same label.
Allowed values: A string value enclosed in single
quotation marks.

The nbap_common and nbap_dedicated values must match the MO scripts, which in turn must
match the settings in the RNC. If the MO scripts delivered with 3Gsim are used, the supported
FROIds are 1 and 2 for NBAP-Common and 3 and 4 for NBAP-Dedicated in the first RBS, 5 and 6 for
NBAP-Common and 7 and 8 for NBAP-Dedicated in the for the second RBS etc.
All the parameters required to set up NBAP IP communication are given in the node configuration.
This applies to the IP addresses of the IP hosts, the relation from the SCTP host to its IP host and
the IP version to use.
All the parameters required for setting up transport bearers are either set up in the node configuration
or received from the RNC. This applies to the IP address, UDP port, and all parameters for the
internal ATM connection.
The NBAP signaling for handling Radio links contains 64QAM and MIMO information. The
information concerning cells is checked in the RBS so that 64QAM or MIMO is not activated in cells
that are not set up as 64QAM or MIMO capable.
All the parameters required to set up NBAP IP communication are given in the node configuration.
This applies to the IP addresses of the IP hosts, the relation from the SCTP host to its IP host and
the IP version to use.
All the parameters required for setting up transport bearers are either set up in the node configuration
or received from the RNC. This applies to the IP address, UDP port, and all parameters for the
internal ATM connection.
Example:
Create an RBS with 3 cells:
3gsim create rbs -id rbs_1 -processor_unit 002400 -nbap_common 1,2 -nbap_dedicated 3,4 -
sync 1/4 -aesa 991520004301001 -processor_unit_ctc 0024000/1 -cell 30101,30102,30103

enable_log and disable_log


The following log points can be enabled and disabled:
• NBAP_LI
• NBAP_LO
• NBAP_EXC

66
RBS commands

• NBAP_EVENTS
• NBAP (which turns on all the log points in the NBAP protocol)
• MEAS_LI
• MEAS_LO
• MEAS_UO
• MEAS_EXC
• MEAS_EVENTS
• BMC_LI
• BMC_OBS
• BMC_EVENTS
• BMC_EXC
• BMC (turns on all BMC log points)
• all

10.2 Modify RBS


Function:
This command modifies one or all simulated RBSs.
Prerequisites:
The RBSs must have been created with the 3gsim create rbs command.

3gsim mr | modify rbs

-i | -id <RBS ID> | all

{-dpo | -dl_power_offset <value>}

{-dpu | -dl_power_per_ue <value>}

{-dpu_hs | -dl_power_per_ue_hs <value>}

[-el | -enable_log <log point>[,<log point 2>,...] | all]

[-dl | -disable_log <log point>[,<log point 2>,...] | all]

{-c | -cell <local cell ID>[/<RNS cell ID>][,<local cell ID 2>[/


<RNS cell ID 2>],...]}

[-si | -suppress_indication on | off[,on | off,...]]

[-scmc | -sec_cell_mc <local cell ID>[,<local cell ID 2>,...]]

{-scdbmc | -sec_cell_dbmc <local cell ID>[,<local cell ID 2>,...]}

[-rtt | -round_trip_time on | off]

[-cap | -capabilities <capability set>[,<capability set 2>,...]]

[-cb | -cell_behavior <cell behavior>[,<cell behavior 2>,...]]

[-lbl | -label [<description>]]

[-rilbm | -rnc_iurlb_mapping <RNC ID 1>:<Iur loopback RNC ID 1>[/<Iur loopback RNC


ID 2>/...][,<RNC ID 2>:<Iur loopback RNC ID a>[/<Iur
loopback RNC ID b>/...],...]]

67
RBS commands

-id
The identity of one RBS or all.

-dl_power_offset
The transmitted carrier power to report in the common
measurement report when no UE is in the cell.
Unit: %
Allowed values: 0-100
Conditional:
If neither dl_power_offset nor dl_power_per_ue were
set when the RBS was created both have to be set
when the RBS is modified. If both parameters were
set when the RBS was created it is only possible to
modify one of them. This is applicable for both one
RBS and all RBSs.

-dl_power_per_ue
The contribution from each UE in the cell to the carrier
power.
Unit: %
Allowed values: 0-100
Conditional:
If neither dl_power_offset nor dl_power_per_ue were
set when the RBS was created both have to be set
when the RBS is modified. If both parameters were
set when the RBS was created it is possible to modify
just one of them. This is applicable for both one RBS
and all RBSs.

-dl_power_per_ue_hs
The contribution from each HS-UE in the cell to the
carrier power. NBAP periodic common measurement is
described in 3Gsim User's Guide 1553-LZT 123 7595.
Unit: ‰
Allowed values: 0-100
Conditional:
The parameter shall be specified when the RBS is
created, otherwise the periodic measurement is not
started and it is not possible to modify the parameter
afterwards.

-enable_log
Turns on logging for the specified log points or all log
points. If used together with the disable_log parameter the
values are applied as specified from left to right and the
latter overrides the former. Logging can also be activated
per UE with the 3gsim modify ue.
Allowed values: See below

68
RBS commands

-disable_log
Turns off logging for the specified log points or all log
points. If used together with the enable_log parameter the
values are applied as specified from left to right and the
latter overrides the former.
Allowed values: See below

-cell
The local cell ID and, optionally, the RNS cell ID of the
cells in the RBS. The local cell ID must match the ID in the
RNC MO.
Allowed values: 1-24 cells
Conditional:
It is only possible to modify cells for one RBS at
a time. This parameter must be specified when
modifying 64qam, mimo, eul2ms, enhanced L2,
fdpch, fdpch_sf, sec_cell_mc or sec_cell_dbmc.

-suppress_indication
Specifies whether the Resource Status Indication
message is suppressed or not in the cells. Off means that
all changes to the cell capability set are reported to the
RNC. On means that when a change is made to a cell
capability set, the Resource Status Indication message is
suppressed.
Allowed values: on, off. A single value or a list with one
value for each cell in the cell list.
Default value: off

-sec_cell_mc
Specifies which cells that are secondary local cells to
the local cells set by the cell parameter. The list must
have the same number of entries as the cell parameter.
A hyphen (-) indicates that there is no secondary local
cell for the corresponding local cell. If the list of local cell
IDs begins with a hyphen, then the string must be quoted
(single quotes).
Example:
-scmc '-,1,1'
-scmc 3,3,-

For the cells to be Multi Carrier capable, they must use a


cell capability set where Multi Carrier is enabled.
Allowed values: secondary cell IDs or hyphens (-)

-sec_cell_dbmc
Specifies which cells that are secondary local cells to
the local cells set by the cell parameter. The list must
have the same number of entries as the cell parameter.
A hyphen (-) indicates that there is no secondary local

69
RBS commands

cell for the corresponding local cell. If the list of local cell
IDs begins with a hyphen, then the string must be quoted
(single quotes).
Example:
-scdbmc '-,1,1'
-scdbmc 3,3,-

For the cells to be dual-band HSDPA Multi Carrier


capable, they must use a cell capability set where dual-
band HSDPA Multi Carrier is enabled.
Allowed values: secondary cell IDs or hyphens (-)
Conditional:
Do not use in combination with the sec_cell_mc
parameter. If both parameters are used, an exception
will be logged and only Multi Carrier will be reported.

-round_trip_time
Specifies whether the RBS is capable of RTT or not
Allowed values: on, off
Default value: on

-capabilities
Specifies the name of a cell capability set or a list of
names of capability sets. If a single value is given, all
cells in the list of cells use the same capability set. If a list
of values is given, it must contain one capability set for
each cell in the cell list. The first capability set is used for
the first cell in the RBS, se second capability set for the
second cell and so on.

-cell_behavior
Specifies the name of a cell behavior or a list of names
of cell behaviors. If a single value is given, all cells in the
list of cells use the same cell behavior. If a list of values is
given, it must contain one cell behavior for each cell in the
cell list. The first cell behavior is used for the first cell in
the RBS, the second cell behavior for the second cell and
so on.
Allowed values: The name of a predefined or customized
cell behavior of type rbs-cell.

-label
Specifies a description of the RBS. Several RBSs can use
the same label. Using the parameter without value means
that the label is removed.
Allowed values: A string value enclosed in single
quotation marks.

-rnc_iurlb_mapping
Specifies the mapping between RNC IDs and any
connected Iur loopback. All IUR loopback RNC IDs must
be configured when there is at least one IUR loopback in

70
RBS commands

the system. Configuration of multiple RNC IDs is comma


(,) separated. Each RNC ID is followed by a colon (:) and
a slash (/) separated list of Iur loopback RNC IDs.
Allowed values: RNC ID: integer, Iur loopback RNC ID:
integer.

Enable and disable log


The following log points can be enabled and disabled:
• all (turns on or off all logpoints)
• NBAP_LI
• NBAP_LO
• NBAP_EVENTS
• NBAP_EXC
• NPAB (turns on or off all the log points in the NBAP protocol)
• MEAS_LI
• MEAS_LO
• MEAS_EXC
• MEAS_EVENTS
• MEAS (turns on or off all the log points for the common measurement reports)
• BMC_LI
• BMC_OBS
• BMC_EVENTS
• BMC_EXC
• BMC (turns on or off all BMC log points)

10.3 List RBS


Function:
This command lists one or all created RBSs.
Prerequisites:
The RBS must have been created with the 3gsim create rbs command.

3gsim lr | list rbs

[-i | -id <RBS ID> | all]

[-csd | -cell_state_disabled]

[-log]

[-c | -cell <cell>[,<cell 2>,...]]

[-lbl | -label [<description>]]

-id
A unique ID for the RBS to be listed. The value all is also
valid and lists all defined RBSs.
Allowed values: RBS ID or all

71
RBS commands

-cell_state_disabled
Filter option. Selects all RBSs that have one or more cell
IDs with cell state disabled, or that are in status creating.

-log
Lists all active log points.

-cell
Filter option. Selects all RBSs that have one or more of
the specified cell IDs.

-label
Filter option. Selects all RBSs that have the specified
label. The complete name of the label must be specified.
Wildcards are not allowed, only RBSs that exactly match
the label are listed. Using the parameter with no value
means that all RBSs that do not have a label are listed.
Allowed values: A string value enclosed in single
quotation marks.

The following RBS properties are displayed:


ID The ID of the RBS
STATUS The status of the RBS
PU The address of the processor unit where the simulated node executes
and, if a multi core system is used, the program instance
NBAPC The FRO identity for the control plane. In the IP case it is the FRO
identity for the SCTP host and the SCTP port number. If the SCTP FRO
identity is 4 and the port number is 5149, it is displayed as 4:5149. In
the ATM case it is the USAAL CEP FRO identity or identities for the
NBAP common channel.
NBAPD The FRO identity for the control plane. In the IP case it is the FRO
identity for the SCTP host and the SCTP port number. If the SCTP FRO
identity is 4 and the port number is 5149, it is displayed as 4:5149. In
the ATM case it is the USAAL CEP FRO identity or identities for the
NBAP dedicated channel.
CD NBAP status. Consists of 2-6 digits. The two leftmost digits specify the
states of the common and dedicated channels, and the rightmost digits
specify states for NodeSynchTp1 to 4. Possible states are Locked(L),
Disabled(0) and Enabled(1).
DPO The transmitted downlink carrier power, in percent of max power, to
report when no UE is in the cell
DPU The contribution from each UE to the reported downlink power, in
percent of max power
DPU_HS Downlink power per HS-UE
RTT Shows whether the RBS is RTT capable (on) or not (off)
AESA/IP-UP ATM End System Address and IP host FRO ID for the user plane,
separated by a "/". If the RBS supports ATM user plane the AESA
address is shown before the slash(/) If the RBS supports IP user plane
the IP host FRO ID is shown after the slash(/).
RNC_ID The RNC to which the RBS is connected
LABEL The description of the RBS. A hyphen (-) means that the RBS has no
label.

72
RBS commands

LOCAL_CELL_ID The cell ID of the RBS


C-ID RNS unique cell ID
PU The address of the processor unit where the UE stack executes and, if a
multi core system is used, the program instance.
CELL CAP The name of the cell capability set that is used by the cells
BEHAVIOR The name of a predefined or customized cell behavior of type rbs-cell
SC-MC The Multi Carrier capable cells that are secondary local cells to the local
cells
SC-DBMC The dual-band HSDPA Multi Carrier capable cells that are secondary
local cells to the local cells
CELL_STATE Status for the cell consists of 8 digits. The leftmost digit specifies the
state of the cell, digit 2 to 4 specify the states of the common channels
(FACH/RACH/PCH), next two digits specify the states of HSDPA and
EUL and the two rightmost digits specify the states of HS-FACH and
EUL-FACH in the cell. Possible states are Locked(L), Disabled(0) and
Enabled(1).
Example:
These are examples of the contents of the AESA/IP-UP column.
An RBS with ATM user plane only:
49152000430125/-

An RBS with IP user plane only:


-/3

An RBS with Dual stack user plane:


491520004301025/3

10.4 Delete RBS


Function:
This command deletes one or all RBSs from 3Gsim.
Prerequisites:
All UEs in the cells in the RBS must have been deleted with the 3gsim delete ue command.

3gsim delr | delete rbs

-i | -id <RBS ID> | all

-id
The identity of the RBS to be deleted. Use all to delete all
simulated RBSs.
Allowed values: An RBS ID or all

73
LTE RBS commands

11 LTE RBS commands

11.1 Create LTE RBS


Function:
This command creates one LTE RBS.
Prerequisites:
A simulated SGSN node must have been created.

3gsim clr | create lte_rbs

-id <LTE RBS ID>

-mid | -macro_id <number>

-pu | -processor_unit <processor>[/<instance>]

-si | -sgsn_id <SGSN ID>

[-b | -behavior <LTE RBS behavior>]

[-cap | -capabilities <LTE RBS capability set>]

[-c | -cell <LTE cell ID>[,<LTE cell ID 2>,...]]

[-el | -enable_log <log point>[,<log point 2>,...] | all]

[-dl | -disable_log <log point>[,<log point 2>,...] | all]

-id
The name of the LTE RBS to create.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-macro_id
The Macro eNodeB ID to use in the LTE RBS.
Example:
0x1f2e3
Allowed values: 0x <5 digit hexadecimal value>

-processor_unit
Specifies the processor where the LTE RBS executes,
and optionally a program instance (used for multi core
systems).
The specified processor and program instance must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).

74
LTE RBS commands

You can find the processor number and the program


instance number by running the command 3gsim list
installation -process_name tgs_rr_ran_proc and look for
the result displayed in the PU column.
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
Example:
-processor_unit 001400
-processor_unit 001300/6

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

-sgsn_id
The name of the SGSN to be used by the LTE RBS.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-behavior
Specifies which LTE RBS behavior to use.
Allowed values: The name of a predefined or customized
LTE RBS behavior
Default value: lte_rbs_default

-capabilities
Specifies which LTE RBS capability set to use.
Allowed values: The name of a predefined or customized
LTE RBS capability set
Default value: lte_rbs_default

-cell
Specifies a list of LTE cells that belong to the LTE
RBS. The cells are activated immediately. Omitting the
parameter means that no cells are associated to the LTE
RBS.
The cell ID is of the format LTE:<address>. The LTE:
prefix can be omitted.
Example:
-cell 1004, LTE:1003

Allowed values: Integer, optionally with the prefix LTE:

-enable_log
Turns on logging for one, several or all LTE RBS
logpoints. If used together with the disable_log parameter
the values are applied as specified from left to right and
the latter overrides the former.
Allowed values: see below

75
LTE RBS commands

-disable_log
Turns off logging for one, several or all LTE RBS
logpoints. If used together with the enable_log parameter
the values are applied as specified from left to right and
the latter overrides the former.
Allowed values: see below

enable_log and disable_log


Allowed values for enable_log and disable_log:
• all
• LTE_RBS_EXC (exceptions, on by default)
• LTE_RBS_OBS

11.2 Modify LTE RBS


Function:
This command modifies one defined LTE RBS.

3gsim mlr | modify lte_rbs

-id <LTE RBS ID>

[-si | -sgsn_id <SGSN ID>]

[-c | -cell <LTE cell ID>[,<LTE cell ID 2>, ...]]

[-cap | -capabilities <LTE RBS capability set>]

[-ara | -add_rim_association <cell address>]

[-rra | -remove_rim_association <cell address> | all]

[-el | -enable_log <log point>[,<log point 2>,...] | all]

[-dl | -disable_log <log point>[,<log point 2>,...] | all]

-id
Specifies the name of the LTE RBS to modify.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-sgsn_id
The name of the SGSN to be used by the LTE RBS.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-cell
Specifies a list of LTE cells that belong to the LTE RBS.
The list replaces the previous cell list. Added cells are
activated immediately and removed cells are deactivated.
An empty list means that all cells are removed from the
LTE RBS.

76
LTE RBS commands

The cell ID is of the format LTE:<address>. The LTE:


prefix can be omitted.
Example:
-cell 1004, LTE:1003

Allowed values: Integer, optionally with the prefix LTE:

-capabilities
Specifies which LTE RBS capability set to use.
Allowed values: The name of a predefined or customized
LTE RBS capability set
Default value: lte_rbs_default

-add_rim_association
Specifies the cell address of the associated WCDMA cell.
Use the following format:
<LAC>:<RAC>:<RNC ID>:<RIM cell ID>

where LAC is the Location Area Code and RAC is the


Routing Area Code. The RIM cell ID is the local cell ID
(the same as is used in the 3gsim create rbs command).
Example:
3011:1:301:1002
Allowed values: LAC, RAC, RNC ID: As defined in 3GPP
S1AP 36.413 (RIM routing address). RIM cell ID: Integer

-remove_rim_association
Specifies the cell address of the associated WCDMA cell.
Use the following format:
<LAC>:<RAC>:<RNC ID>:<RIM cell ID>

where LAC is the Location Area Code and RAC is the


Routing Area Code. The RIM cell ID is the local cell ID
(the same as is used in the 3gsim create rbs command).
Any of the cell ID components can be replaced by a
wildcard (*).
Example:
3011:1:301:1002
3011:*:301:*
Use the value all to remove all RIM associations for the
specified LTE RBS.
Allowed values: all. LAC, RAC, RNC ID: *, or as defined
in 3GPP S1AP 36.413 (RIM routing address). RIM cell ID:
*, or an integer.

77
LTE RBS commands

-enable_log
Turns on logging for one, several or all LTE RBS
logpoints. If used together with the disable_log parameter
the values are applied as specified from left to right and
the latter overrides the former.
Allowed values: see below

-disable_log
Turns off logging for one, several or all LTE RBS
logpoints. If used together with the enable_log parameter
the values are applied as specified from left to right and
the latter overrides the former.
Allowed values: see below

enable_log and disable_log


Allowed values for enable_log and disable_log:
• all
• LTE_RBS_EXC (exceptions, on by default)
• LTE_RBS_OBS

11.3 List LTE RBS


Function:
This command lists one or all defined LTE RBSs.

3gsim llr | list lte_rbs

[-id <LTE RBS ID> | all]

-id
Specifies an LTE RBS to list. Use all to list all LTE RBSs.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.
Default value: all

The following information is listed:


LTE_RBS_ID The LTE RBS ID
MACRO_ID The macro eNodeB ID
PU Processor unit
SGSN_ID SGSN ID
BEHAVIOR The LTE RBS behavior
CAP The LTE RBS capability set
CELLS The cells associated with the LTE RBS
RIM ASSOCIATIONS The RIM associations for the LTE RBS
Enabled log points The log points that are enabled in this LTE RBS

78
LTE RBS commands

11.4 Delete LTE RBS


Function:
This command deletes one or all defined LTE RBSs.

3gsim dellr | delete lte_rbs

-id <LTE RBS ID> | all

-id
Specifies the LTE RBS to delete. Use all to delete all LTE
RBSs.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _, or all

79
UE commands

12 UE commands

12.1 Create UE
Function:
This command creates one or several simulated UEs.
Prerequisites:
Simulated RBSs must have been created with the 3gsim create rbs command, and the
simulated RBSs must contain cells with cell IDs corresponding to the cell IDs used in the cell
and start_cell parameters. If GSM cells are specified in the cell or start_cell parameter, the
GSM cells must have been created with the 3gsim create gsm_cell command. If LTE cells are
specified in the cell or start_cell parameter, the LTE cells must have been created with the 3gsim
create lte_cell command and activated with the 3gsim create lte_rbs command. If a real Core
Network is used, both the IMSI and the B-number must exist in the HLR; for termination of a CS
call in 3Gsim, the "B UE" must also be created, the IMSI of the "B UE" must correspond to the B-
number used when creating the "A UE", and the "B UEs" must be created before the "A UEs".

3gsim cu | create ue

-i | -imsi <IMSI number>

[-bn | -b_number <IMSI> | <phone number> | <emergency number>]

[-q | -quantity <number of UEs>]

-c | -cell <cell>[,<cell 2>,...] | *[,!<cell>[,!<cell 2>,...]]

[-aac | -additional_allowed_cell <cell>[,<cell 2>,...] | *[,!<cell>[,!<cell 2>,...]]]

[-sc | -start_cell <cId> | <rbsId>:<loc_cId> | <GSM cell ID> | <LTE cell


ID]

[-tb | -traffic_behavior <behavior name>]

{-mb | -mobility_behavior <behavior name>}

[-ub | -ue_behavior <behavior name>]

[-cap | -capabilities <capabilities name>]

[-sg | -statistics_group <Statistics Group 1>[,<Statistics Group 2>,...


<Statistics Group 7>]]

[-el | -enable_log <log point>[,<log point 2>,...] | all]

[-dl | -disable_log <log point>[,<log point 2>,...] | all]

[-ns | -no_start]

80
UE commands

-imsi
The IMSI number of the first UE. If more than one UE is
created (the quantity parameter), the IMSI is increased
with 1 for each created UE, starting with the specified
IMSI.
If you are using MOCN (Multiple Operator Core Network),
the first digits of the IMSI must match the PLMN ID.
Allowed values: 6-15 digits

-b_number
The IMSI or B-number of the called party. If more than
one UE is created (the quantity parameter), the B-number
or IMSI is increased with 1 for each created UE, starting
with <IMSI> or <phone number>.
The format of the b_number parameter depends on
whether a simulated or a real Core Network is used.
Allowed values: For a simulated Core Network: the
IMSI of the called UE. For a real Core Network: the B-
number (linked in the HLR) to the IMSI of the called UEs.
Emergency numbers: 112, 911, 000, 08, 110, 999, 118 or
119.

-quantity
The number of UEs to be created.
Allowed values: 1-1000
Default value: 1

-cell
Specifies one or several cells where the UEs operate. A
cell is specified by any of the following:
<RNS cell ID> An RNS-unique cell ID
<RBS ID>:<local cell The RBS ID and the local cell
ID> ID
<GSM cell ID> A GSM cell ID
<LTE cell ID> An LTE cell ID
GSM cell IDs have the prefix GSM:. LTE cell IDs have the
prefix LTE:.
If more than one cell is used, they must belong to RBSs
that run on the same processor unit.

81
UE commands

The * character means that all cells for all RBSs on the
processor unit running the UE are allowed for the UE to
visit. To exclude a cell, use an exclamation point (!) before
the cell ID. When excluding cells, the cell list must start
with *.
Example:
Allow all cells:
create ue -imsi 123456 -cell *

Exclude the cells 1001 and 1002:


create ue -imsi 123456 -cell *,!1001,!1002

For UEs performing handover, you need to specify


more than one cell. The handovers will be soft or softer
depending on whether the cells are defined in the same or
in different RBSs.
Allowed values: <100 cells

-additional_allowed_cell
Specifies one or more cells that the UE may visit, in
addition to those given by the cell parameter. The cells
are specified by any of the following:
<RNS cell ID> An RNS-unique cell ID
<RBS ID>:<local cell The RBS ID and the local cell
ID>> ID
<GSM cell ID> A GSM cell ID
<LTE cell ID> An LTE cell ID
If more than one cell is used, they must belong to RBSs
that run on the same processor unit.
The * character means that all cells for all RBSs on the
processor unit running the UE are allowed for the UE to
visit. To exclude a cell, use an exclamation point (!) before
the cell ID. When excluding cells, the cell list must start
with *.

-start_cell
The cell where the UEs start in handover simulation.
Allowed values: Any of the values specified in the cell
parameter
Default value: The first cell value in the 'cell' parameter

-traffic_behavior
Specifies which traffic behavior to use for the UEs.
Allowed values: The name of a predefined or customized
traffic behavior of type ue-traffic-classic or ue-traffic-ext-
control.
Default value: int64_20s

82
UE commands

-mobility_behavior
Specifies which mobility behavior to use for the UEs. The
cells_in_sequence behavior requires careful planning of
the cells in the network.
Allowed values: The name of a predefined or customized
mobility behavior of type ue-mobility-cell, or ue-mobility-
ext-control.
Conditional:
A mobility behavior must be specified when creating
handover UEs, that is, when more than one cell is
specified in the cell parameter.

-ue_behavior
Specifies which equipment behavior to use for the UEs.
If not specified, then ue_default is used.
Allowed values: The name of a predefined or customized
behavior of type ue-equipment.

-capabilities
Specifies which UE capability set to use.
Default value: r99

-statistics_group
Specifies a list of statistics groups to which a UE belongs.
Statistics Group is a user defined name of a statistics
group. A statistics group is created if it does not already
exist. A UE can belong to a maximum of seven statistics
groups.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9, and _.

-enable_log
Turns on the logging for one, several or all log points. The
parameter can be used in combination with disable_log.
The values are applied as specified (left-to-right), that is,
the latter overrides the former.
Allowed values: see below

-disable_log
Turns off the logging for one, several or all log points. The
parameter can be used in combination with enable_log.
The values are applied as specified (left-to-right), that is,
the latter overrides the former.
Allowed values: see below

-no_start
Specifies that the UE should not be started when created.
The parameter takes no arguments.

83
UE commands

When a simulated UE is created, signaling traffic and user data traffic for this UE starts immediately
(unless the no_start option is used).
Example:
Create 5 UEs in cell 30101:
3gsim create ue -traffic_behavior int64_infinite -quantity 5 -imsi 235919026003001 -cell
30101

enable_log and disable_log


Allowed values for enable_log and disable_log:
• all
• TB_LI, TB_LO, TB_EVENTS, TB_EXC
• TB (turns on or off all the log points for the traffic behavior)
• NAS_LI, NAS_LO, NAS_EXC, NAS_EVENTS
• NAS (turns on or off all the log points in the NAS protocol)
• RRC_UI, RRC_UO, RRC_LI, RRC_LO, RRC_EVENTS, RRC_EXC, RRC_MON
• RRC (turns on or off all the log points in the RRC protocol)
• RLC_UI, RLC_UO, RLC_LI, RLC_LO, RLC_EXC
• RLC (turns on or off all the log points in the RLC protocol)
• MAC_EXC
• MAC (turns on or off all the log points in the MAC protocol)
• FP_LO, FP_LI (not on common), FP_EXC
• FP (turns on or off all the log points in the FP protocol)
• NBAP_LI, NBAP_LO, NBAP_EXC, NBAP_EVENTS
• NBAP (turns on or off all the log points in the NBAP protocol)
• MEAS_LI, MEAS_LO, MEAS_EXC, MEAS_EVENTS
• MEAS (turns on or off all the log points for the common measurement reports)
• RLP_LI, RLP_LO

12.2 Modify UE
Function:
This command modifies the log settings for all UEs matching at least one value for any specified
filter option. It also specifies the UE report contents for UEs using external control mobility and
traffic behaviors.
Prerequisites:
UEs with the corresponding IMSIs must have been created with the 3gsim create ue command.

3gsim mu | modify ue

[-i | -imsi <IMSI>[-<IMSI>] | all]

[-el | -enable_log <log point>[,<log point 2>,...] | all]

[-dl | -disable_log <log point>[,<log point 2>,...] | all]

[-su | -status <Status>[,<Status 2>,...]]

[-c | -cell <Cell ID>[,<Cell ID 2>,...]]

[-r | -rbs <RBS ID>[,<RBS ID 2>,...]]

84
UE commands

[-b | -behavior <Behavior>[,<Behavior 2>,...]]

[-pu | -processor_unit <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

[-pu_ctc | -processor_unit_ctc <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

[-sg | -statistics_group <Statistics Group 1>[,<Statistics Group 2>,...


<Statistics Group 7>]]

{-trig | -ue_report_trigger no_trigger | * | <condition>}

{-rc | -ue_report_content [all |


[m | MobilityInformation,]
[t | TrafficInformation,]
[c | ConnectionInformation]]}

-imsi
Modifies the UEs with the specified IMSI numbers or all.
Only the last few digits of the last IMSI in the range are
needed.
Example:
imsi 123089-92

gives the range 123089, 123090,123091 and 123092


Allowed values: IMSI number, IMSI range or all

-enable_log
Turns on logging for one or more log points. The
parameter can be used in combination with disable_log.
The values are applied as specified (left-to-right), that is,
the latter overrides the former.
Allowed values: see below

-disable_log
Turns off logging for one or more log points. The
parameter can be used in combination with enable_log.
The values are applied as specified (left-to-right), that is,
the latter overrides the former.
Allowed values: see below

-status
Filter option that specifies one or more statuses to match.
Allowed values: creating, rejected, defined, modifying,
starting, stopped, stopping, deleting, pending, discarded

-cell
Filter option that specifies one or more RNS Cell Ids to
match.
Allowed values: RNS cell IDs

-rbs
Filter option that specifies one or more RBS IDs to match.
Allowed values: RBS IDs

85
UE commands

-behavior
Filter option that specifies one or more mobility or traffic
behaviors to match.
Allowed values: The name of a behavior of type ue-
traffic-classic, ue-traffic-ext-control, ue-mobility-cell or ue-
mobility-ext-control.

-processor_unit
Filter option that specifies one or more processors where
the simulated RBS executes, and optionally program
instances (used for multi core systems).
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
Example:
-processor_unit 0016000/1
-processor_unit 000800,000900/6

The mp option is deprecated. It can still be used for


compatibility reasons.
Allowed values: Processor: a 6-digit or 7-digit number.
Program instance: positive number.

-processor_unit_ctc
Processor Unit Common Transport Channel. Filter option
that specifies one or more processor units where the UE
stack executes, and optionally program instances (used
for multi core systems).
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
The spm and sp options are deprecated. They can still be
used for compatibility reasons.
Example:
-processor_unit_ctc 0011000
-processor_unit_ctc 0011000,0011001,0011002
-processor_unit_ctc 0016000/2,0017001/1

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

86
UE commands

-statistics_group
Modifies the list of statistics groups to which a UE
belongs. Statistics Group is a user defined name of a
statistics group. A statistics group is created if it does not
already exist. A UE can belong to a maximum of seven
statistics groups. A UE is removed from statistics groups
that are not included in the list.
Note:
A UE contributes to increase the value of counters in
the statistics group to which the UE currently belongs.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9, and _.

-ue_report_trigger
Specifies when to print a UE report:
no_trigger UE reports are never printed.
* Every change in mobility,
traffic, and connection
property information triggers
a UE report.
<condition> A logical statement specifies
the conditions for when to
trigger a UE report.
A simple condition uses one of the following formats:
• <property> = <value> | {<value list>}
• <property> contains <value>
Value lists must be surrounded by curly brackets, '{}'. The
contains operator can only be used for single values, not
for lists.
Use and and or to combine simple conditions into more
complex statements. Use brackets, '()', to create nested
conditions.
The following properties are allowed in conditions:
cells Specifies current cell or cells
in the active set. The best
cell is first in the active set.
Allowed values: a cell ID or a
list of cell IDs.
cand_cells Specifies candidate cells,
that is, neighbor cells or cells
in the monitored set. Allowed
values: a cell ID or a list of
cell IDs.
ds_cells Specifies detected set cells.
Allowed values: a cell ID or a
list of cell IDs.
active_meas Specifies active
measurements, either a
single measurement ID or

87
UE commands

a list of measurement IDs.


Allowed values: 1a, 1b, 1c,
1d, 2b, 2d, 2f, 3a, 6b, 6d.
hs_cell Specifies a HS serving cell.
Allowed values: a cell ID.
sec_hs_cells Specifies a secondary HS
serving cell. Allowed values:
a cell ID.
ue_service Specifies a UE service.
Allowed values: see 3Gsim
User's Guide 1553-LZT 123
7595, chapter UE report
information.
conn_prop Specifies connection
properties. Allowed values:
see 3Gsim User's Guide
1553-LZT 123 7595, chapter
UE report information.
qci Specifies Quality of service
Class Identifier for LTE UE
services. Allowed values:
1-9. For description of the
values, see 3Gsim Feature
Description, PSHO from LTE
91/1553-CAL 120 2552.
Example:
-ue_report_trigger no_trigger
-ue_report_trigger *
-ue_report_trigger cells={1001,1002}
-ue_report_trigger cells=1001 and cand_cells
contains 1002
-ue_report_trigger active_meas contains 3a or
cells=GSM:1001
-ue_report_trigger cells=1002 and
(ue_service=int_64_64 or conn_prop contains
{TrafficCh={DchDch}})
-ue_report_trigger hs_cell=4011 or hs_cell=4010
-ue_report_trigger sec_hs_cells=4012
-ue_report_trigger qci={5}

Default value: no_trigger


Conditional:
This parameter is only applicable for UEs using
the ue_traffic_extcontrol or ue_mobility_extcontrol
behaviors.

88
UE commands

-ue_report_content
Specifies the type of information to include in the
UE reports: mobility information, traffic information,
connection information, or a combination of these in a
comma-separated list. Using the parameter with no value
is equal to all.
Example:
-ue_report_content
-ue_report_content all
-ue_report_content
MobilityInformation,TrafficInformation
-ue_report_content c

The UE report printouts have the following format:


UE_REPORT:IMSI=<IMSI number>,RAT=<technology>,
[<mobility information>]
[,<traffic information>][,<connection information>]

Allowed values: all, MobilityInformation,


TrafficInformation, ConnectionInformation, m, t, c
Default value: all
Conditional:
Only UEs with ue_traffic_extcontrol or
ue_mobility_extcontrol behaviors can use this option.

Any UE matching at least one value for any specified filter option is modified.

enable_log and disable_log


Allowed values for enable_log and disable_log:
• all
• TB_LI, TB_LO, TB_EVENTS, TB_EXC
• TB (turns on or off all the log points for the traffic behavior)
• NAS_LI, NAS_LO, NAS_EXC, NAS_EVENTS
• NAS (turns on or off all the log points in the NAS protocol)
• RRC_UI, RRC_UO, RRC_LI, RRC_LO, RRC_EVENTS, RRC_EXC, RRC_MON
• RRC (turns on or off all the log points in the RRC protocol)
• RLC_UI, RLC_UO, RLC_LI, RLC_LO, RLC_EXC
• RLC (turns on or off all the log points in the RLC protocol)
• MAC_EXC
• MAC (turns on or off all the log points in the MAC protocol)
• FP_LO, FP_LI (not on common), FP_EXC
• FP (turns on or off all the log points in the FP protocol)
• NBAP_LI, NBAP_LO, NBAP_EXC, NBAP_EVENTS
• NBAP (turns on or off all the log points in the NBAP protocol)
• MEAS_LI, MEAS_LO, MEAS_EXC, MEAS_EVENTS
• MEAS (turns on or off all the log points for the common measurement reports)
• RLP_LI, RLP_LO

89
UE commands

12.3 List UE
Function:
This command lists information on one or several categories (state, mobility or traffic) about one
or several created UEs.
Prerequisites:
UEs with the corresponding IMSIs must have been created with the 3gsim create ue command.

3gsim lu | list ue

[-i | -imsi <IMSI>-<IMSI> | all]

[-m | -mobility [s | l | ll | h | hs | hl | hll]]

[-t | -traffic [s | l | ll | h | hs | hl | hll]]

[-s | -state [s | l | ll | h | hs | hl | hll | sum]]

[-sn | -session]

[-log]

[-su | -status <status>[,<status 2>,...]]

[-pu | -processor_unit <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

[-pu_ctc | -processor_unit_ctc <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

[-c | -cell <Cell ID>[,<Cell ID 2>,...]]

[-r | -rbs <RBS ID>[,<RBS ID 2>,...]]

[-b | -behavior <behavior>[,<behavior 2>,...]]

{-pf | -print_format table | ue_report}

{-tf | -to_file xml | txt}

{-rc | -ue_report_content [all |


[m | MobilityInformation,]
[t | TrafficInformation,]
[c | ConnectionInformation]]}

{-q | -quantity}

90
UE commands

-imsi
Lists the UEs with the specified IMSI numbers or all UEs.
Only the last few digits of the last IMSI in the range are
needed.
Example:
Specify the range 123089, 123090, 123091 and
123092:
imsi 123089-92

Allowed values: IMSI number, IMSI range or all


Default value: all

-mobility
Lists mobility information, for example visited cells and
performed handovers. The information is printed in table
format.
The use of the values s (short), l (long) and ll (extra long)
controls the amount of information listed:
• s: only the last event is shown (the same result as if
no value is given)
• l: all available history is shown, except timestamps
• ll: all available history is shown, with timestamps
• h: help/information on a category
• hs: short listing with help text
• hl: long listing with help text
• hll: extra long listing with help text
If a help value is given, abbreviation help texts are listed.
Allowed values: s, l, ll, h, hs, hl and hll
Default value: s

-traffic
Lists traffic information, for example sent and received
messages and connection attempts. The information is
printed in table format.
The use of the values s (short), l (long) and ll (extra long)
controls the amount of information listed:
• s: only the last event is shown (the same result as if
no value is given)
• l: all available history is shown, except timestamps
• ll: all available history is shown, with timestamps
• h: help/information on a category
• hs: short listing with help text
• hl: long listing with help text
• hll: extra long listing with help text
If a help value is given, abbreviation help texts are listed.
Allowed values: s, l, ll, h, hs, hl and hll
Default value: s

91
UE commands

-state
Lists the RAB state and its properties, that is, if an EUL
RAB is established with 2 ms TTI or 10 ms TTI. The
information is printed in table format.
The use of the values s (short), l (long), ll (extra long) and
sum (summary) controls the amount of information listed:
• s: only the last event is shown (the same result as if
no value is given)
• l: all available history is shown, except timestamps
• ll: all available history is shown, with timestamps
• h: help/information on a category
• hs: short listing with help text
• hl: long listing with help text
• hll: extra long listing with help text
• sum: number of active UEs per RAB state
If a help value is given, abbreviation help texts are listed.
Allowed values: s, l, ll, h, hs, hl, hll and sum
Default value: s

-session
Lists UE sessions, that is, the source IP addresses with
port numbers, the destination IP addresses with port
numbers, the traffic type (UDP/TCP), the UDP packet rate
and length, the TCP SDU rate and size. The information is
listed in table format.

-log
Lists all active log points for the specified UEs.

-status
Filter option that specifies one or several statuses to
match.
Allowed values: creating, rejected, defined, modifying,
starting, stopped, stopping, deleting, pending, discarded

-processor_unit
Filter option that specifies one or more processors where
the simulated RBS executes, and optionally program
instances (used for multi core systems).
The slot position and the program instance must match
the configuration of the node being used. Slot position and
program instance are separated by a slash (/).
Program instance 1 means a program instance executing
in the first core; program instance 2 means a program
instance executing in the second core.
Example:
-processor_unit 0016000/1
-processor_unit 000800,000900/6

92
UE commands

The mp option is deprecated. It can still be used for


compatibility reasons.
Allowed values: Processor: a 6-digit number. Program
instance: positive number.

-processor_unit_ctc
Processor Unit Common Transport Channel. Filter option
that specifies one or more processor units where the UE
stack executes, and optionally program instances (used
for multi core systems).
The slot position and the program instance must match
the configuration of the node being used. Slot position and
program instance are separated by a slash (/).
Program instance 1 means a program instance executing
in the first core; program instance 2 means a program
instance executing in the second core.
The spm and sp options are deprecated. They can still be
used for compatibility reasons.
Example:
-processor_unit_ctc 0011000
-processor_unit_ctc 0011000,0011001,0011002
-processor_unit_ctc 0016000/2,0017001/1

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

-cell
Filter option that specifies one or several cells to match.
Allowed values: Integer. GSM cells use the prefix GSM:.
LTE cells use the prefix LTE:.

-rbs
Filter option that specifies one or several RBSs to match.
Allowed values: RBS IDs

-behavior
Filter option that specifies one or several behaviors to
match.
Allowed values: Mobility or traffic behaviors

93
UE commands

-print_format
Selects printout format. The default format is table. Use
the value ue_report for UEs using external control traffic
and mobility behaviors. The printout formats are further
described below.
Allowed values: table, ue_report
Default value: table
Conditional:
The ue_report option cannot be used together with
any of the parameters mobility, traffic, state, session
or log.

-to_file
Writes the results to an XML file or a text file. The file
location is /c/3gsim/stats. The naming convention for the
XML file is <date>_<time>_ue_list.xml.gz and for the text
file <date>_<time>_ue_list.txt.gz.
Example:
2012-07-06_10:04:54_ue_list.xml.gz
2012-07-06_10:04:54_ue_list.txt.gz

Allowed values: file name


Default value: The results are written to screen.
Conditional:
This parameter cannot be used together with the
parameter sum for the option state.

-ue_report_content
Specifies the type of information to include in the
UE reports: mobility information, traffic information,
connection information, or a combination of these in a
comma-separated list. Using the parameter with no value
is equal to all.
Details about the contents of the UE reports are found in
3Gsim User's Guide 1553-LZT 123 7595, the UE report
information chapter.
Example:
-ue_report_content
-ue_report_content all
-ue_report_content
MobilityInformation,TrafficInformation
-ue_report_content c

94
UE commands

The UE report printouts have the following format:


UE_REPORT:IMSI=<IMSI number>,RAT=<technology>,
[<mobility information>] [,<traffic information>]
[,<connection information>]

Allowed values: all, MobilityInformation,


TrafficInformation, ConnectionInformation, m, t, c
Default value: all
Conditional:
This parameter is only applicable if print_format is set
to ue_report.

-quantity
Prints the number of existing UEs.
Conditional:
This parameter cannot be used together with any
other parameter.

Filter options
The filter options are inclusive. This means that the parameters specify the information that is shown
in the printout.
The union of the specified filter options is shown in the printout. This means that all UEs matching at
least one value for any of the specified filter options are listed.

Printout formats
UEs can be listed in two formats, as a table and as a UE report. The table format is used by default.
The following basic information is displayed in the table format for the specified UEs if none of the
state, mobility or traffic parameters is used:
• IMSI
• RBS
• Status
• C-Id (cell ID)
• Add.C-Id (additional cell ID)
• Behavior (traffic, mobility, UE)
• BNo (B-number)
• Capabilities
• Statistics group associations
UE reports are structured as follows:
UE_REPORT:IMSI=<IMSI number>, RAT=<technology>,<mobility information>, <traffic
information>,<connection information>

Example:
A UE report containing mobility information. The best cell is first in the active set:
UE_REPORT:IMSI=123456789,RAT=WCDMA,ActiveSet={4010,4011},
MonitoredSet={4012,4009,1009,1026},
DetectedSet={},ActiveMeasurements={1a,1b,1c,1d,2d,2f,6b,6d},
ServingHSCell=4010,SecondaryHSCells={1010}

95
UE commands

12.4 Stop UE
Function:
This command stops one, several or all running UEs.
Prerequisites:
UEs with the corresponding IMSI interval must have been created with the 3gsim create ue
command.

3gsim stou | stop ue

[-i | -imsi <IMSI number>-<IMSI number> | all]

[-su | -status <status>[,<status 2>,...]]

[-c | -cell <Cell ID>[,<Cell ID 2>,...]]

[-r | -rbs <RBS ID>[,<RBS ID 2>,...]]

[-b | -behavior <behavior>[,<behavior 2>,...]]

[-pu | -processor_unit <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

[-pu_ctc | -processor_unit_ctc <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

[-k | -kind complete | fast | hang_up]

-imsi
The IMSI numbers of the UEs to be stopped. Only the
last few digits of the last IMSI in the range are needed. all
stops all simulated UEs.
Example:
Specify the range 123089, 123090, 123091 and
123092:
imsi 123089-92

Allowed values: An IMSI number, an IMSI range or all.


Default value: all

-status
Filter option that specifies one or more statuses to match.
Allowed values: creating, rejected, defined, modifying,
starting, stopped, stopping, deleting, pending, discarded

-cell
Filter option that specifies one or more cell IDs to match.
A cell is specified by either of the following:
<RNS cell ID> An RNS-unique cell ID
<RBS ID>:<local cell The RBS ID and the local cell
ID> ID
<GSM cell ID> A GSM cell ID
<LTE cell ID> An LTE cell ID

96
UE commands

If more than one cell is used, they must belong to RBSs


that run on the same processor unit.
Example:
-cell 1001,1002,1003
-cell GSM:1002
-cell LTE:4001
-cell 1001,GSM:1001,LTE:4001,1002

Allowed values: Integer. GSM cells use the prefix GSM:.


LTE cells use the prefix LTE:.

-rbs
Filter option that specifies one or more RBS IDs to match.
Allowed values: RBS IDs

-behavior
Filter option that specifies one or more mobility or traffic
behaviors to match.
Allowed values: Mobility or traffic behaviors

-processor_unit
Filter option that specifies one or more processors where
the simulated RBS executes, and optionally program
instances (used for multi core systems).
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
Example:
-processor_unit 0016000/1
-processor_unit 000800,000900/6

The mp option is deprecated. It can still be used for


compatibility reasons.
Allowed values: Processor: a 6-digit or 7-digit number.
Program instance: positive number.

-processor_unit_ctc
Processor Unit Common Transport Channel. Filter option
that specifies one or more processors where the UE stack
executes, and optionally program instances (used for multi
core systems).
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).

97
UE commands

Program instance 1 means a program instance that


executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
The spm and sp options are deprecated. They can still be
used for compatibility reasons.
Example:
-processor_unit_ctc 0011000
-processor_unit_ctc 0011000,0011001,0011002
-processor_unit_ctc 0016000/2,0017001/1

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

-kind
Specifies how to stop the selected UEs:
complete stops both the traffic and all other signaling. This
corresponds to hanging up and then removing the battery
from the UEs.
fast stops the UE completely without any signaling. This
corresponds to removing the battery from the UEs. The
fast stop generates less signaling information in the log
files than the other options.
hang_up stops the traffic, but other signaling is left intact.
This corresponds to hanging up and leaving the UEs on.
Allowed values: complete, fast, hang_up
Default value: hang_up

Any UE matching at least one value for any specified filter option is stopped. At least one option is
needed for the command.

12.5 Start UE
Function:
This command starts one or several stopped UEs.
Prerequisites:
UEs with the corresponding IMSI interval must have been created with the 3gsim command. If a
specified UE is running, it will not be affected by this command.

3gsim stau | start ue

[-i | -imsi <IMSI>[-<IMSI>] | all]

[-su | -status <status>[,<status 2>,...]]

[-c | -cell <Cell ID>[,<Cell ID 2>,...]]

[-r | -rbs <RBS ID>[,<RBS ID 2>,...]]

98
UE commands

[-b | -behavior <behavior>[,<behavior 2>,...]]

[-pu | -processor_unit <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

[-pu_ctc | -processor_unit_ctc <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

-imsi
Starts the UEs with the specified IMSI numbers, or all.
Only the last few digits of the last IMSI in the range are
needed.
Example:
Specify the range 123089, 123090, 123091 and
123092:
imsi 123089-92

Allowed values: An IMSI number, an IMSI range or all.

-status
Filter option that specifies one or more statuses to match.
Allowed values: creating, rejected, defined, modifying,
starting, stopped, stopping, deleting, pending, discarded

-cell
Filter option that specifies one or more cell IDs to match.
A cell is specified by either of the following:
<RNS cell ID> An RNS-unique cell ID
<RBS ID>:<local cell The RBS ID and the local cell
ID> ID
<GSM cell ID> A GSM cell ID
<LTE cell ID> An LTE cell ID
If more than one cell is used, they must belong to RBSs
that run on the same processor unit.
Example:
-cell 1001,1002,1003
-cell GSM:1002
-cell LTE:4001
-cell 1001,GSM:1001,LTE:4001,1002

Allowed values: Integer. GSM cells use the prefix GSM:.


LTE cells use the prefix LTE:.

-rbs
Filter option that specifies one or more RBS IDs to match.
Allowed values: RBS IDs

-behavior
Filter option that specifies one or more mobility or traffic
behaviors to match.
Allowed values: Mobility and traffic behaviors

99
UE commands

-processor_unit
Filter option that specifies one or more processors where
the simulated RBS executes, and optionally program
instances (used for multi core systems).
The processor and the program instance must match
the configuration of the node being used. The processor
number and the program instance number are separated
by a slash (/).
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
Example:
-processor_unit 0016000/1
-processor_unit 000800,000900/6

The mp option is deprecated. It can still be used for


compatibility reasons.
Allowed values: Processor: a 6-digit or 7-digit number.
Program instance: positive number.

-processor_unit_ctc
Processor Unit Common Transport Channel. Filter option
that specifies one or more processors where the UE stack
executes, and optionally program instances (used for multi
core systems).
The processor and the program instance must match
the configuration of the node being used. The processor
number and the program instance number are separated
by a slash (/).
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
The spm and sp options are deprecated. They can still be
used for compatibility reasons.
Example:
-processor_unit_ctc 0011000
-processor_unit_ctc 0011000,0011001,0011002
-processor_unit_ctc 0016000/2,0017001/1

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

Any UE matching at least one value for any specified filter option is started.

100
UE commands

When started, the UE will behave according to its traffic behavior, starting from the beginning.
Recommendation:
Do not restart more than 10 UEs at a time. This means that you should use the all option to the
imsi parameter with care. If using it, all UEs tries to establish traffic at the same time, which may
cause resource problems.

12.6 Delete UE
Function:
This command deletes one, several or all simulated UEs.
Prerequisites:
The UEs must have been created with the 3gsim create ue command.

3gsim delu | delete ue

[-i | -imsi <IMSI>[-<IMSI>] | all]

[-su | -status <status>[,<status 2>,...]]

[-c | -cell <Cell ID>[,<Cell ID 2>,...]]

[-r | -rbs <RBS ID>[,<RBS ID 2>,...]]

[-b | -behavior <behavior>[,<behavior 2>,...]]

[-pu | -processor_unit <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

[-pu_ctc | -processor_unit_ctc <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

-imsi
Starts the UEs with the specified IMSI numbers, or all.
Only the last few digits of the last IMSI in the range are
needed.
Example:
Specify the range 123089, 123090, 123091 and
123092:
imsi 123089-92

Allowed values: An IMSI number, an IMSI range or all.

-status
Filter option that specifies one or more statuses to match.
Allowed values: creating, rejected, defined, modifying,
starting, stopped, stopping, deleting, pending, discarded

-cell
Filter option that specifies one or more RNS cell IDs to
match.

-rbs
Filter option that specifies one or more RBS IDs to match.

101
UE commands

-behavior
Filter option that specifies one or more mobility or traffic
behaviors (or both) to match.

-processor_unit
Filter option that specifies one or more processors where
the simulated RBS executes, and optionally program
instances (used for multi core systems).
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
Example:
-processor_unit 0016000/1
-processor_unit 000800,000900/6

The mp option is deprecated. It can still be used for


compatibility reasons.
Allowed values: Processor: a 6-digit or 7-digit number.
Program instance: positive number.

-processor_unit_ctc
Processor Unit Common Transport Channel. Filter option
that specifies one or more processor units where the UE
stack executes, and optionally program instances (used
for multi core systems).
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
The spm option is deprecated. It can still be used for
compatibility reasons.
Example:
-processor_unit_ctc 0011000
-processor_unit_ctc 0011000,0011001,0011002
-processor_unit_ctc 0016000/2,0017001/1

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

If the UEs are not stopped, the command stops them before deleting them.

102
UE commands

Any UE matching at least one value for any specified filter option is deleted.
Recommendation:
When deleting simulated objects in 3Gsim, delete the UEs first, then the RBSs.

12.7 Dump UE
Function:
This command dumps available protocol data for the specified UEs in the trace and error log.
The command is normally used when requested by 3Gsim Customer Support.
Prerequisites:
The UEs must have been created with the 3gsim create ue command.

3gsim duu | dump ue

[-i | -imsi <IMSI>[-<IMSI>] | all]

[-su | -status <status>[,<status 2>,...]]

[-c | -cell <Cell ID>[,<Cell ID 2>,...]]

[-r | -rbs <RBS ID>[,<RBS ID 2>,...]]

[-b | -behavior <behavior>[,<behavior 2>,...]]

[-pu | -processor_unit <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

[-pu_ctc | -processor_unit_ctc <processor>[/<instance>]


[,<processor 2>[/<instance>],...]]

-imsi
The IMSI numbers of the UEs for which you want to
collect trouble-shooting data. Only the last few digits of the
last IMSI in the range are needed.
Example:
Specify the range 123089, 123090, 123091 and
123092:
imsi 123089-92

Allowed values: An IMSI number, an IMSI range or all

-status
Filter option that specifies one or more statuses to match.
Allowed values: creating, rejected, defined, modifying,
starting, stopped, stopping, deleting, pending, discarded

-cell
Filter option that specifies one or more RNS cell IDs to
match.

-rbs
Filter option that specifies one or more RBS IDs to match.

103
UE commands

-behavior
Filter option that specifies one or more mobility or traffic
behaviors (or both) to match.

-processor_unit
Filter option that specifies one or more processors where
the simulated RBS executes, and optionally program
instances (used for multi core systems).
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
Example:
-processor_unit 0016000/1
-processor_unit 000800,000900/6

The mp option is deprecated. It can still be used for


compatibility reasons.
Allowed values: Processor: a 6-digit or 7-digit number.
Program instance: positive number.

-processor_unit_ctc
Processor Unit Common Transport Channel. Filter option
that specifies one or more processor units where the UE
stack executes, and optionally program instances (used
for multi core systems).
The specified processors and program instances must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
The spm and sp options are deprecated. They can still be
used for compatibility reasons.
Example:
-processor_unit_ctc 0011000
-processor_unit_ctc 0011000,0011001,0011002
-processor_unit_ctc 0016000/2,0017001/1

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

Any UE matching at least one value for any specified filter options is dumped.

104
UE commands

12.8 Order UE
Function:
This command controls the mobility, traffic and payload services of simulated UEs.
Prerequisites:
UEs using the ue_traffic_extcontrol traffic behavior or the ue_mobility_extcontrol mobility
behavior or both must exist.

3gsim ou | order ue

-i | -imsi <IMSI>[-<IMSI>] | all

[-c | -cell [<cell ID>[,<cell ID 2>,...]]]

[-brct | -bad_radio_condition_ snr_low_ecno | snr_low_rscp | tx_power_max]


trigger

[-staps | -start_ps_service [tc|traffic_class=<value>,]


[ssd=<value>,]
[qci=<value>,]
[si|signaling_ind=<value>,]
nsapi=<value>
[,lnsapi|linked_nsapi=<value>]
[,protid|protocol_identifier=<value>]
[,port=<value>]
[,apn=<value>]
[,epdgip|external_ps_data_generator_ip=<value>]]

[-stops | -stop_ps_service [td|tear_down=<value>,]


nsapi=<value>]

[-stacs | -start_cs_service [tc|traffic_class=<value>]


[,sk|streaming_kind=<value>]
[,codec=<value>]
[,mulb|max_ul_bitrate=<value>]
[,mdlb|max_dl_bitrate=<value>]]

[-stocs | -stop_cs_service]

[-gmma | -gmm_attach]

[-gmmd | -gmm_detach]

[-mma | -mm_attach]

[-mmd | -mm_detach]

{-psp | -ps_payload '['<nsapi_value>']'


ur|ul_rate=<value>,
us|ul_size=<value>,
ub|ul_bitpattern=<value>,
dr|dl_rate=<value>,
ds|dl_size=<value>,
db|dl_bitpattern=<value>,
pda|packet_dest_addr=<value>}

[-csp | -cs_payload csa|cs_activity=<value>,


csc|cs_cycle=<value>]

105
UE commands

[-csacc | -cs_service_activation_
accept]

[-csrej | -cs_service_activation_
reject]

-imsi
The IMSI number of the UE for which to control the traffic,
mobility or payload services, or a range with the first and
last IMSI numbers. The value all is also valid. Only the last
few digits of the last IMSI in a range are needed.
Example:
Specify the range 123089, 123090, 123091, and
123092:
-imsi 123089-92

Allowed values: 6-15 digit IMSI numbers or all

-cell
Specifies a list of cells with good radio conditions, where
the first (the leftmost) cell is the best cell, the second cell
is the second best, and so on.
When the UE is in CELL_DCH state it is possible to use
the parameter with no value. It means that no cell has
good radio conditions.
A cell is specified by either of the following:
<RNS cell ID> An RNS-unique cell ID
<RBS ID>:<local cell The RBS ID and the local cell
ID> ID
<GSM cell ID> A GSM cell ID
<LTE cell ID> An LTE cell ID
If more than one cell is used, they must belong to RBSs
that run on the same processor unit.
Example:
-cell 1001,1002,1003
-cell GSM:1002
-cell LTE:4001
-cell 1001,GSM:1001,LTE:4001,1002
-cell

Allowed values: Integer. GSM cells use the prefix GSM:.


LTE cells use the prefix LTE:.

-bad_radio_condition_trigger
Specifies the measurement event to use when bad radio
conditions are reported. The ordered condition trigger is
kept in the mobility generator until it is changed by a new
command with a new condition trigger value.
Allowed values: snr_low_ecno, snr_low_rscp,
tx_power_max
Default value: snr_low_rscp

106
UE commands

-start_ps_service
Establishes PS services for the specified UE. For each PS
Service one PDP context is activated for the UE, and as a
result a PS RAB is set up. A value may only occur once in
the list of values. No spaces are allowed.
traffic_class specifies the quality of service of the RAB
to be established. traffic_class is specified in 3GPP TS
24.008. Allowed values: conversational, interactive,
streaming, background. Default value: interactive.
ssd (Source Statistics Descriptor) is a QoS parameter
used when establishing a RAB. ssd is specified in 3GPP
TS 24.008. Allowed values: speech, unknown. Default
value: unknown.
qci specifies the Quality of Service Class Identifier for
LTE UE services. Allowed values: 1-9. Default value:
calculated from traffic_class and ssd. For description of
the values, see 3Gsim Feature Description, PSHO from
LTE 91/1553-CAL 120 2552.
signaling_ind (Signaling Indication) indicates if the RAB
to be established is optimized (1) for signaling or not (0).
signaling_ind is specified in 3GPP TS 24.008. Allowed
values: 0, 1. Default value: 0.
nsapi specifies the Network SAPI (Service Access Point
Identifier) to activate. NSAPI identifies a PDP context.
When a RAB is set up the NSAPI is used as RAB ID.
nsapi is specified in 3GPP TS 24.008. Allowed values:
5-15.
linked_nsapi specifies which NSAPI that holds the NSAPI
value of the PDP context used in the activation of the
primary PDP context when activating a secondary PDP
context to the same address. If not used the value should
be set to 0. linked_nsapi is specified in 3GPP TS 24.008.
Allowed values: 0, 5-15. Default value: 0
protocol_identifier specifies which protocol to use for the
user plane data. protocol_identifier is specified in 3GPP
TS 24.008. Allowed values: udp, tcp, unspecified. Default
value: udp.
port specifies the source port used for user plane data.
This option is ignored if external_ps_data_generator is
specified. Allowed values: 0-65535. Default value: 0.
apn specifies the Access Point Name. Allowed values:
A string with maximum 102 characters. Default value:
"" (empty string).
external_ps_data_generator_ip specifies the IP address
of the external PS data generator on the UE-side that is
assigned to the PDP context which is being activated. The

107
UE commands

IPv6 syntax is described below. IP addresses assigned to


external PS data generators must remain unique within
all UEs in 3Gsim. This option cannot be used for IMSI
ranges, only for a single IMSI. Allowed values: IPv6
address.
Example:
-start_ps_service nsapi=5
-start_ps_service
nsapi=5,protocol_identifier=tcp,port=65000
-start_ps_service nsapi=5,qci=5

-stop_ps_service
Stops PS services for the specified UEs. The PDP
contexts are deactivated, which results in that the
associated PS RABs are released. Each value may only
occur once in the list of values. No spaces are allowed.
tear_down activates (true) or deactivates (false) all
primary and secondary PDP contexts of the given NSAPI.
tear_down is specified in 3GPP TS 24.008. Allowed
values: true, false. Default value: false.
nsapi specifies the Network SAPI (Service Access Point
Identifier) to deactivate. NSAPI identifies a PDP context.
nsapi is specified in 3GPP TS 24.008. Allowed values:
5-15.
tear_down and nsapi are specified in 3GPP TS 24.008.
Example:
-stop_ps_service nsapi=5

-start_cs_service
Establishes a CS service for the specified UEs, meaning
that one CS RAB is set up for each UE. Each value
may only occur once in the list of values. No spaces are
allowed.
traffic_class specifies the quality of service of the RAB
to establish. Allowed values: conv_speech, streaming.
Default value: conv_speech.
streaming_kind specifies how to set up a streaming
service. Allowed values: audio, udi (Unrestricted Digital
Information). Default value: udi.
codec specifies the type of CS traffic that the UE supports.
Allowed values: umts_wb, umts_nb, none. Default value:
umts_wb.
max_ul_bit_rate specifies the maximum uplink bit rate.
Allowed values: 0-65535. Default valaue: 12200. Unit:
bits/s.

108
UE commands

max_dl_bit_rate specifies the maximum downlink bit rate.


Allowed values: 0-65535. Default valaue: 12200. Unit:
bits/s.
Example:
-start_cs_service codec=umts_nb

-stop_cs_service
Stops the CS service for the specified UEs, meaning that
the CS RAB for each UE is released. The parameter takes
no arguments.

-gmm_attach
Attaches the specified UE for GPRS Mobility Management
in the PS domain. The parameter takes no arguments.

-gmm_detach
Detaches the specified UE from the PS domain. The
parameter takes no arguments.

-mm_attach
Attaches the specified UE for Mobility Management in the
CS domain. The parameter takes no arguments.

-mm_detach
Detaches the specified UE from the CS domain. The
parameter takes no arguments.

-ps_payload
Specifies traffic parameters for the activated PS service
for control of the payload for UEs with internal packet data
generators. Each value may only occur once in the list of
values. No spaces are allowed.
nsapi_value specifies the Network SAPI (Service Access
Point Identifier) to activate. NSAPI identifies a PDP
context. It is specified in 3GPP TS 24.008. nsapi_value is
mandatory; the square brackets are part of the syntax and
shall be included. Allowed values: 5-15.
ul_rate specifies the uplink payload data rate for the
specified UE. The value '-' means that the rate is not
considered. Allowed values: 0-65535 or -. Unit: Hz.
ul_size specifies the uplink payload data size for the
specified UE. Allowed values: 0-65535 for TCP and 0,
46-1502 for UDP. Unit: bytes.
ul_bitpattern specifies the representation of the sent user
data. Allowed values: 0-4294967295.
dl_rate specifies the downlink payload data rate for the
specified UE. The value '-' means that the rate is not
considered. Allowed values: 0-65535 or -. Unit: Hz.
dl_size specifies the downlink payload data size for the
specified UE. Allowed values: 0-65535 for TCP and 0,
46-1502 for UDP. Unit: bytes.

109
UE commands

dl_bitpattern specifies the representation of the sent user


data. Allowed values: 0-4294967295.
packet_dest_addr is an IP address or a PDG name.
In both cases the port number can be specified. The
PDG name is the ID given in the command 3gsim create
packet_data_generator. Allowed values: IP address, IP
address with port number, PDG name, or PDG name with
port number. Allowed port numbers: 0-65535. Note: If
User Plane (UP) traffic is running the packet_dest_addr
can only be modified after the PS service is stopped.
When the packet_dest_addr is changed, the PS service
has to be established again using start_ps_service.
Example:
Specify a UE service for int_64_64:
-ps_payload [5]
ul_rate=50,ul_size=70,ul_bitpattern=0,
dl_rate=50,dl_size=70,dl_bitpattern=0,
packet_dest_addr=127.0.0.1:65000

Specify a UE service for int_64_64 without


considering rate:
-ps_payload [5]
ul_rate=-,ul_size=70,ul_bitpattern=0,
dl_rate=-,dl_size=70,dl_bitpattern=0,
packet_dest_addr=127.0.0.1:65000

Conditional:
If a new PS service is set up (using the
start_ps_service parameter), then all ps_payload
values must be specified. If a PS service is running,
then it is possible to modify standalone values.

-cs_payload
Specifies CS traffic parameters. Each value may only
occur once in the list of values. No spaces are allowed.
cs_activity specifies the ratio of speech to silent frames.
Allowed values: 0-100. Unit: percent (%)
cs_cycle specifies the duration of each interval in a
traffic behavior. Allowed values: 100-4294967295. Unit:
milliseconds (ms).
Example:
Specify 10 second cycles with 50% speech, that is,
each cycle starts with speech for 5 seconds and then
silence for 5 seconds.
-cs_payload cs_activity=50,cs_cycle=10000

-cs_service_activation_accept
Specifies that a call that a B-UE receives is answered.

-cs_service_activation_reject
Specifies that a call that a B-UE receives is rejected.

110
UE commands

External PS data generator IP address


Use this syntax to represent IPv6 addresses:
X:X:X:X:X:X:X:X

X is a hexadecimal value of a 16-bit piece of the address.


Example:
Valid IPv6 addresses.
FEDC:BA98:7654:3210:FEDC:BA98:7654:3210
1070:0:0:0:0:800:200C:417B

IPv6 addresses can contain long strings of zero (0) bits. To make it easier to write these addresses,
you can use the double colon characters (::) one time in an address to represent 1 or more 16-bit
groups of zeros.
Example:
Compressing the IPv6 address 1070:0:0:0:0:800:200C:417B by using double colon.
1070::800:200C:417B

111
GSM cell commands

13 GSM cell commands

13.1 Create GSM cell


Function:
This command creates one GSM cell.

3gsim cgc | create gsm_cell

-id <cell name>

-ncc <number>

-bcc <number>

-bcch_arfcn <number>

-id
Specifies the name of the GSM cell. The name must be of
the format GSM:<external GSM cell identity>.
Allowed values: GSM: <decimal number>

-ncc
Specifies the Network Color Code. The value must match
the value of the ncc parameter of the External GSM Cells
defined in the RNC cell configuration.
Allowed values: Integer

-bcc
Specifies the Base station Color Code. The value must
match the value of the bcc parameter of the External GSM
Cells defined in the RNC cell configuration.
Allowed values: Integer

-bcch_arfcn
Specifies the BCCH Absolute Radio Frequency Channel
Number. The value must match the value of the
bcch_arfcn parameter of the External GSM Cells defined
in the RNC cell configuration.
Allowed values: Integer

13.2 List GSM cell


Function:
This command lists one or all defined GSM cells.

3gsim lgc | list gsm_cell

[-i | -id <name> | all]

112
GSM cell commands

-id
Specifies a GSM cell to list. Use all to list all GSM cells.

The following information is listed:


ID The external GSM Cell ID.
NCC The Network Color Code.
BCC The Base station Color Code.
BCCH ARFCN The BCCH Absolute Radio Frequency Channel Number.

113
LTE cell commands

14 LTE cell commands

14.1 Create LTE cell


Function:
This command creates one LTE cell.

3gsim clc | create lte_cell

-id <LTE cell ID>

-dea | -dl_earfcn <number>

-pi | -plmn_id <MCC>-<MNC> | 0x<Hex value>

-tac | -tracking_area_code <TAC>

-lac | -location_area_code <LAC>

-id
Specifies the name of the LTE cell.
The cell ID is of the format LTE:<cell ID>. The LTE: prefix
can be omitted.
Example:
-id 1004
-id LTE:1004

Allowed values: Integer, optionally with the prefix LTE:

-dl_earfcn
Specifies the E-UTRA Absolute Radio Frequency Channel
Number in downlink.
Allowed values: 0-65535

-plmn_id
Specifies the mobile network identity.
Example:
235-19
0x32F591

Allowed values: <MCC> - <MNC> or 0x <6 digit hex


value>

-tracking_area_code
Specifies the Tracking Area Code.
Allowed values: 0-255

-location_area_code
Specifies the Location Area Code for WCDMA cells that
has the same coverage as this LTE cell.
Allowed values: 0-65535

114
LTE cell commands

14.2 Modify LTE cell


Function:
This command modifies one LTE cell.

3gsim mlc | modify lte_cell

-id <LTE cell ID>

[-dea | -dl_earfcn <number>]

-pi | -plmn_id <MCC>-<MNC> | 0x<Hex value>

-tac | -tracking_area_code <TAC>

-lac | -location_area_code <LAC>

[-aur | -add_utran_relation <local cell ID>,[<local cell ID 2>,...]]

[-rur | -remove_utran_relation <local cell ID>,[<local cell ID 2>,...] | all]

-id
Specifies the name of the LTE cell.
The cell ID is of the format LTE:<cell ID>. The LTE: prefix
can be omitted.
Example:
-id 1004
-id LTE:1004

Allowed values: Integer, optionally with the prefix LTE:

-dl_earfcn
Specifies the E-UTRA Absolute Radio Frequency Channel
Number in downlink.
Allowed values: 0-65535

-plmn_id
Specifies the mobile network identity.
Example:
235-19
0x32F591

Allowed values: <MCC> - <MNC> or 0x <6 digit hex


value>

-tracking_area_code
Specifies the Tracking Area Code.
Allowed values: 0-255

-location_area_code
Specifies the Location Area Code for WCDMA cells that
has the same coverage as this LTE cell.
Allowed values: 0-65535

115
LTE cell commands

-add_utran_relation
Specifies one or several UTRAN cell relationships to add.
Allowed values: A local cell ID, a list of local cell IDs or
all.

-remove_utran_relation
Specifies one or several UTRAN cell relationships to
remove. Use all to remove all UTRAN cell relationships.
Allowed values: A local cell ID, a list of local cell IDs or
all.

14.3 List LTE cell


Function:
This command lists one or all defined LTE cells.

3gsim llc | list lte_cell

[-id <LTE cell ID>]

-id
Specifies the id of the LTE cell. Use 'all' to list all LTE
cells.
The cell ID is of the format LTE:<cell ID>. The LTE: prefix
can be omitted.
Example:
-id 1004
-id LTE:1004

Allowed values: Integer, optionally with the prefix LTE:,


or all
Default value: all

The following information is listed:


ID The external LTE cell ID
DL_EARFCN The E-UTRA Absolute Radio Frequency Channel Number in downlink
PLMN_ID The mobile network identity
TAC The Tracking Area Code
LAC The Location Area Code
RELATED_CELLS The UTRAN cells that have relations with the LTE cell
LTE_RBS The LTE RBS which the LTE cell belongs to

14.4 Delete LTE cell


Function:
This command deletes one or all defined LTE cells.

3gsim dellc | delete lte_cell

-id <name> | all

116
LTE cell commands

-id
Specifies an LTE cell to delete. Use all to delete all LTE
cells.
The cell ID is of the format LTE:<cell ID>. The LTE: prefix
can be omitted.
Example:
-id 1004
-id LTE:1004

Allowed values: Integer, optionally with the prefix LTE:,


or all

117
WCDMA cell commands

15 WCDMA cell commands

15.1 Modify WCDMA cell


Function:
This command modifies a WCDMA cell. The command is not symmetrical, that is, if you specify
a list of neighbor cells to one cell, then that will not imply that cell is a neighbor of the of the listed
cells.
Prerequisites:
The cell must have been created with the 3gsim create rbs command. Otherwise the RNS cell ID
is unknown and the 3gsim modify wcdma_cell command will fail because it cannot find the cell.

3gsim mwc | modify wcdma_cell

-id <WCDMA cell ID>

[-nc | -neighbor_cell [<WCDMA cell ID>[,<WCDMA cell ID> ...]]]

-id
Specifies the ID of the WCDMA cell to modify.
A cell is specified by either of the following:
<RNS cell ID> An RNS-unique cell ID
WCDMA:<RNS cell The RNS cell ID may have a
ID> WCDMA prefix
<RBS ID>:<local cell The RBS ID and the local cell
ID> ID
Example:
-id 1004
-id WCDMA:1004
-id iub-1:1004

Allowed values: Integer. Cells may use the prefix


WCDMA:.

-neighbor_cell
Specifies a list of WCDMA cells that can be detected as
neighbors to the modified cell (ANR testing).
If the parameter is omitted, the neighbor cell list will not be
changed.
A cell is specified by either of the following:
<RNS cell ID> An RNS-unique cell ID
WCDMA:<RNS cell The RNS cell ID may have a
ID> WCDMA prefix
<RBS ID>:<local cell The RBS ID and the local cell
ID> ID
To remove all neighbor cell relations, use the parameter
with no argument.

118
WCDMA cell commands

A cell is not allowed to have itself as neighbor. It is not


allowed to specify the same cell twice in the list.
Example:
-neighbor_cell
-neighbor_cell WCDMA:1020,1030,Iub-5:1040

Allowed values: Integer. WCDMA cells may use the


prefix WCDMA:.

15.2 List WCDMA cell


Function:
This command lists one or all WCDMA cells.
Prerequisites:
The cell must have been created with the 3gsim create rbs command. Otherwise the RNS cell ID
is unknown and the 3gsim modify wcdma_cell command will fail because it cannot find the cell.

3gsim lwc | list wcdma_cell

[-id <WCDMA cell ID> | all]

-id
Specifies the ID of the WCDMA cell to list.
<RNS cell ID> An RNS-unique cell ID
WCDMA:<RNS cell The RNS cell ID may have a
ID> WCDMA prefix
<RBS ID>:<local cell The RBS ID and the local cell
ID> ID
Example:
-id 1004
-id WCDMA:1004
-id iub-1:1004
-id all

Allowed values: Integer or all. WCDMA cells may use the


prefix WCDMA:.
Default value: all

The following information is listed:


RBS The RBS that the cell belongs to
LOCAL_CELL_ID The RBS local cell ID for the cell
C-ID RNS unique cell ID
STATUS The status of the simulated cell item
CELL CAP The name of the cell capability set that is used by the cell
BEHAVIOR The name of a predefined or customized cell behavior of type rbs-cell
NEIGHBOR CELLS The list of neighbor cells that are defined for this cell

119
Logging commands

16 Logging commands

16.1 Modify log


Function:
This command modifies log points for one or more UEs or CN subscriptions.
Prerequisites:
UEs with the corresponding IMSI numbers must exist in 3Gsim.

3gsim ml | modify log

-i | -imsi <IMSI>[-<IMSI>] | all

-t | -trace on | off

-lp | -log_point <log point>[,<log point 2>,...] | all

-imsi
A unique IMSI number for the UE or CN subscription to
modify, or a range with first and last IMSI number must be
given. Only the last few digits of the last IMSI in the range
are needed.
Example:
Specify the range 123089, 123090, 123091 and
123092:
imsi 123089-92

Allowed values: IMSI number or all

-trace
Turns the specified log points on or off.
Allowed values: on, off

120
Logging commands

-log_point
Specifies one or several log points or log groups for the
UEs or CN subscriptions. The order in which the trace
values are specified affect the resulting log settings. The
values are applied as specified (left-to-right).
Allowed values: Any log point listed with the 3gsim list
log_points command.

Example:
Logging in one simulated IMSI is turned off for all log points except RRC_UI, which is turned on
again:
3gsim modify log -imsi 235919026003001 -trace off -log_point all -trace on -log_point
RRC_UI

Example:
Logging is turned on in IMSI 123456-1234569 for all log points except RRC_UI and RRC_UO:
3gsim modify log -imsi 123456-123459 -trace on -log_point all -trace off -log_point
RRC_UI, RRC_UO

Recommendation:
Use the value all with care. Avoid turning on all log points in all IMSIs, since this will load the
system heavily, and logging may be lost. (Turning off all logging is no problem.)

16.2 List log points


Function:
This command lists all log points that are available in 3Gsim.

3gsim llp | list log_points

[-g | -group]

[-ma | -matches <search word>]

-group
Lists all log points by groups.

-matches
Lists all trace objects that matches the search word. Both
name and description are matched. The matching is not
case sensitive.

121
Trace commands

17 Trace commands

17.1 List trace objects


Function:
This command lists all trace objects available in 3Gsim.

3gsim lto | list trace_objects

[-l | -long]

[-mo | -module <module name>[,<module name 2>,...] | all]

[-ma | -matches <pattern>]

-long
Lists all trace groups.

-module
Lists all trace objects for the specified modules.
Allowed values: see below
Default value: all

-matches
Lists all log points that matches the pattern. Both name
and description are matched. The matching is not case
sensitive.

If no parameters are specified, all trace objects for all modules are listed. Read more about the trace
groups in the 3Gsim User's Guide 1553/LZT 123 7595.

Trace objects
The following trace objects are listed with the module parameter:
• AAL5_CONN_HDL
• COMMON_PD
• CSSTREAM_CN
• CSSTREAM_UE
• GENERATOR
• L2RCOP
• LOG
• CN_SG
• MSC_XC
• NAS
• PDR
• RBS_SG
• RLC_MAC_FP
• RLP
• RRC
• STAT

122
Trace commands

• UD_ANALYSIS
• UE_BG
• UE_SG
• IPPACGEN
• IPREGI
• SCCP
• PCAP_CO
• SAS_SG
• MEM
• CI
• UD_ANALYSIS_SUP
• RR_RAN
• MBMSUDG
• MBMSLNH
• CN_GMM
• RANAP_CO
• RANAP_CL
• BSSAP_CO
• BSSAP_CL
• CN_MM
• CN_SM
• CN_LCS
• IP_STACK
• IPL
• HLR
• PS_UP_CTRL
• all

123
Statistics commands

18 Statistics commands

18.1 List statistics


Function:
This command lists statistics from one, several or all created objects.
Prerequisites:
A simulated network must have been created. To be able to reset the counters, performance
monitoring must be stopped.

3gsim ls | list statistics

[-ue sum[,reset] |
per_ue[,reset] [-i | -imsi <IMSI range>]] |
per_group[,reset][-id <Statistics Group 1>
[,<Statistics Group 2>,...]]

[-ps_ue sum[,reset] |
per_ue[,reset] [-i | -imsi <IMSI range>]] |
per_group[,reset][-id <Statistics Group 1>
[,<Statistics Group 2>,...]]

[-cs_ue sum[,reset] |
per_ue[,reset] [-i | -imsi <IMSI range>]] |
per_group[,reset][-id <Statistics Group 1>
[,<Statistics Group 2>,...]]

[-rbs sum[,reset] |
per_rbs[,reset] |
per_cell[,reset]]

[-wic sum[,reset]]

[-locator sum[,reset]]

[-sgsn sum[,reset] |
per_subscriber[,reset] [-i | -imsi <IMSI range>]] |
per_ranaplink[,reset]

[-msc sum[,reset] |
per_ranaplink[,reset]]

[-pdg sum[,reset] |
per_subscriber[,reset] [-i | -imsi <IMSI range>]]

[-pcap sum[,reset] | per_node[,reset]]

[-sas sum[,reset] | per_sas[,reset]]

[-pu | -processor_unit [reset]]

[-a | -all sum | per_item]

{-d | -all_defined}

124
Statistics commands

[-co | -counter '<counter string>'[,'<counter string 2>',...]]

{-ra | -reset_all}

{-pm}

[-tf | -to_file xml | txt]

-ue
Lists traffic statistics, both PS and CS, for the specified
UEs.
sum means that the statistics is summed up for all UEs.
per_ue means that both the sum and the statistics for
each individual UE are listed. If you use the imsi option,
the statistics is filtered for the specified IMSIs. For the last
IMSI in a range only the last few digits are needed, see
example below.
Use reset to reset the UE counters for the requested
statistics. If using per_ue,reset the individual counters
are reset while the sum counter continues to accumulate
statistics.
per_group means that statistics for certain statistics
groups are listed. Combine the per_group parameter with
the id parameter to filter the statistics for specific statistics
groups. If the id parameter is not given then all statistics
groups are listed.
If using per_group,reset, the counters included in the
statistics groups are reset.
Allowed values: sum, per_ue, per_group. For imsi: 6-15
digit IMSI number, IMSI range.

-ps_ue
Lists PS traffic statistics for the specified UEs.
sum means that the statistics is summed up for all UEs.
per_ue means that both the sum and the statistics for
each individual UE are listed. If you use the imsi option,
the statistics is filtered for the specified IMSIs. For the last
IMSI in a range only the last few digits are needed, see
example below.
Use reset to reset the UE counters for the requested
statistics. If using per_ue,reset the individual counters
are reset while the sum counter continues to accumulate
statistics.
per_group means that statistics for certain statistics
groups are listed. Combine the per_group parameter with
the id parameter to filter the statistics for specific statistics
groups. If the id parameter is not given then all statistics
groups are listed.

125
Statistics commands

If using per_group,reset, the counters included in the


statistics groups are reset.
Allowed values: sum, per_ue, per_group. For imsi: 6-15
digit IMSI number, IMSI range.

-cs_ue
Lists CS traffic statistics for the specified UEs.
sum means that the statistics is summed up for all UEs.
per_ue means that both the sum and the statistics for
each individual UE are listed. If you use the imsi option,
the statistics is filtered for the specified IMSIs. For the last
IMSI in a range only the last few digits are needed, see
example below.
Use reset to reset the UE counters for the requested
statistics. If using per_ue,reset the individual counters
are reset while the sum counter continues to accumulate
statistics.
per_group means that statistics for certain statistics
groups are listed. Combine the per_group parameter with
the id parameter to filter the statistics for specific statistics
groups. If the id parameter is not given then all statistics
groups are listed.
If using per_group,reset, the counters included in the
statistics groups are reset.
Allowed values: sum, per_ue, per_group. For imsi: 6-15
digit IMSI number, IMSI range.

-rbs
Lists RBS statistics.
sum means that the statistics is summed up for all RBSs.
per_rbs means that statistics for each RBS is listed.
per_cell means that statistics for each cell is listed.
Use reset to reset the RBS counters for the requested
statistics.
Allowed values: sum, per_rbs, per_cell

-wic
Lists WIC statistics.
sum means that the statistics is summed up for all WICs.
Use reset to reset the WIC counters for the requested
statistics.
Allowed values: sum

-locator
Lists Locator statistics.

126
Statistics commands

sum means that the statistics is summed up for all


Locators.
Use reset to reset the Locator counters for the requested
statistics.
Allowed values: sum

-sgsn
Lists SGSN statistics.
sum means that the statistics is summed up for all
SGSNs.
per_subscriber means that statistics for each subscriber is
listed. If you use the imsi option, the statistics is filtered for
the specified IMSIs. For the last IMSI in a range only the
last few digits are needed, see example below.
per_ranaplink means that statistics for each RANAP link
defined for the SGSN is listed.
Use reset to reset the SGSN counters for the requested
statistics.
Allowed values: sum, per_subscriber, per_ranaplink. For
imsi: 6-15 digit IMSI number, IMSI range.

-msc
Lists MSC statistics.
sum means that the statistics is summed up for all MSCs.
per_ranaplink means that statistics for each RANAP link
defined for the MSC is listed.
Use reset to reset the MSC counters for the requested
statistics.
Allowed values: sum, per_ranaplink

-pdg
Lists PDG statistics.
sum means that the statistics is summed up for all PDGs.
per_subscriber means that both the sum and the statistics
for each individual PDG are listed. If you use the imsi
option, the statistics is filtered for the specified IMSIs.
For the last IMSI in a range only the last few digits are
needed, see example below.
Use reset to reset the PDG counters for the requested
statistics. If per_subscriber,reset is used, the individual
counters are reset, while the sum counter continues to
accumulate statistics.
Allowed values: sum, per_subscriber. For imsi: 6-15 digit
IMSI number, IMSI range.

127
Statistics commands

-pcap
Lists PCAP statistics for SAS nodes.
sum means that the PCAP statistics is summed up for all
SAS nodes.
per_node means that the statistics for each SAS node is
listed.
Use reset to reset the PCAP counters for the requested
statistics.
Allowed values: sum, per_node

-sas
Lists SAS statistics for SAS nodes.
sum means that the statistics is summed up for all SAS
nodes.
per_node means that the statistics for each SAS node is
listed.
Use reset to reset the SAS counters for the requested
statistics.
Allowed values: sum, per_sas

-processor_unit
Filter option listing statistics for the processor units (PU).
Use reset to reset the processor unit counters for the
requested statistics.

-all
Lists statistics for all created objects, except for counters
that have not been updated (that is, which have the value
0) which might not be included in the printout.
sum means that the summed up statistics for all counters
is listed.
per_item means that statistics for each active item (for
instance UE, node, cell, subscriber) is listed.
Allowed values: sum, per_item

-all_defined
Displays all counters matching the specified selection,
including counters that have not been updated (that is,
which have the value 0).
Conditional:
At least one other parameter must also be used.

-counter
Includes all counters matching at least one of the counter
strings. Use single quotes (') to denote a string.
Allowed values: comma-separated list of counter strings

128
Statistics commands

-reset_all
Resets all statistics counters in 3Gsim.
Conditional:
This option is prohibited while performance
monitoring is running.

-pm
Lists the specified counters using their PM names instead
of their standard names.
Conditional:
This parameter must be used together with at least
one filter option.

-to_file
Writes the results to an XML file or a text file. The file
location is /c/3gsim/stats. The naming convention for the
XML file is <date>_<time>_statistics.xml.gz and for the
text file <date>_<time>_statistics.txt.gz.
Example:
2012-05-28_13:26:54_statistics.xml.gz
2012-05-28_13:26:54_statistics.txt.gz

Omitting the parameter means that the results are written


to screen.
Allowed values: xml, txt

At least one parameter must be given with the command. All individual statistics counters are
excludable except for Activity cycles and Successful activity cycles. The results are listed on screen
or written to file.
If performance monitoring is on, it is not possible to run the 3gsim list statistics command at all during
the data collection period in the ROP intervals.

IMSI ranges
For the ps_ue, cs_ue, sgsn and pdg parameters you can specify an IMSI number or an IMSI range.
For the last IMSI in a range, only the last few digits are needed.
Example:
Specify the range 123089, 123090, 123091 and 123092:
imsi 123089-92

18.2 Start performance monitoring


Function:
This command starts the performance monitoring. When this command has been specified it is
not possible to give the reset or reset_all option to the 3gsim list statistics command.

3gsim stapm | start performance_monitoring

[-gp | -granularity_period 5 | 15 | 30 | 60]

[-n | -number_of_files <number of files>]

129
Statistics commands

[-p | -filepath <path>]

[-co | -content <Category 1>[,<Category 2>,...]]

-granularity_period
Specifies the period after which a ROP file is written. The
PM counter values are reset after every granularity period.
Unit: minutes
Allowed values: 5, 15, 30 or 60
Default value: 15

-number_of_files
Specifies the maximum number of files to keep. When this
number is exceeded the oldest file is overwritten.
Allowed values: Integer
Default value: 288

-filepath
Specifies the location where the ROP files are stored.
Default value: /c/pm_data

-content
Specifies the statistics categories for which performance
monitoring is started.
All categories, except ps_ue_groups and cs_ue_groups,
are default. All other categories are included as default
values for compatibility reasons.
Allowed values: ps_ue_per_ue | cs_ue_per_ue |
ps_ue_sum | cs_ue_sum | ps_ue_groups | cs_ue_groups
| sgsn_per_subscriber | sgsn_per_ranap_link | sgsn_sum
| msc_per_ranap_link | msc_sum | pdg_per_subscriber
| pdg_sum | rbs_per_rbs | rbs_per_cell | rbs_sum |
wic_sum | locator_sum | pcap_per_node | pcap_sum
| sas_per_node | sas_sum | pu_per_board |
mem_per_board
Default value:
ps_ue_per_ue,cs_ue_per_ue,ps_ue_sum,cs_ue_sum,
sgsn_per_subscriber,sgsn_per_ranap_link,sgsn_sum,
msc_per_ranap_link,msc_sum,pdg_per_subscriber,
pdg_sum,rbs_per_rbs,rbs_per_cell,rbs_sum,
wic_sum, locator_sum,
pcap_per_node,pcap_sum,sas_per_node,sas_sum,
pu_per_board,mem_per_board

130
Statistics commands

18.3 List performance monitoring


Function:
This command lists the current PM settings.

3gsim lpm | list performance_monitoring

The following information is displayed:


• ROP file generation status (on or off)
• Collection interval length
• ROP file storage location
• Number of ROP files to keep before the oldest is overwritten
• Contents of statistics groups included in a ROP-file

18.4 Stop performance monitoring


Function:
This command stops the generation of ROP (Result Output Period) files. The command finishes
successfully also when performance monitoring has not been started.

3gsim stopm | stop performance_monitoring

131
Behavior commands

19 Behavior commands

19.1 List behavior


Function:
This command shows the parameters and values in an existing predefined or customized
behavior, or a list of all existing behaviors.

3gsim lb | list behavior

{-l | -long}

[<behavior name>]

{-all}

-long
Lists the parameters with full explanation.
Conditional:
When used, a behavior name must be specified.

<behavior name>
Lists the parameters for a specified behavior.

-all
Lists the names of all behaviors (without parameters).
Conditional:
Cannot be used together with the any other
parameter.

Running the command without arguments is equal to using the parameter all.
The following information is listed when using the parameter all:
BEHAVIOR The name of the behavior.
TYPE The behavior type.
ORIGIN The name of the behavior it is based upon. If the behavior is a
predefined behavior, this column will contain the text 'predefined'.
LABEL A short text describing the behavior.

19.2 Copy behavior


Function:
This command copies an existing predefined or customized behavior and saves it with a new
name.

3gsim cb | copy behavior

<behavior name>

<name of new behavior>

132
Behavior commands

<behavior name>
The name of the behavior to make a copy of.

<name of new behavior>


The name of the new behavior.

The behavior is available in 3Gsim until the next reboot.


Recommendation:
To save the edited parameter values, use an external editor and save them in a text file.
Example:
3gsim copy behavior int64_20s int64_40s

19.3 Modify behavior


Function:
This command modifies the values in an existing customized behavior.
Prerequisites:
The behavior must have been created with the 3gsim copy behavior command. The predefined
behaviors in 3Gsim cannot be modified.

3gsim mb | modify behavior

<behavior name>

-<parameter name> <new value>

[-<parameter name 2> <new value>]

...

[-<parameter name N> <new value>]

[-label '<text>']

[-description '<text>']

<behavior name>
The name of a customized behavior.

-<parameter name>
Specifies the behavior parameter to modify, and the new
values to assign to the parameter.
Allowed values: Any parameter listed with the 3gsim list
behavior command.

-<parameter name 2>


Specifies the next behavior parameter to modify, and the
new values to assign to the parameter.
Allowed values: Any parameter listed with the 3gsim list
behavior command.

133
Behavior commands

-<parameter name N>


Specifies the last behavior parameter to modify, and the
new values that will be assigned to the parameter.
Allowed values: Any parameter listed with the 3gsim list
behavior command.

-label
Specifies a label for the behavior. Keep it as short as
possible to fit into one row.
Allowed values: A string value enclosed in single
quotation marks.

-description
Specifies a more detailed description of the behavior.
Allowed values: A string value enclosed in single
quotation marks.

The simCN behaviors CC, SM, CN LCS and PCAP cannot be modified while in use. If you modify
a traffic or mobility behavior that is currently being used, it affects all the UEs using this behavior.
The new parameter values are used the next time each value is actually applied. One limitation
regarding modifications of traffic behaviors used by active UEs is that it is not possible to modify the
parameters triggers and rab_states.
Hint:
When you modify the length of the parameter triggers (that is change the number of entries) in
a traffic behavior, all other array parameters are automatically modified accordingly. This means
that you may have to manually edit the automatically generated values in the behavior by using
the command 3gsim modify behavior again.

19.4 Delete behavior


Function:
This command deletes one or all customized behaviors in 3Gsim.

3gsim delb | delete behavior

[<behavior name>]

{-all}

<behavior name>
Specifies a behavior to delete.
Allowed values: behavior name

-all
Deletes all customized behaviors that are not currently
used by any UE.
Conditional:
Cannot be used together with any other parameter.

Neither predefined behaviors nor currently used ones can be deleted. Behaviors created by copying
the deleted behavior are not influenced.

134
UE mobility behaviors

20 UE mobility behaviors

20.1 Single_cell mobility behavior parameters


Function:
UEs using the single_cell mobility behaviors are stationary, that is, they are operating in one cell.

-goto_start_cell_at_disconnect y | yes | n | no

-goto_start_cell_at_disconnect
Specifies whether the UE should return to the start cell
when the call is disconnected.
Allowed values: y, yes, n, no
Predefined value: yes

The predefined single_cell mobility behavior is of the type ue-mobility-cell. It is connected to a UE


with the 3gsim create ue command.
If no mobility behavior is specified for a UE when it is created, it is given the default behavior
single_cell.

20.2 Cells_in_sequence mobility behavior parameters


Function:
The cells_in_sequence mobility behaviors controls the UE mobility. UEs using a
cells_in_sequence mobility behavior perform handover or cell update between a number of
specified cells in a specified order.

{-leg_change_interval <time>[-<time>]}

-goto_start_cell_at_disconnect y | yes | n | no

-ifho_trigger_event 2d_ecno | 2d_rscp | 6d | 3a

-mobility_timer_restart_at_connect y | yes | n | no

-last_cell_condition none | 2d_ecno | 2d_rscp | 6d | 3a

-fach_cell_reselection_interval <time>[-<time>] | -

-ura_cell_reselection_interval <time>[-<time>] | -

-leg_removal_probability <probability 1>[,<probability 2>[,<probability 3>]]

135
UE mobility behaviors

-leg_change_interval
Specifies the time between each addition or removal of a
leg. The value can be given as a specified time or as an
interval.
Unit: milliseconds (ms)
Allowed values: 1000 or more
Predefined value: 60000
Conditional:
This option is overridden if using the parameters
ura_cell_reselection_interval in RAB state URA or
fach_cell_reselection_interval in RAB state FACH.

-goto_start_cell_at_disconnect
Specifies whether the UE should return to the start cell
when the call is disconnected.
Allowed values: y, yes, n, no
Predefined value: no

-ifho_trigger_event
Specifies which event to use to trigger an inter-frequency
handover.
Allowed values: 2d_ecno, 2d_rscp, 6d, 3a
Predefined value: 2d_ecno

-mobility_timer_restart_at_connect
When set to yes this parameter specifies that the mobility
timer controlled by the leg_change_interval parameter is
restarted when the UE goes from idle to connected mode.
When set to no this parameter specifies that the mobility
timer controlling the parameter leg_change_interval
is started when the UE is started and then runs
independently of the UE traffic.
Allowed values: y, yes, n, no
Predefined value: yes

-last_cell_condition
Specifies the radio conditions in the last cell.
none means that 3Gsim works as usual.
2d_ecno and 2d_rscp specify which RRC measurement
report to use.
3a indicates bad quality of the currently used UTRAN
frequency and good quality of the other system.
6d indicates high output power.
When the parameter is set and the UE has reached the
last cell in the cell list and the leg_change_interval has
passed, it will not initiate a soft/softer handover to the
previous cell, but instead send a measurement report of

136
UE mobility behaviors

the type given by the last_cell_condition parameter. When


this cell condition has prevailed for a leg_change_interval,
the normal behavior is resumed and a soft/softer
handover to the previous cell is initiated.
Allowed values: none, 2d_ecno, 2d_rscp, 6d, 3a
Predefined value: none

-fach_cell_reselection_interval
Specifies the time between each cell reselection while the
UE is in state CELL_FACH. The value can be given as a
time value, a time interval or '-', where '-' means that the
parameter is not used. If used, the leg_change_interval
parameter is overridden.
In the predefined cells_in_sequence mobility behavior this
parameter is set to '-'.
Unit: milliseconds (ms)
Allowed values: -, 1000 or more.
Predefined value: -

-ura_cell_reselection_interval
Specifies the time between each cell reselection while the
UE is in state URA_PCH. The value can be given as a
time value, a time interval or '-', where '-' means that the
parameter is not used. If used, the leg_change_interval
parameter is overridden.
Unit: milliseconds (ms)
Allowed values: -, 1000 or more
Predefined value: -

-leg_removal_probability
Specifies the desired probability for decreasing the
number of radio links for a certain active set (AS) size.
The first number is associated with an AS size of 2. The
second number is associated with an AS size of 3, and
the third number is associated with an AS size of 4. The
list must contain at least one value. All non-specified
values are interpreted as 0. If the list contains only 0, this
means that the legacy mobility behavior is active.
Allowed values: 0-100
Predefined value: 0

The predefined cells_in_sequence mobility behavior is of type ue-mobility-cell. It is connected to a


UE with the 3gsim create ue command.

137
UE mobility behaviors

20.3 Random_cells mobility behavior parameters


Function:
The random_cells mobility behaviors controls the UE mobility. UEs using a random_cells
behavior perform handover or cell update between a number of specified cells in random order.

{-leg_change_interval <time>[-<time>]}

-goto_start_cell_at_disconnect y | yes | n | no

-ifho_trigger_event 2d_ecno | 2d_rscp | 6d | 3a

-mobility_timer_restart_at_connect y | yes | n | no

-last_cell_condition none | 2d_ecno | 2d_rscp | 6d | 3a

-ho_type <HO type 1>[,<HO type 2>...[,<HO type 6>]] | -

-ho_ratio <HO ratio 1>[,<HO ratio 2>...[,<HO ratio 6>]]

-inter_rnc_ho_ratio <percentage> | *

-fach_cell_reselection_interval <time>[-<time>] | -

-ura_cell_reselection_interval <time>[-<time>] | -

-resource_balancing_cep_utilization <weight>

-resource_balancing_bandwidth_ <weight>
utilization

-resource_balancing_spm_mobility <weight>

-leg_removal_probability <probability 1>[,<probability 2>[,<probability 3>]]

-leg_change_interval
Specifies the time between each addition or removal
of a leg. The value can be given as a specified time
or as an interval. This option is overridden if using
the parameters ura_cell_reselection_interval or
fach_cell_reselection_interval.
Unit: milliseconds (ms)
Allowed values: 1000 or more
Predefined value: 20000
Conditional:
This option is overridden if using the parameters
ura_cell_reselection_interval in RAB state URA or
fach_cell_reselection_interval in RAB state FACH.

138
UE mobility behaviors

-goto_start_cell_at_disconnect
Specifies whether the UE should return to the start cell
when the call is disconnected.
Allowed values: y, yes, n, no
Predefined value: no

-ifho_trigger_event
Specifies which event to use to trigger an inter-frequency
handover.
Allowed values: 2d_ecno, 2d_rscp, 6d, 3a
Predefined value: 2d_ecno

-mobility_timer_restart_at_connect
When set to yes this parameter specifies that the mobility
timer controlled by the leg_change_interval parameter is
restarted when the UE goes from idle to connected mode.
When set to no this parameter specifies that the mobility
timer controlling the parameter leg_change_interval
is started when the UE is started and then runs
independently of the UE traffic.
Allowed values: y, yes, n, no
Predefined value: yes

-last_cell_condition
Specifies the radio conditions within a cell.
none means that 3Gsim works as usual.
2d_ecno and 2d_rscp specify which RRC measurement
report to use.
3a indicates bad quality of the currently used UTRAN
frequency and good quality of the other system.
6d indicates high output power.
When the parameter is set and the UE has reached the
last cell in the cell list and the leg_change_interval has
passed, it will not initiate a soft/softer handover to the
previous cell, but instead send a measurement report of
the type given by the last_cell_condition parameter. When
this cell condition has prevailed for a leg_change_interval,
the normal behavior is resumed and a soft/softer
handover to the previous cell is initiated.
Allowed values: none, 2d_ecno, 2d_rscp, 6d, 3a
Predefined value: none

-ho_type
Specifies 1 or more handover types to set a desired ratio
for; the ratios are set in the ho_ratio parameter. '-' means
that the parameter is not used and cells are selected
without considering the handover type.

139
UE mobility behaviors

'irat_gsm' is an alias for 'irat_umts_gsm' to maintain


backwards compatibility.
Allowed values: soft, softer, ifho, irat_umts_gsm,
irat_umts_lte, irat_gsm_lte, irat_gsm, -
Predefined value: -

-ho_ratio
Specifies desired percentage of handover types specified
in a ho_type parameter.
If all handover types are specified, the sum of handover
ratio must be 100. The sum of handover ratios must not
exceed 100.
Unit: percent (%)
Allowed values: 0-100
Predefined value: 50

-inter_rnc_ho_ratio
Specifies the desired percentage of inter-RNC handovers.
The value '*' means that any percentage is allowed.
Unit: percent (%)
Allowed values: 0-100, *
Predefined value: *

-fach_cell_reselection_interval
Specifies the time between each cell reselection while the
UE is in state CELL_FACH. The value can be given as a
time value, a time interval or '-', where '-' means that the
parameter is not used. If used, the leg_change_interval
parameter is overridden.
Unit: milliseconds (ms)
Allowed values: 1000 or more.
Predefined value: -

-ura_cell_reselection_interval
Specifies the time between each cell reselection while the
UE is in state URA_PCH. The value can be given as a
time value, a time interval or '-', where '-' means that the
parameter is not used. If used, the leg_change_interval
parameter is overridden.
Unit: milliseconds (ms)
Allowed values: 1000 or more
Predefined value: -

140
UE mobility behaviors

-resource_balancing_cep_utilization
Specifies the weight of CEP in the resource balancing
algorithm. 0 means no probability, that is, resource
balancing is not activated for this evaluation step. 100
means highest probability.
Allowed values: 0-100
Predefined value: 0

-resource_balancing_bandwidth_
utilization Specifies the weight of the bandwidth utilization in the
resource balancing algorithm. 0 means no probability, that
is, resource balancing is not activated for this evaluation
step. 100 means highest probability.
Allowed values: 0-100
Predefined value: 0

-resource_balancing_spm_mobility
Specifies the weight of SPM mobility in the resource
balancing algorithm. 0 means no probability, that is,
resource balancing is not activated for this evaluation
step. 100 means highest probability.
Allowed values: 0-100
Predefined value: 0

-leg_removal_probability
Specifies the desired probability for decreasing the
number of radio links for a certain active set (AS) size.
The first number is associated with an AS size of 2. The
second number is associated with an AS size of 3, and
the third number is associated with an AS size of 4. The
list must contain at least one value. All non-specified
values are interpreted as 0. If the list contains only 0, this
means that the legacy mobility behavior is active.
Allowed values: 0-100
Predefined value: 0

The random_cells mobility behavior is of the type ue-mobility-cell. It is connected to a UE with the
3gsim create ue command.

Resource balancing
The resource balancing function associates a weight to each candidate cell depending on its
resource situation. The weight gives different cells different probabilities in the cell selection
process. The weight 0 means that the cell is the worst candidate and 100 means that the cell is the
best candidate. The resource balancing parameters specify to which extent the evaluation steps
bandwidth usage, CEP and SPM mobility shall be taken into account when calculating cell weights.
When using the parameters, consider the following:
• UEs with high bandwidth requirements may become stuck to a single SPM in a loaded system,
so it may be an idea to keep resource balancing inactive for those.

141
UE mobility behaviors

• The SPM mobility evaluation is binary - either the selected cell is on the same SPM or not. This
means that the evaluation step for SPM mobility is more sensitive than the other two evaluation
steps. The recommendation is therefore to be careful when using this parameter. Using a high
value reduces or even eliminates the effect of the other two parameters.
• If resource_balancing_spm_mobility is set to 100 and there are candidate cells on other SPMs
(but not on the same), the candidates will have their weights reduced to 0 and the cell reselection
will work as if the resource balancing function was disabled.
• Avoid setting all parameters to 100 since this may decrease the weight of all cells to 0 and result
in an inefficient load distribution.

20.4 External control mobility behavior


Function:
The predefined ue_mobility_extcontrol mobility behavior allows manual control of the mobility
services for the UEs using the behavior. The behavior has no parameters.

The ue_mobility_extcontrol mobility behavior is of type ue-mobility-ext-control. It is connected to a UE


with the 3gsim create ue command.

142
UE traffic behaviors

21 UE traffic behaviors

21.1 Classic traffic behavior parameters


Function:
The classic traffic behaviors control the call pattern and the packet, speech and data flow uplink
and downlink for simulated UEs.

-wait_before_start <time>[-<maxtime>]

-activity_cycle_duration <time>

-triggers <triggers>[,<triggers>,...]

-rab_state <RAB state>[,<RAB state 2>,...]

-valid_rab_states <RAB states or RAB state groups> | *[,<RAB states or


RAB state groups>*,...]

-rab_state_counters <counter name>|-[,<counter name>|-,...]

-packet_dest_address <adress>[,<address 2>,...]

-gmm attach | detach | -

-mm attach | detach | -

-sm activate_1 | activate_2 | activate_3 | activate_sec_1


| deactivate_1 | deactivate_2 | deactivate_3 |
deactivate_sec_1 | -

-ul_packet_bitpattern <pattern>[,<pattern 2>,...]

-ul_rlc_sdu_size <size>[,<size 2>,...]

-ul_packet_rate <rate>[-<maxrate>][,<rate 2>[-<maxrate 2>],...]

-ul_tcp_sdu_size <size>[,<size 2>,...]

-ul_tcp_sdu_rate - | <rate>[-<maxrate>][,- | <rate 2>[-<maxrate


2>],...]

-ul_packet_volume <volume>[,<volume 2>,...]

-dl_packet_bitpattern <pattern>[,<pattern 2>,...]

-dl_rlc_sdu_size <size>[,<size 2>,...]

-dl_packet_rate <rate>[-<maxrate>][,<rate 2>[-<maxrate 2>],...]

-dl_tcp_sdu_size <size>[,<size 2>,...]

-dl_tcp_sdu_rate - | <rate>[-<maxrate>][,- | <rate 2>[-<maxrate


2>],...]

143
UE traffic behaviors

-dl_packet_volume <volume>[,<volume 2>,...]

-ps_traffic_type udp | tcp[,udp | tcp,...]

-source_udp_port <port number>

-source_tcp_port <port number>

-ul_packet_bitpattern_2 <pattern>[,<pattern 2>,...]

-ul_rlc_sdu_size_2 <size>[,<size 2>,...]

-ul_packet_rate_2 <rate>[-<maxrate>][,<rate 2>[-<maxrate 2>],...]

-ul_tcp_sdu_size_2 <size>[,<size 2>,...]

-ul_tcp_sdu_rate_2 - | <rate>[-<maxrate>][,- | <rate 2>[-<maxrate


2>],...]

-ul_packet_volume_2 <volume>[,<volume 2>,...]

-dl_packet_bitpattern_2 <pattern>[,<pattern 2>,...]

-dl_rlc_sdu_size_2 <size>[,<size 2>,...]

-dl_packet_rate_2 <rate>[-<maxrate>][,<rate 2>[-<maxrate 2>],...]

-dl_tcp_sdu_size_2 <size>[,<size 2>,...]

-dl_tcp_sdu_rate_2 - | <rate>[-<maxrate>][,- | <rate 2>[-<maxrate


2>],...]

-dl_packet_volume_2 <volume>[,<volume 2>,...]

-ps_traffic_type_2 udp | tcp[,udp | tcp,...]

-source_udp_port_2 <port_number>

-source_tcp_port_2 <port number>

-ul_packet_bitpattern_3 <pattern>[,<pattern 2>,...]

-ul_rlc_sdu_size_3 <size>[,<size 2>,...]

-ul_packet_rate_3 <rate>[-<maxrate>][,<rate 2>[-<maxrate 2>],...]

-ul_tcp_sdu_size_3 <size>[,<size 2>,...]

-ul_tcp_sdu_rate_3 - | <rate>[-<maxrate>][,- | <rate 2>[-<maxrate


2>],...]

-ul_packet_volume_3 <volume>[,<volume 2>,...]

-dl_packet_bitpattern_3 <pattern>[,<pattern 2>,...]

-dl_rlc_sdu_size_3 <size>[,<size 2>,...]

-dl_packet_rate_3 <rate>[-<maxrate>][,<rate 2>[-<maxrate 2>],...]

-dl_tcp_sdu_size_3 <size>[,<size 2>,...]

144
UE traffic behaviors

-dl_tcp_sdu_rate_3 - | <rate>[-<maxrate>][,- | <rate 2>[-<maxrate


2>],...]

-dl_packet_volume_3 <volume>[,<volume 2>,...]

-ps_traffic_type_3 udp | tcp[,udp | tcp,...]

-source_udp_port_3 <port_number>

-source_tcp_port_3 <port number>

-sec_ul_packet_bitpattern <pattern>[,<pattern 2>,...]

-sec_ul_rlc_sdu_size <size>[,<size 2>,...]

-sec_ul_packet_rate <rate>[-<maxrate>][,<rate 2>[-<maxrate 2>],...]

-sec_ul_tcp_sdu_size <size>[,<size 2>,...]

-sec_dl_tcp_sdu_rate - | <rate>[-<maxrate>][,- | <rate 2>[-<maxrate


2>],...]

-sec_dl_packet_bitpattern <pattern>[,<pattern 2>,...]

-sec_dl_rlc_sdu_size <size>[,<size 2>,...]

-sec_dl_packet_rate <rate>[-<maxrate>][,<rate 2>[-<maxrate 2>],...]

-sec_dl_tcp_sdu_size <size>[,<size 2>,...]

-sec_ul_tcp_sdu_rate - | <rate>[-<maxrate>][,- | <rate 2>[-<maxrate


2>],...]

-sec_ps_traffic_type udp | tcp[,udp | tcp,...]

-sec_source_udp_port <port_number>

-sec_source_tcp_port <port number>

-min_dl_ud_ratio - | 1 | 2 | 3 |...| 150

-max_dl_ud_ratio - | 1 | 2 | 3 |...| 150

-min_ul_ud_ratio - | 1 | 2 | 3 |...| 150

{-cs_activity <percentage>[,<percentage 2>,...]}

{-cs_cycle <time>[,<time 2>,...]}

-speech_sample constantFrames | speech_VA100 | AGAM1F01 |


speech_VA58_SNR10dB | speech_10s_50pc

-speech_ver off | pesq

-speech_ver_sample speech_VA100 | speech_10s_50pc | AGAM1F01 |


speech_VA58_SNR10dB

-speech_ver_duration <time>

-speech_mos_threshold <number>

145
UE traffic behaviors

{-speech_rate - | 4_75 | 5_9 | 6_6 | 7_4 | 7_95 | 8_85 | 12_2 |


12_65}

{-valid_speech_rate <rate>[/<rate>/...][,<rate>[/<rate>/...]]}

-apn_1 <label1.label2.label3>

-apn_2 <label1.label2.label3>

-apn_3 <label1.label2.label3>

-max_dl_rate_percentage <number>

-t3212 off | nw

-automatic_pdp_reactivation off | behavior | forced

{-mt_answer_time <time>}

-dropped_call_reconnect_delay <time>

-wait_before_start
Sets the time that the UEs will wait before the behavior
is started, that is before the UEs enters the first interval.
This parameter value is used both for the 3gsim start ue
and the 3gsim create ue commands. It is mandatory for
all UEs. The value is a specified time or an interval. The
UEs are started with a rectangular distribution within the
interval.
Unit: milliseconds (ms)
Allowed values: 1000<

-activity_cycle_duration
Controls the minimum time an activity cycle lasts. The
duration is measured from the start of the behavior. '0'
means that the activity cycle will repeat without delay. A
higher value means that for each activity cycle, the UE
will remain in the last RAB state of the behavior until the
activity_cycle_duration timer expires.
Unit: milliseconds (ms)
Allowed values: 0<
Predefined value: 0

-triggers
Specifies the conditions that make a UE transit to the next
interval in the behavior. The intervals are separated by
comma. Values within an interval are separated by '/'. The
trigger values can be volume triggers, RAB state triggers
or time triggers.
Volume triggers can be separated by '&' (and),
in addition to '/' (or). It is not possible to mix '/'
and '&' in the same behavior interval. Use one

146
UE traffic behaviors

or several values. volume triggers is given as


vdl_1&vdl_2&vdl_3&vul_1&vul_2&vul_3 or vdl_1/vdl_2/
vdl_3/vul_1/vul_2/vul_2.
• vdl_1 is associated with the dl_packet_volume
parameter
• vdl_2 is associated with the dl_packet_volume_2
parameter
• vdl_3 is associated with the dl_packet_volume_3
parameter
• vul_1 is associated with the ul_packet_volume
parameter
• vul_2 is associated with the ul_packet_volume_2
parameter
• vul_3 is associated with the ul_packet_volume_3
parameter
RAB state triggers are any RAB states specified in the
valid_rab_states parameter.
Time triggers are given as a specified time or as an
interval. Unit: milliseconds (ms). Allowed values: 1000<.
Use time triggers - not RAB state triggers - in case of
CN (downlink) initiated URA_PCH upswitch when using
simCN. The time trigger calculates exactly the delay for
when to start the DL data traffic from the PDG.
There is no mechanism in 3Gsim that detects behaviors
where the condition for the trigger does not happen.
Recommendation:
To avoid situations where the UEs get stuck, use time
values along with RAB state triggers.
Allowed values: time triggers (specific time or interval),
RAB state triggers, volume triggers (vul_1, vul_2, vul_3,
vdl_1, vdl_2, vdl_3)

-rab_state
Specifies the RAB states that the UE shall use in the
interval.
There is an alias for all AMR-NB codec modes,
speech_nb, which have the same meaning as
speech_12_2, speech_7_95, speech_5_9 or
speech_4_75. For the parameter rab_state the use of
speech_nb makes the UE try to establish an AMR NB
speech call. For backward compatibility reasons it is
possible to use the value speech_12_2, which has the
same meaning as speech_nb.

147
UE traffic behaviors

Repetitions are allowed using brackets.


Example:
Using brackets to specify the RAB state order state1
state2 state2 state3 state2 state2 state3 state2 state2
state3:
state1,3*(2*(state2),state3)

148
UE traffic behaviors

The 3Gsim User's Guide 1553-LZT 123 7595 contains a


mapping table with all UeRc numbers, RAB states and
parameter names.
Allowed values: idle | 2xint_16_hs | 2xint_64_64
| 2xint_64_128 | 2xint_64_hs | 2xint_128_hs |
2xint_384_hs | 2xint_eul_hs | 3xint_64_64 | 3xint_64_hs
| 3xint_eul_hs | cch | conv64_int8 | conv_64 |
cs_streaming_audio | cs_streaming_udi | int_16_16
| int_16_64 | int_16_hs | int_64_16 | int_64_64 |
int_64_128 | int_64_384 | int_64_hs | int_128_64 |
int_128_128 | int_128_384 | int_128_hs | int_384_64
| int_384_128 | int_384_384 | int_384_hs | int_eul_hs
| int_ura_ura | ps_speech_eul_hs_int_eul_hs |
ps_unknown_eul_hs_int_eul_hs | psstream_16_64 |
psstream_16_128 | psstream_128_16 | psstream_16_hs
| psstream_16_hs_2xint_64_hs | psstream_32_hs |
psstream_128_hs | psstream_128_hs_2xint_64_hs
| speech_4_75 | speech_5_9 | speech_7_95
| speech_12_2 | speech_12_2_2xint_16_hs |
speech_12_2_2xint_64_64 | speech_12_2_2xint_64_hs
| speech_12_2_2xint_128_128 |
speech_12_2_2xint_128_hs | speech_12_2_2xint_384_hs
| speech_12_2_2xint_eul_hs | speech_12_2_3xint_64_64
| speech_12_2_3xint_64_hs | speech_12_2_3xint_eul_hs
| speech_12_2_int_0_0 | speech_12_2_int_64_64 |
speech_12_2_int_64_128 | speech_12_2_int_64_384
| speech_12_2_int_16_hs | speech_12_2_int_64_hs |
speech_12_2_int_128_64 | speech_12_2_int_128_hs
| speech_12_2_int_384_hs | speech_12_2_int_eul_hs
| speech_12_2_pre | speech_12_2_psstream_16_128
| speech_12_2_psstream_16_hs |
speech_12_2_psstream_16_hs_2xint_64_hs
| speech_12_2_psstream_32_hs |
speech_12_2_psstream_128_16 |
speech_12_2_psstream_128_hs |
speech_12_2_psstream_128_hs_2xint_64_hs |
speech_NB_MM_pre | speech_WB_pre | speech_nb
| speech_nb_mm | speech_nb_mm_2xint_16_hs
| speech_nb_mm_2xint_64_64
| speech_nb_mm_2xint_64_hs |
speech_nb_mm_2xint_128_128
| speech_nb_mm_2xint_128_hs
| speech_nb_mm_2xint_384_hs
| speech_nb_mm_2xint_eul_hs
| speech_nb_mm_3xint_64_64
| speech_nb_mm_3xint_64_hs |
speech_nb_mm_3xint_eul_hs | speech_nb_mm_int_0_0 |
speech_nb_mm_int_64_64 | speech_nb_mm_int_64_128
| speech_nb_mm_int_64_384 |

149
UE traffic behaviors

speech_nb_mm_int_16_hs | speech_nb_mm_int_64_hs
| speech_nb_mm_int_128_64
| speech_nb_mm_int_128_hs |
speech_nb_mm_int_384_hs | speech_nb_mm_int_eul_hs
| speech_nb_mm_low_2 | speech_nb_mm_low_2_int_0_0
| speech_nb_mm_low_2_int_eul_hs
| speech_nb_mm_psstream_16_128
| speech_nb_mm_psstream_16_hs |
speech_nb_mm_psstream_16_hs_2xint_64_hs
| speech_nb_mm_psstream_32_hs |
speech_nb_mm_psstream_128_16 |
speech_nb_mm_psstream_128_hs |
speech_nb_mm_psstream_128_hs_2xint_64_hs
| speech_wb | speech_wb_2xint_64_64 |
speech_wb_2xint_eul_hs | speech_wb_int_0_0 |
speech_wb_int_64_64 | speech_wb_int_64_128
| speech_wb_int_16_hs | speech_wb_int_64_hs |
speech_wb_int_128_64 | speech_wb_int_128_hs |
speech_wb_int_384_hs | speech_wb_int_eul_hs |
speech_wb_3xint_eul_hs

-valid_rab_states
Specifies the RAB states that are valid in each interval. All
RAB state transitions and interval transitions are validated
against this parameter. It is possible to specify one or
more RAB states or RAB state groups as valid for each
interval of the behavior. Use '/' as value separator within
an interval and ',' between intervals. A RAB state may not
be specified more than once within the same interval.
The wildcard symbol '*' denotes that any RAB state is
allowed. If multiple counters are to be used with a '*', all
RAB states to be counted must be listed.
Example:
*,idle/cch,int_64_64/cch/*

For the parameters triggers and valid_rab_states the


speech_nb value has the same meaning as speech_12_2,
speech_7_95, speech_5_9 or speech_4_75, that is, it
works as an alias for all AMR-NB codec modes.
Allowed values: RAB state groups, RAB states, *

-rab_state_counters
Specifies statistical counters that will be created and
associated with the valid RAB states. The counter counts
the RAB state a UE is in when exiting an interval. The list
of counters must match the valid_rab_states parameter.
'-' means that no counter is used for the interval. Use '/' as

150
UE traffic behaviors

separator for counters within an interval. More information


about this parameter is available in the 3Gsim User's
Guide 1553-LZT 123 7595.
Allowed values: counter name, -

-packet_dest_address
A traffic behavior can have multiple packet destination
addresses. When more than one packet destination
address is specified and 3Gsim is configured to use the Gi
interface, load sharing between the corresponding PDGs
takes place. In case the Gi interface is not used, the first
value from the list is always used.
For non-EVO nodes the packet destination address is
an IP address or the PDG name. In both cases the port
number can be specified. If not specified, the default port
number 65000 is used.
For EVO nodes the packet destination address must
specify a port number if IP address is used, since several
PDGs can share the same IP address. If using PDG
name, specifying port is optional. If not specified, a default
port number based on the instance number of the PU
used by this PDG will be given (65000 + 2 x instanceNo).
If the provided value is invalid, an exception is logged and
the default value (127.0.0.1:65000) is used. When 3Gsim
is configured to use the Gi interface, it is also checked
whether the specified PDG exists.
The PDG name is the ID given in the command '3gsim
create packet_data_generator'.

151
UE traffic behaviors

When the IP addresses of the PDGs to use for a traffic


behavior are consecutive, the packet_dest_address value
may be given as a range, see the example below.
Example:
One IP address without port number:
10.11.12.13

One IP address with port number:


10.11.12.13:50002

Several IP addresses with interval:


10.11.12.13-15

Several IP addresses with port numbers:


10.11.12.13:50002,10.11.12.14:50003

Alias:
PDG_1,PDG_2

Mixed IP address and alias:


10.11.12.13, PDG_1

Alias with port number:


PDG_1:30000,PDG_2:34000

Allowed values: IP address, IP address with port


number, PDG name or PDG name with port number

-gmm
Specifies whether to perform an attach or a detach in the
PS domain. '-' means that nothing is done.
Allowed values: attach, detach, -

-mm
Specifies whether to perform an attach or a detach in the
CS domain. '-' means that nothing is done.
Allowed values: attach, detach, -

-sm
Specifies which PDP context to activate or deactivate. '-'
automatically activates the PDP context if the RAB state
requires that. Therefore, the value activate_1 has the
same meaning as the value '-'.
• activate_1 activates the first primary PDP context.
• activate_2 activates the second primary PDP context.
• activate_3 activates the third primary PDP context.
• activate_sec_1 activates the first secondary PDP
context.
• deactivate_1 deactivates the first primary PDP
context.
• deactivate_2 deactivates the second primary PDP
context.
• deactivate_3 deactivates the third primary PDP
context.
• deactivate_sec_1 deactivates the first secondary PDP
context.

152
UE traffic behaviors

If a primary PDP context is deactviated, then existing


linked secondary PDP contexts are also deactviated.
Recommendation:
Give the traffic behavior the parameters -rab_state
idle,int_64_64,2xint_64_64,int_64_64,idle -sm
-,activate_1,activate_2,deactivate_2,deactivate_1
It is easier to keep track of which PDP context that is
activated when using the value activate_1 than the
value '-'.
Allowed values: activate_1, activate_2, activate_3,
activate_sec_1, deactivate_1, deactivate_2, deactivate_3,
deactivate_sec_1, -

-ul_packet_bitpattern
Specifies the contents of the uplink packet user data for
the first primary PDP context. The pattern is 1-4 bytes.
Allowed values: hexadecimal values in the range
0x00-0xFFFFFFFF

-ul_rlc_sdu_size
Specifies the size of the uplink user data packets for the
first primary PDP context.
This parameter is for UDP only.
Recommendation:
If 0 is used, then also set ul_packet_rate to 0.
Unit: number of octets
Allowed values: 0, 46-1502

-ul_packet_rate
Specifies the frequency of the uplink packet transmission
for the first primary PDP context. The value can be given
as a fixed single rate or as an interval. Use an interval to
get a random and varying traffic mix, or to vary the traffic
intensity over time.
This parameter is for UDP only.
Recommendation:
The actual frequency may be constrained due to
current RAB state limitations and frequencies above
500 packets/s are not recommended.
Unit: packets per second
Allowed values: 0-65535

-ul_tcp_sdu_size
Specifies the number of bytes to send uplink for the first
primary PDP context.
Unit: bytes
Allowed values: 0-65535

153
UE traffic behaviors

-ul_tcp_sdu_rate
Specifies the frequency of the uplink TCP SDU
transmission for the first primary PDP context.
If specifying a range of values, a random value is used in
every applicable interval. '-' means that no rate is defined.
If no rate is specified, a new TCP SDU is invoked on
the TCP layer as soon as the previous one has been
acknowledged. If a rate is specified, new TCP SDUs are
invoked on the TCP layer with the given rate. If the TCP
send buffer becomes full, the rate will become lower than
specified.
Unit: Hz
Allowed values: 0-65535, -

-ul_packet_volume
Specifies the volume of the uplink packet transmission for
the first primary PDP context. '0' means that data is sent
until a change of interval occurs.
The unit is payload bytes, it does not include UDP/IP
headers. This differ from rlc_sdu_size which includes
headers.
Peer messages (for inband control of downlink PDG) are
not included in the volume.
Unit: payload bytes
Allowed values: 0-4294967295 (2^(32)-1)

-dl_packet_bitpattern
Specifies the contents of the downlink packet user data for
the first primary PDP context. The pattern is 1-4 bytes.
Allowed values: hexadecimal values in the range
0x00-0xFFFFFFFF

-dl_rlc_sdu_size
Specifies the size of the downlink user data packets for
the first primary PDP context.
This parameter is for UDP only.
Recommendation:
If 0 is used, then also set dl_packet_rate to 0.
Unit: number of octets
Allowed values: 0, 46-1502

-dl_packet_rate
Specifies the frequency of the downlink packet
transmission for the first primary PDP context. The value
can be given as a fixed single rate or as an interval. Use
an interval to get a random and varying traffic mix, or to
vary the traffic intensity over time.

154
UE traffic behaviors

This parameter is for UDP only.


Recommendation:
The actual frequency may be constrained due to
current RAB state limitations and frequencies above
500 packets/s are not recommended.
Unit: packets per second
Allowed values: 0-65535

-dl_tcp_sdu_size
The number of bytes to send downlink for the first primary
PDP context.
Allowed values: 0-65535

-dl_tcp_sdu_rate
Specifies the frequency of the downlink TCP SDU
transmission for the first primary PDP context.
If specifying a range of values, a random value is used in
every applicable interval. '-' means that no rate is defined.
If no rate is specified, a new TCP SDU is invoked on
the TCP layer as soon as the previous one has been
acknowledged. If a rate is specified, new TCP SDUs are
invoked on the TCP layer with the given rate. If the TCP
send buffer becomes full, the rate will become lower than
specified.
Unit: Hz
Allowed values: 0-65535, -

-dl_packet_volume
Specifies the volume of the downlink packet transmission
for the first primary PDP context. '0' means that data is
sent until a change of interval occurs.
The unit is payload bytes, it does not include UDP/IP
headers. This differ from rlc_sdu_size which includes
headers.
Peer messages (for inband control of downlink PDG) are
not included in the volume.
Unit: payload bytes
Allowed values: 0-4294967295 (2^(32)-1)

-ps_traffic_type
Specifies the type of PS traffic for the first primary PDP
context.
Allowed values: udp, tcp

-source_udp_port
Specifies the source UDP port number for a UE in the first
primary PDP context. Using this parameter is optional.
3Gsim can handle any value.

155
UE traffic behaviors

This parameter is for UDP only.


Allowed values: integer

-source_tcp_port
Specifies the source TCP port number for a UE in the first
primary PDP context.
Allowed values: 1-65535

-ul_packet_bitpattern_2
Specifies the contents of the uplink packet user data for
the second primary PDP context. The pattern is 1-4 bytes.
Allowed values: hexadecimal values in the range
0x00-0xFFFFFFFF

-ul_rlc_sdu_size_2
Specifies the size of the uplink user data packets for the
second primary PDP context.
This parameter is for UDP only.
Recommendation:
If 0 is used, then also set ul_packet_rate_2 to 0.
Unit: number of octets
Allowed values: 0, 46-1502

-ul_packet_rate_2
Specifies the frequency of the uplink packet transmission
for the second primary PDP context. The value can be
given as a fixed single rate or as an interval. Use an
interval to get a random and varying traffic mix, or to vary
the traffic intensity over time.
This parameter is for UDP only.
Recommendation:
The actual frequency may be constrained due to
current RAB state limitations and frequencies above
500 packets/s are not recommended.
Unit: packets per second
Allowed values: 0-65535

-ul_tcp_sdu_size_2
Specifies the number of bytes to send uplink for the
second primary PDP context.
Unit: bytes
Allowed values: 0-65535

-ul_tcp_sdu_rate_2
Specifies the frequency of the uplink TCP SDU
transmission for the second primary PDP context.
If specifying a range of values, a random value is used in
every applicable interval. '-' means that no rate is defined.

156
UE traffic behaviors

If no rate is specified, a new TCP SDU is invoked on


the TCP layer as soon as the previous one has been
acknowledged. If a rate is specified, new TCP SDUs are
invoked on the TCP layer with the given rate. If the TCP
send buffer becomes full, the rate will become lower than
specified.
Unit: Hz
Allowed values: 0-65535, -

-ul_packet_volume_2
Specifies the volume of the uplink packet transmission for
the second primary PDP context. '0' means that data is
sent until a change of interval occurs.
The unit is payload bytes, it does not include UDP/IP
headers. This differ from rlc_sdu_size which includes
headers.
Peer messages (for inband control of downlink PDG) are
not included in the volume.
Unit: payload bytes
Allowed values: 0-4294967295 (2^(32)-1)

-dl_packet_bitpattern_2
Specifies the contents of the downlink packet user data for
the second primary PDP context. The pattern is 1-4 bytes.
Allowed values: hexadecimal values in the range
0x00-0xFFFFFFFF

-dl_rlc_sdu_size_2
Specifies the size of the downlink user data packets for
the second primary PDP context.
This parameter is for UDP only.
Recommendation:
If 0 is used, then also set dl_packet_rate_2 to 0.
Unit: number of octets
Allowed values: 0, 46-1502

-dl_packet_rate_2
Specifies the frequency of the downlink packet
transmission for the second primary PDP context. The
value can be given as a fixed single rate or as an interval.
Use an interval to get a random and varying traffic mix, or
to vary the traffic intensity over time.

157
UE traffic behaviors

This parameter is for UDP only.


Recommendation:
The actual frequency may be constrained due to
current RAB state limitations and frequencies above
500 packets/s are not recommended.
Unit: packets per second
Allowed values: 0-65535

-dl_tcp_sdu_size_2
Specifies the number of bytes to send downlink for the
second primary PDP context.
Unit: bytes
Allowed values: 0-65535

-dl_tcp_sdu_rate_2
Specifies the frequency of the downlink TCP SDU
transmission for the second primary PDP context.
If specifying a range of values, a random value is used in
every applicable interval. '-' means that no rate is defined.
If no rate is specified, a new TCP SDU is invoked on
the TCP layer as soon as the previous one has been
acknowledged. If a rate is specified, new TCP SDUs are
invoked on the TCP layer with the given rate. If the TCP
send buffer becomes full, the rate will become lower than
specified.
Unit: Hz
Allowed values: 0-65535, -

-dl_packet_volume_2
Specifies the volume of the downlink packet transmission
for the second primary PDP context. '0' means that data is
sent until a change of interval occurs.
The unit is payload bytes, it does not include UDP/IP
headers. This differ from rlc_sdu_size which includes
headers.
Peer messages (for inband control of downlink PDG) are
not included in the volume.
Unit: payload bytes
Allowed values: 0-4294967295 (2^(32)-1)

-ps_traffic_type_2
Specifies the type of PS traffic for the second primary
PDP context.
Allowed values: udp, tcp

-source_udp_port_2
Specifies the source UDP port number for a UE in the
second primary PDP context.

158
UE traffic behaviors

This parameter is for UDP only.


Allowed values: integer

-source_tcp_port_2
Specifies the source TCP port number for a UE in the
second primary PDP context.
Allowed values: 1-65535

-ul_packet_bitpattern_3
Specifies the contents of the uplink packet user data for
the third primary PDP context. The pattern is 1-4 bytes.
Allowed values: hexadecimal values in the range
0x00-0xFFFFFFFF

-ul_rlc_sdu_size_3
Specifies the size of the uplink user data packets for the
third primary PDP context.
This parameter is for UDP only.
Recommendation:
If 0 is used, then also set ul_packet_rate_3 to 0.
Unit: number of octets
Allowed values: 0, 46-1502

-ul_packet_rate_3
Specifies the frequency of the uplink packet transmission
for the third primary PDP context. The value can be given
as a fixed single rate or as an interval. Use an interval to
get a random and varying traffic mix, or to vary the traffic
intensity over time.
This parameter is for UDP only.
Recommendation:
The actual frequency may be constrained due to
current RAB state limitations and frequencies above
500 packets/s are not recommended.
Unit: packets per second
Allowed values: 0-65535

-ul_tcp_sdu_size_3
Specifies the number of bytes to send uplink for the third
primary PDP context.
Unit: bytes
Allowed values: 0-65535

-ul_tcp_sdu_rate_3
Specifies the frequency of the uplink TCP SDU
transmission for the third primary PDP context.
If specifying a range of values, a random value is used in
every applicable interval. '-' means that no rate is defined.

159
UE traffic behaviors

If no rate is specified, a new TCP SDU is invoked on


the TCP layer as soon as the previous one has been
acknowledged. If a rate is specified, new TCP SDUs are
invoked on the TCP layer with the given rate. If the TCP
send buffer becomes full, the rate will become lower than
specified.
Unit: Hz
Allowed values: 0-65535, -

-ul_packet_volume_3
Specifies the volume of the uplink packet transmission for
the third primary PDP context. '0' means that data is sent
until a change of interval occurs.
The unit is payload bytes, it does not include UDP/IP
headers. This differ from rlc_sdu_size which includes
headers.
Peer messages (for inband control of downlink PDG) are
not included in the volume.
Unit: payload bytes
Allowed values: 0-4294967295 (2^(32)-1)

-dl_packet_bitpattern_3
Specifies the contents of the downlink packet user data for
the third primary PDP context. The pattern is 1-4 bytes.
Allowed values: hexadecimal values in the range
0x00-0xFFFFFFFF

-dl_rlc_sdu_size_3
Specifies the size of the downlink user data packets for
the third primary PDP context.
This parameter is for UDP only.
Recommendation:
If 0 is used, then also set dl_packet_rate_3 to 0.
Unit: number of octets
Allowed values: 0, 46-1502

-dl_packet_rate_3
Specifies the frequency of the downlink packet
transmission for the third primary PDP context. The value
can be given as a fixed single rate or as an interval. Use
an interval to get a random and varying traffic mix, or to
vary the traffic intensity over time.

160
UE traffic behaviors

This parameter is for UDP only.


Recommendation:
The actual frequency may be constrained due to
current RAB state limitations and frequencies above
500 packets/s are not recommended.
Unit: packets per second
Allowed values: 0-65535

-dl_tcp_sdu_size_3
Specifies the number of bytes to send downlink for the
third primary PDP context.
Unit: bytes
Allowed values: 0-65535

-dl_tcp_sdu_rate_3
Specifies the frequency of the downlink TCP SDU
transmission for the third primary PDP context.
If specifying a range of values, a random value is used in
every applicable interval. '-' means that no rate is defined.
If no rate is specified, a new TCP SDU is invoked on
the TCP layer as soon as the previous one has been
acknowledged. If a rate is specified, new TCP SDUs are
invoked on the TCP layer with the given rate. If the TCP
send buffer becomes full, the rate will become lower than
specified.
Unit: Hz
Allowed values: 0-65535, -

-dl_packet_volume_3
Specifies the volume of the downlink packet transmission
for the third primary PDP context. '0' means that data is
sent until a change of interval occurs.
The unit is payload bytes, it does not include UDP/IP
headers. This differ from rlc_sdu_size which includes
headers.
Peer messages (for inband control of downlink PDG) are
not included in the volume.
Unit: payload bytes
Allowed values: 0-4294967295 (2^(32)-1)

-ps_traffic_type_3
Specifies the type of PS traffic for the third primary PDP
context.
Allowed values: udp, tcp

-source_udp_port_3
Specifies the source UDP port number for a UE in the
third primary PDP context.

161
UE traffic behaviors

This parameter is for UDP only.


Allowed values: integer

-source_tcp_port_3
Specifies the source TCP port number for a UE in the
second primary PDP context.
Allowed values: 1-65535

-sec_ul_packet_bitpattern
Specifies the contents of the uplink packet user data for
the secondary PDP context. The pattern is 1-4 bytes.
Allowed values: hexadecimal values in the range
0x00-0xFFFFFFFF

-sec_ul_rlc_sdu_size
Specifies the size of the uplink user data packets for the
secondary PDP context.
This parameter is for UDP only.
Recommendation:
If 0 is used, then also set sec_ul_packet_rate to 0.
Unit: number of octets
Allowed values: 0, 46-1502

-sec_ul_packet_rate
Specifies the frequency of the uplink packet transmission
for the secondary PDP context. The value can be given
as a fixed single rate or as an interval. Use an interval to
get a random and varying traffic mix, or to vary the traffic
intensity over time.
This parameter is for UDP only.
Recommendation:
The actual frequency may be constrained due to
current RAB state limitations and frequencies above
500 packets/s are not recommended.
Unit: packets per second
Allowed values: 0-65535

-sec_ul_tcp_sdu_size
Specifies the number of bytes to send uplink for the
secondary PDP context.
Unit: bytes
Allowed values: 0-65535

-sec_dl_tcp_sdu_rate
Specifies the frequency of the downlink TCP SDU
transmission for the secondary PDP context.
If specifying a range of values, a random value is used in
every applicable interval. '-' means that no rate is defined.

162
UE traffic behaviors

If no rate is specified, a new TCP SDU is invoked on


the TCP layer as soon as the previous one has been
acknowledged. If a rate is specified, new TCP SDUs are
invoked on the TCP layer with the given rate. If the TCP
send buffer becomes full, the rate will become lower than
specified.
Unit: Hz
Allowed values: 0-65535, -

-sec_dl_packet_bitpattern
Specifies the contents of the downlink packet user data for
the secondary PDP context. The pattern is 1-4 bytes.
Allowed values: hexadecimal values in the range
0x00-0xFFFFFFFF

-sec_dl_rlc_sdu_size
Specifies the size of the downlink user data packets for
the secondary PDP context.
This parameter is for UDP only.
Recommendation:
If 0 is used, then also set sec_dl_packet_rate to 0.
Unit: number of octets
Allowed values: 0, 46-1502

-sec_dl_packet_rate
Specifies the frequency of the downlink packet
transmission for the secondary PDP context. The value
can be given as a fixed single rate or as an interval. Use
an interval to get a random and varying traffic mix, or to
vary the traffic intensity over time.
This parameter is for UDP only.
Recommendation:
The actual frequency may be constrained due to
current RAB state limitations and frequencies above
500 packets/s are not recommended.
Unit: packets per second
Allowed values: 0-65535

-sec_dl_tcp_sdu_size
Specifies the number of bytes to send downlink for the
secondary PDP context.
Unit: bytes
Allowed values: 0-65535

-sec_ul_tcp_sdu_rate
Specifies the frequency of the uplink TCP SDU
transmission for the secondary PDP context.

163
UE traffic behaviors

If specifying a range of values, a random value is used in


every applicable interval. '-' means that no rate is defined.
If no rate is specified, a new TCP SDU is invoked on
the TCP layer as soon as the previous one has been
acknowledged. If a rate is specified, new TCP SDUs are
invoked on the TCP layer with the given rate. If the TCP
send buffer becomes full, the rate will become lower than
specified.
Unit: Hz
Allowed values: 0-65535, -

-sec_ps_traffic_type
Specifies the type of PS traffic for the secondary PDP
context.
Allowed values: udp, tcp

-sec_source_udp_port
Specifies the source UDP port number for a UE in the
secondary PDP context.
This parameter is for UDP only.
Allowed values: integer

-sec_source_tcp_port
Specifies the source TCP port number for a UE in the
secondary PDP context.
Allowed values: 1-65535

-min_dl_ud_ratio
Specifies the minimum DL user data ratio. Use '-' to switch
off this check. With the min_dl_ud_ratio, max_dl_ud_ratio
and the min_ul_ud_ratio parameters it is possible to find
out if the user data troughput is enough in 3Gsim, and it is
also possible to verify that the right RAB state is reached.
The calculated ratio for DL can be larger than 100%
because of the delay of the peer messages that are used
to control the user data generation in DL. The calculated
ratio is the quotient of the actual and the theoretical
(calculated from user data amount in the behavior) UL/
DL value. If any calculated ratio, UL or DL, for an activity
cycle is outside the limits, defined by these parameters,
the activity cycle is counted as failed and an exception is
generated.
Unit: percent (%)
Allowed values: 0-150, -

-max_dl_ud_ratio
Specifies the maximum DL user data ratio. Use '-'
to switch off this check. With the min_dl_ud_ratio,
max_dl_ud_ratio and the min_ul_ud_ratio parameters it is
possible to find out if the user data troughput is enough in

164
UE traffic behaviors

3Gsim, and it is also possible to verify that the right RAB


state is reached. The calculated ratio for DL can be larger
than 100% because of the delay of the peer messages
that are used to control the user data generation in DL.
The calculated ratio is the quotient of the actual and
the theoretical (calculated from user data amount in the
behavior) UL/DL value. If any calculated ratio, UL or DL,
for an activity cycle is outside the limits, defined by these
parameters, the activity cycle is counted as failed and an
exception is generated.
Unit: percent (%)
Allowed values: 0-150, -

-min_ul_ud_ratio
Specifies the minimum UL user data ratio. Use '-' to switch
off this check. With the min_dl_ud_ratio, max_dl_ud_ratio
and min_ul_ud_ratio parameters it is possible to find out if
the user data troughput is enough in 3Gsim, and it is also
possible to verify that the right RAB state is reached. The
calculated ratio for DL can be larger than 100% because
of the delay of the peer messages that are used to control
the user data generation in DL. The calculated ratio is the
quotient of the actual and the theoretical (calculated from
user data amount in the behavior) UL/DL value. If any
calculated ratio, UL or DL, for an activity cycle is outside
the limits, defined by these parameters, the activity cycle
is counted as failed and an exception is generated.
Unit: percent (%)
Allowed values: 0-150, -

-cs_activity
Specifies the percentage of speech or data during a CS
cycle.
Unit: percent (%)
Allowed values: 0-100
Conditional:
This parameter is only used if speech_sample is set
to constant_frames.

-cs_cycle
Specifies the duration of one CS cycle. A CS cycle
consists of one flow of speech or data frames followed by
one flow of SIDs (silence indicators).
Unit: milliseconds (ms)
Allowed values: 100<
Conditional:
This parameter is only used if speech_sample is set
to constant_frames.

165
UE traffic behaviors

-speech_sample
Specifies the name of the speech sample to be used, that
is, sent from the UEs.
Allowed values: constantFrames, speech_VA100,
AGAM1F01, speech_VA58_SNR10dB, speech_10s_50pc
Predefined value: constant_frames

-speech_ver
Specifies if speech verification shall be done or not.
Allowed values: off, pesq

-speech_ver_sample
Specifies which speech sample to verify against, that is,
the sample you expect to receive.
Allowed values: speech_VA100, speech_10s_50pc,
AGAM1F01, speech_VA58_SNR10dB

-speech_ver_duration
Specifies how long the verification lasts from the start of
the call. The verification period cannot be longer than the
length of the speech sample used. The speech samples
are of the following lengths:
speech_VA100 17s
speech_10s_50pc 10s
AGAM1F01 8s
speech_VA58_ 31s
SNR10dB
Unit: milliseconds (ms)
Allowed values: integer

-speech_mos_threshold
Gives the threshold value for the PESQ algorithm. All
calls with a MOS value below this threshold are logged
as exceptions. The values is specified as 'MOS value x
1000'. All predefined traffic behaviors have this parameter
set to -500, which means that no exceptions are logged.
Allowed values: integer

-speech_rate
Changes the AMR NB speech rate in the uplink for
simulated UEs during an ongoing speech call. The values
to this parameter are the requested uplink speech rates.

166
UE traffic behaviors

The '-' character means either that the speech rate is the
highest rate given by the RNC or that a speech rate is not
applicable for the current RAB.
Allowed values: -, 4_75, 5_9, 6_6, 7_4, 7_95, 8_85,
12_2, 12_65
Conditional:
The rab_state and speech_rate traffic behavior
parameters are related to each other because of their
function. A value of the speech_rate parameter is
only taken into account when there is a multi-mode
speech RAB.

-valid_speech_rate
Validates the current uplink speech rate of simulated
UEs during an ongoing speech call. This means that the
current speech rate is compared to an expected value.
The parameter has a list of values where each value is
one or more speech rates separated by the '/' character.
The '*' character means that any uplink speech rate is
valid.
Allowed values: In AMR-multimode: *, 4_75, 5_9, 7_4,
7_95, 12_2. In AMR-WB: *, 6_6, 8_85, 12_65
Conditional:
The valid_rab_state and valid_speech_rate
traffic behavior parameters are related to each
other because of their function. A value of the
valid_speech_rate parameter is only taken into
account when there is a RAB containing speech.

-apn_1
The APN for the first primary PDP context.

-apn_2
The APN for the second primary PDP context.

-apn_3
The APN for the third primary PDP context.

-max_dl_rate_percentage
Specifies the percentage 3Gsim uses when calculating
the maximum limit of DL user data rate. Exceeding the
throughput limit forces an upswitch.
The maximum DL data rate (bit/s) is calculated as:
8 x (packet length) x (percentage) x (packet rate) /
100

where percentage is the value of the


max_dl_rate_percentage parameter, and the following
holds for the packet rate and the packet length:
For a cch RAB:
• DL packet rate = 4500 cHz
• DL packet length = 0 bytes

167
UE traffic behaviors

For an 8 kbps DL RAB:


• DL packet rate = 1265 cHz
• DL packet length = 79 bytes
For a 16 kbps DL RAB:
• DL packet rate = 2530 cHz
• DL packet length = 79 bytes
For a 64 kbps DL RAB:
• DL packet rate = 4020 cHz
• DL packet length = 199 bytes
For a 64 kbps (shared) DL RAB:
• DL packet rate = 4020 cHz
• DL packet length = 199 bytes
For a 128 kbps DL RAB:
• DL packet rate = 4010 cHz
• DL packet length = 399 bytes
For a 128 kbps (shared) DL RAB:
• DL packet rate = 4010 cHz
• DL packet length = 399 bytes
For a 384 kbps DL RAB:
• DL packet rate = 6000 cHz
• DL packet length = 799 bytes
Example:
With max_dl_rate_percentage set to 75% and a 128
kbps DL RAB, the calculated maximum DL data rate
is 8 x 399 x 0,75 x 4010 / 100 = 95999 bit/s
This parameter is for UDP only.
Unit: percent (%)
Allowed values: 50-100
Predefined value: 93

-t3212
Specifies whether periodic Location Area Updates are
done or not. off means that no periodic Location Area
Updates are done and nw that the value for timer T3212
is taken from the network, system information block, SIB1.
The value is only used when creating new UEs; it does
not affect existing UEs.
Allowed values: off, nw

-automatic_pdp_reactivation
Configures the UE to try to reactivate the PDP context if
the PDP has been deactivated by the Network.
• off means that the UE does not automatically
reactivate the PDP contexts.
• behavior means that the UE tries to follow the
behavior, that is, if the deactivation was done in a

168
UE traffic behaviors

state where the current RAB state contains packet


data, the UE automatically tries to reactivate the PDP
context.
• forced means that the UE always tries to be online,
that is, it always tries to reactivate the PDP context
even if the UE is in the RAB state idle.
Allowed values: off, behavior, forced
Predefined value: off

-mt_answer_time
Specifies the time the UE shall wait before it answers a
call from another UE.
Unit: milliseconds (ms)
Allowed values: 0-60000
Predefined value: 1000
Conditional:
This parameter is only applicable for MT (Mobile
Terminated) behaviors.

-dropped_call_reconnect_delay
Specifies how long a UE waits after a dropped call is
detected until a new RRC Connection Request is sent.
Unit: milliseconds (ms)
Allowed values: integer
Predefined value: 500

The traffic behaviors are of type ue-traffic-classic. They are connected to UEs with the 3gsim create
ue command.
To customize the predefined UE traffic behaviors, use the behavior commands. Customizing a traffic
behavior may be necessary in order to make it work correctly on the RNC. This is due to the fact that
RNCs of different versions use different algorithms to switch the UEs between RAB states.
Some parameters in the traffic behavior are followed by a list of values. The number of values must
be the same in all lists.

21.2 External control traffic behavior


Function:
The predefined ue_traffic_extcontrol traffic behavior allows manual control of the traffic services
for the UEs using the behavior. The behavior has no parameters.

The ue_traffic_extcontrol traffic behavior is of type ue-traffic-ext-control. It is connected to a UE with


the 3gsim create ue command.

169
UE equipment behaviors

22 UE equipment behaviors

22.1 Equipment behavior parameters


Function:
The equipment behavior controls the behavior and misbehavior of the user equipment (not its
applications), for instance protocol configuration and parameters unique to certain UE types.

-dl_rlc_pdu_rb2 <answer>[:<activity>][,<answer>[:<activity>],...]

-dl_rlc_pdu_rb3 <answer>[:<activity>][,<answer>[:<activity>],...]

-dl_rlc_pdu_rb5 <answer>[:<activity>][,<answer>[:<activity>],...]

-dl_rlc_pdu_rb6 <answer>[:<activity>][,<answer>[:<activity>],...]

-dl_rlc_pdu_rb7 <answer>[:<activity>][,<answer>[:<activity>],...]

-dl_rlc_pdu_rb12 <answer>[:<activity>][,<answer>[:<activity>],...]

-dl_rlc_pdu_rb16 <answer>[:<activity>][,<answer>[:<activity>],...]

-dl_rlc_pdu_rb17 <answer>[:<activity>][,<answer>[:<activity>],...]

-dl_rlc_pdu_rb18 <answer>[:<activity>][,<answer>[:<activity>],...]

-dl_rlc_pdu_rb22 <answer>[:<activity>][,<answer>[:<activity>],...]

-dl_rlc_pdu_rb23 <answer>[:<activity>][,<answer>[:<activity>],...]

-mac_pdu_reorder_interval <number>

-c_edch_ccch_segm_interval <number>

{-c_edch_ccch_crc_error_interval <number>}

-speech_ver off | pesq

-speech_ver_sample speech_VA100 | speech_10s_50pc | AGAM1F01 |


speech_VA58_SNR10dB

-speech_ver_duration <time>

-speech_mos_threshold <number>

{-speech_rate - | 4_75 | 5_9 | 6_6 | 7_4 | 7_95 | 8_85 | 12_2 |


12_65}

-t3212 off | nw

-automatic_pdp_reactivation off | behavior | forced

-inactivity_release_time <time> | -

170
UE equipment behaviors

-t3310 <T3310 timeout value>

-t3311 <T3311 timeout value>

-t3317 <T3317 timeout value>

-t3321 <T3321 timeout value>

-t3330 <T3330 timeout value>

-t3340 <T3340 timeout value>

-cell_up_connect_delay <time>[-<time>]

-positioning_success true | false

-positioning_accuracy good | bad

-lau_retries <number of LAU retries>

-rau_retries <number of RAU retries>

-gmm_attach_retries <number of GMM attach retries>

answer
default | discard

default means that the incoming request is forwarded to


the addressee and handled according to its rules.
discard means that the incoming request is ignored.
Allowed values: default, discard

activity
none | rlc_unrecoverable_error | rl_failure

none means that no activity is specified.


rlc_unrecoverable_error means that an RLC
Unrecoverable Error is triggered.
rl_failure means that a Radio Link Failure is triggered.
Allowed values: none, rlc_unrecoverable_error, rl_failure

-dl_rlc_pdu_rb2
Specifies the behavior when DL RLC PDUs are received
on radio bearer 2. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

171
UE equipment behaviors

-dl_rlc_pdu_rb3
Specifies the behavior when DL RLC PDUs are received
on radio bearer 3. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

-dl_rlc_pdu_rb5
Specifies the behavior when DL RLC PDUs are received
on radio bearer 5. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

-dl_rlc_pdu_rb6
Specifies the behavior when DL RLC PDUs are received
on radio bearer 6. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

-dl_rlc_pdu_rb7
Specifies the behavior when DL RLC PDUs are received
on radio bearer 7. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

-dl_rlc_pdu_rb12
Specifies the behavior when DL RLC PDUs are received
on radio bearer 12. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

-dl_rlc_pdu_rb16
Specifies the behavior when DL RLC PDUs are received
on radio bearer 16. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

-dl_rlc_pdu_rb17
Specifies the behavior when DL RLC PDUs are received
on radio bearer 17. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

172
UE equipment behaviors

-dl_rlc_pdu_rb18
Specifies the behavior when DL RLC PDUs are received
on radio bearer 18. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

-dl_rlc_pdu_rb22
Specifies the behavior when DL RLC PDUs are received
on radio bearer 22. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

-dl_rlc_pdu_rb23
Specifies the behavior when DL RLC PDUs are received
on radio bearer 23. Use repetitions to define suitable
answer and activity patterns. The syntax for repetitions is
described below.
Predefined value: default:none

-mac_pdu_reorder_interval
Specifies the interval between each attempt to reorder
MAC PDUs. 0 means that no PDUs are sent out of order.
Example:
If you set the parameter to 4, 3 PDUs are sent
followed by an attempt to reorder the next 2 PDUs.
Then 3 PDUs are sent and a reordering attempt is
made for the next 2, and so on.
In order to get the expected amount of PDUs out of order,
make sure that the packet rate is high enough to generate
data at each TTI.
Allowed values: 0-1000000
Predefined value: 0

-c_edch_ccch_segm_interval
Specifies the interval between each segmented CCCH
transmission. 0 means that no CCCH transmission will be
segmented; 1 means that all CCCH transmissions will be
segmented.
Example:
If the interval is set to 10, every 10th CCCH
transmission will be segmented.
Allowed values: 0-1000000
Predefined value: 0

173
UE equipment behaviors

-c_edch_ccch_crc_error_interval
Specifies the interval between each segmented CCCH
transmission that will contain CRC errors. 0 means that no
faulty CRC will be generated; 1 means that all CRCs will
be faulty.
Example:
If the interval is set to 10, every 10th segmented
CCCH transmission will contain CRC errors.
Allowed values: 0-1000000
Predefined value: 0
Conditional:
This parameter is only used if
c_edch_ccch_segm_interval is set to a value greater
than 0.

-speech_ver
Specifies if speech verification shall be done or not.
Note:
The equipment behaviors do not use this parameter
yet; it is overridden by the speech_ver parameter in
the classic traffic behaviors.
Allowed values: off, pesq

-speech_ver_sample
Specifies which speech sample to verify against, that is,
the sample you expect to receive.
Note:
The equipment behaviors do not use this parameter
yet; it is overridden by the speech_ver_sample
parameter in the classic traffic behaviors.
Allowed values: speech_VA100, speech_10s_50pc,
AGAM1F01, speech_VA58_SNR10dB

-speech_ver_duration
Specifies how long the verification lasts from the start of
the call. The verification period cannot be longer than the
length of the speech sample used. The speech samples
are of the following lengths:
speech_VA100 17s
speech_10s_50pc 10s
AGAM1F01 8s

174
UE equipment behaviors

speech_VA58_ 31s
SNR10dB
Note:
The equipment behaviors do not use this parameter
yet; it is overridden by the speech_ver_duration
parameter in the classic traffic behaviors.
Unit: milliseconds (ms)
Allowed values: integer

-speech_mos_threshold
Gives the threshold value for the PESQ algorithm. All
calls with a MOS value below this threshold are logged
as exceptions. The values is specified as 'MOS value x
1000'. -500 means that no exceptions are logged.
Note:
The equipment behaviors do not use this parameter
yet; it is overridden by the speech_mos_threshold
parameter in the classic traffic behaviors.
Allowed values: integer

-speech_rate
Changes the AMR NB speech rate in the uplink for
simulated UEs during an ongoing speech call. The values
to this parameter are the requested uplink speech rates.
The '-' character means either that the speech rate is the
highest rate given by the RNC or that a speech rate is not
applicable for the current RAB.
Note:
The equipment behaviors do not use this parameter
yet; it is overridden by the speech_rate parameter in
the classic traffic behaviors.
Allowed values: -, 4_75, 5_9, 6_6, 7_4, 7_95, 8_85,
12_2, 12_65
Conditional:
The rab_state and speech_rate traffic behavior
parameters are related to each other because of their
function. A value of the speech_rate parameter is
only taken into account when there is a multi-mode
speech RAB.

-t3212
Specifies whether periodic Location Area Updates are
done or not. off means that no periodic Location Area
Updates are done and nw that the value for timer T3212

175
UE equipment behaviors

is taken from the network, system information block, SIB1.


The value is only used when creating new UEs; it does
not affect existing UEs.
Note:
The equipment behaviors do not use this parameter
yet; it is overridden by the t3212 parameter in the
classic traffic behaviors.
Allowed values: off, nw

-automatic_pdp_reactivation
Configures the UE to try to reactivate the PDP context if
the PDP has been deactivated by the Network.
• off means that the UE does not automatically
reactivate the PDP contexts.
• behavior means that the UE tries to follow the
behavior, that is, if the deactivation was done in a
state where the current RAB state contains packet
data, the UE automatically tries to reactivate the PDP
context.
• forced means that the UE always tries to be online,
that is, it always tries to reactivate the PDP context
even if the UE is in the RAB state idle.
Note:
The equipment behaviors do not use
this parameter yet; it is overridden by the
automatic_pdp_reactivation parameter in the classic
traffic behaviors.
Allowed values: off, behavior, forced

-inactivity_release_time
Specifies how long a UE must be inactive before the
Signaling Connection Release Indication procedure starts.
'-' means that no UE initiated release is made due to
inactivity. The timer is triggered every 100 ms, which
means that in-between timer values are rounded down.It
is not applicable for UEs with GSM traffic
Note:
This parameter can be modified for running UE
Unit: milliseconds (ms)
Allowed values: 100-2147483647, -
Predefined value: -

-t3310
Specifies the GMM timer T3310. The timer starts when
ATTACH REQ is received and stops when ATTACH
ACCEPT/REJECT is received.

176
UE equipment behaviors

The timer is defined in 3GPP TS 24.008.


Unit: ms
Allowed values: Unsigned integer (0-4294967295)
Predefined value: 15000

-t3311
Specifies the GMM timer T3311. The timer starts when
ATTACH REJECT or ROUTING AREA UPDATE REJECT
with a cause indicating an abnormal situation is received,
and stops at the change of routing area.
The timer is defined in 3GPP TS 24.008.
Unit: ms
Allowed values: Unsigned integer (0-4294967295)
Predefined value: 2500

-t3317
Specifies the GMM timer T3317. The timer starts when
SERVICE REQ is sent and stops when SERVICE
ACCEPT/REJECT is received.
The timer is defined in 3GPP TS 24.008.
Unit: ms
Allowed values: Unsigned integer (0-4294967295)
Predefined value: 10000

-t3321
Specifies the GMM timer T3321. The timer starts when
DETACH REQ is sent and stops when DETACH ACCEPT
is received.
The timer is defined in 3GPP TS 24.008.
Unit: ms
Allowed values: Unsigned integer (0-4294967295)
Predefined value: 15000

-t3330
Specifies the GMM timer T3330. The timer starts when
ROUTING AREA UPDATE REQ is sent and stops when
ROUTING AREA UPDATE ACC/REJ is received.
The timer is defined in 3GPP TS 24.008.
Unit: ms
Allowed values: Unsigned integer (0-4294967295)
Predefined value: 15000

177
UE equipment behaviors

-t3340
Specifies the GMM timer T3340. The timer starts when
ATTACH REJ or ROUTING AREA UPDATE REJ with any
of the causes #11, #12, #13, #15 or #25 is received, and
stops when the signaling connection is released.
The timer is defined in 3GPP TS 24.008.
Unit: ms
Allowed values: Unsigned integer (0-4294967295)
Predefined value: 10000

-cell_up_connect_delay
Specifies how long the UE waits before making a
connection attempt. The timer starts when the cell is
operational, that is, when the common channels are
established. If the delay is set to 0, there is a risk that the
UE connects too early with failed traffic behavior activity
cycles as a result.
Use a single value or an interval. If an interval is specified,
the timer value is randomly picked within the interval,
thus spreading the connection attempts in time. Thereby,
overload situations can be avoided in large scale testing.
Unit: ms
Allowed values: Integer
Predefined value: 500-5000

-positioning_success
Specifies if the UE shall report positioning error with
"no position" or positioning success with Geographical
Position.
Allowed values: true, false
Predefined value: true

-positioning_accuracy
Specifies the positioning accuracy. Good accuracy is up to
25 meters and bad accuracy is up to 200 meters.
Allowed values: good, bad
Predefined value: good

-lau_retries
Specifies the number of retries when performing a
Location Area Update. The value is specified by 3GPP TS
24.008 to 4 but can be altered with this parameter.
Allowed values: 0-255
Predefined value: 4

178
UE equipment behaviors

-rau_retries
Specifies the number of retries when performing a Routing
Area Update. The value is specified by 3GPP TS 24.008
to 5 but can be altered with this parameter.
Allowed values: 0-255
Predefined value: 5

-gmm_attach_retries
Specifies the number of retries when performing a GMM
attach. The value is specified by 3GPP TS 24.008 to 5 but
can be altered with this parameter.
Allowed values: 0-255
Predefined value: 5

The UE equipment behaviors are of the type ue-equipment. The default behavior is called
ue_equipment_default. An equipment behavior is connected to a UE with the 3gsim create ue
command.

Repetitions
Actions in the equipment behaviors can contain repetitions. Use this syntax:
<count>*(<list of actions>)

where count is:


inf | <number> | uniform(<min>,<max>)
• inf means that the list of actions is repeated infinitely.
• number means that the list of actions is repeated the specified number of times.
• uniform means that the list of actions is repeated a random number of times. A new random
value is generated each time a repetition is started. The random value is selected with a
uniformly distributed probability within the specified range.
Repetitions can be nested. That is, a repetition can contain other repetitions.
Example:
Discard every 10th DL RLC PDU on RB16.
-dl_rlc_pdu_rb16 inf*(9*(default),discard)

Trigger 10000 DL RLC PDUs and then a burst of minimum 5 and maximum 10 RL failures on
RB17.
-dl_rlc_pdu_rb17 10000*(default:none),uniform(5,10)*(default:rl_failure)

179
CN behaviors

23 CN behaviors

23.1 RANAP CL behavior parameters


Function:
This behavior introduces deviations from the normal behavior of the connectionless parts of the
RANAP protocol.

-auto_run <activity>[,<activity>,...]

-reset <answer>[:<activity>][:<modifier>]
[,<answer>[:<activity>][:<modifier>],...]

-reset_resource <answer>[:<activity>][:<modifier>]
[,<answer>[:<activity>][:<modifier>],...]

-reset_ack <activity>[:<modifier>][,<activity>[:<modifier>],...]

-reset_resource_ack <activity>[:<modifier>][,<activity>[:<modifier>],...]

-error_ind <activity>[:<modifier>][,<activity>[:<modifier>],...]

-ium_rate [<qualifier>:]<activity>[:<modifier>]
[,[<qualifier>:]<activity>[:<modifier>],...]

-no_of_reset_sendings <number>

-reset_resend_time <time>

-reset_resource_hold_time <time>

-reset_resource_max_conn <number>

-reset_resource_max_unacked <number>

qualifier
rate<operator><IUM rate>

operator specifies which operator to use for comparison.


Available operators are =, <, >, <=, and >=, where:
= means that the integer part of ium_rate must be equal to
the specified value,
< means that ium_rate must be less than the specified
value,
> means that ium_rate must be greater than the specified
value,
<= means that ium_rate must be less than or equal to the
specified value,
>= means that ium_rate must be greater than or equal to
the specified value.

180
CN behaviors

The rate qualifier can only be used for the ium_rate


trigger. Using it for any other trigger renders an error
message and the RANAP CL behavior will not be
accepted by 3Gsim.
Unit: messages per second
Allowed values: Operator: =, <, >, <=, >=. IUM rate:
0-10000000

answer
default[[<delay>]] | discard

The delay is optional. The inner square brackets are part


of the syntax and shall be included in the message trigger.
Unit: Delay: milliseconds
Allowed values: default, discard

activity
none |
reset[<delay>,<RANAP cause>] |
error_ind[<delay>,<RANAP cause>] |
overload[<delay>]

The delays are mandatory; the square brackets are part of


the syntax and shall be included in the message trigger.
Delay unit: milliseconds.
The RANAP causes are defined in 3GPP TS 25.413.
overload sends a RANAP Overload message after the
specified delay.
Unit: Delay: milliseconds
Allowed values: Delay: 0-10000000

modifier
blocking

blocking means that the activity is fully executed before


the behavior continues with the next activity. Events
that are triggered during the execution of the activity are
discarded.
Allowed values: blocking

-auto_run
Specifies a comma separated list of automatically
triggered activities for RANAP connectionless auto run.
Predefined value: reset[0,115]

181
CN behaviors

-reset
Specifies the behavior when the RANAP Reset message
is received.
Predefined value: default[25000]

-reset_resource
Specifies the behavior when the RANAP Reset Resource
message is received.
Predefined value: default

-reset_ack
Specifies the behavior when the RANAP Reset
Acknowledge message is received.
Predefined value: none

-reset_resource_ack
Specifies the behavior when the RANAP Reset Resource
Acknowledge message is received.
Predefined value: none

-error_ind
Specifies the behavior when the RANAP Error Indication
message (connectionless) is received.
Predefined value: none

-ium_rate
Occurs when 3Gsim has calculated an IUM rate, which is
done periodically every 100 milliseconds.
Predefined value: none

-no_of_reset_sendings
Specifies the number of attempts to send a RANAP Reset
message before giving up.
Allowed values: Integer
Predefined value: 5

-reset_resend_time
Specifies the time between the attempts to send RANAP
Reset messages.
Unit: milliseconds
Allowed values: Integer
Predefined value: 40000

182
CN behaviors

-reset_resource_hold_time
Specifies the time to wait before sending the Reset
Resource message. The timer is started when a Reset
Resource Request message arrives from RANAP CO to
an empty queue.
Unit: milliseconds (ms)
Allowed values: Integer
Predefined value: 0

-reset_resource_max_conn
Specifies the maximum number of connection IDs to put
into a single Reset Resource message.
Allowed values: 1-250
Predefined value: 1

-reset_resource_max_unacked
Specifies how many simultaneous Reset Resource
procedures that are allowed. When the maximum number
is reached, an acknowledgement must be received before
the next Reset Resource Request message can be sent.
The value '-' means unlimited, that is, there is no need to
wait for an acknowledgement.
Allowed values: 1-24, -
Predefined value: -

The predefined RANAP CL behavior is named ranap_cl_default. The RANAP CL behaviors are
of type cn-ranap-cl. They are connected to RANAP links with the 3gsim create ss7_signaling_link
command.

Repetitions
Activities and answers in the RANAP CL behaviors can contain repetitions. Use this syntax:
inf|<number>*(<list of actions>)

23.2 RANAP CO behavior parameters


Function:
This behavior introduces deviations from the normal behavior of the connection oriented parts of
the RANAP protocol.

-auto_run <activity>[,<activity>,...]

-rab_release_req <answer>[:<activity>][,<answer>[:<activity>],...]

-iu_release_req <answer>[:<activity>][,<answer>[:<activity>],...]

-rab_assign_resp [<qualifier>:]<activity>
[,[<qualifier>:]<activity>,...]

-security_mode_comp <activity>[,<activity>,...]

183
CN behaviors

-security_mode_rej <activity>[,<activity>,...]

-initial_ue_message <activity>[,<activity>,...]

-direct_transfer <activity>[,<activity>,...]

-error_ind <activity>[,<activity>,...]

-iu_release_command_delay <number>

-spid_control c[:<number>],d[:<number>],r[:<number>]

qualifier
rabid<operator><RAB ID>

RAB ID is specified in 3GPP TS 25.413.


Allowed values: Operator: =, <, >, <= and >=. RAB ID:
integer.

answer
default[[<delay>]] | discard

The delay is the time period before the answer is initiated.


The delay is optional. The inner square brackets are part
of the syntax and shall be included in the message trigger.
Delay unit: milliseconds. Delay values: Integer.
Allowed values: default, discard

activity
none |
iu_release_cmd[<delay>,<RANAP cause>] |
rab_assign_req[<delay>,(<list of RAB IDs>),(<list of
RANAP causes>)] |
error_ind[<delay>,<RANAP cause>] |
ranapcl{reset_resource[<delay>[-<delay>],<RANAP
cause>]} |
ranapcl{overload[<delay>[-<delay>]]}

The delay is the time period before the activity is initiated.


The delays are mandatory. The outer square brackets are
part of the syntax and shall be included in the message
trigger. Delay intervals can be used for the reset_resource
and overload activities in order to get a less deterministic
behavior. Delay unit: milliseconds. Delay values: Integer.
The RAB IDs and the RANAP causes are specified in
3GPP TS 25.413.
The lists of RAB IDs and RANAP cause values are given
in a comma separated list: ( <value1> , <value2> ,...). The
RAB ID list and the RANAP cause value list must be of
equal length.

184
CN behaviors

-auto_run
Specifies a comma separated list of automatically
triggered activities for RANAP connection oriented auto
run.
Predefined value: none

-rab_release_req
Specifies the behavior when the RANAP RAB Release
Request message is received.
Predefined value: default

-iu_release_req
Specifies the behavior when the RANAP Iu Release
Request message is received
Predefined value: default

-rab_assign_resp
Specifies the behavior when the RANAP RAB Assignment
Response message is received.
Predefined value: none

-security_mode_comp
Specifies the behavior when the RANAP Security Mode
Command message is received.
Predefined value: none

-security_mode_rej
Specifies the behavior when the RANAP Security Mode
Reject message is received.
Predefined value: none

-initial_ue_message
Specifies the behavior when the RANAP Initial UE
Message message is received.
Predefined value: none

-direct_transfer
Specifies the behavior when the RANAP Direct Transfer
message is received
Predefined value: none

-error_ind
Specifies the behavior when the RANAP Error Indication
message (connection oriented) is received.
Predefined value: none

-iu_release_command_delay
Specifies the delay before the Iu Release Command is
sent to the RNC, after release of the last RAB.
Unit: Milliseconds (ms)
Allowed values: Integer
Predefined value: 400

185
CN behaviors

-spid_control
Specifies the number of consecutive RANAP messages in
which the SPID IE is included:
• 'c' is the Common ID message.
• 'd' is the Direct Transfer message.
• 'r' is the Relocation Request message.
The SPID IE is only included in the message if SPID is
defined in the subscription data record. Counting starts
when the behavior starts. If any parameter or trigger in
the behavior is modified then the whole behavior restarts,
including the counting in this parameter. If the <:number>
is omitted, the SPID IE is always sent.
Example:
-spid_control c,d,r

If SPID is defined, it is always sent in Common ID,


Direct Transfer and Relocation Request.
-spid_control c,d:0,r:2

If SPID is defined, it is always sent in Common ID,


never in Direct Transfer and only in the next two
Relocation Request messages.
Allowed values: Integer
Predefined value: c,d,r

The predefined RANAP CO behavior is named ranap_co_default. The RANAP CO behaviors are of
type cn-ranap-co. They are connected to subscriptions with the 3gsim create subscription command.
It is possible to modify RANAP CO behaviors during execution.

Repetitions
Activities and answers in the RANAP CO behaviors can contain repetitions. Use this syntax:
inf|<number>*(<list of actions>)

23.3 MM behavior parameters


Function:
The MM behaviors introduces deviations from the normal behavior of the MM protocol in simCN.

-auto_run <activity>[,<activity>,...]

-la_updating_req [<qualifier>:]<answer>[:<activity>]
[,[<qualifier>:]<answer>[:<activity>],...]

-auth_resp <answer>[:<activity>][,<answer>[:<activity>],...]

-cm_service_req <answer>[:<activity>][,<answer>[:<activity>],...]

-paging_resp <activity>[,<activity>,...]

-tmsi_realloc_comp <activity>[,<activity>,...]

186
CN behaviors

-imsi_detach <activity>[,<activity>,...]

qualifier
lut=<LA update type>

LA update type is specified in 3GPP TS 24.008.


Allowed values: LA update type: integer

answer
default[[<delay>]] |
reject[<delay>,<MM cause>] |
discard

delay is the time period before an answer is initiated. The


default delay is optional and the reject delay is mandatory.
The inner square brackets are part of the syntax and shall
be included in the message trigger. The MM causes are
defined in 3GPP TS 24.008.
Unit: Delay: milliseconds

activity
none |
tmsi_realloc_cmd[<delay>] |
ranapcl{paging[<delay>[-<delay>],<ID type>,<paging
cause>,<non searching indication>,<DRX cycle length
coefficient>,<paging area>]} |
ranapco{iu_release_cmd[<delay>,<RANAP cause>]}

delay is the time period before an activity is initiated. The


delays are mandatory. The outer square brackets are
part of the syntax and shall be included in the message
trigger. For the paging activity delay intervals can be used
in order to get a less deterministic behavior. Delay unit:
milliseconds.
ID type specifies the type of identity. Allowed values: imsi,
tmsi (for compatibility reasons the values 0 for IMSI and 1
for TMSI are also allowed).
paging cause is an integer defined in 3GPP TS 25.413.
non searching indication is defined in 3GPP TS 25.413.
Allowed values: searching, non_searching, '-', where '-'
means that the parameter shall not be included in the
RANAP paging message.
DRX cycle length coefficient is an integer defined in 3GPP
TS 25.413. Allowed values: 6-9, '-', where '-' means that
the parameter shall not be included in the RANAP paging
message.
paging area is an integer defined in 3GPP TS 25.413.
Allowed values: default, rnc, where default means that
pagings are sent to the LA and rnc means that pagings
are sent to all cells managed by the RNC.

187
CN behaviors

RANAP cause is an integer defined in 3GPP TS 25.413.


See the 3Gsim User's Guide 1553-LZT 123 75 95
about initiating procedures in lower protocols in simCN
behaviors, in this case in RANAP CL and RANAP CO.

-auto_run
Specifies a comma separated list of automatically
triggered activities for MM.
Predefined value: none

-la_updating_req
Specifies the behavior when the MM Location Area
Updating Request message is received.
Predefined value: default

-auth_resp
Specifies the behavior when the MM Authentication
Response message is received.
Predefined value: default

-cm_service_req
Specifies the behavior when the MM CM Service Request
message is received.
Predefined value: default

-paging_resp
Specifies the behavior when the MM Paging Response
message is received.
Predefined value: none

-tmsi_realloc_comp
Specifies the behavior when the MM TMSI Reallocation
Complete message is received.
Predefined value: none

-imsi_detach
Specifies the behavior when the MM IMSI Detach
message is received.
Predefined value: none

The predefined MM behavior is named cn_mm_default. The MM behaviors are of type cn-mm. They
are connected to subscriptions with the 3gsim create subscription command.

Repetitions
Activities and answers in the MM behaviors can contain repetitions. Use this syntax:
inf|<number>*(<list of actions>)

It is possible to modify MM behaviors during execution.

188
CN behaviors

23.4 CC behavior parameters


Function:
The CC behaviors introduces deviations from the normal behavior of the CC protocol in simCN.

-auto_run <activity>[,<activity>,...]

-connect <answer>[:<activity>][,<answer>[:<activity>],...]

-release <answer>[:<activity>][,<answer>[:<activity>],...]

-connect_ack <activity>[,<activity>,...]

-disconnect <activity>[,<activity>,...]

-alerting <activity>[,<activity>,...]

-call_confirmed <activity>[,<activity>,...]

-emergency_setup <activity>[,<activity>,...]

-setup <activity>[,<activity>,...]

answer
default[[<delay>]] | discard

delay is the time period before the answer is initiated. The


delay is optional. The inner square brackets are part of the
syntax and shall be included in the message trigger. Delay
unit: milliseconds.
Allowed values: default, discard

activity
none |
disconnect[<delay>,<CC cause>] |
release[<delay>,<CC cause>] |
release_comp[<delay>,<CC cause>] |
ranapco{iu_release_cmd[<delay>,<RANAP cause>]}

delay is the time period before the activity is initiated. The


delays are mandatory. The square brackets are part of the
syntax and shall be included in the message trigger. Delay
unit: milliseconds.
CC cause is defined in 3GPP TS 24.008. Allowed value:
integer.
RANAP cause is defined in 3GPP TS 25.413. Allowed
value: integer.
See the 3Gsim User's Guide 1553-LZT 123 75 95 about
initiating procedures in lower protocols, in this case in
RANAP CO.

189
CN behaviors

-auto_run
Specifies a comma separated list of automatically
triggered activities for CC.
Predefined value: none

-connect
Specifies the behavior when the CC Connect message is
received.
Predefined value: default

-release
Specifies the behavior when the CC Release message is
received.
Predefined value: default

-connect_ack
Specifies the behavior when the CC Connect
Acknowledge message is received.
Predefined value: none

-disconnect
Specifies the behavior when the CC Disconnect message
is received.
Predefined value: none

-alerting
Specifies the behavior when the CC Alerting message is
received.
Predefined value: none

-call_confirmed
Specifies the behavior when the CC Call Confirmed
message is received.
Predefined value: none

-emergency_setup
Specifies the behavior when the CC Emergency Setup
message is received.
Predefined value: none

-setup
Specifies the behavior when the CC Setup message is
received.
Predefined value: none

The predefined CC behavior is named cn_cc_default. The CC behaviors are of type cn-cc. They are
connected to subscriptions with the 3gsim create subscription command.

Repetitions
Activities and answers in the CC behaviors can contain repetitions. Use this syntax:
inf|<number>*(<list of actions>)

190
CN behaviors

23.5 GMM behavior parameters


Function:
The GMM behaviors introduces deviations from the normal behavior of the GMM protocol in
simCN.

-auto_run <activity>[,<activity>,...]

-ra_update_req [<qualifier 1>:]<answer>[:<activity>]


[,[<qualifier1>:]<answer>[:<activity>],...]

-service_req [<qualifier 2>:]<answer>[:<activity>]


[,[<qualifier2>:]<answer>[:<activity>],...]

-attach_req <answer>[:<activity>][,<answer>[:<activity>],...]

-detach_req <answer>[:<activity>][,<answer>[:<activity>],...]

-auth_and_ciph_resp <answer>[:<activity>][,<answer>[:<activity>],...]

-t3312 <T3312 timeout value>

qualifier 1
ut=<RA update type>

The RA (Routing Area) update type is defined in 3GPP TS


24.008.
Allowed values: integer

qualifier 2
st=<service type>

The service type is defined in 3GPP TS 24.008.


Allowed values: integer

answer
default[[<delay>]] |
reject[<delay>,<GMM cause>] |
discard

delay is the time period before the answer is initiated. The


default delay is optional and the reject delay is mandatory.
The inner square brackets are part of the syntax and shall
be included in the message trigger.
GMM cause is defined in 3GPP TS 24.008.
Unit: Delay: milliseconds
Allowed values: Delay: integer. GMM cause: integer

activity
none |
detach_req[<delay>,<ID type>,<GMM cause>] |

191
CN behaviors

ranapcl{paging[<delay>[-<delay>],<ID type>,<paging
cause>,<non searching indication>,<DRX cycle length
coefficient>,<paging area>]} |
ranapco{iu_release_cmd[<delay>,<RANAP cause>]}

delay is the time period before the activity is initiated. The


delays are mandatory. The outer square brackets are
part of the syntax and shall be included in the message
trigger. For the paging activity delay intervals can be used
in order to get a less deterministic behavior. Delay unit:
milliseconds.
GMM cause is defined in 3GPP TS 24.008. Allowed value:
integer.
ID type specifies the type of identity. Allowed values: imsi,
tmsi (for compatibility reasons the values 0 for IMSI and 1
for P-TMSI are also allowed).
paging cause is defined in 3GPP TS 25.413. Allowed
value: integer.
non searching indication is defined in 3GPP TS 25.413.
Allowed values: searching, non_searching, '-', where '-'
means that the parameter shall not be included in the
RANAP paging message.
DRX cycle length coefficient is defined in 3GPP TS
25.413. Allowed values: 6-9, '-', where '-' means that the
parameter shall not be included in the RANAP paging
message.
paging area is defined in 3GPP TS 25.413. Allowed
values: default, rnc, where default means that pagings are
sent to the RA and rnc means that pagings are sent to all
cells managed by the RNC.
RANAP cause is defined in 3GPP TS 25.413. Allowed
value: integer.
See the 3Gsim User's Guide 1553-LZT 123 75 95 about
initiating procedures in lower protocols, in this case in
RANAP CL and RANAP CO.

-auto_run
Specifies a comma separated list of automatically
triggered activities for GMM.
Predefined value: none

-ra_update_req
Specifies the behavior when the GMM Routing Area
Updating Request message is received.
Predefined value: default

192
CN behaviors

-service_req
Specifies the behavior when the GMM Service Request
message is received.
Predefined value: default

-attach_req
Specifies the behavior when the GMM Attach Request
message is received.
Predefined value: default

-detach_req
Specifies the behavior when the GMM Detach Request
message is received.
Predefined value: default

-auth_and_ciph_resp
Specifies the behavior when the GMM Authentication And
Ciphering Response message is received.
Predefined value: none

-t3312
Specifies the value of the GMM timer T3312. T3312
controls the frequency of the periodic Routing Area
Update. The parameter is further explained below.
Allowed values: Integer
Predefined value: 73 (54 minutes)

The predefined GMM behavior is named cn_gmm_default. The GMM behaviors are of type cn-gmm.
They are connected to subscriptions with the 3gsim create subscription command.

Repetitions
Activities and answers in the GMM behaviors can contain repetitions. Use this syntax:
inf|<number>*(<list of actions>)

It is possible to modify GMM behaviors during execution.

t3312
The t3312 parameter specifies the timeout for the T3312 timer, which controls the frequency of the
periodic Routing Area Update in the UEs. T3312 is defined in 3GPP TS 24.008.
Use a decimal value; you can also enter a hexadecimal value by using the syntax 0x<value>. The
parameter value represents an 8-bit integer. The first 3 bits indicate the unit:
• 000 means that the value is incremented in multiples of 2 seconds
• 001 means that the value indicates minutes
• 010 means that the value indicates decihours
• 111 means that the value indicates that the timer is deactivated
The remaining 5 bits indicate the timer value, as shown in the figure below.

193
CN behaviors

Figure: Representation of the t3312 parameter. The parameter is set to


0x21 (decimal 33), meaning that the T3312 timer expires after one minute.
Example:
Set the T3312 timer to 15 minutes:
The 3 most significant bits are set to 001 to indicate minutes, and the 5 remaining bits are set to
01111 (15 decimal). This gives the binary 00101111 (47 decimal or 0x2F hexadecimal) for the 8-
bit integer. This means that the timer shall be set to value 47 (or 0x2F), if the timer shall expire
after 15 minutes.
Deactivate the T3312 timer:
The 3 most significant bits are set to 111, while the 5 remaining bits makes no difference
(choose for example the binary 10000). This gives the binary 11110000 (240 decimal or 0xF0
hexadecimal) for the 8-bit integer. This means that the timer can for example be set to value 240
(or 0xF0), if the timer shall be deactivated.

23.6 SM behavior parameters


Function:
The SM behaviors introduces deviations from the normal behavior of the SM protocol in simCN.

-auto_run <activity>[,<activity>,...]

-activate_pdp_req [<qualifier>:]<answer>[:<activity>]
[,[<qualifier>:]<answer>[:<activity>],...]

-activate_sec_pdp_req [<qualifier>:]<answer>[:<activity>]
[,[<qualifier>:]<answer>[:<activity>],...]

-deactivate_pdp_req [<qualifier>:]<answer>[:<activity>]
[,[<qualifier>:]<answer>[:<activity>],...]

qualifier
nsapi=<NSAPI>

NSAPI is specified in 3GPP TS 24.008.

answer
default[[<delay>]] |
reject[<delay>,<SM cause>] |
discard

194
CN behaviors

delay is the time period before an answer is initiated. The


default delay is optional and the reject delay is mandatory.
The inner square brackets are part of the syntax and shall
be included in the message trigger.
SM cause is defined in 3GPP TS 24.008.
Unit: Delay: milliseconds
Allowed values: Delay: integer. SM cause: integer

activity
none |
deactivate_pdp_req[<delay>,<NSAPI>,<tear down
indicator>,<SM cause>] |
gmm{detach_req[<delay>,<ID type>,<GMM cause>]} |
ranapcl{paging[<delay>,<ID type>,<paging cause>]} |
ranapco{iu_release_cmd[<delay>,<RANAP cause>]}

The delays are mandatory. The square brackets are part


of the syntax and shall be included in the message trigger.
NSAPI, tear down indicator, GMM cause and SM cause
are integers specified in 3GPP TS 24.008.
ID type specifies the type of identity. Allowed values: 0 for
IMSI, 1 for P-TMSI.
paging cause and RANAP cause are defined in 3GPP TS
25.413. Allowed values: integer.
See the 3Gsim User's Guide 1553-LZT 123 75 95 about
initiating procedures in lower protocols, in this case in
RANAP CL and RANAP CO.
Unit: Delay: milliseconds

-auto_run
Specifies a comma separated list of automatically
triggered activities for SM.
Predefined value: none

-activate_pdp_req
Specifies the behavior when the SM Activate PDP Context
Request message is received.
Predefined value: default

-activate_sec_pdp_req
Specifies the behavior when the SM Activate Secondary
PDP Context Request message is received.
Predefined value: default

-deactivate_pdp_req
Specifies the behavior when the SM Deactivate PDP
Context Request message is received.
Predefined value: default

195
CN behaviors

The predefined SM behavior is named cn_sm_default. The SM behaviors are of type cn-sm. They
are connected to subscriptions with the 3gsim create subscription command.
The SM behavior is common for all SM instances used by a subscriber. One instance of SM is used
for each PDP context, identified by NSAPI.

Repetitions
Activities and answers in the SM behaviors can contain repetitions. Use this syntax:
inf|<number>*(<list of actions>)

23.7 LCS behavior parameters


Function:
The LCS behaviors specify the details of the UE positioning procedure and introduce deviations
from the normal procedure.

-auto_run <activity>[,<activity>,...]

-location_response <activity>[,<activity>,...]

activity
none |
location_control [<delay>,
[accuracy_code=<value>,]
[vertical_accuracy_code=<value>,]
[methods=<value>,]
[pcap_behavior=<value>,]
[response_time=<value>,]
[positioning_priority=<value>,]
[client_type=<value>,]
[event_type=<value>]]

The delay for location_control is mandatory. The square


brackets are part of the syntax and shall be included in the
message trigger. Delay unit: milliseconds.
accuracy_code specifies the integer value of the Accuracy
Code IE in the RANAP Location Reporting Control
message. Use this parameter for RNC-centric mode
positioning. Valid values: 0-127.
vertical_accuracy_code specifies the integer value of
the Vertical Accuracy Code IE in the RANAP Location
Reporting Control message. Use this parameter for RNC-
centric mode positioning. Valid values: 0-127. Conditional:
if specified, accuracy_code must also be specified.
methods specifies one or more positioning methods for
the subscribers using this behavior. Use | as separator.
The positioning methods will be attempted in the specified
order. The cell_id method always succeeds. Use the
methods parameter for SAS-centric mode positioning.
Valid values: aglonass_ue_based, aglonass_ue_assisted,

196
CN behaviors

aglonass_ue_random, agps_random, agps_ue_based,


agps_ue_assisted, rtt and cell_id. Only one of
agps_random, agps_ue_based or agps_ue_assisted
can be included. If omitted, aglonass_ue_based|
agps_random|rtt|cell_id is used.
pcap_behavior specifies the name of the PCAP CO
behavior (a behavior of type sas-pcap), as configured in
the SAS node. Use this parameter for SAS-centric mode
positioning. If omitted, the pcap_co_default behavior is
used. Conditional: If using this parameter, the methods
parameter must also be used.
response_time specifies the required response time for
the positioning method included in the RANAP message.
Valid values: low_delay, delay_tolerant. Optionally use
this parameter for either SAS-centric mode or RNC-centric
mode positioning. If omitted and SAS-centric positioning is
used, the SAS node interprets this as low_delay.
positioning_priority specifies the priority of positioning
included in the RANAP message. Valid values: normal,
high. Optionally use this parameter for either SAS-centric
mode or RNC-centric mode positioning. If omitted and
SAS-centric mode positioning is used, the SAS node
interprets this as normal.
client_type specifies the type of client included in the
RANAP message. Valid values: emergency, valueadded,
operator, lawful_intercept, operator_broadcast,
operator_o_et_m (O&M), operator_anonymous_stat,
operator_target_ms. Optionally use this parameter for
either SAS-centric mode or RNC-centric mode positioning.
If omitted and SAS-centric mode positioning is used, the
SAS node interprets this as valueadded.
event_type specifies the type of event included in the
RANAP message. Valid values: direct, stop_direct.
Optionally use this parameter for either SAS-centric mode
or RNC-centric mode positioning. If omitted, direct is used.

-auto_run
Specifies a list of automatically triggered activities. The
activities are comma separated. The first activity is
triggered after the given delay after the UE is registered
to the Core Network. The second activity is triggered after
the given delay after the previous activity is started.
Predefined value: none

197
CN behaviors

-location_response
Specifies a list of activities. The activities are comma
separated. The first activity is triggered when the first
location response is received and the given delay has
elapsed. The second activity is triggered after the given
time after the previous procedure is finished.
Predefined value: none

The predefined LCS behavior is named cn_lcs_default. The LCS behavior is of type cn-lcs. It is
connected to a subscription with the 3gsim create subscription command.

Repetitions
The activities can contain repetitions. Use this syntax:
inf|<number>*(<list of actions>)

The activities in the cn_lcs_default behavior are set to none, which means that no positioning
procedure will be triggered. To trigger positioning you need to create a customized CN LCS behavior.

RNC-centric mode and SAS-centric mode settings


For RNC-centric mode positioning, use the accuracy_code and vertical_accuracy_code parameters.
For SAS-centric mode positioning, use the methods and pcap_behavior parameters.
For both modes, use the response_time, positioning_priority, client_type and event_type parameters.
All parameters are optional.

Asynchronous versus synchronuos mode of operation


For an asynchronous mode of operation, use a number of auto_run triggers but no
location_response trigger. This allows overwriting of positioning procedures without waiting for a
response.
For a synchronous mode of operation, use one auto_run trigger and a number of activities triggered
by location_response.
The difference between these two ways of using the CN LCS behaviors is shown in the figure below.

198
CN behaviors

Figure: Two ways of using triggers in the CN LCS behaviors.

23.8 PCAP CO behavior parameters


Function:
The PCAP CO behaviors specify the details of the UE positioning procedure and introduce
deviations from the normal behavior of the PCAP protocol in simCN.

-position_init_req <answer>[:<activity>][,<answer>[:<activity>],...]

-position_act_resp <activity>[,<activity>,...]

-position_act_fail <activity>[,<activity>,...]

-error_indication <activity>[,<activity>,...]

-abort <activity>[,<activity>,...]

answer
default[[<delay>]] |
reject[<delay>,<PCAP cause>] |
discard

The default delay is optional and the reject delay is


mandatory. The inner square brackets are part of the
syntax and shall be included in the message trigger.
The discard answer used with activity cause that default
settings will be changed to this chosen in the activity.

199
CN behaviors

PCAP cause is defined in 3GPP TS 25.453. See below


regarding how to format the PCAP cause.
Unit: milliseconds
Allowed values: integer.

activity
none |
default[[<delay>]] |
position_act_req[<delay>[,amount=<value>]
[,no_of_agps_satellites=<value>]
[,no_of_aglonass_satellites=<value>]
[,time_rnc_resp_rtt=<value>]
[,time_rnc_resp_agps=<value>]
[,time_rnc_resp_aglonass=<value>]
[,assistance_data=<hex value>]] |
position_init_fail[<delay>,<PCAP cause>] |
error_ind [<delay>,<PCAP cause>] |
position_init_resp[<delay>[,accuracy=<value>]]

The default delay is optional and the other delays are


mandatory. The square brackets for the delays are part of
the syntax and shall be included in the message trigger.
Unit: milliseconds. Allowed values: integer.
PCAP cause is specified in 3GPP TS 25.453. See below
regarding how to format the PCAP cause.
position_act_req specifies a delay and optionally one or
several of the following parameters, which are used in the
PCAP Position Activation Request messages:
• amount, specifying the number of PCAP Position
Activation Request Messages. Allowed value:
0-6. These values correspond to the values:
2,4,6,15,32,64,infinity that are specified in 3GPP TS
25.453. Predefined value is 0.
• no_of_agps_satellites, specifying the number of
AGPS satellites to use in positioning. Allowed value:
0-32. Predefined value: 4.
• no_of_aglonass_satellites, specifying the number of
A-GLONASS satellites to use in positioning. Allowed
value: 0-32. Predefined value: 4.
• time_rnc_resp_rtt, specifying the RNC Response
Time for the RTT method. Unit: milliseconds
(ms). Allowed value: See WRAN PCAP message
description 210/15519-HSD10102UX. Predefined
value: 2000.
• time_rnc_resp_agps, specifying the RNC Response
Time for the AGPS method. Unit: milliseconds
(ms). Allowed value: See WRAN PCAP message
description 210/15519-HSD10102UX. Predefined
value: 24000.

200
CN behaviors

• time_rnc_resp_aglonass, specifying the RNC


Response Time for the A-GLONASS method. Unit:
milliseconds (ms). Allowed value: See WRAN PCAP
message description 210/15519-HSD10102UX.
Predefined value: 24000.
• assistance_data, specifying the assistance data as a
hexadecimal value (0xXX) that represents a bit-string
with the chosen methods. Allowed values: See below.
Predefined value: See below.
The sum of A-GPS and A-GLONASS satellites cannot be
greater than 32.
position_init_fail specifies the delay and the cause of the
PCAP Position Initiation Failure message.
error_ind specifies the delay and the cause of the PCAP
Error Indication message.
position_init_resp specifies the delay and the Accuracy
Fulfillment Indicator included in the PCAP Position
Initiation Response message. Allowed values: fulfilled,
not_fulfilled, random, default. Predefined value: default,
which means that the value is set to fulfilled if the first
attempted positioning method succeeds, otherwise
not_fulfilled.

-position_init_req
Specifies the behavior when the PCAP Position Initiation
Request message is received from the RNC.
Predefined value: default

-position_act_resp
Specifies the behavior when the PCAP Position Activation
Response message is received from the RNC.
Predefined value: default

-position_act_fail
Specifies the behavior when the PCAP Position Activation
Failure message is received from the RNC.
Predefined value: default

-error_indication
Specifies the behavior when the PCAP Error Indication
message is received from the RNC.
Predefined value: default

-abort
Specifies the behavior when the PCAP Abort message is
received from the RNC.
Predefined value: default

201
CN behaviors

The predefined PCAP CO behavior is named pcap_co_default. The PCAP CO behavior is of type
sas-pcap. It is specified in the LCS behavior.

Repetitions
The answers and the activities can contain repetitions. Use this syntax:
inf|<number>*(<list of actions>)

PCAP cause
The PCAP cause is formatted in the following way:
<cause type>[<cause code>]

The square brackets are part of the syntax and shall be included in the message trigger.
Allowed values for cause type are RadioNetwork, Protocol, Transport or Misc.
The cause code is a numerical value of the PCAP cause, as defined in /vobs/rnc/pcap/
compiled_asn.ppc/pcap.h.
Example:
A position_init_fail activity with no delay and a PCAP cause of type RadioNetwork and cause
code 13.
position_init_fail[0, RadioNetwork[13]]

Assistance data
This is the satellite assistance_data bitmap layout:
#bit Satellite assistance data
0 gps_almanac_health
1 gps_utc_model
2 gps_ionospheric_model
3 gps_navigation_model
4 dgps_corrections
5 gps_reference_time
6 gps_acqusition_assistance
7 gps_real_time_integrity
8 gps_reference_location
9 ganss_reference_time
10 ganss_ionospheric_model
11 ganss_reference_location
12 ganss_additional_ionospheric_model
13 ganss_earth_orientation_parameters
14 ganss_id
15 ganss_real_time_integrity
16 ganss_data_bit_assistance
17 dganss_corrections
18 ganss_almanac_health
19 ganss_reference_measurement_information
20 ganss_utc_model
21 ganss_time_model
22 ganss_navigation_model
23 ganss_additional_time_models
24 ganss_additional_navigation_models

202
CN behaviors

25 ganss_additional_utc_models
26 ganss_auxiliary_information
This is the predefined assistance data:
#bit Satellite assistance data
0 gps_almanac_health
1 gps_utc_model
2 gps_ionospheric_model
5 gps_reference_time
8 gps_reference_location
Presented default assistance data would be inputed as: 0x127.
Example:
A position_act_req activity with no delay and all default settings:
position_act_req[0,amount=0,no_of_agps_satellites=4,no_of_aglonass_satellites=4,
time_rnc_resp_rtt=2000,time_rnc_resp_agps=24000,time_rnc_resp_aglonass=24000,
assistance_data=0x127]

203
RBS cell behaviors

24 RBS cell behaviors

24.1 RBS cell behavior parameters


Function:
The cell behaviors control the behavior of cells.

-unhappy_ue <activity>[,<activity>,...]

-hsdpcch_quality_based_olpc_delay <delay> | <minDelay>-<maxDelay>

-hsdpcch_quality_based_olpc_values <SIRTarget>:<CQIPowerOffset>:
<ACKPowerOffset>:<NACKPowerOffset>
[,<SIRTarget>:<CQIPowerOffset>:
<ACKPowerOffset>:<NACKPowerOffset>,...]

-hsdpcch_quality_based_olpc_repeat_interval <time>[,<time>,...]

-eul_prim_throughput_limit <throughput, percent of max>

-eul_sec_activation_threshold <throughput, percent of max>

-eul_sec_activation_time_to_trigger <no of TTIs>

-unhappy_ue
Specifies the EUL scheduled rate to use for
different periods. Allowed values: a list of
activities or none.
The activity item is defined as:
none | <value>[<delay>]

The delay is mandatory. The square brackets


are part of the syntax and shall be included
in the unhappy_ue trigger. Delay unit:
milliseconds.
value is the EUL scheduled rate.
delay is the time period during which the value
may be sent in the load balancing measurement
report.
Example:
none

Example:
17[100],13[200]

Predefined value: none

204
RBS cell behaviors

-hsdpcch_quality_based_olpc_delay
Specifies the time between triggering and
sending the first NBAP message Radio Link
Parameter Update Indication when a trigger
condition has been fulfilled.
Example:
3000

Example:
1000-4500

Unit: ms
Allowed values: 0-65535
Predefined value: 3000

-hsdpcch_quality_based_olpc_values
Specifies a list of values to use in Radio Link
Parameter Update Indication messages.
Each list item is a colon-separated quadruplet
that defines values of the IEs SIR target,
the CQI power offset, the ACK power offset,
and the NACK power offset in a Radio Link
Parameter Update Indication message,
according to the following:
SIRTarget 0-255 or '-'
CQIPowerOffset 0-10 or '-'
ACKPowerOffset 0-10 or '-'
NACKPowerOffset 0-10 or '-'

A '-' character means that the corresponding IE


in the Radio Link Parameter Update Indication
message is left out when this message is sent.
When the trigger condition is fulfilled, the
number of sent Radio Link Parameter Update
Indication messages is the same as the number
of items of this parameter.
SIR Target corresponds to the value -82 to 173
when sending the Radio Link Parameter Update
Indication message. This means the following
mapping between SIR target and the value
used when sending the RL Parameter Update
Indication message:
0 corresponds to the value -82
1 corresponds to the value -81
. . .
254 corresponds to the value 172

205
RBS cell behaviors

255 corresponds to the value 173

Example:
60:8:-:3

Example:
60:5:5:5,-:1:2:3

Allowed values: 0-65535


Predefined value: 60:8:8:8

-hsdpcch_quality_based_olpc_repeat_interval
Specifies the time gap between the Radio Link
Parameter Update Indication messages.
If the number of time values is less than
the length of the list of values in the
hsdpcch_quality_based_olpc_values parameter
minus 1, then the last time value is used as the
time interval between the remaining Radio Link
Parameter Update Indication messages.
Example:
1000

Example:
1000,1100,1200

Unit: ms
Allowed values: 0-65535
Predefined value: 1000

-eul_prim_throughput_limit
Specifies the EUL throughput limit for one UE
on the primary carrier when the secondary
carrier is activated.
Example:
100

Unit: throughput, percent of max


Allowed values: 1-100
Predefined value: 100

-eul_sec_activation_threshold
Specifies the EUL secondary carrier activation
or de-activation threshold for one UE.
Example:
80

Unit: throughput, percent of max


Allowed values: 1-100
Predefined value: 80

206
RBS cell behaviors

-eul_sec_activation_time_to_trigger
Specifies the time to trigger (de)activation of an
EUL secondary carrier. It is an absolute value
indicating the amount of 2ms TTIs.
Example:
3

Unit: no of TTIs
Allowed values: 1-65535
Predefined value: 3

The predefined cell behavior is named rbs_cell_default. The cell behavior is of type rbs-cell. It is
connected to cells with the 3gsim create rbs command.
For more information about the HS_DPCCH quality based OLPC parameters, please see the
document 3Gsim Feature Description, HS-DPCCH quality based OLPC, 87/1553-CAL 120 2552

Repetitions
Repetitions are allowed in cell behaviors except for the parameter
hsdpcch_quality_based_olpc_delay and EUL-MC parameters. Repetitions can be nested, that is, one
repetition can contain other repetitions. Use this syntax:
inf|<number>*(<list of values>)

Use the 3Gsim behavior commands to list, copy and modify cell behaviors.

207
LTE RBS behaviors

25 LTE RBS behaviors

25.1 LTE RBS behavior parameters


Function:
The LTE RBS behaviors control the behavior of simulated LTE RBSs.

-rim_association_attempt <timeout value 1>


[,<timeout value 2>
[,...,<timeout value 10>]]]

-rim_si_update <SI update timeout value>

-rim_initial_wait <time>[-<time>]

-rim_procedure_start_interval <time>[-<time>]

-rim_association_attempt
Specifies a list of maximum 10 retry timer values to be
used for surveillance of RIM association attempts. When
the first RAN Information Request is sent to the RNC, the
surveillance timer is started with the first value in the list.
If no RAN Information is received before the timer runs
out, a new request is sent and the timer is started with the
second value in the list. If the end of the list is reached no
more attempts are made.
After a successful attempt the list is reset to the first
value so that the procedure is restarted for all new RIM
association attempts.
Unit: milliseconds (ms)
Allowed values: Integer
Predefined value:
60000,600000,1200000,2400000,4800000,
9600000,19200000,38400000,86400000

-rim_si_update
Specifies the life span of the received System Information.
If no update is received within this time, a new RIM
association procedure is triggered.
Unit: milliseconds (ms)
Allowed values: Integer
Predefined value: 86400000 (24 h)

208
LTE RBS behaviors

-rim_initial_wait
Specifies a delay from the time when an LTE RBS has
become functional until the first RIM association attempt
is made. The value is given as a single number or as an
interval. If an interval is given, a value is randomly picked
within the interval.
Unit: milliseconds (ms)
Allowed values: Integer
Predefined value: 0

-rim_procedure_start_interval
Specifies the time between the start of two consecutive
RIM association procedures. The value is given as a
single value or as an interval. If an interval is given, a
value is randomly picked within the interval.
Unit: milliseconds (ms)
Allowed values: Integer
Predefined value: 50-500

The predefined LTE RBS behavior is named lte_rbs_default. The LTE RBS behavior is of type lte-
rbs.

LTE RBS timers and RIM association timers


The parameters rim_initial_wait and rim_procedure_start_interval are LTE RBS timers. The timer
values are used once per LTE RBS.
The parameters rim_association_attempt and rim_si_update are RIM association timers. Each RIM
association in a given LTE RBS uses its own copy of the timer values.
Modifying the value of the rim_association_attempt timer triggers all RIM associations to restart in
the LTE RBSs that use the behavior. Modifying other timers does not restart any association. The
change is however propagated to all associations in each LTE RBS that use the behavior, and the
new value is used the next time the timers are started.

209
Capabilities commands

26 Capabilities commands

26.1 List capabilities


Function:
This command shows the parameters and values in a predefined or customized set of
capabilities, or a list of all existing sets of capabilities.

3gsim lc | list capabilities

{-l | -long}

[<capabilities name>]

{-all}

-long
Lists the parameters for a specified capability set with full
explanation.
Conditional:
When used, a capability set name must be specified.

<capabilities name>
Lists all parameters of the specified set of capabilities.
Allowed values: capability set name

-all
Lists all defined capabilities (without parameters).
Conditional:
Cannot be used together with any other parameter.

Running the command without arguments is equal to using the option all.

26.2 Copy capabilities


Function:
This command copies an existing predefined or customized set of capabilities and saves it with a
new name.

3gsim cc | copy capabilities

<capabilities name>

<new capabilities name>

<capabilities name>
Specifies the name of the capability set to copy.

<new capabilities name>


Specifies the name of the new capability set.

210
Capabilities commands

The capability set is available in 3Gsim until the next reboot. To save the edited parameter values,
use an external editor and create a command file.

26.3 Modify capabilities


Function:
This command changes the values in an existing customized capability set.
Prerequisites:
The capability set must have been created with the 3gsim copy capabilities command.

3gsim mc | modify capabilities

<capabilities name>

-<parameter name> <new value>

[-<parameter name 2> <new value>]

...

<capabilities name N>

<capabilities name>
Specifies the name of a customized set of capabilities.

-<parameter name>
Specifies the name of a capability parameter to modify
and the new value that will be assigned to the parameter.
Allowed values: Any parameter listed with the 3gsim list
capabilities command.

-<parameter name 2>


Specifies the name of another capability parameter to
modify and the new value that will be assigned to the
parameter.
Allowed values: Any parameter listed with the 3gsim list
capabilities command.

<capabilities name N>


Specifies the name of the last capability parameter to
modify and the new value that will be assigned to the
parameter.
Allowed values: Any parameter listed with the 3gsim list
capabilities command.

You can modify a set of capabilities that is in use by UEs, but the effect is not possible to specify in
general. Depending on what is modified and when you modify, different situations will result. The
modifications affect all UEs using this set of capabilities.

211
Capabilities commands

26.4 Delete capabilities


Function:
This command deletes one or all customized sets of capabilities in 3Gsim.

3gsim delc | delete capabilities

[<capabilities name>]

{-all}

<capabilities name>
Specifies a customized capability set to delete.
Allowed values: capability set name

-all
Deletes all customized capability sets not in use.
Conditional:
Cannot be used together with any other parameter.

Predefined and currently used capability sets cannot be deleted. Capability sets created by copying
the deleted capability set are not influenced.

212
UE capabilities

27 UE capabilities

27.1 UE capability parameters


Function:
The UE capability parameters specify the capabilities of a UE.

-ciphering UEA0 | UEA1

-security_threshold <number>

-hsdpa_capable false | true

-hs_fach_capable false | true

-hsdpa_ul_capacity 64 | 384

-hsdsch_category <HS-DSCH category>


[,<HS-DSCH category extension>
[,<HS-DSCH category extension 2>
[,<HS-DSCH category extension 3>
[,<HS-DSCH category extension 4>
[,<HS-DSCH category extension 5>]]]]]

-eul_capable false | true

-edch_category <E-DCH category>


[,<E-DCH category extension>
[,<E-DCH category extension 2>]]

-fdpch_support none | R6 | R7

-gsm_capable false | true

-cpc_capable false | true

-rxtx_type2_capable true | false

-gps_tcf_support true | false

-na_gps_support ue_assisted | ue_based |


both_ue_assisted_and_ue_based | no_support_for_na_gps

-ganss_id aglonass

-ganss_mode ue_based | ue_assisted |


both_ue_assisted_and_ue_based | no_support_for_ganss

-time_aglonass <delay>

-time_agps <delay>

-time_rtt <delay>

-band_combination <number 1>,[<number 2>[,...,<number 16>]]

213
UE capabilities

-access_class <class>

-domain_barring_capable false | true

-fast_dormancy_request_capable false | true

-mac_i_is_capable true | false

-hs_drx_capable true | false

-common_edch_support true | false

-eutra_fdd_support true | false

-eutra_tdd_support true | false

-eutra_feature_group_indicators true | false[,true | false[,true | false[,true |


false]]]

-eutra_bands - | <band>[,<band 2>[,...,<band 16>]]

-eutra_need_for_compressed_mode - | <true|false for eutra_band>[,<true|false for


eutra_band 2>[,...,<true|false for eutra_band 16>]]

-direct_upswitch_ura_dch_capable true | false

-umts_codec_set <codec type>

-gsm_codec_set <codec type>

-min_3gpp_rrc_protocol_version v370 | v380 | v3a0 | v3d0 | v4b0 | v590 | v5c0 | v650


| v690 | v6b0 | v6e0 | v770 | v7b0 | v7e0 | v7g0 |
v860 | v920 | v1000

-ul_need_for_compressed_mode true | false

-dl_need_for_compressed_mode true | false

-ciphering
Specifies whether the UE supports ciphering.
Allowed values: UEA0 (no ciphering), UEA1
Predefined value: UEA1

-security_threshold
Specifies the lifetime of the cipher and integrity keys,
according to 3GPP TS 33.102.
Allowed values: 1-1048575
Predefined value: 1048575

-hsdpa_capable
Specifies whether the UE is capable of HSDPA.
Allowed values: false, true
Predefined value: In r99: false. In hsdpa and eul: true

214
UE capabilities

-hs_fach_capable
Specifies whether the UE is capable of HS FACH.
Allowed values: false, true
Predefined value: false

-hsdpa_ul_capacity
Specifies the maximum UL capacity. The maximum UL
capacity is set for all interactive RABs, not only HSDPA.
Unit: kbit/sec
Allowed values: 64, 384
Predefined value: In r99: 64. In hsdpa and eul: 384

-hsdsch_category
Specifies the HS-DSCH physical layer of a UE as defined
in 3GPP TS 25.306 and 3GPP TS 25.331.
Using HS-DSCH category with no extensions means
that the highest required category is specified and that
3Gsim automatically sets the remaining lower categories
(use the 3gsim list capabilities command to display which
values that are used). It is not possible to specify a higher
category extension without also specifying all lower
extensions.
Note:
Extensions 4 and 5 are not supported in 3Gsim.
This means that if you create a UE with category
extension 4 or 5 (categories 29-32), the UE will use
category 28 instead.
Allowed values: Without extensions: 1-32. With
extensions: 1-64 for HS-DSCH category, 1-20 for HS-
DSCH category extension, 21-24 for extension 2, 25-28
for extension 3, 29-30 for extension 4, 31-32 for extension
5.
Predefined value: 6

-eul_capable
Specifies whether the UE is capable of EUL. The value
true is only used for the EUL RAB state int_eul_hs.
Allowed values: false, true
Predefined value: In r99 and hsdpa: false. In eul: true

-edch_category
Specifies the E-DCH physical layer of a UE as defined
in 3GPP TS 25.306 and 3GPP TS 25.331. The values
are only used for the EUL RAB state int_eul_hs. Using
E-DCH category with no extensions means that the
highest required category is specified and that 3Gsim

215
UE capabilities

automatically sets the remaining lower categories. It is not


possible to specify the higher category extension without
also specifying the lower.
Allowed values: Without extensions: 1-9. With
extensions: 1-16 for E-DCH category, 7 for E-DCH
category extension, 8-9 for E-DCH category extension 2.
Predefined value: 2

-fdpch_support
Specifies whether the UE has support for F-DPCH. R6
means that the UE is F-DPCH capable (read more in the
3GPP specification TS 25.331 version 6.20.0). R7 means
that the UE is F-DPCH and Enhanced F-DPCH capable
(read more in the 3GPP specification TS 25.331 version
7.11.0).
Allowed values: none, R6, R7
Predefined value: none

-gsm_capable
Specifies whether the UE is capable of using GSM.
Allowed values: false, true
Predefined value: false

-cpc_capable
Specifies whether the UE has support for Continuous
Packet Connectivity.
Allowed values: false, true
Predefined value: false

-rxtx_type2_capable
Indicates whether the UE is capable of Rx-Tx time
difference type 2. This parameter is only valid for UEs
supporting 3GPP release 5 and higher, which means that
it is not valid for UEs using the predefined r99 capability
set.
Allowed values: true, false
Predefined value: true

-gps_tcf_support
Indicates whether the UE supports GPS timing of cell
frames.
Allowed values: true, false
Predefined value: true

216
UE capabilities

-na_gps_support
Specifies which type of network assisted GPS support the
UE has.
Allowed values: ue_assisted, ue_based,
both_ue_assisted_and_ue_based,
no_support_for_na_gps
Predefined value: both_ue_assisted_and_ue_based

-ganss_id
Specifies which network assisted GANSS system the UE
supports.
Allowed values: aglonass
Predefined value: aglonass

-ganss_mode
Specifies which mode of GANSS the UE supports.
Allowed values: ue_based, ue_assisted,
both_ue_assisted_and_ue_based, no_support_for_ganss
Predefined value: ue_based

-time_aglonass
Specifies the time delay before the UE sends an answer
to the A-GLONASS Measurement Control message.
Unit: milliseconds (ms)
Allowed values: 0-60000
Predefined value: 0

-time_agps
Specifies the time delay before the UE sends an answer
to the A-GPS Measurement Control message.
Unit: milliseconds (ms)
Allowed values: 0-60000
Predefined value: 0

-time_rtt
Specifies the time delay before the UE sends an answer
to the RTT Measurement Control message.
Unit: milliseconds (ms)
Allowed values: 0-60000
Predefined value: 0

-band_combination
Specifies up to 16 frequency band combinations for the
UEs using the capability set. The value shall match the
RNC settings.
Allowed values: 1-256
Predefined value: 1

217
UE capabilities

-access_class
Specifies the access class for the UEs using this
capability set. 0-9 is used for ordinary UEs, while 11-15 is
reserved for groups like the police and the fire brigade.
Allowed values: 0-9, 11-15
Predefined value: 0

-domain_barring_capable
Specifies whether the UEs using this capability set are
capable of domain barring.
Allowed values: false, true
Predefined value: false

-fast_dormancy_request_capable
Specifies whether the UEs using the capability set include
the cause "UE requested PS Data session end" in the
RRC Signaling Connection Release Indication message.
False means that the IE cause is excluded, true means
that it is included.
Allowed values: false, true
Predefined value: false

-mac_i_is_capable
Specifies whether the UE is capable of the MAC protocol
MAC-I/IS for Improved Layer 2.
Allowed values: true, false
Predefined value: false

-hs_drx_capable
Specifies whether the UE has support for enhanced UE
DRX.
Allowed values: true, false
Predefined value: false

-common_edch_support
Specifies whether the UE is capable of E-DCH or not.
Allowed values: true, false
Predefined value: false

-eutra_fdd_support
Specifies whether the UE has support for the FDD
(Frequency Division Duplex) LTE mode. The UE
is LTE capable if at least one of the parameters
eutra_fdd_support or eutra_tdd_support is set to true.
Allowed values: true, false
Predefined value: false

218
UE capabilities

-eutra_tdd_support
Specifies whether the UE has support for the TDD (Time
Division Duplex) LTE mode. The UE is LTE capable
if at least one of the parameters eutra_fdd_support or
eutra_tdd_support is set to true.
Allowed values: true, false
Predefined value: false

-eutra_feature_group_indicators
This capability contains 4 true|false values. If less than 4
values are introduced, the missing values will be set to
'false'.
1 The first value specifies
whether the UE supports
UTRA CELL_PCH to EUTRA
RRC_IDLE cell reselection
and UTRA URA_PCH to
EUTRA RRC_IDLE cell
reselection.
2 The second value specifies
whether the UE supports
EUTRAN measurements and
reporting in connected mode.
3 The third value specifies
whether the UE supports
UTRA CELL_FACH absolute
priority cell reselection for
high priority layers.
4 The fourth value specifies
whther the UE supports
UTRA CELL_FACH absolute
priority cell reselection for all
layers.
Allowed values: true, false
Predefined value: false,false,falsse,false

-eutra_bands
Specifies a list of LTE frequency bands that the UE
supports as defined in 3GPP TS 36.101. The position of
the numbers has no special meaning. '-' means that no
bands are supported.
Allowed values: 1-16 unique values between 1 and 64,
or '-'.
Predefined value: -

-eutra_need_for_compressed_mode
Specifies whether each supported Eutra frequency
band needs compressed mode. Each position
in the list corresponds to the frequency band in
the same position in the list eutra_bands. If more

219
UE capabilities

eutra_need_for_compressed_mode values than the


number of defined eutra_bands are defined, those without
a correspondent eutra_band value will be ignored. If
less eutra_need_for_compressed_mode values are
introduced than the number of eutra_bands, the missing
eutra_need_for_compressed_mode values will be filled
with 'false'.
Allowed values: 1-16 true or false values.
Predefined value:

-direct_upswitch_ura_dch_capable
Specifies whether the UE is able to perform upswitch
from URA_PCH directly to CELL_DCH. This parameter is
only valid for UEs supporting RRC release 6 and higher.
For instance, set the hsdpa_capable parameter to true to
make the UE support release 6.
Allowed values: true, false
Predefined value: false

-umts_codec_set
Specifies the UMTS speech codec types that the UE
supports. The value is a 16-bit binary corresponding to the
codec list bitmap defined in 3GPP 26.103.
A codec type is supported if the corresponding bit is set
to 1. Reserved bits must be set to 0. All codec types
are coded in the first and second octet of the codec list
bitmap. A description of the codec list bitmap is given
below.
Note:
If both UEs are in UMTS, the umts_codec_set has
higher priority than the gsm_codec_set . If one or
both of the UEs are in GSM, the gsm_codec_set has
higher priority than the umts_codec_set.
Allowed values: 0000000000000000,
0000010000100000, 0000010000000000,
0000000000100000
Predefined value: 0000010000100000

-gsm_codec_set
Specifies the GSM speech codec types that the UE
supports. The value is a 16-bit binary corresponding to the
codec list bitmap defined in 3GPP 26.103.

220
UE capabilities

A codec type is supported if the corresponding bit is set


to 1. Reserved bits must be set to 0. All codec types
are coded in the first and second octet of the codec list
bitmap. A description of the codec list bitmap is given
below.
Note:
If both UEs are in UMTS, the umts_codec_set has
higher priority than the gsm_codec_set . If one or
both of the UEs are in GSM, the gsm_codec_set has
higher priority than the umts_codec_set.
Allowed values: 0000000000000000,
0000000000001000
Predefined value: 0000000000000000

-min_3gpp_rrc_protocol_version
Specifies the minimum 3GPP RRC release version that
the UE supports.
Using this parameter means that the UE's 3GPP RRC
release version that is defined by the capability set can be
overridden by higher versions.
Allowed values: v370, v380, v3a0, v3d0, v4b0, v590,
v5c0, v650, v690, v6b0, v6e0, v770, v7b0, v7e0, v7g0,
v860, v920, v1000
Predefined value: v380

-ul_need_for_compressed_mode
Specifies whether the supported UTRA frequency bands
need compressed mode in uplink direction.
Allowed values: true, false
Predefined value: true

-dl_need_for_compressed_mode
Specifies whether the supported UTRA frequency bands
need compressed mode in downlink direction.
Allowed values: true, false
Predefined value: true

There are 3 predefined sets of capabilities: r99, hsdpa, and eul. r99 is the default behavior. It is used
if no UE capability set is specified when creating the UE.

221
UE capabilities

Predefined settings for HS-DSCH and E-DCH categories


If you choose to specify only the highest required HS-DSCH and E-DCH category and let 3Gsim set
the values for the lower categories, you can display the currently used values by using the command
3gsim list capabilities -long <name of capability set>. The values are presented within brackets for
the hsdsch_category and edch_category parameters.
Example:
3gsim list capabilities eul_hsdsch_cat28
...
hsdsch_category: 28 (10,20,24,28)
...

These are the predefined settings for HS-DSCH categories:


Highest required Predefined values
category
1 1
2 2
3 3
4 4
5 5
6 6
7 7
8 8
9 9
10 10
11 11
12 12
13 9,13
14 10,14
15 9,15
16 10,16
17 9,17
18 10,18
19 9,19
20 10,20
21 9,15,21
22 10,18,22
23 9,19,23
24 10,20,24
25 9,15,21,25
26 10,18,22,26
27 9,19,23,27
28 10,20,24,28
29 10,20,24,28,29
30 10,20,24,28,30
31 10,20,24,28,29,31
32 10,20,24,28,30,32
These are the predefined settings for E-DCH categories:
Highest required Predefined values
category

222
UE capabilities

1 1
2 2
3 3
4 4
5 5
6 6
7 6,7
8 6,7,8
9 6,7,9

Codec list bitmap defined in 3GPP 26.103


All codec types for the umts_codec_set and the gsm_codec_set are coded in the first and second
octet of the codec list bitmap, as follows:
Octet 1:
bit 8 TDMA EFR
bit 7 UMTS AMR 2
bit 6 UMTS AMR
bit 5 HR AMR
bit 4 FR AMR
bit 3 GSM EFR
bit 2 GSM HR
bit 1 GSM FR
Octet 2:
bit 16 (reserved)
bit 15 (reserved)
bit 14 OHR AMR-WB
bit 13 OFR AMR-WB
bit 12 OHR AMR
bit 11 UMTS AMR-WB
bit 10 FR AMR-WB
bit 9 PDC EFR

223
Cell capabilities

28 Cell capabilities

28.1 Cell capability parameters


Function:
The cell capability parameters specify the capabilities of a cell.

-hsdpa on | off

-eul10ms on | off

{-eul2ms on | off}

-enhanced_l2 on | off

-64qam on | off

-mimo on | off

{-mimo_multi_carrier on | off}

{-64qam_and_mimo on | off}

-fdpch on | off

-fdpch_slot_format on | off

-hs_fach on | off

-dch_consumption_law rax2 | rax3

-edch_consumption_law eul1 | eul2 | eul3

-continuous_packet_connectivity on | off

{-max_ue_dtx_cycle <number>}

-multi_carrier on | off

-dual_band_multi_carrier on | off

-dch_eul_load_balancing on | off

-eul_load_balance_threshold <ratio>

-dch_eul_load_balance_threshold <ratio>

-ul_capacity_credit <number>

-dl_capacity_credit <number>

-mac_i_is on | off

-enhanced_ue_drx on | off

224
Cell capabilities

-aqm_hs on | off

-aqm_hs_spi <on or off for SPI 0>,<on or off for SPI 1>,...,<on
or off for SPI 15>

-aqm_hs_spi_bit_rate_dl <rate>

-common_edch on | off

{-common_edch_max_rate <rate>}

-eul_td_scheduling on | off

-ce_cap_eul on | off

-hsdpcch_quality_based_olpc on | off

{-multi_cell_edch on | off}

{-separate_iub_transport on | off}

-user_specific_hs_throughput_est on | off

-hsdpa
Specifies if the cell is capable of HSDPA or not.
Allowed values: on, off
Predefined value: on

-eul10ms
Specifies if the cell is capable of EUL or not.
Allowed values: on, off
Predefined value: on

-eul2ms
Specifies if the cell is capable of EUL 2ms TTI or not.
Allowed values: on, off
Predefined value: off
Conditional:
This parameter is only applicable if the parameter
eul10ms is set to on.

-enhanced_l2
Specifies if a cell has support for enhanced layer 2 or not.
Allowed values: on, off
Predefined value: off

-64qam
Specifies if the cell is capable of 64QAM or not.
Allowed values: on, off
Predefined value: off

225
Cell capabilities

-mimo
Specifies if the cell is capable of MIMO or not.
Allowed values: on, off
Predefined value: on

-mimo_multi_carrier
Specifies if the cell is capable of both MIMO and Multi
Carrier.
Allowed values: on, off
Predefined value: off
Conditional:
If set to on, the parameter mimo must also be set
to on in order to enable the MIMO and Multi Carrier
combination.

-64qam_and_mimo
Specifies if the cell is capable of both 64QAM and MIMO.
Allowed values: on, off
Predefined value: off
Conditional:
If set to on, the parameters 64qam and mimo must
also be set to on in order to enable the 64QAM and
MIMO combination.

-fdpch
Specifies if the cell is capable of F-DPCH or not.
Allowed values: on, off
Predefined value: off

-fdpch_slot_format
Specifies if the cell is capable of F-DPCH slot format or
not.
Allowed values: on, off
Predefined value: off

-hs_fach
Specifies if the cell is capable of HS FACH or not.
Allowed values: on, off
Predefined value: off

-dch_consumption_law
Specifies for the cell in the RBS which consumption law
ladder to report to the RNC for the dedicated channel.
The consumption law value must be the same for all cells
belonging to the same local cell group
Allowed values: rax2, rax3
Predefined value: rax3

226
Cell capabilities

-edch_consumption_law
Specifies for the corresponding cells in the RBS which
consumption law ladder to report to the RNC for EUL.
The consumption law value must be the same for all cells
belonging to the same local cell group.
Allowed values: eul1, eul2, eul3
Predefined value: eul3

-continuous_packet_connectivity
Specifies if continuous packet connectivity is supported
or not. CPC reduces negative impact on the battery life
and on the bandwidth for other devices in the cell. The
max_ue_dtx_cycle is depending on this parameter.
Allowed values: on, off
Predefined value: off

-max_ue_dtx_cycle
Specifies the maximum number of silent slots (DTX cycle)
between the short bursts that are transmitted at regular
time intervals.
Allowed values: 5, 10, 20, 40, 64, 80, 128, 160
Predefined value: 5
Conditional:
This parameter is used if
continuous_packet_connectivity is set to on.

-multi_carrier
Specifies if the cells using the capability set are capable of
Multi Carrier or not.
Allowed values: on, off
Predefined value: off

-dual_band_multi_carrier
Specifies if the cells using the capability set are capable of
dual-band HSDPA Multi Carrier or not.
Allowed values: on, off
Predefined value: off

-dch_eul_load_balancing
Specifies if the cell is capable of DCH/EUL load balancing
or not.
Allowed values: on, off
Predefined value: off

227
Cell capabilities

-eul_load_balance_threshold
Specifies the number of EUL users required in the cell to
fulfill the unhappy UE criterion. The number of UEs must
be equal to or exceed the threshold to fulfil the criterion.
Allowed values: A positive integer
Predefined value: 100

-dch_eul_load_balance_threshold
Specifies the threshold for the DCH channels to EUL
users ratio. The ratio must be equal to or exceed the
threshold to fulfill the unhappy UE criterion. The ratio is
calculated as:
number of DCH channels / (number of DCH channels +
number of EUL users)

Example:
If the sum of DCH channels is 8 and the sum of EUL
users is 6, then the ratio is 8/(8+6) = 0,57, that is
57%.
Unit: percent (%)
Allowed values: 0-100
Predefined value: 100

-ul_capacity_credit
Indicates the UL capacity credits for the cell.
Allowed values: 0-60000
Predefined value: 60000

-dl_capacity_credit
Indicates the DL capacity credits for the cell.
Allowed values: 0-60000
Predefined value: 60000

-mac_i_is
Specifies if the MAC protocol MAC-I/IS for Improved Layer
2 is enabled in the cell or not.
Allowed values: on, off
Predefined value: off

-enhanced_ue_drx
Specifies if the cell has support for enhanced UE DRX or
not.
Allowed values:
Predefined value: off

228
Cell capabilities

-aqm_hs
Specifies if the cell is capable of AQM-based HSDPA
congestion control or not.
Allowed values: on, off
Predefined value: off

-aqm_hs_spi
Specifies if the AQM-based HSDPA congestion control is
turned on or off for each SPI. The values are entered as a
comma-separated list (no spaces), where SPI 0 is the first
element and SPI 15 the last.
In the predefined cell capability set hs_cell SPI 1, 2, 3, 4
and 7 are turned on, and the rest are turned off.
Allowed values: on, off
Predefined value:
off,on,on,on,on,off,off,on,off,off,off,off,off,off,off,off

-aqm_hs_spi_bit_rate_dl
Specifies the rate for all SPIs that have AQM-based
HSDPA congestion control activated. The specified rate is
sent to the RNC in the Capacity Allocation frames.
0 means no transmission.
unlimited is an alias for the maximum value
(4294967295).
Unit: kbit/s
Allowed values: 0-4294967295 (2^(32)-1), unlimited
Predefined value: 100000 (100 Mbit/s)

-common_edch
Specifies whether the cell is capable of E-DCH or not.
Allowed values: on, off
Predefined value: off

-common_edch_max_rate
Specifies the maximum data throughput on the C-EDCH
channel in the cell. If common_edch is set to on, the value
set in common_edch_max_rate is sent to the RNC as
serving grant value during the cell setup.
Unit: kbps
Allowed values: 32-1376
Predefined value: 1376
Conditional:
This parameter is only used if common_edch is set to
on.

229
Cell capabilities

-eul_td_scheduling
Specifies if the cell is capable of the EUL TD Scheduling
or not.
Allowed values: on, off
Predefined value: off

-ce_cap_eul
Specifies if the cell is capable of Channel Element
capacity for EUL Smartphones (per HARQ) or not. The
ce_cap_eul value must be the same for all cells belonging
to the same local cell group
Allowed values: on, off
Predefined value: off

-hsdpcch_quality_based_olpc
Specifies if the feature HS-DPCCH Quality Based
OLPC is enabled in the cell or not. See also the cell
behavior parameters hsdpcch_quality_based_olpc_delay,
hsdpcch_quality_based_olpc_values, and
hsdpcch_quality_based_olpc_repeat_interval.
Allowed values: on, off
Predefined value: off

-multi_cell_edch
Specifies if the local cell is capable of Multi Cell E-
DCH. This parameter must be set to on in order for EUL
Multi Carrier to work. The Multi Cell E-DCH capability
is indicated in the IE "Cell Capability Container" in the
NBAP messages Audit Response and Resource Status
Indication, where the "Multi Cell E-DCH Capability" bit is
set to "1".
Allowed values: on, off
Predefined value: off
Conditional:
If set to on, then the parameters eul10ms,
eul2ms, mac_i_is, fdpch, hsdpa, enhanced_l2 and
multi_carrier must be set to on in order to enable EUL
Multi Carrier. Both the primary and the secondary cell
need to have support for EUL Multi Carrier.

-separate_iub_transport
Specifies if the local cell is capable of Separate Iub
Transport Bearer for EUL Multi Carrier. This parameter
must be set to on in order for EUL Multi Carrier to
work. The Separate Iub Transport Bearer capability
is indicated in the IE "Cell Capability Container" in the

230
Cell capabilities

NBAP messages Audit Response and Resource Status


Indication, where the "Transport Bearer Capability" bit is
set to "1".
Allowed values: on, off
Predefined value: off
Conditional:
If set to on, then the parameters eul10ms,
eul2ms, mac_i_is, fdpch, hsdpa, enhanced_l2 and
multi_carrier must be set to on in order to enable EUL
Multi Carrier. Both the primary and the secondary cell
need to have support for EUL Multi Carrier.

-user_specific_hs_throughput_est
Specifies if the cell is capable of user specific HS
throughput estimation or not.
Allowed values: on, off
Predefined value: off

The predefined cell capability set is named hs_cell. To customize it, use the capabilities commands.

231
LTE RBS capabilities

29 LTE RBS capabilities

29.1 LTE RBS capability parameters


Function:
The LTE RBS capability parameters specify the capabilities of an LTE RBS.

-psho true | false

-psho
Specifies whether the LTE RBS is PSHO capable.
Allowed values: true (PSHO capable), false
Predefined value: true

There is 1 predefined set of capabilities: lte_rbs_default, which is the default capability set. It is used
if no LTE RBS capability set is specified when creating the LTE RBS.

232
RAB state group commands

30 RAB state group commands

30.1 Create RAB group


Function:
This command creates a new RAB state group.

3gsim crg | create rab_group

<name>

<RAB>[,<RAB 2>,...]

<name>
The name of the new RAB group. The name must be
unique.
Allowed values: A-Z, a-z, 0-9, _ and *

<RAB>[,<RAB 2>,...]
The RAB states included in the new RAB state group. If
<RAB> is a RAB state group, all RAB states included in
that group are added to this group.
Allowed values: RABs and RAB state groups

30.2 List RAB group


Function:
This command lists one or all RAB state groups.

3gsim lrg | list rab_group

[[<RAB group name>]]

[<RAB group name>]


The name of the RAB group to list.

If no RAB state group is given, all existing RAB state groups are listed.

233
RAB state group commands

30.3 Modify RAB group


Function:
This command modifies a user-defined RAB state group.
Prerequisites:
User-defined RAB state groups must have been created with the 3gsim create rab_group
command.

3gsim mrg | modify rab_group

<RAB group>

<RAB> | <RAB group>


[,<RAB 2> | <RAB group 2>,...

<RAB group>
The name of the RAB state group to modify.
Allowed values: The name of an existing user-defined
RAB state group

<RAB> | <RAB group>


[,<RAB 2> | <RAB group 2>,... The RAB states and RAB state groups to include in the
RAB state group. If <RAB> is a RAB state group, all RAB
states included in that group are added to this group. The
specified list of RAB states replaces the old list of RAB
states.
Allowed values: RAB states, RAB state groups

It is not possible to modify predefined RAB state groups.

30.4 Delete RAB group


Function:
This command deletes a user-defined RAB state group.
Prerequisites:
User-defined RAB state groups must have been created with the 3gsim create rab_group
command.

3gsim delrg | delete rab_group

[<name>]

{-all}

<name>
Specifies a user-defined RAB state group to delete.
Allowed values: RAB state group name

234
RAB state group commands

-all
Deletes all defined RAB groups.
Conditional:
Cannot be used together with any other parameter.

Predefined RAB groups and RAB groups that are currently used in a traffic behavior cannot be
deleted.

235
Packet Data Generator (PDG) commands

31 Packet Data Generator (PDG) commands

31.1 Create Packet Data Generator


Function:
This command creates one Packet Data Generator (PDG).

3gsim cpdg | create packet_data_generator

-i | -id <PDG ID>

-pu | -processor_unit <processor>[/<instance>]

[-iaf | -iu_atm_fro <FRO ID>]

[-iif | -iu_ip_fro <FRO ID>]

[-gif | -gi_ip_fro <FRO ID>]

[-ias | -iu_atm_server <type>/<IP address>:<port> [,<type>/<IP


address>:<port>],...]]

[-iis | -iu_ip_server <type>/<IP address>:<port> [,<type>/<IP


address>:<port>],...]]

[-gis | -gi_ip_server <type>/<port>[,<type>/<port>],...]]

[-nic | -no_inband_control]

[-sgsn_ip <IP address>[,<IP address>,...]]

-id
Specifies a unique identity of the PDG to create.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-processor_unit
Specifies the processor where the simulated node
executes, and optionally a program instance (used for
multi core systems).
The specified processor and program instance must
match the configuration of the node being used. The
processor number and the program instance number are
separated by a slash (/).
You can find the processor number and the program
instance number by running the command 3gsim list
installation -process_name tgs_ippacgen_proc and look
for the result displayed in the PU column.

236
Packet Data Generator (PDG) commands

Program instance 1 means a program instance that


executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on.
The spm option is deprecated. It can still be used for
compatibility reasons.
Example:
-processor_unit 0011000
-processor_unit 0016000/2
-processor_unit 0017001/1

Allowed values: Processor: a 6-digit or 7-digit number.


Program instance: positive number.

-iu_atm_fro
Specifies the FRO ID of an AAL5 PVC on the processor
unit given by the processor_unit parameter. Used in
simCN with Iu over ATM.
Allowed values: decimal number

-iu_ip_fro
Specifies the FRO ID of an IP Access Host on the
processor unit given by the processor_unit parameter.
Used in simCN with Iu over IP.
Allowed values: decimal number

-gi_ip_fro
Specifies the FRO ID of an IP Access Host on the
processor unit given by the processor_unit parameter.
Used in real Core Networks.
Allowed values: decimal number

-iu_atm_server
Specifies a list of additional servers to create. Used in
simCN with Iu over ATM.
Type is a server type (UDP or TCP).
IP address is a server IP address.
Port is a server port.
Allowed values: Type: udp, tcp. IP address: IPv4
address in dot notation. Port: 1-65535.
Default value: UDP/127.0.0.1:65000,
TCP/127.0.0.1:65000

-iu_ip_server
Specifies a list of additional servers to create. Used in
simCN with Iu over IP.
Type is a server type (UDP or TCP).
IP address is a server IP address.

237
Packet Data Generator (PDG) commands

Port is a server port.


Allowed values: Type: udp, tcp. IP address: IPv4
address in dot notation. Port: 1-65535.
Default value: UDP/127.0.0.1:65000,
TCP/127.0.0.1:65000

-gi_ip_server
Specifies a list of additional servers that shall be created
in case a real core network is used (Gi interface). No
IP address is specified with this parameter since the IP
address of the processor unit is used. The IP address
is specified indirectly in the gi_ip_fro parameter. When
using an EVO node the default port is based on the
instance number of the PU used for this PDG. The port
number is 65000 + 2 x (The PU core instance number).
For example, instance 5 has UDP/65010 and TCP/65010.
Instance 6 has UDP/65012 and TCP/65012. Instance 7
has UDP/65014 and TCP/65014.
Type is a server type (UDP or TCP).
Port is a server port.
Allowed values: Type: udp, tcp. Port: 1-65535.
Default value: UDP/65000 (+ 2 x instanceNo),
TCP/65000 (+ 2 x instanceNo)

-no_inband_control
When this parameter is used, the PDG considers all
received packets as data packets. The parameter takes
no argument.

-sgsn_ip
Specifies the Iu-GTP-U service IP addresses of the SGSN
node in a simCN with Iu over ATM.
Allowed values: comma-separated list of IP addresses

Always create PDGs when PS traffic is used, both for simulated and real Core Networks. Create the
PDGs before the SGSN node is created in a simCN. Depending on if you run Iu over IP, Iu over ATM
or Gi, different parameters are used.

31.2 List Packet Data Generator


Function:
This command lists one or all created PDGs.

3gsim lpdg | list packet_data_generator

[-i | -id <PDG ID> | all]

[-l | -long]

238
Packet Data Generator (PDG) commands

{-imsi <IMSI>[-<IMSI>] | all}

-id
A unique ID for the PDG to be listed. The value all is also
valid and lists all defined PDGs.
Allowed values: PDG ID or all

-long
Prints information in long format, including information
about the PDG sessions that exist when the command is
executed.

-imsi
Specifies the IMSI number for the UE to be listed, or a
range with the first and last IMSI numbers. Only the last
few digits of the last IMSI in the range are needed. The
value all is also valid and lists all defined subscriptions.
Example:
Specify the range 123089, 123090, 123091, and
123092:
imsi 123089-92

Note:
This parameter is not implemented yet and using it
has no effect.
Conditional:
This parameter is valid only if the long parameter is
used.

When listing a PDG using the long option, the following is displayed:
ID The name of the PDG
PU The address of the processor unit where the PDG executes and, if a
multi core system is used, program instance
IP ADDRESS The IP address of the processor unit
IuAtmFro The FRO ID of an AAL5 PVC
IuIpFro The FRO ID of an IP Access Host
GiIpFro The FRO ID of an IP Access Host
ALLOWS INBAND Tells whether inband control is allowed
CONTROL
IP-ADDRESSES The IP addresses used for RAB assignments
USED AT RAB
ASSIGNMENT

239
Packet Data Forwarder (PDF) commands

32 Packet Data Forwarder (PDF) commands

32.1 Create Packet Data Forwarder


Function:
This command creates one Packet Data Forwarder (PDF). NOTE: The PDF is currently not
supported on EVO.

3gsim cpdf | create packet_data_forwarder

-id <PDF ID>

-pu | -processor_unit <board>[/<instance>]

-f | -ip_fro <FRO ID>

-id
Specifies a unique identity of the PDF (Packet Data
Forwarder) to create.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-processor_unit
A number identifying the slot position for the processor
unit where the simulated node executes, and optionally a
program instance (used for multi core systems).
The slot position and the program instance must match
the configuration of the node being used. Slot position and
program instance are separated by a slash (/).
You can find the slot position by running the command
3gsim list installation -process_name tgs_pdf_proc and
look for the result displayed in the PU column.
Program instance 1 means a program instance that
executes in the first core; program instance 2 means a
program instance that executes in the second core and so
on. If a multi core system is used and a program instance
is not specified means that program instance 1 is used.
If a single core system is used, program instance 1 can
optionally be specified.
Example:
-processor_unit 0011000
-processor_unit 0016000/2
-processor_unit 0017001/1

Allowed values: Board number: a 6-digit or 7-digit


number. Program instance: 1 to 8.

240
Packet Data Forwarder (PDF) commands

-ip_fro
Specifies the FRO ID of an IP Access Host on the PU
given by the pu parameter.
Allowed values: decimal number

A Packet Data Forwarder is needed if external PS data generators are used.

32.2 List Packet Data Forwarder


Function:
This command lists one or all created PDFs.

3gsim lpdf | list packet_data_forwarder

[-id <PDF ID> | all]

[-l | -long]

{-i | -imsi <IMSI>[-<IMSI>] | all}

-id
A unique ID for the PDF to be listed. The value all is also
valid and lists all defined PDFs.
Allowed values: PDF ID or all

-long
Prints information in long format, including information
about the PDF translation rules that exist when the
command is executed.

-imsi
Specifies the IMSI number for the UE to be listed, or a
range with the first and last IMSI numbers. Only the last
few digits of the last IMSI in the range are needed. The
value all is also valid and lists all defined subscriptions.
Example:
Specify the range 123089, 123090, 123091, and
123092:
imsi 123089-92

Conditional:
This parameter is valid only if the long parameter is
used.

When listing a PDF, the following is displayed:


ID The name of the PDF
PU The processor unit where the PDF executes and, if a multi core system
is used, the program instance.
IP ADDRESS The IP address of the processor unit
IP-FRO The FRO ID of an IP Access Host
IMSI The IMSI of the UE

241
Packet Data Forwarder (PDF) commands

EXTERNAL The IP address of external PS data generator for given PDP context
GENERATOR IP-
ADDRESS
PDP CONTEXT IP- The IP address assigned to PDP context
ADDRESS
RB ID The ID of radio bearer transporting data for given PDP context

242
RIM association commands

33 RIM association commands

33.1 Create RIM association


Function:
This command is obsolete! Use the 3gsim modify lte_rbs command to create RIM associations.

3gsim cra | create rim_association

-id <RIM ID>

-sgsn_id <SGSN ID>

-lte_cell_id <Cell ID>

-cell_address <LAC>:<RAC>:<RNC ID>:<RIM cell ID>

-rim_association_attempt <timeout value 1>


[,<timeout value 2>
[,...,<timeout value 10>]]]

-rim_si_update <SI update timeout value>

-id
Specifies the ID of the RIM association to create.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-sgsn_id
Specifies the ID of the SGSN node to which the traffic
from the cell is routed.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _.

-lte_cell_id
Specifies the ID of the LTE cell for which to create a RIM
association.
Allowed values: A positive integer

-cell_address
Specifies the cell address of the associated WCDMA cell.
Use the format <LAC>:<RAC>:<RNC ID>:<RIM cell ID>.
Example:
1:10:1:1002
Allowed values: LAC (Location Area Code), RAC
(Routing Area Code), and RNC ID are defined in 3GPP
S1AP 36.413 (RIM routing address). RIM cell ID is the
value specified in the second and third octets of the Cell
Identity IE as defined in 3GPP TS 24.008.

243
RIM association commands

-rim_association_attempt
Specifies a list of maximum 10 retry timer values to be
used for surveillance of RIM association attempts. When
the first RAN Information Request is sent, the surveillance
timer is started with the first value in the list. If no RAN
Information Confirm is received before the timer runs out,
a new request is sent and the timer is started with the
second value in the list. If the end of the list is reached no
more attempts are made.
After a successful attempt the list is reset to the first
value so that the procedure is restarted for all new RIM
association attempts.
Unit: milliseconds (ms)
Allowed values: Positive integers
Default value:
60000,600000,1200000,2400000,4800000,
9600000,19200000,38400000,86400000

-rim_si_update
Specifies the duration of the RIM information. If no
update is received within this time, a new RIM association
procedure is triggered.
Use 1 timer per association in the simulated eNodeB.
Unit: milliseconds (ms)
Allowed values: A positive integer
Default value: 86400000 (24 h)

33.2 List RIM association


Function:
This command is obsolete! Use the 3gsim list lte_rbs command to list RIM associations.

3gsim lra | list rim_association

-id <RIM ID> | all

-id
Specifies the RIM association to list. Use all to list all
associations.
Unit:
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _, or all.
Default value:

The following RIM association properties are displayed:


• RIM association ID
• SGSN ID

244
RIM association commands

• LTE cell ID
• Cell address of the associated WCDMA cell
• RIM association attempt timeout values
• RIM system information update timeout value

33.3 Delete RIM association


Function:
This command is obsolete! Use the 3gsim modify lte_rbs command to delete RIM associations.

3gsim delra | delete rim_association

-id <RIM ID> | all

-no_stop

-id
Specifies the RIM association to delete. Use all to delete
all existing associations.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _, or all.

-no_stop
Specifies whether RIM signaling takes place to end the
RIM association in a controlled way or not.
Not using this option means that a RAN-INFORMATION-
REQUEST/Stop PDU is triggered before the association is
terminated.
Using this option means that no RAN-INFORMATION-
REQUEST/Stop message is sent to the RNC, and as
a result no RAN-INFORMATION/Stop message is sent
back. This allows you to simulate an S1 outage, that
is, a scenario where the eNodeB goes down without
stopping its associations and then after restart recreates
the associations again.
Allowed values: A string containing any of the characters
A-Z, a-z, 0-9 and _, or all.

245
Scripts

34 Scripts

34.1 3Gsim_update.pl
Function:
This script updates 3Gsim on a node with an existing installation.

3gsim_update.pl

[-r | -restart]

[-cv <CV name>]

[-l | -list]

-file load module file

[-cc= "<CV comment>"]

[-d | -debug]

[-group <file>]

[-h | -help]

[-md5debug]

[-print_cpp_version]

[-source <directory>]

[-telnet_port <telnet port>]

[-ftp_port <ftp port>]

<node name>

<password>

<3Gsim release label>

-restart
Restarts the node after the update. 3Gsim must always be
restarted for the update to take effect, either immediately
with the restart option, or later manually.

-cv
Creates a CV after the update.

-list
Lists the current versions of the 3Gsim load modules.

-file
Updates a single load module. The parameter can be
used several times in the same command if more than
one load module shall be updated.

246
Scripts

-cc=
Sets a comment on the CV created by this command.
Example:
cc="This is a CV comment"

-debug
Prints debug information.

-group
Specifies a text file containing names of files to be
updated.

-help
Prints help information.

-md5debug
Prints debug information related to MD5 checksums.

-print_cpp_version
Prints the CPP version on the node.

-source
Specifies the directory where the load modules are stored.

-telnet_port
Specifies the port to use for Telnet operations. This option
can be used together with any other combination of
options.

-ftp_port
Specifies the port to use for FTP operations. This option
can be used together with any other combination of
options.

<node name>
Specifies the name of the hardware.

<password>
Specifies the user password.

<3Gsim release label>


Specifies the 3Gsim release label.

During the update the script does the following:


• Copies updated versions of 3Gsim load modules to the node
• Distributes the MP and the BP load modules to the GPBs/EPBs using these load modules
• Removes the SP load modules from the SPBs
• Updates the SQL database with the versions of the new load modules
• Creates a CV
• Restarts the node (optional)
The 3gsim_update.pl script is avaliable in the /vobs/3gsim/3gsim_products/3gsim/install/ directory.
The 3Gsim web page for SW release information at https://ericoll.internal.ericsson.com/
SITES/3GSIM_PRODUCT/default.aspx lists all 3Gsim builds that are available for updating.
The script does not depend on or modify the hardware configuration. It only changes the version
of the 3Gsim or the CPP load modules. The script checks the hardware configuration data in the
database on the node in order to distribute the MP load modules to the correct GPBs.

247
Scripts

The script does not add any load modules to the node that was not present before the update. This
means that if there are new load modules that need to be added, a new installation has to be done.
The script automatically detects which software release of CPP the 3Gsim build is based on.
Example:
Update to 3Gsim 3GSIM_12_1806_CPP8.0.1.1_EP34:
3gsim_update.pl -restart tgs8 mypassword 3GSIM_12_1806_CPP8.0.1.1_EP34

List the current versions of the 3Gsim load modules:


3gsim_update.pl -list tgs97 mypassword

248
Scripts

34.2 3gsim_clean.pl
Function:
This script starts a GUI in which you can select CVs, 3Gsim load mobules and PMD files to
remove from the EPBs, GBPs and SPBs in the node.

3gsim_clean.pl

[-debug]

[-s]

[-usage]

[-verbose]

[-activeFtp]

[-passiveFtp]

[-deletePMD]

[-deleteLMs]

<node name>

<password>

-debug
Prints debug information during the script execution.

-s
Lists the commands that are used by the script to modify
the node without executing them.

-usage
Displays information about all parameters that can be
given to this script.

-verbose
Prints log messages during the script execution.

-activeFtp
Uses active mode FTP towards the node. This is the
default option.

-passiveFtp
Uses passive mode FTP towards the node.

-deletePMD
Removes unused 3Gsim PMD files from the node without
starting the GUI.

-deleteLMs
Removes unused 3Gsim modules from the node without
starting the GUI.

<node name>
The name of the hardware to clean.

249
Scripts

<password>
The user password.

Use the 3gsim_clean.pl script when the hard disks on the boards in 3Gsim become full. The script is
avaliable in the directory /vobs/3gsim/3gsim_products/3gsim/install/.

250

You might also like