WICL Commands STD 101513024289001

Proprietary Use pursuant to Company instruction
DRAFT
Title page
W-CDMA
9353 Management System | OAM07.1
Commands Reference Guide (WICL)
DRAFT
Alcatel-Lucent Internal
NN-20500-030
ISSUE 12.01/EN
OCTOBER 2009
DRAFT

Legal notice
Legal notice
Alcatel, Lucent, Alcatel-Lucent and the Alcatel-Lucent logo are trademarks of Alcatel-Lucent. All other trademarks are the property of their respective
owners.
The information presented is subject to change without notice. Alcatel-Lucent assumes no responsibility for inaccuracies contained herein.
Copyright 2009 Alcatel-Lucent. All rights reserved.
Contains proprietary/trade secret information which is the property of Alcatel-Lucent and must not be made available to, or copied or used by anyone outside
Alcatel-Lucent without its written authorization.
DRAFT
ot to be used or disclosed except in accordance with applicable agreements.
DRAFT
Contents
About this document
Purpose ........................................................................................................................................................................................ xxiii
xxiii
PUBLICATIO HISTORY
............................................................................................................................................................................... xxv
xxv
Applicability
Intended audience
Prerequisites
................................................................................................................................................. xxiii
..................................................................................................................................................................... xxv
xxv
.............................................................................................................................................................................. xxvi
xxvi
How this publication is organized

Vocabulary conventions
Related information
How to comment
1
..................................................................................................................................... xxvi
........................................................................................................................................................ xxvi
xxvi
............................................................................................................................................................... xxvii
xxvii
.................................................................................................................................................................... xxvii
xxvii
Roadmap to W-CDMA Customer Documentation

.......................................................................................................................................................................................................... 1-1
1-1
New in this release

.......................................................................................................................................................................................................... 2-1
2-1
WICL Access
Overview ....................................................................................................................................................................................... 3-1
3-1
WICL console
............................................................................................................................................................................. 3-2
3-2
WICL line mode shell

4
.............................................................................................................................................................. 3-5
3-5
Basic syntax
.......................................................................................................................................................................................................... 4-1
4-1
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
iii
Issue 12.01/EN October 2009
DRAFT
Contents
...................................................................................................................................................................................................................................
WICL command description

5-1
Overview ....................................................................................................................................................................................... 5-1
Typographic conventions in the description of the WICL commands
................................................................... 5-8
Object discovery
.......................................................................................................................................................................................................... 5-9
5-9
ROC command
......................................................................................................................................................................... 5-10
5-10
UTRA list <param> command ........................................................................................................................................ 5-11

UTRA OAMLinkBreaks command
UTRA AllDesynchro command
UTRA
.............................................................................................................................. 5-13
..................................................................................................................................... 5-14
ECriticalAlarms command ............................................................................................................................. 5-15
UTRA getObjectListFrom3gppD command

list command
.......................................................................................................... 5-16
............................................................................................................................................................................. 5-17
5-17
displayTraceSession command
.......................................................................................................................................... 5-19
Object selection ........................................................................................................................................................................ 5-20

5-20
Object edition
........................................................................................................................................................................................................ 5-24
5-24
delete command
....................................................................................................................................................................... 5-25
5-25
createOnline command .......................................................................................................................................................... 5-26

5-26
5-27
deleteOnline command .......................................................................................................................................................... 5-27
CreateTraceSession command
............................................................................................................................................ 5-28
5-28
DeleteTraceSession command
............................................................................................................................................ 5-34
5-34
setTraceSession command
................................................................................................................................................... 5-35
5-35
DRAFT
Parameter manipulation
........................................................................................................................................................................................................ 5-37
5-37
...................................................................................................................................................................................................................................
NN-20500-030
iv
...................................................................................................................................................................................................................................
dis.play command
Get command
................................................................................................................................................................... 5-38
5-38
............................................................................................................................................................................ 5-39
5-39
GetAttributes command
DRAFT
Contents
........................................................................................................................................................ 5-40
5-40
5-41
GetAll command ...................................................................................................................................................................... 5-41
SetOnline command
............................................................................................................................................................... 5-42
5-42
SetOnlineAdministrativeState command ........................................................................................................................ 5-44

SetAllOnline command
GetIC command
......................................................................................................................................................... 5-45
5-45
....................................................................................................................................................................... 5-46
5-46
SetIC command ........................................................................................................................................................................ 5-47

5-47
5-48
GetAllIC command ................................................................................................................................................................. 5-48
GetDD command ..................................................................................................................................................................... 5-49
5-49
GetAllDD command
.............................................................................................................................................................. 5-50
5-50
getDescription command
...................................................................................................................................................... 5-51
5-51
getStateChange command
getStatus command
.................................................................................................................................................... 5-53
5-53
................................................................................................................................................................. 5-56
5-56
getAttributeValueInBulk command
.................................................................................................................................. 5-58
UTRA commands
........................................................................................................................................................................................................ 5-59
5-59
iR C commands ...................................................................................................................................................................... 5-60

5-60
iBTSEquipment commands
POC command
................................................................................................................................................. 5-76
5-76
......................................................................................................................................................................... 5-94
5-94
MicroPicoBTS commands
................................................................................................................................................... 5-95
5-95
OneBTSEquipment commands
.......................................................................................................................................... 5-98
5-113
I- ode command ................................................................................................................................................................... 5-113
Work order manipulation commands ............................................................................................................................. 5-114
Configuration manager commands
...................................................................................................................................................................................................................................
NN-20500-030
v
DRAFT
...................................................................................................................................................................................................... 5-117
5-117
DRAFT
Contents
...................................................................................................................................................................................................................................
CM createSession command ............................................................................................................................................. 5-118

5-118
CM terminateSession command
CM abortSession command
CM validate command
...................................................................................................................................... 5-119
.............................................................................................................................................. 5-120
........................................................................................................................................................ 5-121
5-121
CM listSession command
.................................................................................................................................................. 5-122
5-122
CM displaySession command
CM preActivate command
.......................................................................................................................................... 5-123
................................................................................................................................................ 5-124
5-124
CM activate command
........................................................................................................................................................ 5-125
5-125
CM resume command
......................................................................................................................................................... 5-126
5-126
CM setActivationType command
................................................................................................................................... 5-127
CM getAvailableConfigModels command
CM export command
.................................................................................................................. 5-128
........................................................................................................................................................... 5-129
5-129
CM exportR S command
................................................................................................................................................. 5-131
CM getImpactedConfig odes command ..................................................................................................................... 5-133

CM getImpactedConfig odesInfo command
CM release odes command
............................................................................................................ 5-134
............................................................................................................................................. 5-135
5-135
5-136
CM fallback command ........................................................................................................................................................ 5-136
CM listGeneratedSessions command
CM launchSession command
createCMSession command
............................................................................................................................ 5-137
........................................................................................................................................... 5-138
.............................................................................................................................................. 5-139
5-139
Performance manager commands

..................................................................................................................................................................................................... 5-140
5-140
PM block E command ....................................................................................................................................................... 5-141

5-141
PM unblock E command .................................................................................................................................................. 5-142
PM set odeBGranularity command .............................................................................................................................. 5-143
DRAFT
PM get odeBGranularity command

PM upgCounterFile command
............................................................................................................................. 5-146
......................................................................................................................................... 5-147
...................................................................................................................................................................................................................................
NN-20500-030
vi
...................................................................................................................................................................................................................................
recoverObs command .......................................................................................................................................................... 5-149

5-149
PM importCounterList command
................................................................................................................................... 5-150
DRAFT
Contents
PM exportCounterList command .................................................................................................................................... 5-151

PM checkCounterList command
..................................................................................................................................... 5-152
Fault manager commands

..................................................................................................................................................................................................... 5-154
5-154
FM getAlarms command
................................................................................................................................................... 5-155
5-155
FM setFmbbCache command ........................................................................................................................................... 5-159

FM clearAlarm command
.................................................................................................................................................. 5-160
5-160
FM acknowledgeAlarm command
SEC EncryptSecret command
................................................................................................................................. 5-161
.......................................................................................................................................... 5-162
I-ode and POC commands

..................................................................................................................................................................................................... 5-164
5-164
5-166
declaration command ........................................................................................................................................................... 5-166
undeclaration command ...................................................................................................................................................... 5-168
5-168
5-169
startProv command ............................................................................................................................................................... 5-169
endProv command
................................................................................................................................................................ 5-170
5-170
start command
........................................................................................................................................................................ 5-171
5-171
copy command
....................................................................................................................................................................... 5-172
5-172
check command
..................................................................................................................................................................... 5-173
5-173
activate command
................................................................................................................................................................. 5-174
5-174
confirm command
................................................................................................................................................................. 5-175
5-175
commit command
................................................................................................................................................................. 5-176
5-176
save command ........................................................................................................................................................................ 5-177

5-177
load command
........................................................................................................................................................................ 5-178
5-178
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
vii
DRAFT
Contents
...................................................................................................................................................................................................................................
apply command ...................................................................................................................................................................... 5-179

5-179
end command
......................................................................................................................................................................... 5-180
5-180
lock command
........................................................................................................................................................................ 5-181
5-181
unlock command
reset command
................................................................................................................................................................... 5-182
5-182
....................................................................................................................................................................... 5-183
5-183
switch command .................................................................................................................................................................... 5-184

5-184
5-185
switchover command ........................................................................................................................................................... 5-185
ppBackup command
............................................................................................................................................................ 5-186
5-186
ppRestore command
............................................................................................................................................................ 5-188
5-188
at commands
..................................................................................................................................................................................................... 5-190
5-190
Date-and-time syntax ........................................................................................................................................................... 5-191

5-191
Eval command
Exec scripts
Get job list
............................................................................................................................................................................. 5-193
5-193
............................................................................................................................................................................... 5-194
5-194
Remove job
............................................................................................................................................................................. 5-195
5-195
Get job result

Get job info
....................................................................................................................................................................... 5-192
5-192
.......................................................................................................................................................................... 5-196
5-196
............................................................................................................................................................................. 5-197
5-197
Configuration file
..................................................................................................................................................................................................... 5-198
5-198
WICLConfigInit command
............................................................................................................................................... 5-199
5-199
WICLConfigGetValue command .................................................................................................................................... 5-200

Trace file
..................................................................................................................................................................................................... 5-201
5-201
WICLTraceInit command
DRAFT
WICLTrace command
.................................................................................................................................................. 5-202
5-202
......................................................................................................................................................... 5-203
5-203
...................................................................................................................................................................................................................................
NN-20500-030
viii
...................................................................................................................................................................................................................................
WICLTraceError command ............................................................................................................................................... 5-204

5-204
WICLTraceBegin command
WICLTraceEnd command
............................................................................................................................................. 5-205
5-205
DRAFT
Contents
................................................................................................................................................. 5-206
5-206
File management
..................................................................................................................................................................................................... 5-207
5-207
open command
....................................................................................................................................................................... 5-208
5-208
close command
...................................................................................................................................................................... 5-209
5-209
dir command
........................................................................................................................................................................... 5-210
5-210
Help command management

...................................................................................................................................................................................................... 5-211
5-211
help command
........................................................................................................................................................................ 5-212
5-212
help <wicl_command> command ................................................................................................................................... 5-213
Long command management ............................................................................................................................................ 5-214
OAM software management
............................................................................................................................................. 5-216
Environmental variable management

..................................................................................................................................................................................................... 5-218
5-218
setEnv command
................................................................................................................................................................... 5-219
5-219
getEnv command ................................................................................................................................................................... 5-220

5-220
prepareReport command
licenseCheck command
.................................................................................................................................................... 5-221
5-221
...................................................................................................................................................... 5-223
5-223
...................................................................................................................................................................................................................................
NN-20500-030
ix
DRAFT
licenseSnapshot command ................................................................................................................................................. 5-225

5-225
DRAFT
Contents
...................................................................................................................................................................................................................................
WICL command / E mapping

6
........................................................................................................................................ 5-227
WICL script management

6-1
Overview ....................................................................................................................................................................................... 6-1
Script access security ................................................................................................................................................................ 6-3

6-3
WICL script editor
.......................................................................................................................................................................................................... 6-5
6-5
Use the command parameter wizard ................................................................................................................................... 6-7

6-9
Create a script .............................................................................................................................................................................. 6-9
Edit a script
................................................................................................................................................................................ 6-11
6-11
Save a script
.............................................................................................................................................................................. 6-12
6-12
WICL script browser

........................................................................................................................................................................................................ 6-13
6-13
Create a Directory or a Script File
.................................................................................................................................... 6-14
Rename a Directory or a Script File

Delete a Directory or a Script File
................................................................................................................................. 6-15
.................................................................................................................................... 6-16
Move a Directory or a Script File ...................................................................................................................................... 6-17

Duplicate a Directory or a Script File
.............................................................................................................................. 6-18
Open a Script File .................................................................................................................................................................... 6-19

6-19
Search for a Directory or a Script File
............................................................................................................................. 6-20
6-21
Refresh a Directory Content ................................................................................................................................................ 6-21
WICL Script Running and Scheduling
........................................................................................................................................................................................................ 6-22
6-22
DRAFT
WICL Script Running
............................................................................................................................................................ 6-23
6-23
6-24
WICL Script Scheduling ....................................................................................................................................................... 6-24
...................................................................................................................................................................................................................................
NN-20500-030
...................................................................................................................................................................................................................................
WICL script examples

........................................................................................................................................................................................................ 6-27
6-27
Build All R C
DRAFT
Contents
.......................................................................................................................................................................... 6-28
6-28
6-29
Openlink All R C ................................................................................................................................................................... 6-29
Set All Attributes for all ode Bs ...................................................................................................................................... 6-30
WICLConfig
............................................................................................................................................................................. 6-31
6-31
6-32
WICLTrace ................................................................................................................................................................................. 6-32
HTML table output using WICL script
Count Access Objects
........................................................................................................................... 6-34
............................................................................................................................................................ 6-37
6-37
Scheduled Export script
........................................................................................................................................................ 6-40
6-40
Access scripts ............................................................................................................................................................................ 6-41

6-41
E inventory
............................................................................................................................................................................. 6-42
6-42
OAM software inventory ...................................................................................................................................................... 6-46

6-46
ortel Multiservice Switch Scripts
................................................................................................................................... 6-47
6-48
Feature Lock Scripts ............................................................................................................................................................... 6-48
7
WICLET
Overview ....................................................................................................................................................................................... 7-1
7-1
WICL plug-ins
.......................................................................................................................................................................................................... 7-2
7-2
WICL server pages (WSP)

WICLET management
..................................................................................................................................................... 7-3
7-3
............................................................................................................................................................. 7-6
7-6
WICLET examples
.......................................................................................................................................................................................................... 7-8
7-8
Online neighbouring management wiclet
......................................................................................................................... 7-9
7-19
Other WICLET examples ..................................................................................................................................................... 7-19
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
xi
DRAFT
Contents
...................................................................................................................................................................................................................................
Using WICLETs ....................................................................................................................................................................... 7-23

7-23
8
Error dictionary
8-1
Overview ....................................................................................................................................................................................... 8-1
WICL Server ................................................................................................................................................................................ 8-3

8-3
WICL Facade
WICL Client
.............................................................................................................................................................................. 8-50
8-50
WICL Scripts
DRAFT
............................................................................................................................................................................ 8-10
8-10
............................................................................................................................................................................ 8-53
8-53
...................................................................................................................................................................................................................................
NN-20500-030
xii
DRAFT
List of tables
5-1
ROC command ......................................................................................................................................................... 5-10

5-10
5-2
UTRA list <param> command
5-3
UTRA OAMLinkBreaks command .............................................................................................................. 5-13
5-4
5-5
UTRA
5-6
UTRA getObjectListFrom3gppD command .......................................................................................... 5-16
5-7
list command ............................................................................................................................................................. 5-17

5-17
5-8
5-9
FD Syntax for UTRA objects
5-10
FD example 1
........................................................................................................................................................ 5-21
5-21
5-11
FD example 2
........................................................................................................................................................ 5-21
5-21
5-12
FD Syntax for I- ode objects
5-13
FD Syntax for POC object
5-14
FD mapping summary
5-15
delete command
5-16
createOnline command
......................................................................................................................................... 5-26
5-17
deleteOnline command
......................................................................................................................................... 5-27
5-18
CreateTraceSession command ............................................................................................................................ 5-29
5-19
DeleteTraceSession command ............................................................................................................................ 5-34
5-20
5-21
dis.play command
5-22
Get command ............................................................................................................................................................ 5-39

5-39
5-23
GetAttributes command ........................................................................................................................................ 5-40
....................................................................................................................... 5-11
..................................................................................................................... 5-14
ECriticalAlarms command
............................................................................................................ 5-15
.......................................................................................................................... 5-19
...................................................................................................................... 5-20
......................................................................................................................... 5-21
............................................................................................................................... 5-22
....................................................................................................................................... 5-23
....................................................................................................................................................... 5-25
5-25
................................................................................................................................... 5-35
................................................................................................................................................... 5-38
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
xiii
DRAFT
DRAFT
List of tables
...................................................................................................................................................................................................................................
5-24
GetAll command
..................................................................................................................................................... 5-41
5-41
5-25
SetOnline command
5-26
SetOnlineAdministrativeState command
5-27
SetAllOnline command ......................................................................................................................................... 5-45
5-28
GetIC command ....................................................................................................................................................... 5-46

5-46
5-29
SetIC command
5-30
GetAllIC command
5-31
GetDD command
5-32
GetAllDD command
5-33
getDescription command ...................................................................................................................................... 5-51
5-34
getStateChange command .................................................................................................................................... 5-54
5-35
getStatus command ................................................................................................................................................. 5-56
5-36
getAttributeValueInBulk command .................................................................................................................. 5-58
5-37
download command
5-38
activate command
................................................................................................................................................... 5-61
5-61
5-39
Rebuild command
................................................................................................................................................... 5-62
5-40
Audit command
5-41
cancelBuild command
5-42
resetMIB command
5-43
openLink command ................................................................................................................................................ 5-65
5-44
closeLink command
5-45
dbBackup command ............................................................................................................................................... 5-66
5-46
dbRestore command ............................................................................................................................................... 5-67
5-47
ListDbBackup command ...................................................................................................................................... 5-67
5-48
dbBackupR S command
..................................................................................................................................... 5-68
5-49
dbRestoreR S command
..................................................................................................................................... 5-69
5-50
abortUpgradeSession command
............................................................................................................................................... 5-42
....................................................................................................... 5-44
....................................................................................................................................................... 5-47
5-47
................................................................................................................................................ 5-48
.................................................................................................................................................... 5-49
.............................................................................................................................................. 5-50
............................................................................................................................................... 5-60
....................................................................................................................................................... 5-63
........................................................................................................................................... 5-64
................................................................................................................................................ 5-64
............................................................................................................................................... 5-66
........................................................................................................................ 5-69
...................................................................................................................................................................................................................................
NN-20500-030
xiv
...................................................................................................................................................................................................................................
5-51
fmSnapshot command
........................................................................................................................................... 5-70
5-52
specificAction command
5-53
backupImage command
5-54
listImage command
5-55
getImageDescription command
5-56
rehome command
5-57
synchronizeSoftware command
5-58
ppSynchronize command
5-59
download command
5-60
activate command
................................................................................................................................................... 5-77
5-77
5-61
Rebuild command
................................................................................................................................................... 5-78
5-62
resetMIB command
5-63
cancelBuild command
5-64
Reset command ........................................................................................................................................................ 5-80

5-80
5-65
openLink command ................................................................................................................................................ 5-81
5-66
closeLink command
5-67
dbBackup command ............................................................................................................................................... 5-83
5-68
dbRestore command ............................................................................................................................................... 5-83
5-69
ListDbBackup command ...................................................................................................................................... 5-84
5-70
5-71
fmSnapshot command
5-72
Reset command ........................................................................................................................................................ 5-86

5-86
5-73
rehome command
5-74
Audit command
5-75
AuditAllBts command ........................................................................................................................................... 5-87
5-76
pcmModeChange command
............................................................................................................................... 5-87
5-77
pcmLoopbackTest command
.............................................................................................................................. 5-88
...................................................................................................................................... 5-71
DRAFT
List of tables
........................................................................................................................................ 5-71
................................................................................................................................................ 5-72
......................................................................................................................... 5-72
.................................................................................................................................................... 5-73
......................................................................................................................... 5-74
..................................................................................................................................... 5-74
............................................................................................................................................... 5-76
................................................................................................................................................ 5-79
........................................................................................................................................... 5-79
............................................................................................................................................... 5-82
........................................................................................................................ 5-84
........................................................................................................................................... 5-85
.................................................................................................................................................... 5-86
....................................................................................................................................................... 5-86
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
xv
DRAFT
List of tables
...................................................................................................................................................................................................................................
5-78
atmF4F5Test command ......................................................................................................................................... 5-90
5-79
rssiGathering command
5-80
rehome command
5-81
exportCMReport command
5-82
5-83
MicroPicoBTS Download command
5-84
MicroPicoBTS Activate command
5-85
MicroPicoBTS abortUpgradeSession command
5-86
OneBTS download command ............................................................................................................................. 5-98
5-87
OneBTS activate command ................................................................................................................................. 5-99
5-88
OneBTS diagnose command
5-89
OneBTS abortUpgradeSession command
5-90
OneBTS fmSnapshot command
5-91
OneBTS openLink command ........................................................................................................................... 5-102
5-92
OneBTS closeLink command
.......................................................................................................................... 5-103
5-93
OneBTS powerTest command
......................................................................................................................... 5-104
5-94
OneBTS rxAntennaTest command ................................................................................................................. 5-105
5-95
OneBTS initiateSelfSurvey command
.......................................................................................................... 5-105
5-96
OneBTS cancelSelfSurvey command
........................................................................................................... 5-106
5-97
OneBTS Reset command ................................................................................................................................... 5-107
5-98
OneBTS createBackupImage command
5-99
OneBTS restoreBackupImage command ..................................................................................................... 5-108
........................................................................................................................................ 5-91
.................................................................................................................................................... 5-94
................................................................................................................................. 5-94
..................................................................................................................................... 5-94
............................................................................................................... 5-95
................................................................................................................... 5-96
......................................................................................... 5-96
............................................................................................................................ 5-100
................................................................................................... 5-101
...................................................................................................................... 5-101
5-100 OneBTS listBackupImage command
...................................................................................................... 5-107
............................................................................................................ 5-109
5-101 OneBTS cmsynchronize command ................................................................................................................ 5-109

5-102 OneBTS fmsynchronize command
DRAFT
5-103 OneBTS preprovision command
................................................................................................................ 5-110
..................................................................................................................... 5-111
5-104 OneBTS fallbackSoftware command
............................................................................................................ 5-111
...................................................................................................................................................................................................................................
NN-20500-030
xvi
...................................................................................................................................................................................................................................
5-105 fmI odeSnapshot command

5-106 WO Export command
............................................................................................................................ 5-113
......................................................................................................................................... 5-114
DRAFT
List of tables
5-107 WO Display command ........................................................................................................................................ 5-114

5-108 WO CreateObject command ............................................................................................................................. 5-115
5-109 WO setObject command
.................................................................................................................................... 5-115
5-110 WO deleteObject command

5-111
.............................................................................................................................. 5-116
CM createSession command ............................................................................................................................. 5-118
5-112 CM terminateSession command ...................................................................................................................... 5-119

5-113 CM abortSession command
.............................................................................................................................. 5-120
5-114 CM validate command ........................................................................................................................................ 5-121

5-115 CM listSession command
.................................................................................................................................. 5-122
5-116 CM displaySession command

5-117 CM preActivate command
.......................................................................................................................... 5-123
................................................................................................................................ 5-124
5-118 CM activate command
........................................................................................................................................ 5-125
5-119 CM Resume command
....................................................................................................................................... 5-126
5-120 CM setActivationType command
................................................................................................................... 5-127
5-121 CM getAvailableConfigModels command .................................................................................................. 5-128

5-122 CM export command ........................................................................................................................................... 5-129
5-123 CM exportR S command
................................................................................................................................. 5-131
5-124 CM getImpactedConfig odes command
.................................................................................................... 5-133
5-125 CM getImpactedConfig odesInfo command

5-126 CM release odes command
5-127 CM fallback command
............................................................................................ 5-134
............................................................................................................................. 5-135
....................................................................................................................................... 5-136
5-128 CM listGeneratedSessions command ............................................................................................................ 5-137

5-129 CM launchSessioncommand
............................................................................................................................ 5-138
5-130 createCMSession command .............................................................................................................................. 5-139

...................................................................................................................................... 5-141
...................................................................................................................................................................................................................................
NN-20500-030
xvii
DRAFT
5-131 PM block E command
DRAFT
List of tables
...................................................................................................................................................................................................................................
5-132 PM unblock E command
................................................................................................................................. 5-142
5-133 PM set odeBGranularity command
............................................................................................................. 5-143
5-134 PM get odeBGranularity command
............................................................................................................. 5-146
5-135 PM upgCounterFilecommand
5-136 recoverObs command
.......................................................................................................................... 5-147
......................................................................................................................................... 5-149
5-137 PM importCounterList command
................................................................................................................... 5-150
5-138 PM exportCounterList command
................................................................................................................... 5-151
5-139 PM checkCounterList command ..................................................................................................................... 5-152

5-140 FM getAlarms command
................................................................................................................................... 5-156
5-141 FM setFmbbCache command
.......................................................................................................................... 5-159
5-142 FM clearAlarm command .................................................................................................................................. 5-160

5-143 FM acknowledgeAlarm command
5-144 SEC EncryptSecret command
5-145 declaration command
.......................................................................................................................... 5-162
.......................................................................................................................................... 5-166
5-146 undeclaration command

5-147 startProv command
................................................................................................................. 5-161
..................................................................................................................................... 5-168
.............................................................................................................................................. 5-169
5-148 endProv command ................................................................................................................................................ 5-170

5-149 start command ........................................................................................................................................................ 5-171
5-171
5-150 copy command ....................................................................................................................................................... 5-172
5-151 check command ..................................................................................................................................................... 5-173
5-152 activate command
................................................................................................................................................. 5-174
5-174
5-153 confirm command ................................................................................................................................................. 5-175

5-154 commit command
5-155 save command
................................................................................................................................................. 5-176
....................................................................................................................................................... 5-177
5-156 load command ........................................................................................................................................................ 5-178

5-178
DRAFT
5-157 apply command

5-158 end command
..................................................................................................................................................... 5-179
......................................................................................................................................................... 5-180
...................................................................................................................................................................................................................................
NN-20500-030
xviii
...................................................................................................................................................................................................................................
5-159 lock command ........................................................................................................................................................ 5-181

5-181
5-160 unlock command ................................................................................................................................................... 5-182
5-161 reset command
DRAFT
List of tables
....................................................................................................................................................... 5-183
5-183
5-162 switch command
................................................................................................................................................... 5-184
5-163 switchover command ........................................................................................................................................... 5-185

5-164 ppBackup command
............................................................................................................................................ 5-186
5-165 ppRestore command
............................................................................................................................................ 5-188
5-166 Date-and-time syntax
.......................................................................................................................................... 5-191
5-167 at eval command
................................................................................................................................................... 5-192
5-192
5-168 at exec command
.................................................................................................................................................. 5-193
5-169 at list command
..................................................................................................................................................... 5-194
5-194
5-170 at listall command
................................................................................................................................................ 5-194
5-194
5-171 at remove command ............................................................................................................................................. 5-195

5-172 at result command
5-173 at info command
................................................................................................................................................ 5-196
................................................................................................................................................... 5-197
5-174 WICLConfigInit command
............................................................................................................................... 5-199
5-175 WICLConfigGetValue command

5-176 WICLTraceInit command
5-177 WICLTrace command
................................................................................................................... 5-200
.................................................................................................................................. 5-202
......................................................................................................................................... 5-203
5-178 WICLTraceError command
.............................................................................................................................. 5-204
5-179 WICLTraceBegin command
............................................................................................................................. 5-205
5-180 WICLTraceEnd command
................................................................................................................................. 5-206
5-181 open command ....................................................................................................................................................... 5-208

5-182 close command
...................................................................................................................................................... 5-209
5-209
5-183 dir command ........................................................................................................................................................... 5-210

5-210
5-184 Help command ....................................................................................................................................................... 5-212
................................................................................................................. 5-213
...................................................................................................................................................................................................................................
NN-20500-030
xix
DRAFT
5-185 Help <wicl_command> command
DRAFT
List of tables
...................................................................................................................................................................................................................................
5-186 setMaxTimeout command
................................................................................................................................. 5-214
5-187 OAM command ..................................................................................................................................................... 5-216

5-188 setEnv command ................................................................................................................................................... 5-219
5-189 getEnv command
.................................................................................................................................................. 5-220
5-190 prepareReport command
DRAFT
5-191 licenseCheck command
.................................................................................................................................... 5-221
...................................................................................................................................... 5-223
5-192 licenseSnapshot command
................................................................................................................................ 5-225
5-193 WICL command mapping
................................................................................................................................. 5-227
6-1
Script access security
6-2
exec command
6-3
WICL script files
............................................................................................................................................... 6-3
6-3
............................................................................................................................................................ 6-3
6-3
..................................................................................................................................................... 6-42
6-42
...................................................................................................................................................................................................................................
NN-20500-030
xx
DRAFT
List of figures
1-1
Roadmap to W-CDMA Customer Documentation ........................................................................................ 1-1
3-1
WICL console main window ................................................................................................................................. 3-2
3-2
WICL console script exec ....................................................................................................................................... 3-4
6-1
Script Editor main window
6-2
WICL command parameter wizard
6-3
Create a new WICL script file
.............................................................................................................................. 6-9
6-4
Script Browser main window
............................................................................................................................. 6-13
6-5
Create Schedule main window
6-6
Launch of the getR C.wcl inventory script .................................................................................................. 6-43
6-7
getR C.wcl script result
7-1
Header page
7-2
Displayed page of UMTS neighbour list
7-3
Audit of unidirectional neighbour list
7-4
A WICL html example
.................................................................................................................................... 6-5
..................................................................................................................... 6-7
........................................................................................................................... 6-25
...................................................................................................................................... 6-44
................................................................................................................................................................. 7-9
7-9
........................................................................................................ 7-10
............................................................................................................. 7-18
.......................................................................................................................................... 7-21
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
xxi
DRAFT
DRAFT
About this document
DRAFT
About this document
Purpose
The Wireless Internet Command Language (WICL) is primarily aimed at the

configuration of network elements and allows to execute commands or sequence of
commands (called a script) at the ROC level. Each WICL command applies for a type of
E and can manage objects stored in all main servers.
WICL is based on the Tool Command Language (Tcl). This means that WICL conforms
to the Tcl syntax and provides an equivalent to most Tcl commands while the WICL
scripts are interpreted only at the server level.
From another part, a Web-oriented interface allows to write and run high-level scripts
called Wiclets. They rely on a fusion of HTML and WICL Server Page commands (WSP)
PUBLICATION HISTORY
SYSTEM RELEASE: OAM07.1
October 2009
Issue 12.01/E Draft
Updates for OAM07.1
June 2009
Issue 11.02/E Preliminary
Updates after review
April 2009
Issue 11.01/E Draft
Update for OAM07.0
April 2009
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
xxiii
DRAFT
About this document

...................................................................................................................................................................................................................................
Issue 10.11/E Standard

Update for DR5
January 2009
Minor updates
ovember 2008
Update for M CL1
October 2008
Issue 10.08/E Draft
Update for M CL1
September 2008
Update after internal review
August 2008
Issue 10.06/E Draft
Update for DR4 after internal comment about E Inventory
August 2008
Issue 10.05/E Draft
Update for DR4
July 2008
April 2008
Issue 10.03/E Draft
Update for Pre-DR4
April 2008
February 2008
Issue 10.01/E Draft
Creation for OAM06.0
DRAFT

...................................................................................................................................................................................................................................
NN-20500-030
xxiv
...................................................................................................................................................................................................................................
ovember 2007
DRAFT
About this document

September 2007
August 2007
Issue 09.01/E Draft
Update for OAM05.2
SYSTEM RELEASE: UMTS 5.1
July 2007
Update for OAM 5.1 / UA 5.0 Channel Readiness
March 2007
Editorial update
February 2007
January 2007
Issue 08.01/E Draft
Update for OAM 5.1 / UA 5.0
The Publication History information for the outdated releases has been deleted.
Document creation date: August 2002
Applicability
This publication applies to the OAM07.1 System Release.

Intended audience
This document is intended for the UMTS network controllers.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
xxv
DRAFT
About this document

...................................................................................................................................................................................................................................
Prerequisites
It is recommended that readers become familiar with the following publication:

Alcatel-Lucent 9353 Management System - User Guide, (
-20500-032)
How this publication is organized
The document consists of the following modules:
Chapter 1, Roadmap to W-CDMA Customer Documentation

Chapter 2, ew in this release
Chapter 3, WICL Access

Chapter 4, Basic syntax
Chapter 5, WICL command description
Chapter 6, WICL script management
Chapter 7, WICLET
Chapter 8, Error dictionary
Vocabulary conventions
For a definition of the UMTS terms used in this document, see Alcatel-Lucent 9300
W-CDMA Product Family - Terminology, ( -20500-002).
The specific acronyms used in this publication include the following:
XML
eXtensible Markup Language
CSV
Comma Separated Values
GPO
General Permanent Observation
The specific terms used in this publication include the following:

Granularity Period (GP)
The time between two successive measurement results gatherings

in the E.
Session
The session can be Observation or Trace. It identifies a data

collection requested by the user.
In the rest of this document and unless differently stated, the term R C refers to R C
Cplane part (also named C- ode) and the term MSS Platform refers both to R C Uplane
part (also named I- ode) and POC.
DRAFT
The terms used in this document are listed in Alcatel-Lucent 9300 W-CDMA Product
Family - Terminology, ( -20500-002).
...................................................................................................................................................................................................................................
NN-20500-030
xxvi
...................................................................................................................................................................................................................................
Related information
Alcatel-Lucent 9300 W-CDMA Product Family - Access etwork Management Overview, ( -20500-031)
Alcatel-Lucent 9300 W-CDMA Product Family - Fault Management, (
DRAFT
About this document
-20500-156)
Alcatel-Lucent 9300 W-CDMA Product Family - Parameter Reference Guides,

( -20500-027)
How to comment
To comment on this document, go to the Online Comment Form (http://infodoc.

alcatel-lucent.com/comments/enus/) or e-mail your comments to the Comments Hotline
(comments@alcatel-lucent.com) .
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
xxvii
DRAFT
DRAFT
1oadmap to W-CDMA
R
Customer Documentation
DRAFT
The current document belongs to the OAM Cross-Domains category in the following
figure.
Figure 1-1 Roadmap to W-CDMA Customer Documentation
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
1-1
DRAFT
DRAFT
New in this release

2
DRAFT
The following sections detail what is new in the Alcatel-Lucent 9353 Management System
- Commands Reference Guide (WICL) for OAM07.1.
Features
The following features impact this publication:
FRS 30934, Activation Manager Enhancements

FRS 34626, OAM support of UTRA Licensing Enhancements
FRS 36250, OAM support UTRA Sharing Enhancements
New commands
The added commands are the following:
CM listGeneratedSessions
CM launchSession
licenseSnapshot
exportCMReport
Modified commands
The modified commands are the following:

resetMib
dbBackup
dbRestore
dbBackupR S
dbRestoreR S
createTraceSession
setTraceSession
CM release odes
CM getImpactedConfig odesInfo
...................................................................................................................................................................................................................................
NN-20500-030
2-1
DRAFT
DRAFT
DRAFT
DRAFT
WICL Access
3
Overview
Purpose
The Wireless Internet Command Language (WICL) gives the end user the possibility of
performing OAM commands as a programming language. The user can configure the
etwork Elements ( Es) and execute OAM commands at the ROC level.
Access to the WICL is provided via the etwork Service Platform ( SP) Graphical User
Interface, where a WICL command or a script of WICL commands can be executed
interactively from the WICL console (p. 3-2) or the Chapter 6, WICL script
management tool. Access is also possible from the Main server by using WICL line
mode shell (p. 3-5)
Only users with granted privilege are allowed to launch the WICL GUI.
There is no resource access control taken by WICL, which means any user connected to
the WICL session can see all the network elements managed by WICL.
Contents
3-2
WICL console
3-2
3-5
3-5
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
3-1
DRAFT
WICL Access
WICL console
...................................................................................................................................................................................................................................
WICL console
With the WICL console, the user is able to type and immediately execute WICL
commands and receive answers. The user can also select and execute script files.
To launch the WICL console, select Configuration > Wireless Internet Command
Language (WICL) from the opened SP Graphical User Interface (GUI). ote that before
using the WICL console, a network layout must be opened. See Alcatel-Lucent 9353
Management System - User Guide, ( -20500-032)
The main window of the WICL console is shown on the figure Figure 3-1, WICL
console main window (p. 3-2).
DRAFT
Figure 3-1 WICL console main window
...................................................................................................................................................................................................................................
NN-20500-030
3-2
WICL console
...................................................................................................................................................................................................................................
The WICL console allows:
to type and execute WICL commands then to receive answers

to select and execute script files
DRAFT
WICL Access
The WICL commands are written in the main window and executed by pressing the Enter
key. The answer is then automatically returned.
Some edition facilities are available in the WICL console:
Command line edition: word or character navigation and modification

Selection of menus Edit > Copy and Edit > Paste (or use of Control-C and Control-V
keys) to duplicate a previously selected text
Selection of menus History > Previous or Next (or use of up and down arrow keys) to
insert the previous or the next command at the cursor position
Selection of menu Console > Exec to open and execute a stored WICL script
The Select a wcl File to execute window opens:
Go to the wanted directory, select the WICL script and click [Select]
The name of the file is displayed in the WICL Console
Press [Enter] to execute the script then read the returned response
From the WICL interface menu bar, select Console>Exec. The Select a wcl File to
execute window opens. Go to the wanted directory and select the WICL script to launch.
See (Figure 3-2, WICL console script exec (p. 3-4))
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
3-3
DRAFT
DRAFT
WICL Access
WICL console
...................................................................................................................................................................................................................................
Figure 3-2 WICL console script exec
...................................................................................................................................................................................................................................
NN-20500-030
3-4
Overview
...................................................................................................................................................................................................................................
DRAFT
WICL Access
The wiclsh tool allows to execute WICL commands in a line mode shell. It is an Unix
shell automatically delivered and available in /opt/nortel/shell/wicl in all Main servers in
the ROC. This application can be executed in interactive or non-interactive mode. In both
modes, the user must connect using his SP user name and password.
ote: For security reasons, the connection shuts down automatically if the WICL
session is inactive for more than 30 minutes. The user must reconnect to open a new
WICL session.
The WICL line mode shell has no graphical console so all commands are either typed
from a Unix shell session or from an opened script file
Depending on the application parameters, the following operations can be performed:
ask for a user/password prompt (interactive mode)
evaluate a string parameter as a script command

give a script file name to execute
check a WICL script syntax without executing it
The following parameters are available:
-u <NSP user name>: if not supplied on the command line, the application
prompts you.
-p <NSP user password>: if not supplied on the command line, the application
prompts you.
[-c "<WICL command>"] | [-f <script file>]: executes a WICL
command or script file
[-check]: checks the script syntax

[- -]: all the input parameters that come after this parameter are passed to the script
application
A unitary command is a command which contains no enclosed quotas, braces, brackets or
array element names.
The verbose mode works in script execution mode only. The unitary commands are
executed one by one and the intermediate results and outputs are displayed while script
execution.
Attention: For security reasons, if the WICL session is inactive for more than 30
minutes, the connection shuts down automatically. The user must reconnect to open a
new WICL session.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
3-5
DRAFT
WICL Access
...................................................................................................................................................................................................................................
Line mode execution
Once the wiclsh tool is launched in interactive mode, the user has to provide the SP user
name and SP password. If the user authentication is correct, the WICL tool prompt is
displayed and the user can enter WICL commands. In the opposite case, an error message
is displayed and the tool exits.
Example:
user authentication succeeds
uctfe024:/opt/nortel/shell/wicl <37> (nortel) >% ./wiclsh
Starting Wireless Internet Command Language

Command mode launched
login
John
password
****
... wait please

Wireless Internet Command Language (WICL)
>:
Example:
user authentication fails
uctfe024:/opt/nortel/shell/wicl <37> (nortel) >% ./wiclsh

Command mode launched
login
John
password
****
... wait please

User Authentication failed
Exiting
uctfe024:/opt/nortel/shell/wicl <38> (oamops) >%
Script execution
The wicl scripts can be launched from the wiclsh tool on the Main servers:
DRAFT
Examples:
/opt/nortel/shell/wicl/wiclsh -u <Username> -p <Password> -f
...................................................................................................................................................................................................................................
NN-20500-030
3-6
...................................................................................................................................................................................................................................
/opt/nortel/shell/wicl/scripts/test1.wcl - - param1 param2

ote:
DRAFT
WICL Access
When using the parameter -f, the file path is a real path in the same machine as the
shell is launched.
The script can retrieve the parameters using the Tcl argv variable
The file /opt/nortel/shell/wicl/scripts/test1.wcl was created with this text:

eval $argv dis
The following example shows how to execute a WICL script from the Unix shell:
uctfe024:/opt/nortel/ <37> (oamops) >% /opt/nortel/shell/wicl/wiclsh -u <Username> -p
<Password> -f /opt/nortel/shell/wicl/scripts/test1.wcl -- "rnc R CM1_20"
Script mode launched
operatorId
testOperator
runningSoftwareVersion
unknown
dn
(R C,256)
rnc SAPAddress
123456789ABCDEF0123456789ABCDEF012345678
rncArchitecture
10
userLabel
R CM1_20
cnodeCapacity
100
rncId
20
provisionedSystemRelease
02_00_02
inAccessOperationalState
disabled
perfServerId
UPERFSERV1
userSpecificInfo
USI
securityControl
integrity otChecked
model ame
mobile etworkCode
class
R C
systemRelease
02_00_02
operationalState
enabled
mobileCountryCode
208
frequencyBand
umtsBand
...................................................................................................................................................................................................................................
NN-20500-030
3-7
DRAFT
Disconnecting....
DRAFT
WICL Access
...................................................................................................................................................................................................................................
One command execution
You can launch WICL commands from the wiclsh tool on the Main server.
Example:
% /opt/nortel/shell/wicl/wiclsh -u <Username> -p <Password> -c "RNC RNCM1_
20 display"

on interactive command mode launched
operatorId
testOperator
runningSoftwareVersion
U SET
dn
(R C,256)
rnc SAPAddress
123456789ABCDEF0123456789ABCDEF012345678
rncArchitecture
userLabel
R CM1_20
cnodeCapacity
100
rncId
20
provisionedSystemRelease
02_00_02
inAccessOperationalState
disabled
perfServerId
UPERFSERV1
userSpecificInfo
USI
securityControl
integrity otChecked
model ame
accessRestrictionList
mobile etworkCode
class
R C
systemRelease
U SET
operationalState
enabled
mobileCountryCode
208
frequencyBand
umtsBand
Disconnecting....
DRAFT
uctfe024:/opt/nortel/shell/wicl <13> (oamops) %
...................................................................................................................................................................................................................................
NN-20500-030
3-8
...................................................................................................................................................................................................................................
WICL script syntax check
The script checker helps to create WICL scripts and finds errors before executing these
scripts on the real UMTS devices.
DRAFT
WICL Access
ote: This function is available using the wiclsh tool only. The script files must
contain the full command name and not abbreviated forms, such as "dis" for
"display".
This function checks the static syntax of the selected WICL script. It only works in script
execution mode: the script checker does not handle run time execution errors (dynamic
error). For example, the third following line contains a dynamic error ( CC), which is not
detected:
set var "R C R C_M1"
eval $var display

set var "R C CC R C_M1"
eval $var display
In the following example, a wiclsh command is used to trace execution and check a file
stored in /tmp/exa.wcl:
The following example displays a file with some Tcl and WICL errors:
R C R CM1 display
# Tcl Command with the set command error
settt value 3
# WICL command with error

RNC RNCM1 displayyy
# A WICL command
set list [utran list RNC]
# A loop without the close brace

foreach elem $list {
#This is a dynamic execution command and the syntax checker cannot verify if no error is
present
eval $elem set rncArchitecture 0
Example:
This is the wiclsh execution trace to check the above file stored in /tmp/exa.wcl
The tool encounters three errors in this wicl example script.
...................................................................................................................................................................................................................................
NN-20500-030
3-9
DRAFT
# /opt/nortel/shell/wicl/wiclsh -check /tmp/exa.wcl
DRAFT
WICL Access
...................................................................................................................................................................................................................................

Check Mode launched
Checking file /tmp/exa.wcl
Line 4:
Unknown command "settt"
Line 6:
Unknown WICL SubCommand for class R C
Line 12:
Could not complete statement. One close brace would complete the first line
One close brace would complete the script body at line 15.
Assuming completeness for further processing.
Some issues are not supported by the checker in current version

1. Procedures embedded in namespace, for example a namespace creation with a new
method inside:
namespace eval exampleNS {
proc displayDN {dn} {
eval $dn display } }
# Call the new method inside the namespace

exampleNS::displayDN "RNC RNC_M1"
The tool cannot check the method execution using namespace names
2. Abbreviated commands
The tool cannot check commands in their abbreviated forms
Example: if the command "dis" (instead of "display") is used to show all the attributes of
E, the checker cannot recognize this command and thus report an error
3. Options in commands
Example:
When the command is executed with some options :
RNC RNC1 list child
The tool can only guarantee that the command itself, for example "list", is correct: but the
improper option "child" is ignored.
DRAFT
"UTRA " is an special command because everything following it is treated as an option,

so the tool cannot find any errors in such as: utran listss rer.
...................................................................................................................................................................................................................................
NN-20500-030
3-10
Basic syntax
4
DRAFT
WICL is based on the Tool Command Language (Tcl). This means that WICL conforms
to the Tcl syntax and provides an equivalent to most Tcl commands. However, WICL
scripts are interpreted only at the server level. For example, you cannot handle
environment variables, data or files located at the client level. Standard input and output
channels are established between the WICL server and the WICL client application and
there is no direct interaction with the server or client terminals.
WICL is case-sensitive but most of the WICL commands and operations related to the
UMTS etwork objects are accepted in lowercase and uppercase. Only variables are
always case-sensitive.
The "\" symbol with a blank always precedes the parameters referring to WICL objects, as
in the following examples:
:> tracesessiontemplate myTemplate create tracefilterlist
{{TraceFilter/my\ trace\ filter}}
In the example above, the last argument is a list, so two "{}" are needed.
:> BTSEquipment BTSM1_400_000 AntennaAccess set antennaSystemRef
{Site/Site\ 000\ 001 Sector/0 AntennaSystem/0}
Commands
WICL scripts are made up of commands separated by new lines or semicolons. All
commands follow the same basic format. They contain a command name plus a sequence
of parameters separated with blanks, as shown in the following example:
<command> [<parameter>]*
Example:
set a 12
puts "hello world"
expr 56 * 2
All commands return results. An empty string means the result is meaningless.
ote: In the previous example, the puts command echoes a string at display level.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
4-1
DRAFT
Basic syntax
...................................................................................................................................................................................................................................
Variable
The variable names are case sensitive. They do not have types so can hold any value such
as an integer or a string
The following commands can be used:
set command, to modify and read the value of a variable

For example, modifying the variable a to hold the value 12:
set a 12
set command, to get the value of a variable

For example, get the value of the variable a:
set a
The variable is automatically created the first time it is set. You can check 'a' symbol
to see if it refers to a set variable.
unset command, to delete a variable

For example, delete the variable a
unset a
expr $ command to use the value of a variable in a command, perform a variable
substitution
For example:
expr $a*3
expr $a*$a
WICL interprets the letters and digits following the $ character as a variable name,
and substitutes the value of the variable in place of the name.
Command substitution
Square brackets [ ] delimit a nested command. WICL interprets the command nested
between the brackets, substitutes the [<command>] statement with the result value and
then evaluates the remaining expression (evaluates the nested commands from left to
right).
> set x [expr 12 + 5]
17
Backslash substitution
Special characters can be substituted by prefixing them with a backslash
DRAFT
> set x \$foo

$foo
> set y $x
$foo
...................................................................................................................................................................................................................................
NN-20500-030
4-2
...................................................................................................................................................................................................................................
Grouping with braces and double-quotes
Double quotes (") or braces ({ }) are used to delimit a group of words into one argument.
The difference between double quotes and braces is that backslash, variable and
command substitutions apply to the expression between the quotes, whereas expressions
and words between braces do not.
DRAFT
Basic syntax
You can delay the substitutions to a later stage by grouping with brackets.
> set s "Hello world"
Hello world
> puts "The length of \"$s\" is [string length $s]"
The length of "Hello world" is 11
> puts {The length of $s is [string length $s]}
The length of $s is [string length $s]
Control structures
WICL provides all the usual control flow statements. The following list is not exhaustive:
for - loop Syntax: for <start> <test> <next> <body>

Example:
for {set i 0} {$i < 100} { incr i} { puts "Hello $i" }
foreach -iterate over all elements of list Syntax: foreach <varname> <list> <body>
Example:
foreach {i} {a b c d} {puts "elem: $i" }
if -conditional execution Syntax: if <expr1> [then] <body> [elseif <expr2> <body>]
[else <body>]
Example :
if {$i<0} {puts "error"} else {puts "success" }
switch -switch statement Syntax: switch <var> {<pattern1> <body> [<pattern2>
<body>]*[default <body>]}
Example:
switch myVar { Hello { puts "myVar is set to Hello"} 125 { puts "mayVar is set to
125"} default { puts "unexpected value"}}
while -loop Syntax: while <test> <body>
Example:
while {$i < 100} { puts "Hello $i"; incr i }
Procedures
Use the proc command to define procedures using the following syntax:
proc <name> [<arglist>] <body>
Procedure names and variable names do not conflict with each other.
...................................................................................................................................................................................................................................
NN-20500-030
4-3
DRAFT
proc factorial {n} {

if {$n<0} {return} elseif {$n<=1} {return 1} else {
return [expr n * [factorial [expr $n - 1]] }
DRAFT
Basic syntax
...................................................................................................................................................................................................................................
Comments
WICL comments begin with a "#" character and stay on a single line.
Example:
# this is a comment
set a 3; # this right part is also a comment
Eval Command
The eval command concatenates all of its arguments in one string. It splits this string
using spaces as separators and evaluates the command sentence formed by all the
substrings:
Example
proc sum (args) {
set result 0
foreach n $args {
set result [expr $result+$n]}
return $result
}
proc average {args} {
return [expr [eval sum $args] / [llength $args]] }
average 45.0 65.0 78.0 55.0
60.75
In the example above, if the eval command is omitted, the "sum" procedure returns an
error. This means that the eval command requires a one-string argument only ("45.0 65.0
78.0 55.0" in the previous example), while "sum" expects numerical arguments.
Basic commands
DRAFT
The following list describes the basic WICL commands available from the Tcl. These
basic commands are case-sensitive.
after: executes a command after a predefined time period
array: manipulates array variables
catch: evaluates the script
continue: skips to the next iteration of a loop
append: adds a value to a variable

break: aborts looping command
clock: obtains and manipulates time
concat: merges lists
eof: checks the end condition of a channel
...................................................................................................................................................................................................................................
NN-20500-030
4-4
...................................................................................................................................................................................................................................
error: generates an error
expr: evaluates an expression
format: formats a string in the form of sprintf
global: accesses global variables
join: creates a string by joining list elements together
lindex: retrieves an element from a list
llength: counts the number of elements in a list
eval: evaluates a WICL script
DRAFT
Basic syntax
flush: flushes buffered output for a channel

foreach: iterates over all elements in one or more lists
gets: reads a line from a channel
incr: increments the value of a variable
info: returns information about the state of the Tcl interpreter
lappend: adds list elements to a variable
linsert: adds elements to a list
list: creates a list
lrange: returns one or more adjacent elements from a list
lreplace: replaces elements in a list with new elements
lsort: sorts the elements of a list
puts: displays messages
regexp: matches a regular expression against a string
return: returns from a procedure
set: reads and writes variables
lsearch: checks if a list contains a particular element

namespace: creates and manipulates contexts for commands and variables
proc: creates a WICL procedure
read: reads from a channel
regsub: performs substitution based on regular expression pattern matching
rename: renames and deletes a command
scan: parses strings using conversion specifiers in the form of sscanf
source: evaluates a file or resource as a WICL script
split: splits a string into a complete WICL list
string: manipulates strings
switch: evaluates one of several scripts, according to a given value
subst: performs backslash, command and variable substitution
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
4-5
DRAFT
Basic syntax
...................................................................................................................................................................................................................................
time: times the execution of a script
unset: deletes variables
upvar: creates links to variables in different stack frames
vwait: processes events until a variable is written
trace: monitors variable accesses

update: processes pending events and idle callbacks
uplevel: executes a script in a different stack frame
variable: creates and initializes a name space variable
WICL limits certain Tcl default commands for security reasons.

These commands are:
info: for this command, the only available subcommand is exists

namespace: for this command, the only available subcommands are eval, import,
export, code, current, forget, inscope, qualifiers, parent and tail
Hexadecimal value manipulation
WICL supports hexadecimal values thanks to the format command

For example:
# Set a value to 0x45 hexadecimal (69 decimal), do not use 'Site site_RC65 '
>: Site site_RNC65 set longitude [format "%d" 0x45]
DRAFT
>: Site site_RNC65 display
altitude
1300
class
Site
clusterId
Cluster/UMAISERV1
dn
(Site, 0)
latitude
50
location
OE
longitude
69
name
site_RC65
note
Test_RC_ISS
operatorId
SKT
siteManager
OE
userSpecificInfo
USI
...................................................................................................................................................................................................................................
NN-20500-030
4-6
...................................................................................................................................................................................................................................
# here is an example how to display the value

>: puts [format "0x%x" [Site site_RNC65 get longitude]]
DRAFT
Basic syntax
0x45
# here is an example how to set a variable with the correct hexadecimal typing
>: set a [format "0x%x" [Site site_RNC65 get longitude]]
0x45
# an example of error that will occur if the data type is not fully handled
>: Site site_RNC65 setonline altitude 0x1300
Exception FMK_UNM_ItManagedObject::XmlStringCheckErrors:
altitude : Bad attribute type, use INT type instead of Unknown
Object update failed.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
4-7
DRAFT
DRAFT
5 ICL command
W
description
DRAFT
Overview
Purpose
WICL can manage objects stored in different main servers of a ROC system. WICL
allows to:
Create/set/get/delete managed objects and certain Es

Rebuild/reset/audit RC devices
Handle cmXML files and commands

Download/upgrade E software
Synchronize the OAM database with UTRA Es
Access OAM file systems

Schedule command/script execution
Provision passport components
This chapter provides the description of all WICL commands:

Object discovery (p. 5-9)
Object selection (p. 5-20)
Object edition (p. 5-24)

Parameter manipulation (p. 5-37)
UTRA commands (p. 5-59)
Configuration manager commands (p. 5-117)

Performance manager commands (p. 5-140)
Fault manager commands (p. 5-154)
SEC EncryptSecret command (p. 5-162)

I-ode and POC commands (p. 5-164)
at commands (p. 5-190)
Configuration file (p. 5-198)

Trace file (p. 5-201)
...................................................................................................................................................................................................................................
NN-20500-030
5-1
DRAFT
DRAFT
Overview
...................................................................................................................................................................................................................................
File management (p. 5-207)
Help command management (p. 5-211)

Long command management (p. 5-214)
OAM software management (p. 5-216)
Environmental variable management (p. 5-218)
prepareReport command (p. 5-221)

licenseCheck command (p. 5-223)
licenseSnapshot command (p. 5-225)
The last section provides the WICL command /E mapping (p. 5-227)
Contents
5-8
Typographic conventions in the description of the WICL commands
5-8
Object discovery
5-9
5-9
ROC command
5-10
UTRA list <param> command
5-11
UTRA OAMLinkBreaks command
5-13
5-14
UTRA ECriticalAlarms command
5-15
UTRA getObjectListFrom3gppD command
5-16
list command
5-17
5-19
5-20
Object selection
5-20
Object edition
5-24
DRAFT
5-24
delete command
5-25
5-26
5-27
5-28
5-34
5-35
...................................................................................................................................................................................................................................
NN-20500-030
5-2
Overview
...................................................................................................................................................................................................................................
5-37
5-37
dis.play command
5-38
Get command
5-39
5-40
GetAll command
5-41
SetOnline command
5-42
5-44
5-45
GetIC command
5-46
SetIC command
5-47
GetAllIC command
5-48
GetDD command
5-49
GetAllDD command
5-50
5-51
5-53
getStatus command
5-56
5-58
UTRA commands
5-59
DRAFT
5-59
iRC commands
5-60
5-76
POC command
5-94
5-95
5-98
I-ode command
5-113
Work order manipulation commands
5-114
5-117
5-117
5-118
5-119
5-120
CM validate command
5-121
...................................................................................................................................................................................................................................
NN-20500-030
5-3
DRAFT
CM createSession command
DRAFT
Overview
...................................................................................................................................................................................................................................
5-122
5-123
5-124
CM activate command
5-125
CM resume command
5-126
5-127
5-128
CM export command
5-129
CM exportRS command
5-131
CM getImpactedConfigodes command
5-133
CM getImpactedConfigodesInfo command
5-134
CM releaseodes command
5-135
CM fallback command
5-136
5-137
5-138
5-139
5-140
5-140
PM blockE command
5-141
PM unblockE command
5-142
PM setodeBGranularity command
5-143
PM getodeBGranularity command
5-146
5-147
recoverObs command
5-149
5-150
PM exportCounterList command
5-151
5-152
5-154
DRAFT
5-154
5-155
FM setFmbbCache command
5-159
5-160
5-161
...................................................................................................................................................................................................................................
NN-20500-030
5-4
Overview
...................................................................................................................................................................................................................................
5-162
5-162
I-ode and POC commands
5-164
DRAFT
5-164
declaration command
5-166
undeclaration command
5-168
startProv command
5-169
endProv command
5-170
start command
5-171
copy command
5-172
check command
5-173
activate command
5-174
confirm command
5-175
commit command
5-176
save command
5-177
load command
5-178
apply command
5-179
end command
5-180
lock command
5-181
unlock command
5-182
reset command
5-183
switch command
5-184
switchover command
5-185
ppBackup command
5-186
ppRestore command
5-188
at commands
5-190
5-190
5-191
Eval command
5-192
Exec scripts
5-193
Get job list
5-194
Remove job
5-195
Get job result
5-196
...................................................................................................................................................................................................................................
NN-20500-030
5-5
DRAFT
Date-and-time syntax
DRAFT
Overview
...................................................................................................................................................................................................................................
Get job info
5-197
Configuration file
5-198
5-198
5-199
WICLConfigGetValue command
5-200
Trace file
5-201
5-201
5-202
WICLTrace command
5-203
WICLTraceError command
5-204
5-205
5-206
File management
5-207
5-207
open command
5-208
close command
5-209
dir command
5-210
5-211
5-211
help command
5-212
help <wicl_command> command
5-213
5-214
Long command management
5-214
5-216
5-216
5-218
5-218
setEnv command
5-219
getEnv command
5-220
5-221
5-221
DRAFT
5-223
5-223
...................................................................................................................................................................................................................................
NN-20500-030
5-6
Overview
...................................................................................................................................................................................................................................
5-225
licenseSnapshot command
5-225
DRAFT
5-227
WICL command /E mapping
5-227
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-7
DRAFT
Typographic conventions in the description of the WICL

commands
...................................................................................................................................................................................................................................
Typographic conventions in the description of the WICL

commands
This section lists the typographic conventions used in this document to describe the
WICL commands.
When describing the syntax of a wicl command, the bold font is used. All the words need
to be typed verbatim except the following situations:
If the word is separated by the dot character (.), either the characters before dot or the
fully word can be valid.
If the word is surrounded by angle brackets (< >), the user has to input the actual
value to replace the word in the command format.
If the word is surrounded by square brackets ([ ]), this parameter is optional.

If any parameter is followed by the asterisk character (*), this parameter can appear in
the command more than once.
If several parameters are separated by the vertical bar (|) and surrounded together by
the braces ({ }), all these parameters are exclusive with each other.
Here are two examples:

Example:
cmXML export -f.ile <dfsFilePath> -dn <userDnList> [-p] [-s] [-iandc] [-inv] [-ai] [-d]
[-c.ustomer|-m.anufacture] [-comp.ressed] [-errStr <errMsg>]
Example:
DRAFT
<User D> switch [-force] {protectionToWorking | workingToProtection} [-timeout

<timevalue>]
...................................................................................................................................................................................................................................
NN-20500-030
5-8
Object discovery
...................................................................................................................................................................................................................................
Object discovery
DRAFT
WICL offers a command list to check the objects found in the subtree of the selected
object.
The object discovery commands are the following:
ROC command (p. 5-10)
UTRA list <param> command (p. 5-11)

UTRA OAMLinkBreaks command (p. 5-13)
UTRA AllDesynchro command (p. 5-14)
UTRA ECriticalAlarms command (p. 5-15)
UTRA getObjectListFrom3gppD command (p. 5-16)

list command (p. 5-17)
displayTraceSession command (p. 5-19)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-9
DRAFT
Object discovery
ROC command
...................................................................................................................................................................................................................................
ROC command
Use the ROC command to host the UTRA domain managed by WICL.
When the UMTS ACCESS OAM is installed on the Main server, the UTRA network is
available using WICL.
Table 5-1
ROC command
Syntax
ROC list children
Result
Gets the list of domains which are found at the ROC.
Return Value
Returns the list of domains which are found at the ROC.
Errors
Returns an exception if an error is encountered.
Example:
# This is the result in an UMTS Access Network
>: ROC list children
DRAFT
UTRAN
...................................................................................................................................................................................................................................
NN-20500-030
5-10
Object discovery
UTRAN list <param> command
...................................................................................................................................................................................................................................

Use the UTRAN list <param> command to get objects managed by WICL at the
UTRA level.
Table 5-2
DRAFT
Syntax
UTRAN list <param> [-cluster <serverName>] [verbose]
<param>: this parameter can have one of the following values:
the keyword children
the network element type returned by the children parameter

list call
<serverName>: this parameter specifies a server for an object
search
-verbose: retrieves problems encountered during execution.
Result / return value
If the keyword children is used as a parameter: returns the list of

E types that are found at the UTRA level.
If the E type is used as a parameter: returns the list of objects of
the selected type.
Errors
An exception is returned if an error is encountered.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-11
DRAFT
Object discovery
...................................................................................................................................................................................................................................
Table 5-2
UTRAN list <param> command (continued)
Examples:
# Get all the classes managed at the UTRAN level
>: UTRAN list children
RNC BTSEquipment MicroBTS Cluster NodeB Site EM PMCluster POC
ATMProfile TraceSession TraceRecord TraceFilter
TraceSessionTemplate Operator externalAlarmMappingTable
# Get all the RNC objects at the UTRAN level
>: UTRAN list RNC
{RNC Paris} {RNC Toulouse}
# Get all the BTSEquipment objects at the UTRAN level

>: UTRAN list BTSEquipment
{BTSEquipment BTS_Paris} {BTSEquipment BTS_Toulouse} {BTSEquipment BT
NY}
# Get all the MicroBTS objects at the UTRAN level
>: UTRAN list MicroBTS {MicroBTS MBTS_Paris} {MicroBTS MBTS_
Toulouse}
# Get all the BTSEquipment objects on the server: SERVERPARIS
>: UTRAN list BTSEquipment -cluster SERVERPARIS
{BTSEquipment BTS_Paris}
DRAFT
# Get all RNC objects on all servers:

>: UTRAN list RNC -errStr msg {RNC rnc_M1_0} {RNC rnc_M1_4}
...................................................................................................................................................................................................................................
NN-20500-030
5-12
Object discovery
UTRAN OAMLinkBreaks command
...................................................................................................................................................................................................................................

Use the UTRAN OAMLinkBreaks command to get the list of the RCs and BTSs for
which the OAM link is down. An OAM link to a E is down if defined as follows:
unknownStatus = TRUE && oamAdministrativeLinkState = unlocked
Table 5-3
Syntax
DRAFT

UTRAN list OAMLinkBreaks [-cluster <serverName>]
[-errStr <msg>]
search.
<msg>: this parameter returns the error information for the
command.
Result
Searches in all RCs and BTSEquipments of the ROC for those

with an unknownStatus equal to TRUE and an oamAdministrativeLinkState equal to unlocked. The link with the E is broken.
Return Value
Returns a list of RC and BTSEquipment FDs.
Errors
Examples:
# Get all the NE (RNC/BTSEquipment) of which OAM links are down.
>: UTRAN list OAMLinkBreaks
{RNC RNCM1_1} {RNC RNCM3_1} {BTSEquipment BTSM1_1}
>: UTRAN list OAMLinkBreaks -errStr msg
{RNC RNC1_1} {RNC1_4} {BTSEquipment BTS3}
>: puts $msg
Warning: Service (object_***_20204_CPUmtsProcessManagedObjectAcces

4) on zsupsXXX is unreachable now,
Maybe the server is Down.
Available Cluster: UMAINSERV1
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-13
DRAFT
Object discovery
UTRAN AllDesynchro command
...................................................................................................................................................................................................................................

Use the UTRAN AllDesynchro command to get a list of all desynchronized Es from
the OAM database.
Table 5-4
Syntax

UTRAN list AllDesynchro [-cluster <serverName>]
search.
Result

that are desynchronized from the OAM database.
Return Value
Errors
Examples:
>: UTRAN list AlLDesynchro
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-14
Object discovery
UTRAN NECriticalAlarms command
...................................................................................................................................................................................................................................

Use the UTRAN NECriticalAlarms command to get all the Es that have critical
alarms in.
Table 5-5
Syntax
DRAFT

UTRAN list NECriticalAlarms [-cluster
<serverName>]
search.
Result

that contain critical alarms.
Return Value
Errors
Examples:
# Get all the NE (RNC/BTSEquipment) that have Critical alarms.
>: UTRAN list NECriticalAlarms
>: UTRAN list NECriticalAlarms
{RNC RNC1_2} {RNC1_3} {BTSEquipment BTS7}
>: puts $msg
Warning: Service (object_***_20204_CPUmtsProcessManagedObjectAcces

4) on zsupsXXX is unreachable now,
Maybe the server is Down.
Available Cluster: UMAINSERV1
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-15
DRAFT
Object discovery
UTRAN getObjectListFrom3gppDN command
...................................................................................................................................................................................................................................

Use the UTRAN getObjectListFrom3gppDN command to retrieve objects which are
identified by the input 3GPPD.
According to the input, it builds the workorder file that will be activated by CM
(Configuration Manager) commands.
Table 5-6
Syntax

UTRAN getObjectListFrom3gppDN -dn <3GPPDN> -mode
<mode>
<3GPPD>: this parameter is a kind of Distinguished ame

which uses the primary key as a part of the identifier.
<mode>: this parameter can be all or the first.
Result
This command searches objects which are identified by the input

3GPPD.
Return Value
Returns the objects which are identified by the input 3GPPD.
Errors
Examples:
>: utran getObjectListFrom3gppDN -dn "RNC.rdnId 123" -mode first
DRAFT
{RNC rnc_M1_1}
...................................................................................................................................................................................................................................
NN-20500-030
5-16
Object discovery
list command
...................................................................................................................................................................................................................................
list command
Use the list command to navigate through the model tree of a etwork Element and to
retrieve other sub-objects.
DRAFT
This command applies to a FD.

Table 5-7
Syntax
list command
<FDN> list <param> [-cluster <clusterName>]
<FDN>: to understand the FD identifiers in UMTS WICL, see
FD Mapping (p. 5-23).

<param>: this parameter can be one of the following values:
the keyword children
a sub-class of the selected object
<clusterName>: select a specific cluster to perform the
operation.
Result
If the keyword children is used as parameter: returns the list of

objects class names that are found at the sub-tree of the selected
object.
If a sub-class is used as parameter: returns the list of objects of the
selected sub-class depending on the FD.
Return Value
If the the keyword children is used as parameter: returns the list of

object class types.
If a type of object class is used as parameter: returns the list of
objects of the selected class.
Errors
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-17
DRAFT
Object discovery
list command
...................................................................................................................................................................................................................................
Table 5-7
list command (continued)
Examples:
# Get all the RNC of the UMTS Access Network
>: UTRAN list Rnc
{Rnc RNC_Paris} {Rnc "Rnc Bordeaux"}
# Get all the RNCs, save them in a tcl variable and build all the
RNCs
>: set rncList [UTRAN list Rnc]
>: foreach rnc $rncList { eval $rnc build }
# Get all the Node B of the UMTS Access Network
>: Rnc Paris list NodeB
{Rnc Paris NodeB NodeB_paris} {Rnc Paris NodeB NodeB_bordeaux}
# Get all the lp components
>: Rnc Paris_VI INode IN_Paris Vr/0 list lp
{ Rnc Paris_VI INode IN_Paris Vr/0 lp/1} { Rnc Paris_VI INode IN_
Paris Vr/0 lp/2}
# Get all the lp components from a WG if it exists
>: Passport IN_ParisVr/0 list lp
{ Passport IN_ParisVr/0 lp/5}
# Get all Network Elements classes managed at the UTRAN level
>: UTRAN list children
DRAFT
RNC BTSEquipment NodeB Site ATMProfile TraceSession TraceRecord Trace
...................................................................................................................................................................................................................................
NN-20500-030
5-18
Object discovery
...................................................................................................................................................................................................................................
Use the displayTraceSession command to display all the TraceSession userLabel.
Table 5-8
DRAFT
Syntax
displayTraceSession
Result
Display all the TraceSession userLabel
Return Value
The userLabel of all the TraceSession
Errors
An exception is returned if an error is encountered
Examples:
>: utran list TraceSession
{TraceSession IuR-test_UMAINSERV1} {TraceSession CellTest_

UMAINSERV1} {TraceSession GeographicalTest_UMAINSERV1} {TraceSes
UMAINSERV2}
>: displayTraceSession
IuR-test CellTest GeographicalTest
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-19
DRAFT
Object selection
...................................................................................................................................................................................................................................
Object selection
The user must select an UMTS object before applying a WICL command on it. Use
WICL to interact with the following managed objects:
Distinguished ame for UTRA objects (p. 5-20)
Distinguished ame for I-ode objects (p. 5-21)

Distinguished ame for POC objects (p. 5-22).
To be accessible with WICL, these objects, components or devices, must be managed in

the same Regional Operation Center (ROC). These objects can be localized on one or
several main servers.
A Full Distinguished ame (FD Mapping (p. 5-23)) identifies each object in WICL.
Even if WICL manages objects in each domain in a specific way, all the different types of
Distinguished ames used in each domain are homogeneous.
Distinguished Name for UTRAN objects
For more details on managed objects, see the RA Model description in Alcatel-Lucent
9300 W-CDMA Product Family - Parameter Reference Guide, (-20500-027).
A FD identifies each object in WICL. This FD is a sequence of Relative Distinguished
ames (RD). See below the FD syntax table for UTRA objects.
Table 5-9
FDN Syntax for UTRAN objects
FD Syntax
RDN1 RDN2 ... RDNn
RD Syntax
ObjClassName Identifier
ObjClassame
ame of the class the object belongs to (the naming attribute

depends on the class) or name of the class plus the explicitly
selected naming attribute.
Identifier
Value uniquely identifying the object relatively to its parent
Example:
DRAFT
>: RNC 5 NodeB Paris1 FDDCell 12

>: RNC 5 NodeB Paris1 FDDCell.userLabel 1243
...................................................................................................................................................................................................................................
NN-20500-030
5-20
Object selection
...................................................................................................................................................................................................................................
WICL uses the primary identifier key defined in the RA Model documentation as the
first naming attribute for each RA class. When two different identifiers exist (RC for
example), WICL will consider the given value as the primary identifier unless customer
specified the secondary identifier in the command.
Table 5-10
FDN example 1
RC 12 odeB Paris FDDCell.rdnId 12
FDDCell whose rdnId is 12
RC 12 odeB Paris FDDCell 12
FDDCell whose userLabel is 12
RC 12 odeB Paris FDDCell Paris4
FDDCell whose userLabel is "Paris4"
Table 5-11
DRAFT
FDN example 2
There are 2 Rc :

RC userLabel = 12, rncId = 01
RC userLabel = RC_12, rncId = 12
RC 12
returns the first RC
RC.rncId 12
returns the second RC.
ote: If no identifier is specified using the create and delete command, then WICL
considers that the given value corresponds to the primary identifier.
Distinguished Name for I-Node objects
The I-ode components are accessible with the FD used for the I-ode RA objects.
After the I-ode RA objects are selected, you must select the full Multiservice Switch
component sequence list.
See below the FD syntax table for I-ode objects.
Table 5-12
FDN Syntax for I-Node objects
FD Syntax
FDN_IN component1 component2 componentN
Component Syntax
ObjClassName/<Identifier>
ObjClassame
ame of the class the component belongs to. It is not

case-sensitive.
Identifier
Value uniquely identifying the component relative to its parent.

This value is not necessary when the system contains a single
component by class.
Example:
>: Rnc Paris_VI RNCEquipment 0 INode IN_Paris Lp/0
...................................................................................................................................................................................................................................
NN-20500-030
5-21
DRAFT
Example to access Iode Lp/0 component from the RC:
DRAFT
Object selection
...................................................................................................................................................................................................................................
Example:
Rnc Paris_VI RCEquipment 0 Iode I_Paris Lp/0 display In the example above:
Rnc Paris_VI R CEquipment 0 I ode I _Paris

is the FD.
Lp/0
is the PP component.
display
is the operation.
FD is defined for Iode passport objects and manipulated by WICL as the grouping of
the FD UTRA and PP components.
Distinguished Name for POC objects
The POC object manipulation is similar to the UTRA object manipulation. The POC
Multiservice Switch components are accessible via the FD used for the POC UTRA
objects. After the POC RA object is selected, the full Multiservice Switch component
sequence list must be added.
See below the FD syntax table for POC objects.
Table 5-13
FDN Syntax for POC object
FD Syntax
FDN_POC component1 component2 componentN
Component Syntax
ObjClassName/<Identifier>
ObjClassame
ame of the class the component belongs to. It is not case

sensitive.
Identifier
Value uniquely identifying the component relative to its parent.

This value is not necessary when the system contains a single
component by class.
Example:
>: POC paris_poc Lp/0
Example to access POC Lp/0 component:

Example:
DRAFT
POC poc_Paris Lp/0 display
...................................................................................................................................................................................................................................
NN-20500-030
5-22
Object selection
...................................................................................................................................................................................................................................
In the example above:
POC poc_Paris
is the FD.
Lp/0
is the PP component.
display
is the operation.
DRAFT
FD is defined for POC passport objects and manipulated by WICL as the grouping of
the FD UTRA and PP components.
FDN Mapping
The FD mapping table provides a summary of the object types used in the FD syntax:
Table 5-14
FDN mapping summary
Object type
FDN syntax
UTRA Access
RD1 RD2 ...RDn
I
FD_I component1 component2 component
POC
FD_POC component1 component2component
In all the command descriptions, the FD or technology corresponds to all UTRA RA
model objects.
Use the defined FD for each command when required.
3GPP Distinguished Name Detection and Conversion
WICL supports 3GPP Distinguished ame. A 3GPP Distinguished ame will be detected
in the WICL command line and converted to Operator Distinguished ame. So continue
to launch the corresponding command by using FD followed by the name of the
command.
Examples:
RC.rncId 430 display
==> RC RC430 display
RC.rncId 430 odeB odeBM1_430_002 display
==> RC RC430 odeB odeBM1_430_002 display
RC RC430 odeB.nodeBId 259 display
==> RC RC430 odeB odeBM1_430_002 display
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-23
DRAFT
Object edition
...................................................................................................................................................................................................................................
Object edition
Use WICL to create and delete managed objects.
When you create an object, the object attributes are given default values.
When you create an object that does not have a parent object, an exception is returned.
When you delete an object, the selected object and all subtree objects are also deleted.
When you create or delete I-ode / POC objects, you must use the startprov command
to activate the provisioning mode before executing these commands. Otherwise, an
exception is returned.
The object edition commands are the following:
delete command (p. 5-25)

createOnline command (p. 5-26)
deleteOnline command (p. 5-27)
CreateTraceSession command (p. 5-28)

DeleteTraceSession command (p. 5-34)
setTraceSession command (p. 5-35)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-24
Object edition
delete command
...................................................................................................................................................................................................................................
delete command
Use the delete command to delete Manage Object and all subtree.
DRAFT
For UTRA objects: deletion is performed offline. The modification is made only in the
OAM Database and not in the Equipment. Only BTS, RC and OneBTS are supported.
For passport: when selecting passport objects to delete, you must use the startprov
command to start the provisioning mode, before executing this command. Otherwise, an
Table 5-15
Syntax
delete command
<FDN> delete [-cluster <clusterName>] <-verbose>

operation.
-verbose: retrieves problems encountered during the execution.
Result
Delete the selected object and all subtree objects. For UTRA
objects, deletion is performed offline.
Return Value
In case of success:
Successful
In case of failure:
Failed
Errors
Examples:
# Delete the RNC object from the OAM database
>: Rnc Paris_VI Delete
# Delete the Vr/0 component from the WG if possible
>: Passport wireless_gateway_paris Vr/0 delete
otes
The creation and deletion of CallTrace and ObjectTrace

sessions is not supported by WICL in UMTS V5.1.
When using this command in passport devices, they must be in
provisioning mode. For more details, see Provisioning commands
in section I-ode and POC commands (p. 5-164)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-25
DRAFT
Object edition
...................................................................................................................................................................................................................................
Use the createOnline command to set default values to the attributes when a new
object is created.
WICL can manage different UTRA etwork Element versions. Use this command to
select a given version of the etwork Element and of the Main server in which the object
will be created. The creation is performed online.
Table 5-16
Syntax
<FDN> createOnline <Attribute1> <value1> ...
<AttributeN> <valueN> [-cluster <clusterName>]

<Attribute>: name of an attribute of the specified FD. This
parameter is optional.
<Value>: new value set at creation time to the selected attribute.
This parameter is optional.

operation.
Result
If no attribute values are provided at creation time, the default

attribute values are used to create the object. Otherwise the
specified attributes are used to create the object.
The object identifier is taken from the FD.
When using the userLabel to select the UTRA object RC, this
label is used as the attribute of the RC. UTRA objects are
created on-line.
Return Value
The final status of the CreateOnline job.
Errors
Examples
one
otes
When creating an object that does not have a parent object, an

exception is returned
DRAFT
If the externalSessionId attribute is selected during the creation,

the object is not generated automatically. Its creation depends on
the selected value.
...................................................................................................................................................................................................................................
NN-20500-030
5-26
Object edition
...................................................................................................................................................................................................................................
Use the deleteOnline command to delete a specified object and all its subtrees.
DRAFT
The deletion is performed online.

Table 5-17
Syntax
<FDN> deleteOnline [-cluster <clusterName>]

operation.
Result
Delete the selected object and all subtree objects.
Return Value
The final status of the DeleteOnline job.
Errors
Examples:
# Delete a RNC object online
>: Rnc Paris_VI
deleteOnline
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-27
DRAFT
DRAFT
Object edition
...................................................................................................................................................................................................................................
Use the CreateTraceSession command to create a TraceSession and its associated
objects.
...................................................................................................................................................................................................................................
NN-20500-030
5-28
Object edition
...................................................................................................................................................................................................................................
Table 5-18
Syntax
DRAFT
<FDN> CreateTraceSession <userLabel> <-rnclist
RNC_LIST> <-sessiontype SESSION_TYPE> [objectList <objectList>] [-ueIdType <ueIdType> ueId <ueId>] -<Attribute1> <value1> ... <AttributeN> <valueN> [-Nbapd
<NbapdAttributsList>] [-Rrcd <RrxdAttributesList>
] [-Nbapc<NbapcAttributsList>]
userLabel: the TraceSession userLabel. This parameter is
mandatory.
rnclist: create the TraceSession in appropriate Cluster
according to the rnclist. This parameter is mandatory.

sessiontype: indicates the trace session type. This parameter is
mandatory.
The supported values are:
AccessSession
GeographicalSession
eighbouringSession
CellSession
IuBcSession
IuCsSession
IuPsSession
IuRSession
RCSession
Note:
You cannot create a Real Time Call Trace using WICL now.
objectList: this parameter is mandatory for CellSession,
GeographicalSession, eighbouringSession. For CellSession,

GeographicalSession and eighbouringSession it contains the
FddCellList to be traced. It is optional for
IuCsSession/IuPsSession/IuRSession. It contains a list of
Cs/PsCoreetworkAccess ids to be traced, if no id is configured,
all Cs/PsCoreetworkAccess ids in CS or PS domain are selected.
For IuRSession, it contains the list of neighbouring RC. If no
RC Id is configured, all neighboring RCs are selected.
<ueIdType>: this parameter is mandatory for AccessSession. It
defines the ID type of the UE that will be traced.

the ID value of the UE that will be traced.
...................................................................................................................................................................................................................................
<AttributeN>: the TraceSession attribute. The following
NN-20500-030
Alcatel-Lucent
Internal
5-29
attributes
are mandatory:
duration
rncList
sessionote
DRAFT
<ueId>: this parameter is mandatory for AccessSession. It defines
DRAFT
Object edition
...................................................................................................................................................................................................................................
Table 5-18
Result
CreateTraceSession command (continued)

Create the TraceSession in the appropriate Cluster according to the
rncList. The _<Cluster> suffix is appended to the userLabel of the
created TraceSession.
A TraceSession with session type AccessSession can be mapped to
RC -> CallTrace -> AccessSession
A TraceSession with session type GeographicalSession can be
mapped to RC ->CallTrace -> GeographicalSession
A TraceSession with session type eighbouringSession can be
mapped to RC -> CallTrace -> eighbouringSession
A TraceSession with session type CellSession can be mapped to
RC -> ObjectTrace -> CellSession
A TraceSession with session type luBcSession can be mapped to
RC -> ObjectTrace -> luBcSession
A TraceSession with session type luCsSession can be mapped to
RC -> ObjectTrace -> luCsSession
A TraceSession with session type luPsSession can be mapped to
RC -> ObjectTrace -> luPsSession
A TraceSession with session type luRSession can be mapped to
RC -> ObjectTrace -> luRSession
DRAFT
Return Value
The final status of the CM operation job
...................................................................................................................................................................................................................................
NN-20500-030
5-30
Object edition
...................................................................................................................................................................................................................................
Table 5-18
Errors

DRAFT
If the specified UserLabel already exists:

' ERROR: The userlabel $userLabel already exists
In case of invalid sessionType:

' ERROR: SessionType $sessionType is unknown
In case of unrecognised callType:

' ERROR: unrecognised callType: $callType
In case of 'can not activate workorder file':

' ERROR: Problem encountered to activate
workorder $woFile through CM Session.\n
$exception
In case of 'can not read the template file':

' ERROR: Reading the template file $TPL_LOCATION/
$template.tpl failed: $ex
In case of 'Max session number reached on the specified RC for

the specified sessionType':
' ERROR: No more $sessionType can be created on
\"$rnc\". Max session number reached
In case of 'Can not get cluster information for specified RC':

' ERROR: RNC $rnc in rncList has no cluster
information\n
In case of 'Can not create CM session':

' ERROR: Got problem when create CM session for
TraceSession.\ $exception
In case of 'Can not create the workorder file':

' ERROR: workorder file can not be created due
to $exception
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-31
DRAFT
Object edition
...................................................................................................................................................................................................................................
Table 5-18
Examples:
>: createTraceSession CTb-test -ueIdtype IMSI -ueId 130111332455 rncList {RNC Paris_1} {RNC Paris_2} -sessiontype AccessSession duration 0 -traceSessionTemplateName StandardTroubleShooting sessionNote CTB-test starttime 0 -nbapd rttperiod 2000 rtt false sir
false sirperiod 2000 tcopperiod 2000 tcop false -rrcd intrafreq false
quality false rrcperiod 500 ueInternal false
# With 'utran list traceSession' can see {TraceSession CTb-test_

UMAINSERV1} {TraceSession CTb-test_UMAINSERV2} were created if Par
1 located in UMAINSERV1 and Paris_2 located in UMAINSERV2
DRAFT
>:createTraceSession CellTest -objectList {RNC Paris_1 NodeB Paris_1_

nodeb1 FddCell Paris_1_nodeb1_0} {RNC Paris_1 NodeB Paris_1_nodeb1
FddCell Paris_1_nodeb1_1} -rncList {RNC Paris_1} -template
StandardTroubleShooting -sessiontype CellSession -duration 0 startTime 0 -sessionNote OT-cell-test -nbapc RTWPperiod 2000 RTWP
false TCaPperiod 2000 TCaP false
>:createTraceSession Geo-test -rncList {RNC RNC501} -sessiontype
GeographicalSession -objectList {RNC RNC501 NodeB NodeBM1_501_004
FDDCell FDDCell50113} {RNC RNC501 NodeB NodeBM1_501_004 FDDCell
FDDCell50120014} -calltypeList OrigSubTrafCall TermConvCall
TermStreaCall TermInterCall -tracesessiontemplatename
StandardTroubleShooting -startTime 0 -duration 0 -sessionNote
GeographicalSession -nbapd rttperiod 2000 rtt false sir false
sirperiod 2000 tcopperiod 2000 tcop false -rrcd intrafreq false
quality false rrcperiod 500 ueInternal false
>:createTraceSession CTn-test -rncList {RNC RNC_1} -sessiontype
NeighbouringSession -objectList {RNC RNC_1 NodeB Lab2_32pE1MSA
FDDCell Lab2_32pE1MSA_0} -calltypeList OrigSubTrafCall
TermConvCall TermStreaCall TermInterCall -tracesessiontemplatename
StandardTroubleShooting -startTime 0 -duration 0 -sessionNote
NeighbouringSession
>:createTraceSession IuBc-test -rncList {RNC RNC501} -sessiontype
IuBcSession -tracesessiontemplatename StandardTroubleShooting startTime 0 -duration 0 -sessionNote IuBcSession
>: createTraceSession IuCs-test -rncList {RNC RNC501} -sessiontype
IuCsSession -objectList {RNC RNC501 CsCoreNetworkAccess 0} tracesessiontemplatename StandardTroubleShooting -startTime 0 duration 0 -sessionNote IuCsSession
>: createTraceSession IuPs-test -rncList {RNC RNC501} -sessiontype
IuPsSession -objectList {RNC RNC501 PsCoreNetworkAccess 0} tracesessiontemplatename StandardTroubleShooting -startTime 0 duration 0 -sessionNote IuPsSession
>: createTraceSession IuR-test -rncList {RNC RNC501} -sessiontype
...................................................................................................................................................................................................................................
NN-20500-030
5-32
Object edition
...................................................................................................................................................................................................................................
Table 5-18
ote

The options: -nbapd -rrcd -KPIMonReq -KPIMonCellIDList
-KPIMonDuration in the following example are only available
since UA7.0:
DRAFT
>: createTraceSession CTb-test -ueIdtype IMSI ueId 130111332455 -rncList {RNC Paris_1} {RNC Paris_
2} -sessiontype AccessSession -duration 0 traceSessionTemplateName
StandardTroubleShooting -sessionNote
AccessSession -nbapd rttperiod 2000 rtt false
sir false sirperiod 2000 tcopperiod 2000 tcop
false -rrcd intrafreq false quality false
rrcperiod 500 ueInternal false -KPIMonReq true KPIMonCellIDList 561.1027 561.1028 KPIMonDuration 60
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-33
DRAFT
Object edition
...................................................................................................................................................................................................................................
Use the DeleteTraceSession command to delete a Trace Session and its associated
objects.
Table 5-19
Syntax
DeleteTraceSession <userLabel>
<userLabel>: the TraceSession userLabel. This parameter is
compulsory.
Result
Delete the Trace Session into all clusters
Return Value
Errors
Examples:
{TraceSession CTb-test_UMAINSERV1} {TraceSession Ctb-test_
UMAINSERV2}
>: deleteTraceSession CTb-test
DRAFT
# {TraceSession CTb-test_UMAINSERV1} {TraceSession Ctb-test_UMAINSERV
...................................................................................................................................................................................................................................
NN-20500-030
5-34
Object edition
...................................................................................................................................................................................................................................
Use the setTraceSession command to modify the traceType of a RC Session. It
deletes the specified traceSession and creates a new one with the previous attribute value
and the input traceType.
Table 5-20
Syntax
DRAFT
setTraceSession <userLabel> -traceType <value>
userLabel: the TraceSession userLabel. This parameter is
mandatory.
tracetype: the enum value of traceType. This parameter is
mandatory.
Result
Set the Trace Session on all clusters
Return Value
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-35
DRAFT
Object edition
...................................................................................................................................................................................................................................
Table 5-20
Errors
setTraceSession command (continued)

If the specified TraceSession in ROC cannot be found:
' ERROR: TraceSession $userLabel does not exist
in ROC
If a CM session cannot be created

' Got problem when create CM session for
TraceSession.\n $exception
If the workorder file cannot activated:

' ERROR: Problem encountered to activate
workorder $woFile through CM Session.\n
$exception
If the workorder file cannot be created:

' ERROR: workorder file can not be created due
to $exception
Failed to getall attribute value of existing traceSession

' INTERNAL ERROR: TraceSession $sessLabel getall
failed, reason: $exp
User input invalid traceSession

' ERROR: setTraceSession is only used for
RNCSession. $sessionType not supported
Failed to get the value of traceType:

' ERROR: traceType is not specified
User specify invalid value:

' ERROR: The correct traceType include:
$enumTraceType
Failed to delete the existing traceSession before creation:

' INTERNAL ERROR: Failed to deleteTraceSession
$userlabel, reason: $ex
Examples:
DRAFT
{TraceSession CTb-test_UMAINSERV1} {TraceSession Ctb-test_

UMAINSERV2}
>: setTraceSession CTb-test -tracetype AllFail
...................................................................................................................................................................................................................................
NN-20500-030
5-36
...................................................................................................................................................................................................................................
DRAFT
You can perform the following operations on all objects managed by WICL:
Display all attributes and their values

Get the value of an attribute from the attribute name
Change the value of an attribute using the attribute name
Get the list of attributes names

Get a tab containing all attributes and their values
Get attributes description
More operations can be performed in Es.

The configuration manager commands are the following:
dis.play command (p. 5-38)

Get command (p. 5-39)
GetAttributes command (p. 5-40)
GetAll command (p. 5-41)

SetOnline command (p. 5-42)
SetOnlineAdministrativeState command (p. 5-44)
SetAllOnline command (p. 5-45)

GetIC command (p. 5-46)
SetIC command (p. 5-47)
GetAllIC command (p. 5-48)

GetDD command (p. 5-49)
GetAllDD command (p. 5-50)
getDescription command (p. 5-51)

getStateChange command (p. 5-53)
getStatus command (p. 5-56)
getAttributeValueInBulk command (p. 5-58)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-37
DRAFT
dis.play command
...................................................................................................................................................................................................................................
dis.play command
Use the dis.play command to display the list of the attribute names and values of the
selected FD.
Table 5-21
Syntax
dis.play command
<FDN> dis.play [-o|-p] [-cluster <clusterName>]

-o: if the ortel Multiservice Switch is in provision mode, only
the provisional attributes will be displayed. Use "-o" to display the

operational attributes.
-p: if the ortel Multiservice Switch is in operational mode, only
the operational attributes will be displayed. Use "-p" to display the

provisional attributes.
operation.
Result
Displays the list of the attribute names and values.
Return Value
one.
Errors
Examples:
# Display FDDCell information attributes and values
>: RNC 5 NodeB Paris1 FDDCell 12 Display
CellID 12
UserLabel paris1
DlFrequencyNumber 256
DRAFT
otes
This command cannot be used in a WICL script because it displays

the attribute names and values into the WICL console. This
command does not return any value. To retrieve the attribute
values of an object in a WICL script, use the get or getall
command.
...................................................................................................................................................................................................................................
NN-20500-030
5-38
Get command
...................................................................................................................................................................................................................................
Get command
Use the Get command to get an attribute value from the selected FD.
Table 5-22
DRAFT
Get command
Syntax
<FDN> Get <AttributeName> [-cluster <clusterName>

]

<AttributeName>: name of an attribute of the selected FD
operation.
Result
Retrieve the value of the attribute.
Return Value
The attribute value.
Errors
Examples:
# Get the CellId attribute value and save it in a tcl variable. At the next comm
displays the value of the attribute
>: set the CellID [NodeB paris FDDCell 4 Get CellID]
>: puts "the CellID is $theCellID"
the CellID is 23
# Get the ifIndex attribute value from the selected FDN
>: Rnc Paris_VI INode IN_Paris Vr/0 pp/OAMNET get ifIndex
18
# Get the ifIndex attribute value from the selected FDN
>: Passport IN_Paris Vr/0 pp/OAMNET get ifIndex
28
# Get the numberOfChildren attribute value from the selected DMS F
>: MSC GMNA/NET_Container get numberOfChildren
2
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-39
DRAFT
...................................................................................................................................................................................................................................
Use the GetAttributes command to retrieve the list of attribute names for the selected
FD
Table 5-23
Syntax
<FDN> GetAttributes [-cluster <clusterName>]

operation.
Result
Retrieves the list of all attribute names
Return Value
List containing all attribute names
Errors
Examples:
# Get all the attributes from the selected UTRAN FDN and save into a tcl variable
>: set theAttributeList [Rnc rncParis RncEquipment 0 CNode 0
GetAttributes]
{ neId unknownStatus siteName ipAddress availabilityStatus
operationalState }
# Get all the attributes from the selected DMS UTRAN
>: MSC GMNA/NET_Container getattributes
{containerId highestAlarm numberOfChildren alarmStatus highestChildAl
DRAFT
ote
...................................................................................................................................................................................................................................
NN-20500-030
5-40
GetAll command
...................................................................................................................................................................................................................................
GetAll command
Use the GetAll command to retrieve all the attribute values in a Tcl array for the selected
FD.
Table 5-24
DRAFT
GetAll command
GetAll
Syntax
<FDN> GetAll <tclArray> [-cluster <clusterName>]

<tclArray>: a Tcl array
operation.
Result
Fill tclArray with the object attributes and their value. The
index attributes are case sensitive. You can obtain the full attribute
name using the command GetAttributes. If one of the attributes is
not already set, the keyword USET will be the value for this
attribute.
Return Value
one
Errors
Examples:
# Get all the attribute values andsave it in a tcl array. Display the cellId value using the tcl array information.
>: NodeB paris FDDCell 4 GetAll theParameters
>: puts "the cellID is $theParameters(cellID)"
the cellID is 23
# Get all the attribute values and save it in a tcl array. Display
the ifIndex value using the tcl array information.
>: Rnc Paris_VI INode IN_Paris Vr/0 pp/OAMNE GetAll theParameters
>: puts "the ifIndex is $theParameters(ifIndex)"
the ifIndex is 23
# Get all the attribute values and save it in a tcl array. Display
the alarmStatus value using the tcl array information.
>: MSC GMNA/NET_Container GetAll tab
>: puts "the alarmStatus is $tab(alarmStatus)"
the alarmStatus is warning
otes
The index of the tcl array is case sensitive. You can obtain the
exact attribute name using the WICL command GetAttributes.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-41
DRAFT
SetOnline command
...................................................................................................................................................................................................................................
SetOnline command
Use the SetOnline command to modify the attribute in the selected etwork Element. It
also modifies the value in the OAM database. It also has the function of the command
setOnlineAdministrativeState.
Table 5-25
Syntax
SetOnline command
<FDN> SetOnline <AttributeName1> <Value1>...
<AttributeNameN> <ValueN> [-cluster <clusterName>
] [-verbose]

<AttributeName>: name of the attribute
<Value>: new value to set
operation.
Result
Change the value of the attribute online for the UTRA object and
if an error is encountered during the execution, an exception is
raised.
o offline modification is done if an error is encountered. If no
error is encountered, the OMC internal database is also modified
(as in offline mode). This command is synchronous.
Return Value
SDO result: For more details, see Long command management

(p. 5-214).
Errors
Examples:
# Modify the attribute CellId in the NodeB Network Element. If CellId cannot be set
an exception is displayed
DRAFT
>: NodeB paris FDDCell 4 SetOnline CellID 25
...................................................................................................................................................................................................................................
NN-20500-030
5-42
SetOnline command
...................................................................................................................................................................................................................................
Table 5-25
otes
SetOnline command (continued)

Only class-2 and class-3 attributes support modification of the
Es. For class-2 parameters, lock the object or parent object
AdminState before the set. For more information on class types
and online sets, see the RA Model description in Alcatel-Lucent
9300 W-CDMA Product Family - Parameter Reference Guide,
(-20500-027).
DRAFT
When you put a value in a list, surround it with quotes:

>:RC RC433 ObjectTrace 0 RCSession 0 TraceFilter 0 get
traceModeList
>:RC RC433 ObjectTrace 0 RCSession 0 TraceFilter 1
setOnline traceModeList "{asn1 eventOnly}"
If the attribute cannot be modified, an exception is returned.
This is a long operation: For more details, see Long command
management (p. 5-214).
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-43
DRAFT
...................................................................................................................................................................................................................................
Use the SetOnlineAdministrativeState command to modify the
administrativeState attribute in the specified etwork Element. It also modifies its value
in the OAM database.
Table 5-26
Syntax
<FDN> SetOnlineAdministrativeState <Value> [cluster <clusterName>]

<Value>: the value of the AdmministrativeState attribute. It is
locked or unlocked.
operation.
Result
Change the value of the AdministrativeState attribute for the

UTRA object.
Return Value
The final status of the job
Errors
Examples:
DRAFT
>: RNC RNC_1 NodeB NodeB_1 setOnlineAdministrativeState locked

>: RNC RNC03SKT RNCEquipment 0 INode RNC03SKTINO lp/0
setOnlineAdministrativeState locked
...................................................................................................................................................................................................................................
NN-20500-030
5-44
...................................................................................................................................................................................................................................
Use the SetAllOnline command to set an attribute value to all children objects for a
given object and class type. The operation is performed online.
Table 5-27
Syntax
DRAFT
<FDN> SetAllOnline <class> <AttributeName>
<value> [-cluster <clusterName>] [-verbose]

<class>: a correct child class depending on the specified object
<attribute>: name of the attribute
<value>: new value to set
operation.
Result
This command displays a list of all the objects that have been set
and their set result.
Return Value
The list of all the objects that have been set and their set result.
Errors
An exception is returned if an error is encountered
Examples:
# Set all the Node B contained in the selected RNC
>: RNC Paris SetAllOnline NodeB startPoint 114
{{{Rnc Paris NodeB A1} {job finished without error} {{Rnc Paris No
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-45
DRAFT
GetIC command
...................................................................................................................................................................................................................................
GetIC command
Use the GetIC command to get the I&C parameters from the etwork Element. This
command works only for BTSEquipment etwork Element.
Table 5-28
Syntax
GetIC command
<FDN> GetIC <AttributeName> [-cluster
<clusterName>]

operation.
Result
Retrieve the value of the I&C attribute
Return Value
The attribute value. If the attribute is not already set, the keyword
USET will be returned for this attribute.
Errors
Examples:
# Get an I&C attribute value from the selected BTS and save it into a tcl variable.
display this value
>: set IP [BTSEquipment parisBTS getIC ipAddressOMCB]
>: puts "the IP Address of the OMCB is $IP"
the IP Address of the OMCB is 23.44.55.33
DRAFT
otes
The link of the BTSEquipment has to be opened before.
...................................................................................................................................................................................................................................
NN-20500-030
5-46
SetIC command
...................................................................................................................................................................................................................................
SetIC command
Use the SetIC command to set the I&C parameters from the etwork Element. This
command works only for BTSEquipment etwork Element.
Table 5-29
Syntax
DRAFT
SetIC command
<FDN> SetIC <AttributeName> <AttributeValue> [cluster <clusterName>]

<AttributeValue>: value of the attribute
operation.
Result
Change the value of the I&C attribute
Return Value
SDO result: for more details, see Long command management

(p. 5-214).
Errors
Examples:
>: BTSEquipment parisBTS setIC ipAddressOMCB 123.122.11.11
otes
The link of the BTSEquipment has to be open before.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-47
DRAFT
GetAllIC command
...................................................................................................................................................................................................................................
GetAllIC command
Use the GetAllIC command to get all the I&C parameters from the etwork Element.
This command works only for BTSEquipment etwork Element.
Table 5-30
GetAllIC command
GetAllIC
Syntax
<FDN> GetAllIC<tclArray> [-cluster <clusterName>]

<tclArray>: a Tcl table
operation.
Result
Fill AttributeTable with the object I&C attributes and their value.
The index attributes are case sensitive.
Return Value
one
Errors
Examples:
# Get all the I&C parameter value into a tcl array and display the omcBPort value
>: BTSEquipment parisBTS getAllIC theParameters
>: puts "the OMCB port is $theParameters(omcBPort)"
the OMCB port is 23
DRAFT
otes
The link of the BTSEquipment has to be opened before.
...................................................................................................................................................................................................................................
NN-20500-030
5-48
GetDD command
...................................................................................................................................................................................................................................
GetDD command
Use the GetDD command to get the dynamic data attribute value of a specified FD.
Table 5-31
Syntax
DRAFT
GetDD command
<FDN> getDD <AttributeName> [-cluster
<clusterName>]

operation.
Result
Get the dynamic data attribute value of a specified FD.
Return Value
The attribute value
Errors
Examples:
>: rnc RNC62 getDD rncStatsGet
>: rnc RNC62 NodeB NodeB_62_0 FDDCell NodeB_62_0_0 getDD cellStatsGet
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-49
DRAFT
GetAllDD command
...................................................................................................................................................................................................................................
GetAllDD command
Use the GetAllDD command to retrieve all the dynamic data attribute values into a Tcl
array for a specified FD
Table 5-32
Syntax
GetAllDD command
<FDN> getAllDD <TclArray> [-cluster <clusterName>
]

<TclArray>: a tcl array
operation.
Result
Fill a TclArray with the object dynamic data attributes and their
values.
Return Value
one
Errors
Examples:
DRAFT
>: RNC RNCM1_1 getAllDD arrayofDD
...................................................................................................................................................................................................................................
NN-20500-030
5-50
...................................................................................................................................................................................................................................
Use the getDescription command to get the description of the selected attribute for
the selected FD
Table 5-33
DRAFT
GetDescription
This command.
Syntax
<FDN> getDescription <AttributeName> <TclArray>

[-cluster <clusterName>] [-verbose]

<AttributeName>: attribute name of the selected FD object
<TclArray>: a Tcl array.
operation.
-verbose: retrieves the problems encountered during the
execution
Result
Fill TclArray with the object attribute description. The index

attributes are case sensitive.
umber class datatype ranges will be rangeList item in the array.
umber class datatype discrete values will be valueList item in the
array.
String class datatypes length ranges will be rangeLengthList item
in the array.
String class datatype discrete lengths will be lengthList item in the
array.
Integersequence datatype ranges will be rangeList item in the
array.
Return Value
one
Errors
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-51
DRAFT
...................................................................................................................................................................................................................................
Table 5-33
getDescription command (continued)

GetDescription
Examples:
>: RNC RNC05SKT_43K NodeB Lab303_43K FDDCell Lab30343K_2
UMTSFddNeighbouringCell 3421.503 getDescription dlFrequencyNumber ar
>: parray ar
ar(visibility)=customer
ar(accessRight)=readWrite
ar(domain)=RNC
ar(name)=dlFrequencyNumber
ar(presence)=required
ar(valueList)=412 437 462 487 512 537 562 587 612 637 662 687
ar(rangeList)={min=10562 max=10838} {min=9662 max=9938}
ar(class)=0
ar(qualifier)=standard
ar(type)=MixedDecimal
otes
The attribute datatype has 2 ranges and 12 discrete values as

shown below. For each range its min and max are into a couple of
braces.
Sometimes there is a step in addition of min and max
ar(valueList)=412 437 462 487 512 537 562 587 612 637 662 687
DRAFT
ar(rangeList)={min=10562 max=10838} {min=9662 max=9938}
...................................................................................................................................................................................................................................
NN-20500-030
5-52
...................................................................................................................................................................................................................................
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-53
DRAFT
DRAFT
...................................................................................................................................................................................................................................
Use the getStateChange command to get the state-changed notifications of the

selected FD if present.
Table 5-34
Syntax
<FDN> getStateChange [-notif <NotifID>] [-from
<time>] [-to <time>] [-adminstate <AdminState>]
[-unknownstatus <UnknownStatus>] [operationalstate <OperationalState>] [standbystatus <StandByStatus>] [-neupgradestatus
<NEUpgradeStatus>] [-upgradestatus
<UpgradeStatus>] [-inaccessoperationalstate
<InaccessOperationalState>] [oamlinkadministrativestate
<OAMLinkadministrativestate>] [-mibstate
<MIBState>] [-cluster <clusterName>]

NotifID: the ID of notification
from & to: these parameters are optional. The value of time is as
follows: yyyy-mm-dd HH:MM ( yyyy for year, mm for month,

dd for day, HH for hour, MM for minutes and SS for seconds).
These two parameters should always appear in pairs.
adminstate: the possible values are locked, unlocked and
shuttingdown.
unknownstatus: the possible values are false and true.
operationalstate: the possible values are enabled and
disabled.
standbystatus: the possible values are hotstandby,
coldstandby and providingservice.
neupgradestatus: the possible values are idle,
download_requested, download_in_progress,
download_completed, activation_in_progress,
fallback_in_progress, installation_in_progress and
probative.
upgradestatus: the possible values are not_in_progress,
in_progress and idle.
inaccessoperationalstate: the possible values are enabled
and disabled.
DRAFT
oamlinkadministrativestate: the possible values are

locked and unlocked.
mibstate: the possible values are not_built, up_todate,
not_up_todate, inconsistence, reset_request,
reset_running and update_inprogress.
...................................................................................................................................................................................................................................
5-54
clusterName
: select a specific
NN-20500-030
cluster to perform
the operation.
...................................................................................................................................................................................................................................
Table 5-34
getStateChange command (continued)
Result
A list of state-changed notifications about the selected FD which

match the pre-defined criteria.
Return Value
A list of state-changed notifications about the selected FD which

match the pre-defined criteria.
Errors
DRAFT
Examples:
# get all the changed-state of RNC
>: RNC RNCM1_1 getStateChange
otes
The period set by the "from" and "to" parameters must not exceed
8 days.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-55
DRAFT
getStatus command
...................................................................................................................................................................................................................................
getStatus command
Use the getStatus command to gets different status of the selected FD if present. One
status can also be selected to be returned.
Table 5-35
Syntax
getStatus command
<FDN> getStatus [-type <status>]

<status>: status of the managed object. To see the list of all
available status types, refer to the notes.

Result
A list of different status about the selected FD or the selected

status value
Return Value
A list of status. Each status is a pair of type/value

ot for all UTRA objects all status are available
Errors
Examples:
# get all the status of the RNC
>: RNC RNCM1_1 getStatus
{admState synchronized} {unknownStatus true} {operationalState
enabled} {inAccessOperationalState disabled} {activationState
activatedSynchronized}
# Get only the activationState of the selected RNC
>: RNC RNCM1_1 getStatus -type activationState
DRAFT
activationState
...................................................................................................................................................................................................................................
NN-20500-030
5-56
getStatus command
...................................................................................................................................................................................................................................
Table 5-35
otes
getStatus command (continued)

The list of type of status and their values are:
admState: locked, unlocked, shuttingDown
unknownStatus: false, true
operationalState: disabled, enabled; this state is not refreshed,

please do not rely on its value
availabilityStatus: intest, failed, powerOff, offline, offduty,

dependency, degraded, notInstalled, logfull
controlStatus: subjectToTest, partOfServiceLocked,

reservedForTest, suspended
standByStatus: hotStandby, coldStandby, providingService
neUpgradeStatus: idle, downloadRequested,

downloadInProgress, downloadCompleted, activationInProgress,
fallbackInProgress
upgradeStatus: notInProgress, inProgress, performed
inAccessOperationalState: disabled, enabled
activationState: unset, activatedSynchronized,

activatedDesynchronized, synchronizedWithError,
notActivated, notApplicable, pendingDeletion
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-57
DRAFT
DRAFT
...................................................................................................................................................................................................................................
Use the getAttributeValueInBulk command to return the E attribute information
(XML format) to the terminal or to save it in the DFS file.
Table 5-36
Syntax
getAttributeValueInBulk <FDN> -n.amingTree
<Naming Tree> -a.attributeIdentifier <Attribute
Identifier list> [-f <DFS File>] [-c.luster
<CLUSTER>]

<Naming Tree>: only contains the E type information. The
naming tree can be any child naming tree of the E or the E
itself if the E is supplied by the customer.
<Attribute Identifier List>: specifies which attribute
information of E must be displayed in the xml item.

<DFS File>: defines where the result must be stored. It must
started with 'dfs'. If it is not specified, the result is displayed at the
terminal.
<CLUSTER>: selects a specific cluster to perform the operation. If
it is not specified, all available clusters are applied.

Result
The Es attributes information (XML format) is retrieved at

CLUSTER. If parameters -f is specified, the result is stored to DFS
file with the return message "Success saving the Es attribute info
to the <DFS File> or the result is only displayed at terminal.
Return Value
Es attributes information enclosed by snapshot or a message

about the DFS File info if -f is specified
Errors
An exception is returned if an error is encountered during the

execution of the command.
Examples:
DRAFT
>:getAttributeValueInBulk -namingTree RNC/NodeB -a administrativeState

>:getAttributeValueInBulk -dn {RNC RNC600} -n RNC/NodeB -a
administrativeState -f dfs:/wicl/data/data.xml
>:getAttributeValueInBulk -dn {RNC RNC600} -n RNC/NodeB -a
administrativeState userSpecificInfo
>:getAttributeValueInBulk -dn {RNC RNC600 NodeB NodeBM1_600_001} -n
RNC/NodeB -a administrativeState userSpecificInfo
...................................................................................................................................................................................................................................
NN-20500-030
5-58
UTRAN commands
...................................................................................................................................................................................................................................
UTRAN commands
DRAFT
The UTRA commands are the following:
iRC commands (p. 5-60)

iBTSEquipment commands (p. 5-76)
POC command (p. 5-94)
MicroPicoBTS commands (p. 5-95)

OneBTSEquipment commands (p. 5-98)
I-ode command (p. 5-113)
Work order manipulation commands (p. 5-114)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-59
DRAFT
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
iRNC commands
The iRC commands are the following:
Table 5-37, download command (p. 5-60)

Table 5-38, activate command (p. 5-61)
Table 5-39, Rebuild command (p. 5-62)

Table 5-40, Audit command (p. 5-63)
Table 5-41, cancelBuild command (p. 5-64)
Table 5-42, resetMIB command (p. 5-64)

Table 5-43, openLink command (p. 5-65)
Table 5-44, closeLink command (p. 5-66)
Table 5-45, dbBackup command (p. 5-66)

Table 5-46, dbRestore command (p. 5-67)
Table 5-47, ListDbBackup command (p. 5-67)
Table 5-48, dbBackupRS command (p. 5-68)
Table 5-49, dbRestoreRS command (p. 5-69)

Table 5-50, abortUpgradeSession command (p. 5-69)
Table 5-51, fmSnapshot command (p. 5-70)
Table 5-52, specificAction command (p. 5-71)

Table 5-53, backupImage command (p. 5-71)
Table 5-54, listImage command (p. 5-72)

Table 5-55, getImageDescription command (p. 5-72)
Table 5-56, rehome command (p. 5-73)
Table 5-57, synchronizeSoftware command (p. 5-74)
Table 5-58, ppSynchronize command (p. 5-74)
Table 5-37
download command
download
DRAFT
Use this command to download the software from the SRS server into the RC
C-ode/I-ode/POC.
...................................................................................................................................................................................................................................
NN-20500-030
5-60
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-37
download command (continued)

download
Syntax
DRAFT
<FDN> download [-f.ile <DFS File>] -type

<Upgrade Type> -version <SoftVer> [-cluster
<clusterName>] [-verbose]

<DFS File>: logical path of the workorder file (in the Distributed
File System). It is only significant when upgradeType is equal to

newMIB.
<UpgradeType>: upgrade mode of a download operation. The
possible values are: currentMIB, newMIB and MIBRebuild.

SoftVer>: version of the software to download.
operation
execution.
Result
Download the specified Software version from the SRS into the
C-ode/I-ode/POC of a RC.
Return Value

(p. 5-214).
Errors
Example:
>: RNC RNC1404 download -type currentMIB -version "RNCV01.2B 01"
JOB FINISHED WITHOUT ERROR
otes
This command blocks all other WICL commands, until the

software is downloaded into the C-ode, I-ode and POC.
This is a long operation: for more details, see Long command
Table 5-38
activate command
activate
Use this command to activate the software downloaded from the SRS Server into the RC
C-ode/I-ode/POC.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-61
DRAFT
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-38
activate command (continued)

activate
Syntax
<FDN> activate [-cluster <clusterName>] [verbose]

operation.
execution.
Result
Activate the software version downloaded into the

C-ode/I-ode/POC of a RC.
Return Value

(p. 5-214).
Errors
Example:
>: RNC RNC1404 Activate
otes

software is activated into the C-ode, I-ode and POC.
Table 5-39
Rebuild command
Rebuild
Use this command to launch a rebuild operation on the specified RC/BTS MIB.
Syntax
<FDN> Rebuild [-cluster <clusterName>] [-verbose]

operation.
DRAFT
execution.
Result
Launch a rebuild operation on the specified RC/BTS MIB.
Return Value

(p. 5-214).
...................................................................................................................................................................................................................................
NN-20500-030
5-62
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-39
Rebuild command (continued)

Rebuild
Errors
DRAFT
Examples:
>: Rnc paris rebuild
>: BTSEquipment rose rebuild
otes
Table 5-40

Audit command
Audit
Use this command to launch an audit operation on the RC MIB. This command is used to
compare the RC MIB with the OAM database, and to get the inconsistencies between them.
Syntax
<FDN> Audit [-cluster <clusterName>] [-verbose]

operation.
execution.
Result
Launch an Audit operation on the RC and get the consistency

state.
Return Value

(p. 5-214).
Errors
Example:
# Launch the Audit command and display the result
>: puts "the Audit result is: [Rnc RNC_501 Audit]"
otes
This command blocks all the other WICL commands, until the
audit is achieved.
This command only displays the consistency state between the
RC MIB and the OAM database. If any inconsistency is found, it
is described in the XML return file.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-63
DRAFT
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-41
cancelBuild command
cancelBuild
Use this command to launch a reset operation on the RC or BTs online.
Syntax
<FDN> cancelBuild
[-cluster <clusterName>]

operation.
Result
Launch a reset operation on the RC or BTS online..
Return Value

(p. 5-214).
Errors
Example:
# Cancel a reset on a RNC online
>: RNC RNC1401 cancelBuild
# Cancel a reset on a BTSEquipment online
>: BTSEquipment bts_eiffel cancelBuild
Table 5-42
resetMIB command
resetMIB
Use this command to launch a reset operation on an RC offline.

Syntax
<FDN> resetMIB [-cluster


operation.
DRAFT
execution.
Result
Launch a reset operation on the selected equipment.
Return Value

(p. 5-214).
Errors
...................................................................................................................................................................................................................................
NN-20500-030
5-64
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-42
resetMIB command (continued)

resetMIB
DRAFT
Example:
# Reset a RNC
>: RNC RNC1401 resetMib

otes
Table 5-43
openLink command
openLink
Use this command to launch an open OAM link administrative state operation on a specified
RC. Launching this command does not mean that the link is really opened. The link is opened
(after several seconds) if the unknownStatus of the RC Equipment object is False.
Syntax
<FDN> openLink [-cluster <clusterName>]

operation.
Result
Launch an open OAM link administrative state operation on a

RC.
Return Value
In case of success:
Successful
Description: [success information]
In case of failure:
Failed
Error description: [detail error information]
Errors
Example:
>: RNC paris openLink
Successful
Description: RNC paris is unlocked
>: RNC paris openLink
Failed
Error Description: Errors happened during unlocking operation
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-65
DRAFT
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-44
closeLink command
closeLink
Use this command to launch a close OAM link administrative state operation on a specified
RC. Launching this command does not mean that the link is really closed. The link is closed
(after several seconds) if the unknownStatus of the RC Equipment object is True.
Syntax
<FDN> closeLink [-cluster <clusterName>]
<FDN>: <clusterName>: select a specific cluster to perform the

operation.
Result
Launch a close OAMlink administrative state operation on a RC
Return Value
In case of success:
Successful
In case of failure:
Failed
Errors
Example:
>: RNC paris CloseLink
Successful
Description: RNC paris is locked
>: RNC paris CloseLink
Failed
Error Description: Errors happened during locking operation
Table 5-45
dbBackup command
dbBackup
Use this command to execute backup on CORBA interface, .bkp file will be generated to store
the E backup data. Meanwhile, two same names WO files (.xwo, .xml) will be generated. The
.xwo WO file could be used to create E if it is not present in ROC, and .xml WO file could be
used to delete E if needed
Syntax
<FDN > dbBackup
DRAFT

Result
Success or Failed
Return Value
one
...................................................................................................................................................................................................................................
NN-20500-030
5-66
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-45
dbBackup command (continued)

dbBackup
Errors
DRAFT
Example:
>: RNC paris
otes
Table 5-46
DbBackup
Backup XML file and two WO files stored in the dfs path:
dfs:/utran/neBackup.
dbRestore command
dbRestore
Use this command to restore from the latest backuped file or a specified file, and create E if it
is not present in the current ROC with the same name .xwo WO file
Syntax
<FDN> dbRestore [<DFSFilePath>]
<FDN>: to understand the FD identifiers in WICL, see FD
Mapping (p. 5-23).

Only userLabel should be used as the key of FD.
DFSFilePath: logical Path of the backuped files (in DFS).
Result
Success or failed
Return Value
one
Errors

Example:
>: RNC Paris dbRestore
>: RNC Paris dbRestore dfs:utran/neBackup/RNC-Paris/
backup.20040510211323. Bkp
otes
Table 5-47
Restore XML file stored in the dfs path: dfs:utran/neBackup. If

DFSFilepath is absent, provide to CP_UMTS the latest E backup
file if present (else, error).
ListDbBackup command
ListDbBackup
Use this command to list backuped files related to a specific E, available under
dfs:/access/neBackup/.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-67
DRAFT
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-47
ListDbBackup command (continued)

ListDbBackup
Syntax
<FDN> ListDbBackup

Result
"Successful"
"Failed"
Return Value
List of all backuped files for a specified E
Errors
Example:
>: RNC paris ListDbBackup
Table 5-48
dbBackupRNS command
dbBackupRNS
Use this command to backup all BTSEquipment and OneBTSEquipment under one RC and
RC itself. A .lst file is generated to store the path of all these .bkp files in current RS.
Meanwhile, two same names of WO files will be generated which be used to create/delete RS
if needed.
Syntax
<FDN> dbBackupRNS

Result
Success or failed
Return Value
List of all backuped E list for specified RS
Errors

command execution
Example:
>: RNC paris dbBackupRNS
dbBackupRNS OK
>: RNC paris dbBackupRNS
DRAFT
Error: cannot backup the following NE:

BTSEquipment BTS1
...................................................................................................................................................................................................................................
NN-20500-030
5-68
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-49
dbRestoreRNS command
dbRestoreRNS
DRAFT
Use this command to restore the BTSEquipment, OneBTSEquipment and RC which are stored
in the latest .lst file if there is no specific list file required by customer input. The same name for
.xwo WO files is used to firstly create RS if it is not present in ROC. If any error has occurred
during the RS creation, the command tries to firstly delete RS before returning with error
message. Meanwhile, a same name .xml WO file can be used to delete RS manually if needed.
If any error has occurred while restoring a RC, the operation is stopped. If any error has
occurred while trying to restore a BTSEquipment/OneBTSEquipment, the E is stored to the
fail list file.
Syntax
<FDN> dbRestoreRNS [-file <DFSFilePath> | latest]

file: The specifc .lst file which stored the .bkp files path of these
BTSEquipment, OneBTSEquipment and RC to restore the RS.

This parameter is mutually exclusive with latest parameter.
latest: The specific RC BTSEquipment and
OneBTSEquipment will be restored with the latest .bkp file in

their folder. This parameter is mutually exclusive with file
parameter.
Result
Success or Failed
Return Value
List of all backuped files for specified E.
Errors

execution of the command
Example:
>: RNC paris dbRestoreRNS
dbRestoreRNS OK
>: RNC paris dbRestoreRNS
Error: cannot restore the following NE:
BTSEquipment BTS1
Table 5-50
abortUpgradeSession
...................................................................................................................................................................................................................................
NN-20500-030
5-69
DRAFT
Use this command to cancel upgrade session created by a previous download operation into the
RC C-ode/I-ode/POC.
DRAFT
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-50
abortUpgradeSession command (continued)

abortUpgradeSession
Syntax
<FDN> abortUpgradeSession [-cluster <clusterName>

[-verbose]

operation.
execution
Result
Cancels upgrade session created by a previous download operation

into the RC C-ode/I-ode/POC
Return Value
Abort download for "<internalDn>" successfully
Errors
Example:
>: RNC RNC1404 abortUpgradeSession
Abort download for "RNC RNC1404" successfully.
Table 5-51
fmSnapshot command
fmSnapshot
Use this command to retrieve snapshots from RC and BTSEquipments

Syntax
<FDN> fmSnapshot

Result
Retrieves snapshots from RC and BTSEquipments
Return Value

(p. 5-214).
Errors
Example:
>: RNC paris fmSnapshot
DRAFT
otes
It only requests the Global State of the RC and gets the SDO
result.
...................................................................................................................................................................................................................................
NN-20500-030
5-70
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-52
specificAction command
specificAction
DRAFT
Use this command to execute Lp switchover or reset action into the I-ode and POC.
Syntax
<FDN> specificAction <action> [-force] [-cluster

<clusterName>]

<action>: the possible values are switchover or reset.
-force: the action force flag.
operation.
Result
Executes the specific action into the I-ode or POC, and a Job log
is created in the command manager.
Return Value
The final status of the job.
Errors
Example:
>: RNC RNC03SKT RNCEquipment 0 INode RNC03SKTIN0 lp/0 specificAction
switchover -force
Table 5-53
backupImage command
backupImage
Use this command to backup the RC 1500 critical data through FTP. Those data will be saved
in /opt/nortel/data/utran/ EImage/R C/<R C Label>.
Syntax
<RNC FDN> backupImage [-comment <User Comment>]

<User Comment>: specify the user comments when doing RC
backup operation. The specified user comments will be recorded

in the descriptor file for backuped image.
Result
The RC critical data will be backuped onto the OAM server.
Return Value
The final status of backupImage operation.
Errors
Example:
>: RNC RNC1 backupImage -comment "Backup launched before doing an NE
SW Upgrade"
This command is only applicable for RC 1500.
...................................................................................................................................................................................................................................
NN-20500-030
5-71
DRAFT
otes
DRAFT
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-54
listImage command
listImage
Use this command to view all the IDs of a RC images. ID of an image is composed of two
parts: one part is RC user label, the other is the image creation date.
Syntax
<RNC FDN> listImage

Result
All the IDs of images for a given RC will be displayed to the
user.
Return Value
one
Errors
Example:
>: RNC Paris listImage
Paris_130806:1156 Paris_130806:0056 Paris_130806:0025
otes
Table 5-55

getImageDescription command
getImageDescription
Use this command to retrieve the corresponding RC image description file according to the
inputted imageId for analysing the key information (time of image creation, E release and
comments) and displaying it.
Syntax
<RNC FDN> getImageDescription -imageId <imageId>
<RNC FDN>: to understand the FD identifiers in UMTS WICL,
see FD Mapping (p. 5-23).

<imageId>: specify which backuped image you would like to
DRAFT
view. The imageId is got from the listImage command output.

Result
The image key information is displayed to the user.
Return Value
one
Errors
...................................................................................................................................................................................................................................
NN-20500-030
5-72
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-55
getImageDescription command (continued)

getImageDescription
DRAFT
Example:
>: RNC Paris listImage
Paris_130806:1156 Paris_130806:0056 Paris_130806:0025
>: RNC Paris getImageDescription -imageId Paris_130806:0025
neRelease
imageDate
comment
ote
Table 5-56
050
130806:0025
Backup launched before doing an NE S

rehome command
rehome
Use this command to move the RC MIB from one main-server to another main-server. This
command is only available for RC/BTS/POC/OneBTS.
Syntax
<RNC FDN> rehome -s.cluster <clusterName> t.cluster <clusterName> [-cluster <clusterName>]

[-verbose]

operation.
execution.
Result
The rehome operation is launched on the RC.
Return Value
A success information or an error message report during the

operation.
Errors
Example:
# Launch a rehome RNC command and display the result
>: puts "the rehome result is: [RNC RNC1 rehome -s UMAINSERV1 -t U
ote
This command uses multiple WICL commands, it may need a

delay to perform.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-73
DRAFT
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-57
synchronizeSoftware command
synchronizeSoftware
Use this command to perform the synchronization of the I-ode Software version by comparing
AV of the running delivery with AV of the delivery located on the SRS..
Syntax
<FDN> synchronizeSoftware [-cluster <clusterName>

[-verbose]
<RNC FDN>: to understand the FD identifiers in UMTS WICL,
see FD Mapping (p. 5-23).

operation.
execution.
Result
Performs the synchronization of the I-ode Software version.
Return Value
one
Errors
Example:
>: RNC RNC1 synchronizeSoftware
ote
Table 5-58

ppSynchronize
Use this command to synchronize the passport configuration view on the OAM database from
the selected User D. This command is launched on POC and RC I-ode.
Syntax
<FDN> ppSynchronize [-cluster <clusterName> [verbose]
< FDN>: to understand the FD identifiers in UMTS WICL, see

operation.
execution.
Result
Synchronize the selected User D from passport view.
Return Value
one
Errors
DRAFT
Example:
>: POC POC_1 ppSynchronize
...................................................................................................................................................................................................................................
NN-20500-030
5-74
UTRAN commands
iRNC commands
...................................................................................................................................................................................................................................
Table 5-58
ote
ppSynchronize command (continued)

This command is blocking until the UTRA object is completely
synchonized.
DRAFT
This is a long operation, for more details, see Long command

DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-75
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
The iBTSEquipment commands are the following:
Table 5-59, download command (p. 5-76)

Table 5-60, activate command (p. 5-77)
Table 5-61, Rebuild command (p. 5-78)

Table 5-62, resetMIB command (p. 5-79)
Table 5-63, cancelBuild command (p. 5-79)
Table 5-64, Reset command (p. 5-80)

Table 5-65, openLink command (p. 5-81)
Table 5-66, closeLink command (p. 5-82)
Table 5-67, dbBackup command (p. 5-83)

Table 5-68, dbRestore command (p. 5-83)
Table 5-69, ListDbBackup command (p. 5-84)
Table 5-70, abortUpgradeSession command (p. 5-84)
Table 5-71, fmSnapshot command (p. 5-85)

Table 5-72, Reset command (p. 5-86)
Table 5-74, Audit command (p. 5-86)

Table 5-75, AuditAllBts command (p. 5-87)
Table 5-76, pcmModeChange command (p. 5-87)

Table 5-77, pcmLoopbackTest command (p. 5-88)
Table 5-78, atmF4F5Test command (p. 5-90)
Table 5-79, rssiGathering command (p. 5-91)
Table 5-59
download command
download
DRAFT
Use this command to download the software from the SRS server into the BTSEquipment.
...................................................................................................................................................................................................................................
NN-20500-030
5-76
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-59
download command (continued)

download
Syntax
DRAFT
<FDN> download [-f.ile <DFS File>] -type

<Upgrade Type> -version <SoftVer> [-cluster

<DFS File>: logical path of the workorderfile (in the Distributed
File System). It is only significant when upgradeType is equal to

newMIB.
<UpgradeType>: upgrade mode of a download operation. The
possible values are: currentMIB, newMIB and MIBRebuild.

SoftVer>: version of the software to download.
operation
execution.
Result
Download the specified Software version from the SRS into the
BTSEquipment.
Return Value

(p. 5-214).
Errors
Example:
>: BTSEquipment bts_eiffel download -type currentMIB -version "NODEBV01.2B 01"
otes

software is downloaded into the BTSEquipment.
Table 5-60
activate command
activate
Use this command to activate the software downloaded from the SRS Server into the
BTSEquipment.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-77
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-60
activate command (continued)

activate
Syntax

operation.
execution.
Result
Activate the downloaded version software into the

BTSEquipment.
Return Value

(p. 5-214).
Errors
Example:
>: BTSEquipment bts_eiffel activate
otes
This command is blocked until the software activation of the

BTSEquipment.
Table 5-61
Rebuild command
Rebuild
Use this command to launch a rebuild operation on a specified RC/BTS MIB.

Syntax
<FDN> Rebuild [-cluster <clusterName>] [-verbose]

operation.
DRAFT
execution.
Result
Launch a rebuild operation on a specified RC/BTS MIB.
Return Value

(p. 5-214).
...................................................................................................................................................................................................................................
NN-20500-030
5-78
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-61
Rebuild command (continued)

Rebuild
Errors
DRAFT
Example:
>: Rnc paris rebuild
>: BTSEquipment rose rebuild

otes
Table 5-62
resetMIB command
resetMIB
Use this command to launch a reset operation on an RC or BTs offline.

Syntax
<FDN> resetMIB [-cluster


operation.
execution.
Result
Launch a reset operation on the specified equipment.
Return Value

(p. 5-214).
Errors
Example:
# Reset a RNC
>: RNC RNC1401 resetMib
# Reset a BTSEquipment
>: BTSEquipment bts_eiffel resetMib
otes
Table 5-63

cancelBuild command
cancelBuild
...................................................................................................................................................................................................................................
NN-20500-030
5-79
DRAFT
Use this command to cancel a reset operation on an RC or BTS online.
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-63
cancelBuild command (continued)

cancelBuild
Syntax
<FDN> cancelBuild

operation.
Result
Cancel a reset operation on a RC or BTS online..
Return Value

(p. 5-214).
Errors
Example:
# Cancel a reset on a RNC online
>: RNC RNC1401 cancelBuild
# Cancel a reset on a BTSEquipment online
>: BTSEquipment bts_eiffel cancelBuild
Table 5-64
Reset command
Reset
Use this command to launch a reset operation onto a BTS. There are various sorts of reset for a
BTS. If no type is selected, the default reset type is the following: Reset all the BTSEquipment.
Syntax
<FDN> Reset [-type <type>] [-cluster

<clusterName>]

<type>: the Reset BTSEquipment command has 3 different types
of reset:
Reset BTSEquipent (WholeBTS)
Reset Active CCM (ActiveCcm)
Reset Passive CCM (PassiveCcm)
The reset types are no case sensitive.

operation.
DRAFT
Result
Launch a selected type reset operation onto the specified BTS

equipment
...................................................................................................................................................................................................................................
NN-20500-030
5-80
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-64
Reset command (continued)

Reset
Return Value

(p. 5-214).
Errors
DRAFT
Example:
# Reset the Active CCM
>: BTSEquipment bts_eiffel reset -type activeCCM
# Default Reset: reset the bts equipment
>: BTSEquipment bts_eiffel reset
# Reset the passive ccm
>: BTSEquipment bts_eiffel reset -type passiveCcm
otes
Table 5-65
This is a long operation: seeLong command management

(p. 5-214) for more details.
openLink command
openLink
Use this command to launch an open OAM link administrative state operation onto a
BTSEquipment. Launching this command does not mean that the link is really opened. The link
is opened (after several seconds) if the unknownStatus of the BTSEquipment object is False.
Syntax
<FDN>: see FD Mapping (p. 5-23) to understand the FD
identifiers in UMTS WICL

operation.
Result
Launch an open OAM link administrative state operation on the

BTSEquipment.
Return Value
In case of success:
Successful
In case of failure:
Failed
Errors
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-81
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-65
openLink command (continued)

openLink
Example:
>BTSEquipment bts_eiffel openLink
Successful
Description: BTSEquipment bts_eiffel is unlocked.:>BTSEquipment bts_
eiffel openLink
Failed
Error Description: Errors happened during unlocking operation.
Table 5-66
closeLink command
closeLink
Use this command to launch a close OAM link administrative state operation onto a
BTSEquipment. Launching this command does not mean that the link is really closed. The link
is closed (after several seconds) if the unknownStatus of the BTSEquipment object is True.
Syntax

operation.
Result
Launch a close OAM link administrative state operation onto a

BTSEquipment.
Return Value
In case of success:
Successful
In case of failure:
Failed
DRAFT
Errors
...................................................................................................................................................................................................................................
NN-20500-030
5-82
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-66
closeLink command (continued)

closeLink
DRAFT
Example:
>BTSEquipment bts_eiffel closeLink
Successful
Description: BTSEquipment bts_eiffel is locked.
:>BTSEquipment bts_eiffel closeLink
Failed
Error Description: Errors happened during unlocking operation.
Table 5-67
dbBackup command
dbBackup
Use this command to execute a backup on the CORBA interface. A .bkp file is generated to store
the E backup data. Meanwhile, two same name WO files (.xwo, .xml) are generated. The .xwo
WO file can be used to create E if it is not present in ROC, and .xml WO file can be used to
delete E if needed
Syntax
<FDN > dbBackup
identifiers in UMTS WICL.

Result
Success or Failed
Return Value
one
Errors
Example:
>: BTSEquipment paris DbBackup
otes
Table 5-68
The backup XML file and two WO files are stored in

dfs:/utran/neBackup
dbRestore command
dbRestore
Use this command to restore from the latest backuped file or specified file. It also creates E if
it is not present in current ROC with the same name .xwo WO file
Syntax
<FDN> dbRestore [<DFSFilePath>]
...................................................................................................................................................................................................................................
NN-20500-030
5-83
DRAFT
DFSFilePath: logical Path of the backuped files (into DFS).
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-68
dbRestore command (continued)

dbRestore
Result
Success or Failed
Return Value
one
Errors
Example:
>: BTSEquipment paris DbRestore
>: BTSEquipment paris DbRestore
dfs:utran/neBackup/BTSEquipment-Paris/backup.20040510211323.bkp
Restore the XML file stored in the dfs path: dfs:utran/neBackup. If

you can not access to DFSFilepath, provide to CP_UMTS the
latest E backuped file if possible. Otherwise, an error occurs.
otes
Table 5-69
ListDbBackup command
ListDbBackup
Use this command to list backuped files related to a specific E, available under
dfs:/access/neBackup/.
Syntax
<FDN> ListDbBackup

Result
In case of success:
Successful
In case of failure:
Failed
Return Value
one
Errors
Example:
>: BTSEquipment paris
Table 5-70
ListDbBackup
abortUpgradeSession
DRAFT
BTSEquipment.
...................................................................................................................................................................................................................................
NN-20500-030
5-84
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-70
abortUpgradeSession command (continued)

abortUpgradeSession
Syntax
DRAFT

[-verbose]

operation.
execution
Result
Cancels the upgrade session created by a previous download

operation into the BTSEquipment
Return Value
Errors
Example:
>: BTSEquipment bts_eiffel abortUpgradeSession
Abort download for "BTSEquipment" successfully.
Table 5-71
fmSnapshot command
fmSnapshot
Use this command to retrieve snapshots from RC and BTSEquipments

Syntax
<FDN> fmSnapshot

Result
Retrieves snapshots from RC and BTSEquipments
Return Value
SDO result: see Long command management (p. 5-214) for

more details.
Errors
Example:
>:BTSEquipment BTS_paris fmSnapshot
otes
result.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-85
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-72
Reset command
Reset
Use this command to launch a reset operation onto the selected Board equipment
Syntax
<FDN> Reset [-cluster <clusterName>]

operation.
Result
Launch a reset operation onto the selected Board equipment.
Return Value
one
Errors
The formatted content of the work order on the specified FD is

displayed.
Example:
>: BTSEquipment BTS_paris Board 5 reset
otes
This command blocks all other WICL commands, until the Board
is reset.
This is a long operation: see Long command management
Table 5-73
rehome command
Use this command to launch a rehome operation on the BTSEquipment. This command is used
to move the RC/BTS/POC MIB from one main server to another main server. This command
only applies for RC/BTS/POC
Syntax
Table 5-74
See Table 5-56, rehome command (p. 5-73)

Audit command
Audit
Use this command to launch an audit operation on the BTSEquipment MIB. This command is
used to compare the BTSEquipment MIB with the OAM database, and to get the inconsistencies
between them.
DRAFT
Syntax
See Table 5-40, Audit command (p. 5-63)
...................................................................................................................................................................................................................................
NN-20500-030
5-86
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-75
AuditAllBts command
AuditAllBts
DRAFT
Use this command to launch an audit operation to all the BTSEquipments MIBs on a RC. This
command is used to compare the BTSEquipments MIB and the OAM database, and to get the
inconsistencies between them.
Syntax
<FDN> AuditAllBts [-cluster <clusterName>] [verbose]

operation.
execution.
Result
Launch an Audit operation on all the BTSEquipments on a RC

and get the consistency state.
Return Value

(p. 5-214).
Errors
Example:
>: RNC RNC501 auditAllBts
otes
This command blocks all the other WICL commands, until the
audit is achieved.
This command only displays the consistency state between the
BTSEquipment MIB and the OAM database. If any inconsistency
is found, it is described in the return XML file.
Table 5-76
pcmModeChange command
pcmModeChange
Use this command to change the BTSEquipment PCM mode. Two modes are possible: normal
and loopback. The loopback mode is reserved for loopback testing
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-87
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-76
pcmModeChange command (continued)

pcmModeChange
Syntax
<FDN> pcmModeChange -m.ode <Mode> [-cluster


<Mode>: choose one of the following values: normal or loopback.
operation.
<verbose>: retrieve the problems encountered during the
execution.
Result
The BTSEquipment PCM mode is changed successfully
Return Value
Success
Errors
An exception is returned if any problem is encountered during the

command execution.
The following error message is returned when parameter errors
occur:
'SYNTAX ERROR: Missing parameter '-mode'. Please
refer to the help with command 'help
pcmModeChange'.'
'SYNTAX ERROR: unsupported parameter values for
'-mode '. Please refer to the help with command
'help pcmModeChange'.'
'SYNTAX ERROR: unrecognizable parameter <arg>.'
Example:
>: BTSEquipment bts_eiffel PCM 0 pcmModeChange -mode loopback
success
Table 5-77
pcmLoopbackTest command
pcmLoopbackTest
DRAFT
This command is attached to a BTSEquipment PMC instance. Use this command to trigger a
PCM loopback test on the BTSEquipment
...................................................................................................................................................................................................................................
NN-20500-030
5-88
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-77
pcmLoopbackTest command (continued)

pcmLoopbackTest
Syntax
DRAFT
<FDN> pcmLoopbackTest -t.estMode <testMode> a.mountOfMessagesToSend <amountOfMessagesToSend>

[-cluster <clusterName>] [-verbose]

<testMode>: Enumerate with runLoopbackTest
<amountOfMessagesToSend>: Integer [1..5], representing the
number of message sent

operation.
execution.
Result
The command triggers the PCM loopback test on the <user D>
PCM instance, the BTSEquipment emits a series of messages and
counts the number of received messages from the loop.
Return Value
A list with 3 elements is returned:
Errors
result : success, alreadyImplementedByTIL or failure
numberOfMessagesSent : integer 1..5
numberOfMessagesReceived: integer 0..5

command execution.
occur:
'SYNTAX ERROR: Missing parameter '-testMode'.
Please refer to the help with command 'help
pcmLoopbackTest'.'
'-testMode '. Please refer to the help with
command 'help pcmLoopbackTest'.'
Example:
>: BTSEquipment bts_eiffel PCM 0 pcmLoopbackTest -testMode
runLoopbackTest -amountOfMessagesToSend 5
{success,5,5}
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-89
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-78
atmF4F5Test command
atmF4F5Test
Use this command to run on the BTSEquipment VCC, an ATM F4 or F5 test from a end to end
or segment perspective
Syntax
<FDN> atmF4F5Test -t.estMode <testMode> n.umberOfCells <numberOfCells> [-cluster


<testMode>: enumerate with the endtoEndF4Test,
endtoEndF5Test, segmentF4Test, segmentF5Test

<numberOfCells>: specify the number of cell to be sent during
the test
operation.
DRAFT
execution.
Result
The BTSEquipment sends on the VCC a series of messages and

returns a diagnostic.
Return Value
result : success
numberOfCellsSent: integer 1..5
numberOfCellsReceived integer 0..5
duration : an integer expressing duration in seconds
...................................................................................................................................................................................................................................
NN-20500-030
5-90
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-78
atmF4F5Test command (continued)

atmF4F5Test
Errors
DRAFT

command execution.
occur:
'SYNTAX ERROR: Missing parameter '-testMode'.
atmF4F5Test'.'
'-numberOfCells '. Please refer to the help with
command 'help atmF4F5Test'.'
'SYNTAX ERROR: Missing parameter values for 'testMode '. Please refer to the help with
command 'help atmF4F5Test'.'
'- numberOfCells '. Please refer to the help
with command 'help atmF4F5Test'.'
Example:
>: BTSEquipment bts_eiffel VCC 0
endtoEndF4Test -numberOfCells 5
atmF4F5Test -testMode
{success, 5, 5, 1}
Table 5-79
rssiGathering command
rssiGathering
Use this command to request rssi gathering data to be produced on the BTSEquipment. When
period and duration are both set to 0 the command cancels any previous rssiGathering command
on that BTSEquipment.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-91
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-79
rssiGathering command (continued)

rssiGathering
Syntax
<FDN> rssiGathering -p.eriod <Period> -d.uration

<Duration> [-cluster <clusterName>] [-verbose]

<Period>: enumerate with the following values 10, 20, 0
<Duration>: specify the duration in minutes in 0, 5..1440 by step
of 5 minutes
operation.
execution.
Result
The rssi gathering information are produced on the BTSEquipment

for a duration and period specified in the command line interface.
Return Value
Errors
result : enum success, failed
sequence (integer)
rssiFileFullPathame (String (0..128))

command execution.
occur:
'SYNTAX ERROR: Missing parameter '-period'.
rssiGathering'.'
'-period '. Please refer to the help with
command 'help rssiGathering'.'
'SYNTAX ERROR: Missing parameter values for 'duration'. Please refer to the help with command
'help rssiGathering'.'
'-duration'. Please refer to the help with
command 'help rssiGathering'.'
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-92
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-79
rssiGathering command (continued)

rssiGathering
DRAFT
Example:
>: BTSEquipment bts_eiffel rssiGathering -period 20
-duration 10
{success, 196618,/data/rssiResult.log}
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-93
DRAFT
UTRAN commands
POC command
...................................................................................................................................................................................................................................
POC command
The POC commands are the following:

Table 5-81, exportCMReport command (p. 5-94)
Table 5-82, ppSynchronize command (p. 5-94)
Table 5-80
rehome command
Use this command to launch a rehome operation on the POC. This command is used to move the
RC/BTS/POC MIB from one main server to another main server. This command only applies
for RC/BTS/POC
Syntax
Table 5-81
See Table 5-56, rehome command (p. 5-73)

exportCMReport command
Use this command to generate CM reports for a ROC. Each report is separated by plmnid. The
report includes all utran shared objects info. in the etwork and the feature activation status for
specified types of E
Syntax
<FDN> exportCMReport [-p.lmnid <plmnid>]

<plmnid>: export CM Report for specified plmnid.
Result
One or Several CM Reports are generated and show in a webpage.

Each webpage is separated per plmnid.
Return Value
Successful plmnid list as well as Failed plmnid list if any.
Errors

Examples:
Launch a GPS self survey on a GRS
>:
>:
>:
>:
exportCMReport
Export CM Report Successfully for following plmnid: 208-11 208-27.
exportCMReport -plmnid 208-27
Export CM Report Successfully for following plmnid: 208-27.
Table 5-82
Use this command to synchronize the passport synchronization view on the OAM database from
the selected user D. This command launches on POC and RC Iode
DRAFT
Syntax
See Table 5-58, ppSynchronize command (p. 5-74)
...................................................................................................................................................................................................................................
NN-20500-030
5-94
UTRAN commands
...................................................................................................................................................................................................................................
The MicroPicoBTS commands are the following:
Table 5-83, MicroPicoBTS Download command (p. 5-95)

Table 5-84, MicroPicoBTS Activate command (p. 5-96)
Table 5-85, MicroPicoBTS abortUpgradeSession command (p. 5-96)
Table 5-83
DRAFT
MicroPicoBTS Download command

MicroPicoBTS download
This command does the software download of the BTSEquipment/MicroBTS from the SRS
server.
Syntax
MicroPicoBTS download -dn <FDN> -version

<SoftVer> [-Autoactivate] [-cluster <clusterName>
] [-verbose]
FD Mapping (p. 5-23)

<SoftVer>: Software version to be downloaded.
<Autoactivate>: This flag indicates whether the software
activation will be done automatically. If it is not supplied, it means

that the software activation must be done manually.
operation..
<verbose>: retrieves the problems encountered during the
execution.
Result
Download the selected Software version from the SRS into the
MicroBTS/ipPicoBTS.
Return Value
SDO Result. See Long command management (p. 5-214) for

more information.
Errors

Examples:
>: MicroPicoBTS download -dn {MicroBTS bts_eiffel} -version
"APP01234" -Autoactivate
Job finished without error
otes
This command is blocked until the software is downloaded into

the MicroBTS/ipPicoBTS.
...................................................................................................................................................................................................................................
NN-20500-030
5-95
DRAFT

DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-84
MicroPicoBTS Activate command

MicroPicoBTS Activate
This command does the software activation of the BTSEquipment/MicroBTS from the SRS
server.
Syntax
MicroPicoBTS activate -dn <FDN> [-cluster

FD Mapping (p. 5-23)

operation.
execution.
Result
Activate the downloaded Software in the MicroBTS/ipPicoBTS.
Return Value
SDO Result. SeeLong command management (p. 5-214)
Errors

Examples:
>: MicroPicoBTS activate -dn {MicroBTS bts_eiffel}
otes
This command is blocked until the software is activated into the

MicroBTS/ipPicoBTS.
(p. 5-214)
Table 5-85
MicroPicoBTS abortUpgradeSession command
MicroPicoBTS abortUpgradeSession
BTSEquipment/MicroBTS.
Syntax
MicroPicoBTS abortUpgradeSession -dn <FDN> [cluster <clusterName> [-verbose]

operation.
DRAFT
execution
...................................................................................................................................................................................................................................
NN-20500-030
5-96
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-85
MicroPicoBTS abortUpgradeSession command (continued)
MicroPicoBTS abortUpgradeSession
Result
Cancels upgrade session created by a previous download operation

into the BTSEquipment/MicroBTS
Return Value
Errors
DRAFT
Example:
>: MicroPicoBTS abortUpgradeSession -dn {MicroBTS eiffel}
Abort download for "BTSEquipment" successfully.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-97
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
The OneBTSEquipment commands are the following:
Table 5-86, OneBTS download command (p. 5-98)

Table 5-87, OneBTS activate command (p. 5-99)
Table 5-88, OneBTS diagnose command (p. 5-100)

Table 5-89, OneBTS abortUpgradeSession command (p. 5-101)
Table 5-90, OneBTS fmSnapshot command (p. 5-101)
Table 5-91, OneBTS openLink command (p. 5-102)

Table 5-92, OneBTS closeLink command (p. 5-103)
Table 5-93, OneBTS powerTest command (p. 5-104)
Table 5-94, OneBTS rxAntennaTest command (p. 5-105)

Table 5-95, OneBTS initiateSelfSurvey command (p. 5-105)
Table 5-96, OneBTS cancelSelfSurvey command (p. 5-106)
Table 5-97, OneBTS Reset command (p. 5-107)
Table 5-98, OneBTS createBackupImage command (p. 5-107)

Table 5-99, OneBTS restoreBackupImage command (p. 5-108)
Table 5-100, OneBTS listBackupImage command (p. 5-109)
Table 5-101, OneBTS cmsynchronize command (p. 5-109)

Table 5-102, OneBTS fmsynchronize command (p. 5-110)
Table 5-103, OneBTS preprovision command (p. 5-111)

Table 5-104, OneBTS fallbackSoftware command (p. 5-111)
Table 5-86
OneBTS download command

OneBTS download
DRAFT
Use this command to download the OneBTSEquipment software from the SRS server.
...................................................................................................................................................................................................................................
NN-20500-030
5-98
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-86
OneBTS download command (continued)

OneBTS download
Syntax
DRAFT
<FDN> download -version <SoftVer> [-mode

<AutoMode>] [-cluster <clusterName>] [-verbose]

<SoftVer>: Software version to be downloaded.
<AutoMode>: This flag indicates whether the software activation
will be done automatically. If it is not supplied, it means that the

software activation must be done manually.
operation.
execution.
Result
Download the selected Software version from the SRS into the
OneBTSEquipment.
Return Value
SDO Result. See Long command management (p. 5-214) for

more information.
Errors

Examples:
>: OneBTSEquipment OneBTSEquipment110 download -version "APP004_P4-111" -mode "automatic"
otes
This command is blocked until the software is downloaded into

the OneBTSEquipement.
Table 5-87
OneBTS activate command

OneBTS activate
Use this command to activate the OneBTSEquipment software from the SRS server.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-99
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-87
OneBTS activate command (continued)

OneBTS activate
Syntax

<clusterName>: selects a specific cluster to perform the
operation.
execution.
Result
Activate the downloaded Software in the OneBTSEquipment.
Return Value
SDO Result. See Long command management (p. 5-214)
Errors

Examples:
>: OneBTSEquipment OneBTSEquipment110 activate
otes
This command is blocked until the software is activated into the

OneBTSEquipment.
(p. 5-214)
Table 5-88
OneBTS diagnose command

OneBTS diagnose
Use this command to launch equipment diagnose measure. It could be applied to UCU, Radio,
CTU, OCM, RFHead, TDU, OneBTSEquipment
Syntax
<FDN> diagnose -t.estId <testId Value>

cluster <clusterName>] [-verbose]
[-

<testId>: unique value given by OMC for correlating diagnose
command and diagnoseComplete event

operation.
DRAFT
execution.
...................................................................................................................................................................................................................................
NN-20500-030
5-100
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-88
OneBTS diagnose command (continued)

OneBTS diagnose
Result
Diagnose the equipment
Return Value
SDO Result. See Long command management (p. 5-214)
Errors

DRAFT
Examples:
# Launch a diagnose on an equipment
>: OneBTSEquipment OneBTSEquipment110 diagnose
Table 5-89
OneBTS abortUpgradeSession command

OneBTS abortUpgradeSession
Use this command to cancel an upgrade session performed by a previous download operation
into the OneBTSEquipment.
Syntax

[-verbose]
identifiers in UMTS WICL. Only userLabel should be used as the

key of FD.
operation.
execution
Result
Cancels the upgrade session performed by a previous download

operation into the OneBTSEquipment.
Return Value
Errors
Example:
>: OneBTSEquipment OneBTSEquipment110 abordUpgradeSession
Abort download for "OneBTSEquipment OneBTSEquipment110" successful
Table 5-90
OneBTS fmSnapshot command

OneBTS fmSnapshot
Use this command to retrieve snapshots from RC, BTSEquipments and OneBTSEquipment.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-101
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-90
OneBTS fmSnapshot command (continued)

OneBTS fmSnapshot
Syntax
<FDN> fmSnapshot

Result
Retrieves snapshots from RC, BTSEquipments and

OneBTSEquipments.
Return Value

more details.
Errors
Example:
>:OneBTSEquipment BTS_paris fmSnapshot
otes
Table 5-91
result.
OneBTS openLink command
OneBTS openLink
Use this command to launch an open OAM link administrative state operation on a specified
OneBTSEquipment. Launching this command does not mean that the link is really opened. The
link is opened (after several seconds) if the unknownStatus of the OneBTSEquipment object is
False.
Syntax

operation.
Result
Launch an open OAM link administrative state operation on a

OneBTSEquipment.
Return Value
In case of success:
Successful
In case of failure:
Failed
DRAFT
Errors

...................................................................................................................................................................................................................................
NN-20500-030
5-102
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-91
OneBTS openLink command (continued)

OneBTS openLink
DRAFT
Example:
>: OneBTSEquipment bts_eiffel openLink
Successful
Description: OneBTSEquipment bts_eiffel is unlocked
>: OneBTSEquipment bts_eiffel openLink
Failed
Table 5-92
OneBTS closeLink command

OneBTS closeLink
Use this command to launch a close OAM link administrative state operation on a specified
OneBTSEquipment. Launching this command does not mean that the link is really closed. The
link is closed (after several seconds) if the unknownStatus of the OneBTSEquipment object is
True.
Syntax

operation.
Result
Launch a close OAMlink administrative state operation on a RC
Return Value
In case of success:
Successful
In case of failure:
Failed
Errors
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-103
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-92
OneBTS closeLink command (continued)

OneBTS closeLink
Example:
>: OneBTSEquipment bts_eiffel closeLink
Successful
Description: OneBTSEquipment bts_eiffel is locked
>: OneBTSEquipment bts_eiffel closeLink
Failed
Table 5-93
OneBTS powerTest command

OneBTS powerTest
Use this command to measure the aggregate power of the cell.

Syntax
<FDN> powerTest -t.estId <testId Value> [cluster <clusterName>] [-verbose]

operation.
<-verbose>: retrieves the problems encountered during the
execution
<testId>: unique value given by OMC for correlating powerTest
command and powerTestComplete event.

Result
Measures the aggregate power of the cell.
Return Value
SDO result: seeLong command management (p. 5-214) for more

details.
Errors

Example:
# Launch a powerTest on a Cell
DRAFT
>: OneBTSEquipment OneBTSEquipment110 Cell Cell0 powerTest -testId 10
...................................................................................................................................................................................................................................
NN-20500-030
5-104
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-94
OneBTS rxAntennaTest command

OneBTS rxAntennaTest
DRAFT
Use this command to trigger the RX antenna test of Cell on the specified frequency channel
number.
Syntax
<FDN> rxAntennaTest -t.estId <testId Value> [cluster <clusterName>] [-verbose]

operation.
execution
<testId>: unique value given by OMC for correlating RX
Antenna Testcommand and rxantennaTestComplete event.

Result
Triggers the RX antenna test of Cell on the specified frequency

channel number.
Return Value

details.
Errors

Example:
# Launch a rxAntennaTest on a Cell
>: OneBTSEquipment OneBTSEquipment110 Cell Cell0 rxAntennaTest -te
Table 5-95
OneBTS initiateSelfSurvey command

OneBTS initiateSelfSurvey
Use this command to trigger a GPS self survey whereby the position of the GPS antenna is
established with high precision.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-105
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-95
OneBTS initiateSelfSurvey command (continued)

OneBTS initiateSelfSurvey
Syntax
<FDN> initiateSelfSurvey [-estimateTime

<estimateTime Value>] [-cluster <clusterName>] [verbose]

operation.
execution
<estimatedTime>: enters the estimated time in minutes. If it is
ignored, the default value used is 80.

Result
Triggers a GPS self survey.
Return Value

more details.
Errors

Example:
# Launch a GPS self survey on a GRS
>: OneBTSEquipment OneBTSEquipment110 GRS GRS0 initiateSelfSurvey estimateTime 1000
>: OneBTSEquipment OneBTSEquipment110 GRS GRS0 initiateSelfSurvey
Table 5-96
OneBTS cancelSelfSurvey command

OneBTS cancelSelfSurvey
Use this command to cancel a GPS self survey.

Syntax
<FDN> cancelSelfSurvey [-cluster <clusterName>]

[-verbose]

operation.
DRAFT
execution
Result
Cancels a GPS self survey.
Return Value

details.
...................................................................................................................................................................................................................................
NN-20500-030
5-106
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-96
OneBTS cancelSelfSurvey command (continued)

OneBTS cancelSelfSurvey
Errors
DRAFT

Example:
>: OneBTSEquipment OneBTSEquipment110 GRS GRS0 cancelSelfSurvey
Table 5-97
OneBTS Reset command

Reset
Use this command to launch a reset operation on the OneBTS. There are various sorts of reset
for a BTS. For OneBTS and sub-components, -force is only accepted as input.
Syntax
<FDN> Reset [-force <force flag>] [-cluster

<clusterName>]

<force>: True or False, the default value is false
operation.
Result
Launch the reset operation onto the specified OneBTSEquipment.
Return Value

(p. 5-214)
Errors

command execution.
Example:
# Reset OneBTSEquipment
>: OneBTSEquipment OneBTSEquipment110 reset -force True
Table 5-98
OneBTS createBackupImage command

OneBTS createBackupImage
Use this command to trigger the OneBTSEquipment in order to create a backup file so that the
OMC-U can pick it up via FTP.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-107
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-98
OneBTS createBackupImage command (continued)

OneBTS createBackupImage
Syntax
<FDN> createBackupImage [-cluster <clusterName>]

[-verbose]

operation.
execution.
Result
Triggers the OneBTSEquipment to create a backup file
Return Value

(p. 5-214)
Errors

command execution.
Example:
# triggers the OneBTSEquipment to create a backup file
>: OneBTSEquipment OneBTSEquipment110 createBackupImage
otes
Table 5-99

OneBTS restoreBackupImage command
OneBTS restoreBackupImage
Use this command to trigger the OneBTSEquipment to reset and to come up using the backup
image file that is stored in the specified directory.
Syntax
<FDN> restoreBackupImage -file <filename> [cluster <clusterName>] [-verbose]

operation.
DRAFT
execution.
Result
Triggers the OneBTSEquipment to reset and to come up using the

backup image file that is stored in the specified directory.
Return Value

(p. 5-214).
...................................................................................................................................................................................................................................
NN-20500-030
5-108
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-99
OneBTS restoreBackupImage command (continued)

OneBTS restoreBackupImage
Errors
DRAFT

command execution.
Example:
# triggers the OneBTSEquipment to reset and restore a backup file
>: OneBTSEquipment OneBTSEquipment110 restoreBackupImage -file tes
Table 5-100
OneBTS listBackupImage command

listBackupImage
Use this command to list all backup image files of specified OneBTSEquipment that is stored in
the specified directory.
Syntax
<FDN> listBackupImage [-cluster <clusterName>] [verbose]

operation.
execution.
Result
This action list all backup image files of specified

OneBTSEquipment that is stored in the specified directory.
Return Value
OneBTSEquipment backup image file names
Errors

>: OneBtsEquipment OneBtsEquipment110
listBackupImage
Table 5-101
OneBTS cmsynchronize command

cmsynchronize
Use this command to trigger the OneBTSEquipment so that it launches CM Synchronize

operation.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-109
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-101
OneBTS cmsynchronize command (continued)

cmsynchronize
Syntax
<FDN> cmsynchronize [-cluster <clusterName>] [verbose]

operation.
execution.
Result
Triggers the OneBTSEquipment to launch CM synchronize

operation.
Return Value

(p. 5-214)
Errors

command execution.
occur:
'SYNTAX ERROR: unrecognizable parameter <$args>
Example:
>: OneBTSEquipment OneBTSEquipment110 cmsynchronize
Table 5-102
OneBTS fmsynchronize command

fmsynchronize
Use this command to trigger the OneBTSEquipment so that it launches FM Synchronize

operation.
Syntax
<FDN> fmsynchronize [-cluster <clusterName>] [verbose]

operation.
DRAFT
execution.
Result
Triggers the OneBTSEquipment to launch FM synchronize

operation.
Return Value

(p. 5-214)
...................................................................................................................................................................................................................................
NN-20500-030
5-110
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-102
OneBTS fmsynchronize command (continued)

fmsynchronize
Errors
DRAFT

command execution.
Example:
>: OneBTSEquipment OneBTS_realonebts fmsynchronize
Table 5-103
OneBTS preprovision command

preprovision
Use this command to enable pre-provisioning mode for OneBTSEquipment

Syntax
<FDN> preprovision [-cluster <clusterName>] [verbose]

operation.
execution.
Result
Set preprovisioning flag to TRUE.
Return Value

(p. 5-214)
Errors

command execution.
Example:
>: OneBTSEquipment OneBTS_realonebts preprovision
Table 5-104
OneBTS fallbackSoftware command

fallbackSoftware
Use this command to perform a software fallback of the OneBTSEquipment from the SRS
server.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-111
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-104
OneBTS fallbackSoftware command (continued)

fallbackSoftware
Syntax
<FDN> fallbackSoftware [-cluster <clusterName>]

[-verbose]

operation.
execution.
Result
Fallbacks the downloaded version in the OneBTSEquipment.
Return Value

(p. 5-214)
Errors

command execution.
occur:
'SYNTAX ERROR: The 'activate' operation for
<class> does not support any parameters.
Example:
>: OneBTSEquipment OneBTSEquipment220 fallbackSoftware
ote
This command is blocked until the fallback of the software is done

into the OneBTSEquipment.
DRAFT
This is a long operation, for more information seeLong command

management (p. 5-214)
...................................................................................................................................................................................................................................
NN-20500-030
5-112
UTRAN commands
I-Node command
...................................................................................................................................................................................................................................
I-Node command
Use the fmINodeSnapshot command to retrieve the snapshot of Iode
DRAFT
ote: This is an UTRA command

Table 5-105
Syntax
fmINodeSnapshot command
<FDN> fmINodeSnapshot[-cluster <clusterName>] [verbose]

clusterName: perform the operation in a specific cluster
verbose: This parameter is used to output the encountered
problem during the execution

Result
Retrieve the snapshot of Iode
Return Value
Retrieve the snapshot of Iode
Errors

more details.
Example:
>: RNC RNC14 RNCEquipment 0 INode LAB_RNC14_IN fmINodeSnapshot
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-113
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................

The Work Order commands are the following:
Table 5-106, WO Export command (p. 5-114)

Table 5-107, WO Display command (p. 5-114)
Table 5-108, WO CreateObject command (p. 5-115)

Table 5-109, WO setObject command (p. 5-115)
Table 5-110, WO deleteObject command (p. 5-116)
Table 5-106
WO Export command
WO Export
Use this command to export the work order of a specified FD.

Syntax
WO export -dn <FDN> -f <DFSFile>
<FDN>: specifies the FD of which work order will be exported.

<DFSFile>: specifies where the exported work order will be
stored.
Result
The work order is exported to the file.
Return Value
one
Errors
Examples:
>: WO export -dn {RNC RNC_1} -f dfs:/tmp/Nietzsche.wo
Table 5-107
WO Display command
WO Display
Use this command to display the work order of a specified FD.

Syntax
WO display -dn <FDN>
<FDN>: specifies the FD of which work order will be displayed.
Result
The formatted contents of the work order of the specified FD is

displayed.
Return Value
The contents of the work order.
Errors
Examples:
DRAFT
>: WO display -dn {RNC RNC_1}
...................................................................................................................................................................................................................................
NN-20500-030
5-114
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-108
WO CreateObject command
WO CreateObject
DRAFT
Use this command to create an object from a specified FD, in offline mode.
Syntax
WO CreateObject -dn <FDN> <AttributeName1>

<Value1> ... <AttributeNameN> <ValueN>
<FDN>: specifies the FD from which will be created an object.

<AttributeValue>: value of the attribute
Result
Create a specified object in the WO which has been loaded.
Return Value
The final status of the creating job.
Errors
Examples:
>: WO createObject -dn {RNC RNCM1_400 NodeB NodeBM1_400_002}
Table 5-109
WO setObject command
WO setObject
Use this command to change the value of an attribute.

Syntax
WO setObject -dn <FDN> <AttributeName1> <Value1>

... <AttributeNameN> <ValueN>
<FDN>: specifies the FD of which attribute value will be defined.

<AttributeValue>: value of the attribute, the new value to set.
Result
Set the attribute value of a specified object in the WO which has

been loaded.
Return Value
The final status of the setting job.
Errors
Examples:
>: WO setObject -dn {RNC RNCM1_400 NodeB NodeBM1_400_002} startPoint
50
# Setting attributes which use lists

>: WO setObject-dn {RNC RNCM1_400 RadioAccessService 0 UIRbSetConf
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-115
DRAFT
UTRAN commands
...................................................................................................................................................................................................................................
Table 5-110
WO deleteObject command
WO deleteObject
Use this command to delete objects in offline mode.

Syntax
WO deleteObject -dn <FDN>
<FDN>: specifies the FD of which specified object will be
deleted.
Result
Delete a specified object in the WO which has been loaded.
Return Value
The final status of the deleting job.
Errors
Examples:
DRAFT
>: WO deleteObject -dn {RNC RNC1}
...................................................................................................................................................................................................................................
NN-20500-030
5-116
...................................................................................................................................................................................................................................
DRAFT
The configuration manager commands are the following:
CM createSession command (p. 5-118)

CM terminateSession command (p. 5-119)
CM abortSession command (p. 5-120)
CM validate command (p. 5-121)

CM listSession command (p. 5-122)
CM displaySession command (p. 5-123)
CM preActivate command (p. 5-124)
CM activate command (p. 5-125)

CM resume command (p. 5-126)
CM setActivationType command (p. 5-127)
CM getAvailableConfigModels command (p. 5-128)

CM export command (p. 5-129)
CM exportRS command (p. 5-131)
CM getImpactedConfigodes command (p. 5-133)

CM getImpactedConfigodesInfo command (p. 5-134)
CM releaseodes command (p. 5-135)
CM fallback command (p. 5-136)

CM listGeneratedSessions command (p. 5-137)
CM launchSession command (p. 5-138)
createCMSession command (p. 5-139)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-117
DRAFT

...................................................................................................................................................................................................................................
Use the CM createSession command to create new sessions in the Configuration
Manager.
Table 5-111
Syntax
CM createSession <sessionName> -f.ile <DFSFile>
[-excludeDN <list of exclude confignodes>][manualRelease]
<sessionName>: specifies the name of the session that will be
created.
<DFSFile>: specifies the DFS path of the work order.
<list of exclude confignodes>: list of Configodes to
exclude from the session

<manualRelease>: if this option is activated, the node is not
automatically released when it is activated

Result
Create a new session with a specified name.
Return Value

more details.
Errors
Examples:
DRAFT
>: CM createSession sess1 -f dfs:/tmp/test.xwo

>: CM createSession sess1 -f dfs:/tmp/test.xwo -manualRelease
...................................................................................................................................................................................................................................
NN-20500-030
5-118

...................................................................................................................................................................................................................................
Use the CM terminateSession command to remove a specific session in the
Configuration Manager.
Table 5-112
Syntax
DRAFT
CM terminateSession <sessionName>
removed.
Result
Remove a specific session.
Return Value
one
Errors
Examples:
>: CM terminateSession sess1
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-119
DRAFT

...................................................................................................................................................................................................................................
Use the CM abortSession command to abort a specific session in the Configuration
Manager.
Table 5-113
Syntax
CM abortSession <sessionName>
aborted.
Result
Abort a specific session.
Return Value

more details.
Errors
Examples:
DRAFT
>: CM abortSession sess1
...................................................................................................................................................................................................................................
NN-20500-030
5-120

CM validate command
...................................................................................................................................................................................................................................
CM validate command
Use the CM validate command to validate in the Configuration Manager a specified
session and specified nodes into this session.
Table 5-114
DRAFT
CM validate command
Syntax
CM validate <sessionName> [-dn <list of nodes>]
validated.
<list of nodes>: specifies the list of nodes that will be
validated. An empty list should mean all nodes of the session.

Result
Validate in the Configuration Manager a specified session and

specified nodes into this session.
Return Value
The result for each node.
Errors
Examples:
>: CM validate sess1
Node job information:
{RNC RNC1} {job finished without error}
ValidateStatus
Unknown
allowedActivationTypes
Critical
currentActivationType
Critical
report
/cmXMl/fakeman.xml
Node error information:
{RNC RNC3} {Exception information}
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-121
DRAFT

...................................................................................................................................................................................................................................
Use the CM listSession command to list sessions and their activation status in the
Table 5-115
Syntax
CM listSession <sessionName>
<sessionName>: specifies the name of the sessions to query. An
empty list shoud mean all sessions in the Configuration Manager.

Result
Returns sessions name and their activation status.
Return Value
Sessions name and their activation status. The activation status

should be one of the following values: Idle, InProgress, Activated
or FallbackCompleted.
Errors
Examples:
>: CM listSession
DRAFT
{sess1 Idle} {sess2 Activated}
...................................................................................................................................................................................................................................
NN-20500-030
5-122

...................................................................................................................................................................................................................................
Use the CM displaySession command to display all attributes of a specified session in
the Configuration Manager.
Table 5-116
Syntax
DRAFT
CM displaySession <sessionName> [-dn <node list>]
displayed.
<node list>: specifies the name of the nodes to query.
Result
Returns all attributes of a specified session.
Return Value
All attributes of the specified session.
Errors
Examples:
>: CM displaySession sess1
activationStatus Idle
node {RNC RNC1 NodeB NodeB1}
currentStatus Activated
validateStatus Passed
allowedActivationTypes Critical
report /cmXml/report.xml
currentActivationType
Critical
stepHistory
availableOperations PreActivate, Activate, Resume
node {RNC RNC2 NodeB NodeB1}
currentStatus OutOfSession
>: CM displaySession sess1 -dn {RNC RNC1 RNCEquipment RNCEquipment
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-123
DRAFT

...................................................................................................................................................................................................................................
Use the CM preActivate command to launch the pre-activate operation in the
Table 5-117
Syntax
CM preActivate <sessionName> [-dn <node list>]
pre-activated.
<node list>: specifies the name of the nodes to query.
Result
Launch the pre-activate operation in the Configuration Manager.
Return Value
Errors
Examples:
>: CM preActivate sess1 -dn {RNC RNC1} {RNC RNC2} {RNC RNC3} {RNC
RNC4}
DRAFT
Node
{RNC
{RNC
Node
{RNC
{RNC
job information:
RNC1} {job finished without error}
error information:
RNC3} {Exception information}
...................................................................................................................................................................................................................................
NN-20500-030
5-124

CM activate command
...................................................................................................................................................................................................................................
CM activate command
Use the CM activate command to launch the activate operation in the Configuration
Manager.
Table 5-118
DRAFT
CM activate command
Syntax
CM activate <sessionName> [-dn <rootDn list>]
activated.
<rootDn list>: specifies the list of Root Ds. An empty
sequence for rootObjects should mean all rootObjects.

Result
Launch the activate operation in the Configuration Manager.
Return Value
Errors
Examples:
>: CM activate sess1 -dn {RNC RNC1} {RNC RNC2}
Node
{RNC
Node
{RNC
job information:
error information:
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-125
DRAFT

CM resume command
...................................................................................................................................................................................................................................
CM resume command
Use the CM resume command to resume a specified session and specified nodes into this
session in the Configuration Manager.
Table 5-119
CM Resume command
Syntax
CM resume <sessionName> [-dn <node list>]
resumed.
<node list>: specifies the list of nodes that will be resumed. An
empty list should mean all nodes of the session.

Result
Resume a specified session and specified nodes into this session in

the Configuration Manager.
Return Value
Errors
Examples:
>: CM resume sess1
DRAFT
Node
{RNC
{RNC
Node
{RNC
{RNC
job information:
error information:
...................................................................................................................................................................................................................................
NN-20500-030
5-126

...................................................................................................................................................................................................................................
Use the CM setActivationType command to set the activation type in the
Table 5-120
Syntax
DRAFT
CM setActivationType <sessionName> <FDN1>
<activationType> ... <FDNN> <activationType>]
<sessionName>: specifies the name of the session.

<FDN>: specifies the name of the node.
activationType: this parameter can be one of the following
values:
CRITICAL: o check on impacts (SEPE: build offline/online

depending on initial state, PP: activation without check if the
E will restart)
OLIE : Activate the modifications in a sequence that

minimizes the service downtime. It is used when service
disruption needs to be prevented.
DEFAULT: is pre-defined activation profile type for Passport

device. It ensures that Sw/Lpt and associated Lp are activated
prior to add application components. It can be used in standard
and advanced activation scenarios such as extension of the
feature list, addition of cards.
SIGLESTEP: is pre-defined activation profile type for

Passport device. It enables to activate all the content of a
workorder in one shot without intermediate activation. It is
especially useful when running a feature list reduction.
Result
Set the activation type in the Configuration Manager.
Return Value
Errors
Examples:
>: CM setActivationType sess1 {RNC RNC1} critical {RNC RNC2} online
Successful Nodes:
{RNC RNC1}
Node error information:
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-127
DRAFT

...................................................................................................................................................................................................................................
Use the CM getAvailableConfigModels command to retrieve list of domains that
can be exported by the Configuration Manager.
Table 5-121
Syntax
CM getAvailableConfigModels
Result
Displays information on Config Model.
Return Value
Returns information on Config Model.
Errors
Examples:
>: CM getAvailableConfigModels
DRAFT
{UTRAN} {standard statesAndStatus inventory AdditionalInformation}
...................................................................................................................................................................................................................................
NN-20500-030
5-128

CM export command
...................................................................................................................................................................................................................................
CM export command
Use the CM export command to export all E information or domain network
information into a given XML format file.
Table 5-122
Syntax
DRAFT
CM export command
CM export -f.ile <dfsFilePath> -dn <FDN_List> [p|-s|-inv|-ai|-d] [-c.ustomer|-m.anufacturer] [comp.ressed] [-errStr <errMsg>]
CM export -f.ile <dfsFilePath> -dn <FDN_List> iandc [-comp.ressed] [-errStr <errMsg>]
CM export -f.ile <dfsFilePath> -domain
<domainList> [-p|-s|-inv|-ai|-d] [-c.ustomer|m.anufacturer] [-comp.ressed] [-errStr <errMsg>]
CM export -f.ile <dfsFilePath> -domain
<domainList> -iandc [-comp.ressed] [-errStr
<errMsg>]
<dfsFilePath>: logical Path of the generated XML files (in
DFS)
<FDN_list>: a specific section to export.
<domainList>: the UTRA domain list to export.
compressed: enable to compress the generated file.
-p: attribute to qualify standard.
-s: attribute to qualify statesAndStatus.
-iandc: attribute to qualify installationAndCommisioning.
-inv: attribute to qualify inventory.
-ai: attribute to qualify AdditionalInformation.
-d: attribute qualifier of dynamicData.
-customer: visibility on Customer data.
-m.anufacturer: visibility on Manufacturer data.
<errMsg>: a Tcl variable to retrieve problems encountered during
the execution of the command.

Result
Export E information or domain network information into a

given XML format file.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-129
DRAFT

CM export command
...................................................................................................................................................................................................................................
Table 5-122
Return Value
Errors
CM export command (continued)
If the export is all completed well: SUCCEEDED
If any warnings are encountered during the export:

COMPLETED_WITH_WARIG.
If any errors are encountered during the export:

COMPLETED_WITH_ERRORS
If the export is failed: FAILED
If the job is cancelled: CACELLED

execution of the command or if the export is not totally well done.
Examples:
# export a specific Distinguished Name information
>: CM export -f /cmXML/RNC_0.xml -dn {RNC RNCM1_1} -p -c
# export information of utran networks
>: CM export -f /cmXML/RNC_0.xml -domain utran -p -m
DRAFT
otes
One of the "-m" and "-c" parameters is mandatory, i.e., you must
input "-m", "-c" or "-m -c" in command line.
...................................................................................................................................................................................................................................
NN-20500-030
5-130

CM exportRNS command
...................................................................................................................................................................................................................................
Use the CM exportRNS command to export RS information of the associated root
subtree into a given XML format file, or only a specific section of the etwork.
Table 5-123
Syntax
DRAFT
CM exportRNS -f.ile <dfsFilePath> -dn <FDN_List>
[-p|-s|-inv|-ai|-d] [-c.ustomer|-m.anufacturer]
[-comp.ressed] [-errStr <errMsg>]
CM exportRNS -f.ile <dfsFilePath> -dn <FDN_List>
-iandc [-comp.ressed] [-errStr <errMsg>]
<dfsFilePath>: logical Path of the generated XML files (in
DFS)
<FDN_list>: a specific section to export.
compressed: enable to compress the generated file.
-p: attribute to qualify standard.
-s: attribute to qualify statesAndStatus.
-iandc: attribute to qualify installationAndCommisioning.
-inv: attribute to qualify inventory.
-ai: attribute to qualify AdditionalInformation.
-d: attribute qualifier of dynamicData.
-customer: visibility on Customer data.
-m.anufacturer: visibility on Manufacturer data.
<errMsg>: aTcl variable to retrieve problems encountered during

Result
Export E information into a given XML format file.
Return Value
If the export is all completed well: SUCCEEDED
If any warnings are encountered during the export:

COMPLETED_WITH_WARIG.
If any errors are encountered during the export:

COMPLETED_WITH_ERRORS
If the export is failed: FAILED
If the job is cancelled: CACELLED
Errors

execution of the command or if the export is not totally well done.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-131
DRAFT

...................................................................................................................................................................................................................................
Table 5-123
CM exportRNS command (continued)
Examples:
>: CM exportRNS -f /cmXML/RNC_0.xml -dn {RNC RNCM1_1} -p -c
job finished without error
DRAFT
otes
One of the "-m" and "-c" parameters is mandatory, i.e., you must
input "-m", "-c" or "-m -c" in command line.
...................................................................................................................................................................................................................................
NN-20500-030
5-132

CM getImpactedConfigNodes command
...................................................................................................................................................................................................................................
Use the CM getImpactedConfigNodes command to get the list of Config odes
impacted by a specified work order.
Table 5-124
Syntax
DRAFT
CM getImpactedConfigNodes -f.ile <DFSFile>
Result
Find the list of Config odes in the work order.
Return Value
The list of Config odes found in the work order.
Errors
Examples:
>: CM getImpactedConfigNodes -f /cmXML/RNC_0.xml
{{RNC RNC1} AtSessionCreation 1} {{RNC RNC2} InSession 1} {{RNC RN
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-133
DRAFT

CM getImpactedConfigNodesInfo command
...................................................................................................................................................................................................................................
Use the CM getImpactedConfigNodesInfo command to retrieve impacted nodes,
their activation step and number of actions on a given workorder or on an user's generated
sessions in Configuration Manager after a release is called.
Table 5-125
Syntax
CM getImpactedConfigNodesInfo -f.ile <DFSFile>
| -s.ession <sessionName>

<sessionName>: specifies the name of the generated session.
Result
Find the list of Config odes in the work order or generated

session, their activation steps and number of actions.
Return Value
The list of Config odes found in the work order or generated

session, their activation steps and number of actions.
Errors
Examples:
>: CM getImpactedConfigNodesInfo -f /cmXML/RNC_0.xml
{{RNC RNC1} AtSessionCreation 2} {{RNC RNC2} InSession 3} {{RNC
RNC3} AtSessionCreationAndInSession 4}
>: CM getImpactedConfigNodesInfo -session sesssionA_Resume_
20090204-195530
DRAFT
{{RNC RNC1} AtSessionCreation 2} {{RNC RNC2} InSession 3} {{RNC RNC3}
...................................................................................................................................................................................................................................
NN-20500-030
5-134

CM releaseNodes command
...................................................................................................................................................................................................................................
Use the CM releaseNodes command to exclude specified nodes from a given session.
Table 5-126
Syntax
DRAFT
CM releaseNodes<Session Name> [-dn <node list>]
[-fallback fallbackName] [-resume resumeName
<sessionName>: specifies the name of the given session.

<node list>: specifies the list of nodes that will be excluded.
An empty list should mean all nodes of the session.

<fallbackName>: this parameter is optional. It defines the name
of the generated fallback session

<resumeName>: this parameter is optional. It defines the name of
the generated resume session

Result
Exclude the specified nodes from a given session.
Return Value
Errors
Examples:
>: CM releaseNodes session1 -dn {RNC RNC1} -fallback fallSession resume resSession
Node job information:
{RNC RNC1} {job finished without error}
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-135
DRAFT

CM fallback command
...................................................................................................................................................................................................................................
CM fallback command
Use the CM fallback command to fallback the activation of specified nodes for a given
session.
Table 5-127
CM fallback command
Syntax
CM fallback <sessionName> [-dn <node list>]
<sessionName>: specifies the name of the given session.

<node list>: specifies the list of nodes that will be fallbacked.
An empty list should mean all nodes of the session.

Result
Launch the fallback operation in the Configuration Manager.
Return Value
Errors
Examples:
>: CM fallback sess1 -dn {RNC RNC1} {RNC RNC2}
DRAFT
Node
{RNC
Node
{RNC
job information:
error information:
...................................................................................................................................................................................................................................
NN-20500-030
5-136

...................................................................................................................................................................................................................................
Use the CM listGeneratedSessions command to list user's generated sessions in
Configuration Manager after a release is called
Table 5-128
Syntax
DRAFT
CM listGeneratedSessions [-all]
all: optional parameter to be set to return all sessions
Result
Return the list of session name
Return Value
Session name
Errors
Examples:
>: CM listGeneratedSessions
Fallback Sessions:{sess1_fallback_1 } {sess2_fallback_2 }
Resume Sessions: {sess1_resume_1 } {sess2_resume_2
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-137
DRAFT

...................................................................................................................................................................................................................................
Use the CM launchSession command to launch directly a generated sessions in
Table 5-129
Syntax
CM launchSessioncommand
CM launchSession <session name> [-manualRelease]
sessionName: specifies the session to be launched

manualRelease: If the manualRelease option is activated, then
the node is not released automatically when the node is activated

Result
Generated Session is loaded
Return Value
SDO result
Errors

Examples:
>: CM launchSession sess1_resume_1
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-138

...................................................................................................................................................................................................................................
Use the createCMSession command to create a session on a given ode without
indicating any DFS file. This command is only applicable to RC, BTSEquipment and
OneBTSEquipment.
Table 5-130
Syntax
DRAFT
<FDN> createCMSession <sessionName> [-cluster

created.
operation.
Result
Create a session on a given ode without indicating any DFS file.
Return Value

more details.
Errors
Examples:
:>RNC RNC1 createCMSession lirong
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-139
DRAFT
...................................................................................................................................................................................................................................
DRAFT
The performance manager commands are the following:
PM blockE command (p. 5-141)

PM unblockE command (p. 5-142)
PM setodeBGranularity command (p. 5-143)
PM getodeBGranularity command (p. 5-146)

PM upgCounterFile command (p. 5-147)
recoverObs command (p. 5-149)
PM importCounterList command (p. 5-150)
PM exportCounterList command (p. 5-151)

PM checkCounterList command (p. 5-152)
...................................................................................................................................................................................................................................
NN-20500-030
5-140

PM blockNE command
...................................................................................................................................................................................................................................
PM blockNE command
Use the PM BlockNE command to stop the PM data processing of the selected E. This
command is only available for RC/BTS/POC.
Table 5-131
Syntax
DRAFT
PM blockNE command
PM blockNE -dn <FDN> [-cluster <clustername>] [verbose]

operation.
[verbose]: retrieves problems encountered during the execution.
Result
The PM data processing is stopped on the selected E on the

specified cluster.
Return Value
The PM BlockE operation is successful or reports the error

message during the operation.
Errors
The system will continue to proceed even if some problems are

encountered during the execution of the command
Examples:
# Launch the PM BlockNE command and display the result
>: puts "the PM BlockNE result is: [PM blockNE -dn {RNC RNC1}]"
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-141
DRAFT

PM unblockNE command
...................................................................................................................................................................................................................................
Use the PM unblockNE command to start the PM data processing of the selected E.
This command is only available for RC/BTS/POC.
Table 5-132
Syntax
PM unblockNE -dn <FDN> -cluster <clustername> [verbose]

operation.
Result
A PM UnblockE operation is launched on the selected E on the

specified cluster
Return Value
The PM UnblockE operation is successful or reports the error

message during the operation.
Errors
The system will continue to proceed even if some problems are

encountered during the execution of the command
Examples:
# Launch the PM UnblockNE command and display the result
DRAFT
>: puts "the PM UnblockNE result is: [PM unblockNE -dn {RNC RNC1} -cl
...................................................................................................................................................................................................................................
NN-20500-030
5-142

PM setNodeBGranularity command
...................................................................................................................................................................................................................................
Use the PM setNodeBGranularity command to perform a bulk change of the odeB
collection granularity. The change is applied to all the Es of a specific E type, or to a
specific E.
Table 5-133
Syntax
DRAFT
PM setNodeBGranularity {-type <NodeB type> | -dn
<Operator FDN>} [-synchronizeonly | setdefaultonly] [- targetGranularity <new
granularity>] [-cluster <clustername>] [-verbose]
type: type of the E. Supported values are "BTS" and
"MicroPicoBTS". (mutually exclusive with dn parameter)


synchronizeonly: the synchronize flag (no associated value).
Optional parameter (mutually exclusive with the targetGranularity

parameter).
setdefaultonly: the setdefaultonly flag (no associated value).
Optional parameter (mutually exclusive with the synchronizeonly

flag).
targetGranularity: Collection granularity (in minutes) to be
configured. The supported values are "15" and "60". Optional

parameter (mutually exclusive with the synchronizeonly
parameter).
operation.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-143
DRAFT

...................................................................................................................................................................................................................................
Table 5-133
Result
PM setNodeBGranularity command (continued)

If the <type> parameter is used, the command shall operate in bulk
mode, meaning that WICL shall consider the full list of dns
corresponding to the specified type.
If the <dn> parameter is used, the command shall operate in
"unitary" mode, only considering the specified dn.
Return Value
If <type> is BTS:
If the -synchronizeonly flag or the -setdefaultonly flag is
present, syntax error.
If the -targetGranularity is not present, syntax error. WICL
selects all the BTSEquipement whose systemRelease is
"06_00_00" or higher.
The BTSEquipement attribute "pmObservationPeriod" is
changed to targetGranularity for all the BTSs supporting
the target granularity. (In OAM6.0, only the BTSs whose
systemRelease attribute is "06_00_00" can have its
pmObservationPeriod attribute changed; the supported
values are "15" and "60".)
If <type> is MicroPicoBTS:
If the -setdefaultonly flag is present but the
-targetGranulariuty parameter is not present, syntax error.
If the -synchronizeonly flag is not present, WICL calls
IDL:CP1120_ItServer::setodeBCounterGranularity(),
and the MicroPicoBTS config file used to configure the
default pmJob on PM synchronization is modified so that
the default pmJob granularity is changed to the
targetGranularity.
If the -setdefaultonly flag is not present, WICL iterates
over all the MicroPicoBTSs, and calls for each one
IDL:CP1120_ItServer::pmSynchronize().
WICL captures the result of each IDL:CP1120_
ItServer::pmSynchronize operation and keeps track of the
MicroPicoBTSs for which the operation was not
successful.
WICL considers the operation failed if the
IDL:CP1120_ItServer::seodeBCounterGranularity
operation failed, or if the IDL:CP1120_
ItServer::pmSynchronize operation failed for at least 1
MicroPicoBTS
List of the BTSs/MicroPicoBTSs for which the operation could

not be successfully completed.
DRAFT
one if the operation was successful on all the BTSs/

MicroPicoBTSs.
Errors
...................................................................................................................................................................................................................................
NN-20500-030
5-144

...................................................................................................................................................................................................................................
Table 5-133
PM setNodeBGranularity command (continued)
Examples:
>: PM setNodeBGranularity
"15"
"15"
targetGranularity "15"
DRAFT
-type "BTS" -targetGranularity "15"

-dn "BTSEquipment BTS107" -targetGranularity
-type "MicroPicoBTS" -targetGranularity "15"
-dn "MicroBTS MicoBTS109" -targetGranularity
-dn "MicroBTS MicroBTS109" -synchronize
-type "MicroPicoBTS" -synchronize
-type "MicroPicoBTS" -setdefaultonly -
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-145
DRAFT

PM getNodeBGranularity command
...................................................................................................................................................................................................................................
Use the PM getNodeBGranularity command to trigger the audit of the counter
granularity configured in a specific odeB.
Table 5-134
Syntax
PM getNodeBGranularity {-default | -dn <Operator
FDN>} [-cluster <clustername>] [-verbose]
default: Flag indicating that the granularity to get is the one set
in the default MicroPicoBTS config file. Mutually exclusive with

the dn parameter.
<FDN>: D of the odeB from which should be retrieved the
configured granularity. Mutually exclusive with the default

parameter. To understand the FD identifiers in UMTS WICL, see
operation.
Result
Return Value
If dn corresponds to a BTS:
WICL retrieves the value of the BTSEquipment
pmObservationPeriod attribute associated to the specified
dn.
If there is a "default" flag or if dn corresponds to a

MicroPicoBTS:
WICL calls IDL:CP1120_
ItServer::getodeBCounterGranularity() function and gets
the default MicroPicoBTS collection granularity.
Granularity of the BTS or Default MicroPicoBTS granularity, as

set in the common MicroPicoBTS pmJob config file.
Errors
Examples:
DRAFT
>: PM getNodeBGranularity -dn "MicroBTS MicroBTS-Urban115"

>: PM getNodeBGranularity -default
>: PM getNodeBGranularity dn "BTSEquipment BTSEBTS215"
...................................................................................................................................................................................................................................
NN-20500-030
5-146

...................................................................................................................................................................................................................................
Use the PM upgCounterFile command to upgrade the RC counter list to the specific
E version. It currently supports the upgrade of the counter list file from E version
06_00_00 to E version 07_00_00. It outputs a csv formatted counter list file which has
been upgraded
Table 5-135
Syntax
DRAFT
PM upgCounterFilecommand
PM upgCounterFile -to <NE version> -file <dfs
file path>
<to>: Version of the E which the counter list file will be
upgraded to. Only supported in E version 07_00_00.

<file>: DFS Path to the CSV formatted counter list file. Only
supported in E version 06_00_00

Result
The target counter list file which has been upgraded
Return Value
Returns the target counter list which has been upgraded if the
operation was successful.
Errors
An exception can be thrown if any problem is encountered during

In case of parameter errors:
'SYNTAX ERROR: unrecognizable parameter <arg>'
In case of unsupported E version:

'ERROR: Unsupported NE version'
In case of input file path error:

'ERROR: Please put the file to $dfsPath before
upgrade operation'
In case of upgrade the same version:

'ERROR: Some errors occurred when upgrade
counter list file from $toVersion to $toVersion.
Please check the PM log file
$dfsWarningInfoFilePath'
In case of input file error:

'ERROR: Some errors occurred in the input file :
$dfsFilePath. Please check the PM log file
$dfsWarningInfoFilePath'
If other errors have occured:

'ERROR: Some errors occurred. Please check the
PM log file $dfsWarningInfoFilePath'
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-147
DRAFT

...................................................................................................................................................................................................................................
Table 5-135
PM upgCounterFilecommand
(continued)
Examples:
>: PM upgCounterFile -to 07_00_00 -file
dfs:/counterlists/export/myUpgradeCounterFile.csv
DRAFT
Counter list successfully upgraded to dfs:/counterlists/export/upgrade_143_20060822_054004_rnc_07_00_00.csv
...................................................................................................................................................................................................................................
NN-20500-030
5-148

recoverObs command
...................................................................................................................................................................................................................................
recoverObs command
Use the recoverObs command to trigger the manual collection and mediation
mechanism in case the catch up mechanism is not triggered. This command is only for
Iode, Code, BTSEquipment and OneBTSEquipment.
Table 5-136
Syntax
DRAFT
recoverObs command
<FDN> recoverObs [-cluster <clustername>] [verbose]
default: Flag indicating that the granularity to get is the one set
in the default MicroPicoBTS config file. Mutually exclusive with

the dn parameter.
<FDN>: D of the E which the command is for.
To understand the FD identifiers in UMTS WICL, see FD

Mapping (p. 5-23).
operation.
Result
The performance measurement files are manually retrieved from

the E and the XML files associated with them are generated.
Return Value
The command prints out a list of the files that are going to be
recovered, and a message stating that these files have been
successfully sent to the processing. o indication is given about
when the file processing has completed.
Errors
Examples:
#Display FDDCell information attributes and values.
>: RNC RNC501 RNCEquipment 0 CNode 0 recoverObs
>: RNC RNC501 RNCEquipment 0 INode IN_01 recoverObs
>: BTSEquipment BTS_001 recoverObs
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-149
DRAFT

...................................................................................................................................................................................................................................
Use the PM importCounterList command to apply a specific counter list to a specific
E. Prior to applying the counter list, the command first checks that the counter list does
not exceed the E maximum capacity. If the counter list is acceptable but uses more than
80% of the E capacity, a warning message is raised. If the counter list is not acceptable,
the request is discarded and a warning message is raised.
If the counter list is not valid or exceeds the RC maximum capacity, the command stops
and displays an error message.
This command updates the counter/family lists even if GPO is deactivated when receiving
the new counter/family configuration. This new configuration applies when the GPO is
re-activated.
Table 5-137
Syntax
PM importCounterList -type <NE type> -dn <FDN> file <dfsFilePath>
<NE type>: type of the E on which the operation shall be
performed ( RC is the only supported value in OAM6.0)

<FDN>: FD of the E on which the counter list import shall be
applied. To understand the FD identifiers in UMTS WICL, see

<dfsFilePath>: logical Path of the csv formatted file (in DFS).
Result
counterIdList and familyIdList attributes of the target RC are set.
Return Value
If successful: "Counter list has been successfully imported".
Errors
Example:
>: PM importCounterList -type RNC -dn {RNC RNC105} file
DRAFT
dfs:/counterlists/import/myRCCounterList.csv
...................................................................................................................................................................................................................................
NN-20500-030
5-150

...................................................................................................................................................................................................................................
Use the PM exportCounterList command to retrieve the list of the currently collected
counters on a specific E, and outputs them as a CSV counter list.
Table 5-138
Syntax
DRAFT
PM exportCounterList -type <NE type> -dn <FDN>
PM exportCounterList -type <NE type> utranRelease <UTRAN release>
NE type: type of the E on which the operation shall be
performed ( RC is the only supported value in OAM6.0)

<FDN>: FD of the E on which the counter list export shall be

-UTRAN release: UTRA release of the counter list that are to
be exported to CSV counter list format (only supported value in

OAM6.0 is "06_00_00").
Result
The list of counters currently set to be collected by the target RC

are exported as a CSV counter list file.
Return Value
If successful, path to the exported CSV counter list file.
Errors
Example:
>: PM exportCounterList -type RNC -dn {RNC RNC105}
Counter list successfully exported to

dfs:/counterlists/export/export_123_20060822_102332_R C-R C102_06_00_00.csv
Example:
>: PM exportCounterList -type RNC -utranRelease 06_00_00
Counter list successfully exported to

dfs:/counterlists/export/export_124_20060822_102402_R C_06_00_00.csv
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-151
DRAFT

...................................................................................................................................................................................................................................
Use the PM checkCounterList command to check whether the counter list will not
exceed the maximum capacity of a specific E. It outputs the portion of the E
maximum capacity that will be used.
Table 5-139
Syntax
PM checkCounterList -type <NE type> -dn <FDN> [projectedCells <projected number of cells>] file <dfsFilePath>
PM checkCounterList -type <NE type> utranRelease <UTRAN release> -platform <platform
type> [-projectedCells <projected number of
cells>] -file <dfsFilePath>
<NE type>: Type of the E on which the counter list shall be

applied. ( RC is the only supported value in OAM6.0)
<FDN>: FD of the E on which the counter list import shall be

<UTRAN release>: UTRA release against which shall be
checked the counter list

<Projectedcells>: umber of cells that are likely to be
configured at most for this RC

<dfsFilePath>: DFS Path to the CSV formatted counter list file
to be checked.
<platform type>: Allowed values are all6mPktServSP,
allPktServSP2FullDim, and allPktServSP2.
Result
The target counter list is checked and weighted.
Return Value
Returns the calculated counter list weight if the operation was

successful formatted as <weight in percent of the RC max
capacity> %.
DRAFT
Errors
Returns -1 if the result of the ADI executable check command

is 1
Returns -2 if the result of the ADI executable check command

is 2
Returns -3 if an error was encountered during the command

execution (transient error)
...................................................................................................................................................................................................................................
NN-20500-030
5-152

...................................................................................................................................................................................................................................
Table 5-139
PM checkCounterList command (continued)
Example:
DRAFT
PM checkCounterList -type RNC -dn {RNC RNC-105} projectedCells 1600 file dfs:/counterlists/import/myCounterList.csv112%
>: PM checkCounterList -type RNC -utranRelease 06_00_00_ -platform

all6mPktServSP -file dfs:/counterlists/import/myCounterList.csv
62%
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-153
DRAFT
...................................................................................................................................................................................................................................
DRAFT
The fault manager commands are the following:
FM getAlarms command (p. 5-155)

FM setFmbbCache command (p. 5-159)
FM clearAlarm command (p. 5-160)
FM acknowledgeAlarm command (p. 5-161)
...................................................................................................................................................................................................................................
NN-20500-030
5-154

...................................................................................................................................................................................................................................
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-155
DRAFT
DRAFT

...................................................................................................................................................................................................................................
Use the FM getAlarms command to get alarms from the selected etwork Element.
Apply Filter criteria to get only a subset of existing alarms in FMBB. This command is
only able to get etwork Element alarms: RC and BTSEquipment.
Table 5-140
Syntax
FM getAlarms -dn <FDN> [-perceivedSeverity
<severity>] [-eventType <type>] [- probableCause
<cause> ] [-additionalText <text>] [specificProblems <text>] [-clfi <clfi> ] [alarmedComponent <DN component>] [notificationIdentifier <id>] [-eventTimeBegin
<time>] [-eventTimeEnd <time>] [-alarmCode <text>
] [-correlationGroupId|-cgi <id>] [correlationMainId|-cmi <id>]
[correlationAlarmType|-cat <type>]
[correlationGroupCount|-cgc <count>] [-acked]

perceivedSeverity: CRITICAL, MAJOR, MIOR,
WARIG or CLEARED
eventType: qualityOfServiceAlarm, communicationalarm,
environmentalAlarm, processingErrorAlarm, equipmentAlarm,

attributeValueChangeEvent, objectCreationEvent,
objectDeletionEvent or stateChangeEvent.
probableCause: a string of characters
additionalText: a string of characters
specificProblems: a string of characters
clfi: a clfi value
alarmedComponent: The Distinguished ame of the component
where the alarm is generated. This Distinguished ame is a

Distinguished ame operator as follows: RC and
BTSEquipment uses the userLabel. All other sub-objects use the
rdnId attribute value. For example: RC.userLabel RCM1_31
RCEquipment 0 Cnode 0
notificationIdentifier: an identification number
time: the value is as follows: yyyymmddHHMMSSZ ( yyyy for
year, mm for month, dd for day, HH for hour, MM for minutes

and SS for seconds (this is optional). The Z is optional and it is
used to select the time stamp in GMT.
DRAFT
alarmCode: an alarm code value

correlationGroupId: a correlationGroupId value
correlationMainId: a correlationMainId value
...................................................................................................................................................................................................................................
correlationAlarmType
: a correlationAlarmType value
NN-20500-030
5-156
correlationGroupCount: a correlationGroupCount value

...................................................................................................................................................................................................................................
Table 5-140
FM getAlarms command (continued)
Result
Retrieve the list of alarms using FMBB server that match the
selected criteria.
Return Value
A list of alarms. Each alarm is composed of a list of pairs of

type/value.
DRAFT
The possible types are: AlarmedComponent, notificationIdentifier,

eventTime, eventType, probableCause, perceivedSeverity,
probableCause, specificProblems, additionalText,
clfi and VendorSpecificInfo.
The eventTime value is as follows: yyyymmddHHMMSSZ (
yyyy for year, mm for month, dd for day, HH for hour, MM for
minutes and SS for seconds. The Z to select the time stamp in
GMT).
ot every alarm has all these types filled, so, only those who are
filled in the FMBB database will be returned by WICL.
Errors
Examples:
# Get all the alarms of the RNC of type qualityOfServiceAlarm
>: FM getalarms -dn {RNC RNCM1_311} -eventType qualityOfServiceAla
{{alarmedComponent "RNC.userLabel RNCM1_311 RNCEquipment 0 CNode 0

{notificationIdentifier "105"} {eventTime "20021217181933Z"}
{eventType "qualityOfServiceAlarm"} {perceivedSeverity "CRITICAL
{probableCause "sfwrEnvironmentProblem"} {specificProblems
"Unknown software version"} {additionalText "Unknown software
version"}}
# Get all the alarms from the selected RNC for all the FDDCell
components.
# This filter will display all the alarms in FDDCell components an
the subtree of it
>: FM getalarms -dn {RNC RNCM1_311} -alarmedComponent "FDDCell"
{{alarmedComponent "RNC.userLabel RNCM1_311 NodeB 3 FDDCell 34"} {
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-157
DRAFT

...................................................................................................................................................................................................................................
Table 5-140
otes
FM getAlarms command (continued)

All the filters work in a string match way. The filter string has to
be at least a sub-string of the alarm record.
The eventTimeBegin and eventTimeEnd will work as time scope
filters. If they are used, only alarms with eventTime greater than
eventTimeBegin or with eventTime less than eventTimeEnd are
displayed.
The correlationGroupCount is the sum of all the symptom alarms
of a given group, so this filter value has to be full matched with the
corresponding field in the alarm record.
DRAFT
Considering correlated alarms are stored in managed alarm cache

of the FMBB, the users need to set FM setFmbbCache command
(p. 5-159) prior to the 'FM getAlarms' command for the correlated
alarms
...................................................................................................................................................................................................................................
NN-20500-030
5-158

...................................................................................................................................................................................................................................
Use the FM setFmbbCache command to set the alarm stream to 'manage' or
'non-manage'.
Table 5-141
DRAFT
Syntax
FM setFmbbCache <isManagedcache>
isManagedcache: The value is 0 to set the alarm stream to
"non-manage". Any other integer value can be used to set the

alarm stream to "manage".
Result
The value of the parameter <isManagedCache>
Return Value
The value of the current FMBB cache.
Errors
Examples:
>: FM setFmbbCache 1
ote
The default cache type is un-managed cache.

This command is deprecated in OAM06.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-159
DRAFT

...................................................................................................................................................................................................................................
Use the FM clearAlarm command to clear specific alarms according to dn and
alarmIDs.
Table 5-142
Syntax
FM clearAlarm -dn <FDN> -alarmIDs <alarmIdlist>]

alarmIdlist: a list of the alarm notificationIdentifier
Result
Clear the specific alarms.
Return Value
A successful message or a failed message with a FailureAlarmID

list.
Errors
Examples:
>: FM clearAlarm -dn {RNC RNC501} -alarmIDs 11873 32839
clearAlarm succeeded
>: FM clearAlarm -dn {RNC RNC501} -alarmIDs 12252 34565 89345
clearAlarm failed
FailureAlarmIDs: 34565 89345
ote
Before launching this command, you should retrieves alarms by

FM getAlarms. If you launche FM clearAlarm on not existing
DRAFT
alarms, the command will run successfully and no error message

will be displayed.
...................................................................................................................................................................................................................................
NN-20500-030
5-160

...................................................................................................................................................................................................................................
Use the FM acknowledgeAlarm command to acknowledge specific alarms according to
dn and alarmIDs.
Table 5-143
Syntax
DRAFT
FM acknowledgeAlarm-dn <FDN> -alarmIDs
<alarmIdlist>]

alarmIdlist: a list of the alarm notificationIdentifier
Result
Acknowledge the specific alarms.
Return Value
A successful message or a failed message with a FailureAlarmID

list.
Errors
Examples:
>: FM acknowledgeAlarm -dn {RNC RNC1} -alarmIDs 235 238 300
acknowledgeAlarm succeeded
>: FM acknowledgeAlarm -dn {RNC RNC1} -alarmIDs 255 287 301
AcknowledgeAlarm failed
FailureAlarmIDs: 287 301
ote
Before launching this command, you should retrieve alarms by

FM getAlarms. If you launche FM acknowledgeAlarm on not
existing alarms or acknowledged alarms, the command will run
successfully and no error message will be displayed.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-161
DRAFT
...................................................................................................................................................................................................................................

Use the SEC EncryptSecret command to generate a complex string for a given secret
by the end user.
Table 5-144
Syntax

Sec EncryptSecret -entity <NEType> -secret
<shared secret>
<NEType>: Etype is provided to determine the encrypt key
which is used during encryption process. Currently, only 'BTS' is

supported.
<shared secret>: the shared secret is given by the end user and
is encrypted into a complex hexadecimal string.

It must be between 16 bytes and 128 bytes long.
All the printable characters can be used as shared secret.
We suggest that the shared secret should be enclosed by double
quotation marks, and that back-slash should be used to quote the
characters that have special meanings to TCL interpreter. These
characters are dollar sign, square bracket, back-slash and double
quotation marks. The end user should be in charge of constructing
the secret string if his/her input secret contains those special
characters.
Result
1. WICL checks this facade access authorization according to the

configuration file. An error arises if no access privilege is
provided.
2. WICL then checks the parameters and check whether the E
type is supported. An error occurs if one of procedure fails.
3. WICL then pads shared secret till to 128 bytes and encrypts it
into a hexadecimal cipher text.
DRAFT
4. Last, it checks cipher text length and returns cipher text with
textual information.
Return Value
List of textual information and the cipher text or some error

message if some error occurs during process.
Errors

...................................................................................................................................................................................................................................
NN-20500-030
5-162
...................................................................................................................................................................................................................................
Table 5-144
SEC EncryptSecret command (continued)
Examples:
DRAFT
The following examples will run properly:

>: SEC EncryptSecret -entity BTS -secret
sdfjasdfhsdafjksadfjdfajgghghssdfg
>: SEC EncryptSecret -entity BTS -secret "1111 2222 3333 4444"
>: SEC EncryptSecret -entity BTS -secret "1111 \$sad []as{}df dsadf"
in this case the secret will be turn into: "1111 $sad []as{}df dsadf"
>: SEC EncryptSecret -entity BTS -secret "1111 ;\":' asdf sdafsa"
Using backslash, the secret will be turn into: "1111 ;":' asdf sdafsa"
>: SEC EncryptSecret -entity BTS -secret "1111 \$asdfaasdgdfgjkdasdf"
the secret will be turn into: "1111 $asdfaasdgdfgjkdasdf"

The following example will run but have some problems:
>: SEC EncryptSecret -entity BTS -secret "1111[]sadfasdafdgasdfgd"
In these case, the tcl interpreter recognizes the text between the [] as command and substitutes
command result the text in []. Therefore the secret will be turned into "1111sadfasdafdgasdfgd".
For the same reason an error will occur if secret is "1111[asfasdf]sadfasdafdgasdfgd" and no
proc asfasdf has been defined.
The following example will generate some errors about escape characters:
>: SEC EncryptSecret -entity BTS -secret "sadfasdjfh] [sadfasfasasdf"
An error occurs in Tcl level saying: missing close-bracket

>: SEC EncryptSecret -entity BTS -secret
adfsadfjkaasdfsdffsldfas;dfzxfjksddf
>>This will generate errors because TCL takes this command as two commands separated by a
semicolon. Therefore, it generates a SYTAX ERROR (cannot parse user input to retrieve D
and command) for command dfzxfjksddf.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-163
DRAFT
I-Node and POC commands
...................................................................................................................................................................................................................................

The I-ode and POC commands are the following:
Provisioning commands:
I-ode and POC, currently called passport, can be provisioned using composed
provisioning WICL commands, but the beginning and the end of the provisioning are
called explicitly by the user.
You can manage yourself the modes of provisioning with the unitary provisioning
commands.
After working in a WICL session, if an exit is performed before the provisioning
command is stopped, the modifications do not affect the passport and all the provisioning
work is lost.
Declaration commands:
Declare I-ode and POC in the MDM on the Main server to access and provision them.
WICL offers an easy way to declare and undeclare all types of passports on the Main
server.
declaration command (p. 5-166)

undeclaration command (p. 5-168)
See also I-ode command (p. 5-113) to retrieve the snapshot of Iode
Composed commands:
startProv command (p. 5-169)
endProv command (p. 5-170)
Unitary commands:
These commands require passport and CAS command knowledge.
start command (p. 5-171)

copy command (p. 5-172)
check command (p. 5-173)
activate command (p. 5-174)

confirm command (p. 5-175)
commit command (p. 5-176)

save command (p. 5-177)
load command (p. 5-178)
apply command (p. 5-179)

end command (p. 5-180)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-164
...................................................................................................................................................................................................................................
Other commands:
lock command (p. 5-181)

unlock command (p. 5-182)
reset command (p. 5-183)

switch command (p. 5-184)
switchover command (p. 5-185)
DRAFT
Backup and restore commands:
WICL also offers some commands to backup and restore current views. These views can
be applied on the UTRA domain, a RC and a passport.
Only the 'commit', 'current' and 'edit' views are backuped using WICL.
The commands are the following:
ppBackup command (p. 5-186)
ppRestore command (p. 5-188)
The backuped and restored views are available from the primary main server.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-165
DRAFT

declaration command
...................................................................................................................................................................................................................................
declaration command
Use the declaration command to declare the selected passport in the Main server. By
default the declaration is done in the Primary Main server.
The passport name is obtained from the selected FD. You must select the IP address and
the group name. The group name must already be defined in the MDM configuration file
in /opt/Magellan MS/cfg/GMDR.cfg
Table 5-145
Syntax
declaration command
<FDN> declaration <ip Address> <group name>
[mainServer] [-timeout <timeValue>]

<ip Address>: the IP address of the ortel Multiservice Switch
<group name>: the surveillance group name. This group must be
already declared in the MDM configuration file: GMDR.cfg

mainServer: optional parameter. The Main server where the
passport is declared:
UMAISERV1
UMAISERV2
UMAISERV3
UMAISERV4
Those values depend on the ROC configuration. If this parameter

is not set, the default Main server is the Primary Main server:
UMAISERV1.
<timeValue>: optional parameter. Set the timeout of the
connection to the IT_MDM engine. Using the same IT_MDM

engine, WICL can keep the provision mode of the passport. The
default timeout value is 600 (seconds).
Result
Declares the selected passport name in MDM
Return Value
one
Errors
An exception is returned if the declaration command cannot be

performed.
Examples:
# Declare a new Passport PP_paris with the selected IP address
>: Passport PP_paris declaration 145.33.22.11 SURV
DRAFT
# Declare a new Passport PP_paris with the selected IP address in

the Secondary Main server
>: Passport PP_paris declaration 145.33.22.11 SURV UMAINSERV2
...................................................................................................................................................................................................................................
NN-20500-030
5-166

declaration command
...................................................................................................................................................................................................................................
Table 5-145
ote
declaration command (continued)

The declaration command is used by the Access side only.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-167
DRAFT
DRAFT

...................................................................................................................................................................................................................................
Use the undeclaration command to undeclare the selected passport from the Main
Server. By default the undeclaration is done in Primary Main server.
Table 5-146
Syntax
<FDN> undeclaration [<mainServer>] [-timeout
<timeValue>]

mainServer: optional parameter. The Main Server where the
passport will be declared:
UMAISERV1
UMAISERV2
UMAISERV3
UMAISERV4
Those values depend on the ROC configuration. If this parameter

is not set, the default Main server is the Primary Main server:
UMAISERV1.
connection to the IT_MDM engine. Using the same IT_MDM

engine, WICL can keep the provision mode of the passport. The
Result
Removes declaration of the selected passport will from the

selected MDM.
Return Value
one
Errors
An exception is returned if the undeclaration command cannot be

performed.
Examples:
# Undeclare a new Passport PP_paris from Main server
>: Passport PP_paris undeclaration
# Undeclare a new Passport PP_paris from the Secondary Main server
>: Passport PP_paris undeclaration UMAINSERV2
DRAFT
ote
The undeclaration command is used by the Access side only.
...................................................................................................................................................................................................................................
NN-20500-030
5-168

startProv command
...................................................................................................................................................................................................................................
startProv command
Use the startProv command to start the provisioning of the selected passport object.
Table 5-147
Syntax
DRAFT
startProv command
<FDN> startProv [-timeout <timeValue>] [-cluster
<clusterName>]

connection to the IT_MDM Engine. Using the same IT_MDM

Engine, WICL can keep the provision mode of the passport. The
operation.
Result
Start the provisioning mode in the passportand copy the current

view into the editing view. The provision mode will exit
automatically if no operation occurs in "timeValue" seconds.
Return Value
one
Errors

performed.
Examples:
# Start provisioning mode for the selected Nortel Multiservice Switch
>: Passport IN_Paris startprov
# Start provisioning mode for this I-Node
>: Rnc Paris_VI INode IN_Paris startprov
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-169
DRAFT

endProv command
...................................................................................................................................................................................................................................
endProv command
Use the endProv command to end the provisioning of the selected passport object. It also
checks the coherence of the passport modification and activates the modification in the
passport.
It does some CAS commands to end the provisioning mode: check prov, save prov,
activate prov, confirm prov, commit prov and end prov.
Table 5-148
Syntax
endProv command
<FDN> endProv [-timeout <timeValue>] [-cluster
<clusterName>]
<FDN>:to understand the FD identifiers in UMTS WICL, see


operation.
Result
End the provisioning mode in the selected passport. It

automatically does all the checks and activation.
Return Value
one
Errors

performed.
Examples:
# End provisioning mode for the selected Nortel Multiservice Switch
>: Passport IN_Paris endprov
# End provisioning mode for the selected passport
>: Rnc Paris_VI INode IN_Paris endprov
DRAFT
otes
This command performs automatic check and activation. To

control the end of the provisioning, the unitary WICL provisioning
commands should be used. .
...................................................................................................................................................................................................................................
NN-20500-030
5-170

start command
...................................................................................................................................................................................................................................
start command
Use the start command to send the start command to the PROV component of the
passport.
Table 5-149
Syntax
DRAFT
start command
<FDN> start <options> [-timeout <timeValue>] [cluster <clusterName>]

<options>: see Alcatel-Lucent 9300 W-CDMA Product Family -
Access etwork Management Overview, (-20500-031).


operation.
Result
Start the provisioning mode in the selected passport. The provision

mode will exit automatically if no operation occurs in "timeValue"
seconds.
Return Value
one
Errors
Possible string error if the provisioning is not done
Examples:
# Start the provisioning modefor the selected Nortel Multiservice Switch
>: Passport IN_Paris prov start
>: Rnc Paris_VI INode IN_Paris prov start -timeout 100
otes
The passport must not be in provisioning mode. Otherwise an

Apply this command to the prov component of a passport.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-171
DRAFT

copy command
...................................................................................................................................................................................................................................
copy command
Use the copy command to send the copy command to the PROV component of the
passport. It copies the current view into the edit view.
Table 5-150
copy command
Copy
This command sends

Syntax
<FDN> copy <options> [-timeout <timeValue>] [cluster <clusterName>]
<FDN>:to understand the FD identifiers in UMTS WICL, see



operation.
Result
It copies the current view into the edit view. The passport has to be
in provisioning mode before ; otherwise, an exception is returned.
Return Value
one
Errors
Possible string error if the provisioning is not done.
Examples:
# Copy the current view into theedit view for the selected Nortel Multiservice Switch
>: Passport IN_Paris prov copy
>: Rnc Paris_VI INode IN_Paris prov copy
otes
Set the passport to provisioning mode before the execution of the

command.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-172

check command
...................................................................................................................................................................................................................................
check command
Use the check command to send the check command to the PROV component of the
passport.
DRAFT
The errors are encountered by the passport and an exception is raised by WICL, otherwise
no result.
Table 5-151
Syntax
check command
<FDN> check <options> [-timeout <timeValue>] [cluster <clusterName>]



operation.
Result
Check consistency in the passport edit view
Return Value
one
Errors
Possible string error if the provisioning is not done
Examples:
# Check the edit view for the selected passport
>: Passport IN_Paris prov check
>: Rnc Paris_VI INode IN_Paris prov check
otes

command.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-173
DRAFT

activate command
...................................................................................................................................................................................................................................
activate command
Use the activate command to send the activate command to the PROV component of
the passport. It activates the edit view in the passport.
Table 5-152
Syntax
activate command
<FDN> activate <options> [-timeout <timeValue>]



operation.
Result
Activate the edit view
Return Value
one
Errors
Examples:
# Activate the edit view for the selected passport
>: Passport IN_Paris prov activate
>: Rnc Paris_VI INode IN_Paris prov activate
otes
Set the passportto provisioning mode before the execution of the

command.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-174

confirm command
...................................................................................................................................................................................................................................
confirm command
Use the confirm command to send the confirm command to the PROV component of
the passport. It confirms the current view in the passport.
Table 5-153
DRAFT
confirm command
Confirm
This command sends

Syntax
<FDN> confirm [-timeout <timeValue>] [-cluster

<clusterName>]


operation.
Result
Confirm the edit view as the current view of the passport
Return Value
one
Errors
Examples:
# confirm the edit view for the selected passport
>: Passport IN_Paris prov confirm
>: Rnc Paris_VI INode IN_Paris prov confirm
otes

command.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-175
DRAFT

commit command
...................................................................................................................................................................................................................................
commit command
Use the commit command to send the commit command to the PROV component of the
passport. It commits the current view as the commited view in the passport.
Table 5-154
Syntax
commit command
<FDN> commit <options> [-timeout <timeValue>] [cluster <clusterName>]



operation.
Result
Commit the edit view as the committed view of the passport
Return Value
one
Errors
Examples:
# commit the edit view for the selected passport
>: Passport IN_Paris prov commit
>: Rnc Paris_VI INode IN_Paris prov commit
otes

command.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-176

save command
...................................................................................................................................................................................................................................
save command
Use the save command to send the save command to the PROV component of the
passport. It saves the edit view into a selected file in the passport.
Table 5-155
Syntax
DRAFT
save command
<FDN> save [-file <filename>] [-timeout
<timeValue>] [-cluster <clusterName>]

<filename>: the provisioning system saves the edit view into the
specified filename.
<timeValue>: optional parameter. Set the timeout (in seconds) of
the connection to the IT_MDM Engine. Using the same

IT_MDM Engine, WICL can keep the provision mode of the
passport. The default timeout value is 600 (seconds).
operation.
Result
Save the edit view as a file on the passport
Return Value
one
Errors
Examples:
# save the edit view for the selected passport into the file loadedFile
>: Passport IN_Paris prov save
>: Rnc Paris_VI INode IN_Paris prov save -file loadedFile
otes

command.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-177
DRAFT

load command
...................................................................................................................................................................................................................................
load command
Use the load command to send the load command to the PROV component of the
passport. It loads the file views into the edit view on the passport.
Table 5-156
Syntax
load command
<FDN> load [-file <filename>] [-timeout

<filename>: the file option loads the specified saved viewed file
from the disk into the edit view.


operation.
Result
Load the edit view as a file on the passport
Return Value
one
Errors
Examples:
# load the view for the selectedpassport from the file loadedFile.full.001
>: Passport IN_Paris prov load -file loadedFile.full.001

>: Rnc Paris_VI INode IN_Paris prov load -file loadedFile.full.001
otes

command.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-178

apply command
...................................................................................................................................................................................................................................
apply command
Use the apply command to send the apply command to the PROV component of the
passport.
Table 5-157
DRAFT
apply command
Apply
This command sends the ortel Multiservice Switch.

Syntax
<FDN> apply [-file <filename>] [-timeout


<filename>: the specified filename

operation.
Result
Apply the edit view as a file on the passport
Return Value
one
Errors
Examples:
# apply the view for the selectedpassport from the file loadedFile.full.001
>: Passport IN_Paris prov apply -file loadedFile.full.001

>: Rnc Paris_VI INode IN_Paris prov apply -file loadedFile.full.
otes

command.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-179
DRAFT

end command
...................................................................................................................................................................................................................................
end command
Use the end command to send the end command to the PROV component of the passport.
It ends the provisioning mode on the passport
Table 5-158
Syntax
end command
<FDN> end [-timeout <timeValue>] [-cluster
<clusterName>]


operation.
Result
Ends the provisioning mode on the passport
Return Value
one
Errors
Examples:
# end the provisioning mode for the selected passport
>: Passport IN_Paris prov end
>: Rnc Paris_VI INode IN_Paris prov end
otes
The passport has to be in provisioning mode before the execution

of the command.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-180

lock command
...................................................................................................................................................................................................................................
lock command
Use the at exec command to prevent a component from providing service.
DRAFT
A null job-id value means that an error occurred.

Table 5-159
Syntax
lock command
<FDN> lock [-force | -forever] [-timeout

-force: lock immediately by using the force option.
-forever: lock a Trunk component or an oamEnet component
and have it remained locked using the forever option.


Engine, WICL can keep the provision mode of the passports. The
operation.
Result
The component enters the shutting down OSI administrative state
Return Value
one
Errors
Passport error strings
Examples:
>: Passport Paris_pp Lp/1 lock
>: Passport Paris_pp Lp/1 get adminState
shuttingDown
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-181
DRAFT

unlock command
...................................................................................................................................................................................................................................
unlock command
Use the unlock command to unlock a component that have previously been locked by
the lock command.
Table 5-160
Syntax
unlock command
<FDN> unlock [-timeout <timeValue>] [-cluster
<clusterName>]


operation.
Result
The unlocked component can provide service again.
Return Value
one
Errors
Passport error strings
Examples:
>: Passport Paris_pp Lp/1 unlock
>: Passport Paris_pp Lp/1 get adminState
DRAFT
unlocked
...................................................................................................................................................................................................................................
NN-20500-030
5-182

reset command
...................................................................................................................................................................................................................................
reset command
Use the reset command to reset the hardware, to run the self tests, and to reload the
software for one or more processor cards.
Table 5-161
Syntax
DRAFT
reset command
<FDN> reset {Shelf Card/* | Lp/* | Shelf} [timeout <timeValue>] [-cluster <clusterName>]

Shelf Card/*: reset a particular processor card.
Lp/*: reset the active processor card of a logical processor.
Shelf: reset all processor cards on the shelf.

Engine, WICL can keep the provision mode of the ortel
Multiservice Switch. The default timeout value is 600 (seconds).
operation.
Result
Resets the hardware, runs the self tests, and reloads the software
for one or more processor cards.
Return Value
one
Errors
ortel Multiservice Switch error strings
Examples:
>: Passport Paris_pp Lp/1 reset
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-183
DRAFT

switch command
...................................................................................................................................................................................................................................
switch command
Use the switch command to manually switch between the working and protection line
on an APS-protected link.
Table 5-162
Syntax
switch command
<FDN> switch [-force] {protectionToWorking |
workingToProtection} [-timeout <timeValue>] [cluster <clusterName>]

-force: force a switch to the working or protection line.
protectionToWorking: switch from the protection line to the
working line.
SworkingToProtection: switch from the working line to the
protection line

operation.
Result
The APS-protected link is switched to the working or protection

line.
Return Value
one
Errors
Examples:
DRAFT
>: Passport Paris_pp Aps/1 switch -workingToProtection

>: Passport Paris_pp Aps/1 get nearEndRequestChannel
protection
>: Passport Paris_pp Aps/1 get farEndRequestChannel
protection
...................................................................................................................................................................................................................................
NN-20500-030
5-184

switchover command
...................................................................................................................................................................................................................................
switchover command
Use the switchover command to manually switch control between the active and
standby processor cards of an LP.
Table 5-163
Syntax
DRAFT
switchover command
<FDN> switchover [-force | -cancel | -time
(<date time>)] [-timeout <timeValue>] [-cluster
<clusterName>]

-force: force a logical processor switchover.
-cancel: cancel a scheduled switchover.
<date time>: schedule the switchover for a future time. The
format is: yyyy-mm-dd hh:mm.


operation.
Result
Control is switched between the active and standby processor

cards of an LP.
Return Value
one
Errors
Examples:
>: Passport Paris_pp Lp/1 switchover -force
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-185
DRAFT

ppBackup command
...................................................................................................................................................................................................................................
ppBackup command
Use the ppBackup command to backup some Multiservice Switch views from a domain,
a RC, or a Multiservice Switch.
Table 5-164
Syntax
ppBackup command
<domain | FDN> ppBackup [-force] [-s <rootDir>]
[-log <logFileName>] [-cluster <serverName>] [script] [-cluster <clusterName>]
<domain>: backup only ortel Multiservice Switch in the
specified domain.
domain: utran is the current domain. It means to backup all
passports of this domain


For this command, it could be RC Distinguished ame, or a
Multiservice Switch device Distinguished ame.
-force: if -force option is set, ppBackup tries to backup all
passports and do not stop even meeting an error when backuping a

passport.
If -force option is not set (default), ppBackup exits when meeting
an error with one of the passports.
-script: if -script option is set, ppBackup works in script mode.
It returns a Tcl list: { {tag} {successful backup passport list}

{failed backup passport list} }.
In default mode, if -script option is not set, ppBackup prints
summary information to customer.
<rootDir>: root directory for backuped files. The default value is
/opt/nortel/data/backup/passport.
<logFileName>: log file path to store MDM backup logs. This
file path must be relative to /opt/nortel/logs/wicl directory

<serverName>:
we usually choose a specific server, not the whole ROC.

operation.
DRAFT
Result
Backup passport views to local disk.
...................................................................................................................................................................................................................................
NN-20500-030
5-186

ppBackup command
...................................................................................................................................................................................................................................
Table 5-164
Return Value
ppBackup command (continued)

For a passport, ppBackup tries to backup current view, edit view
and commit view. Commit view is critical so, the back up succeeds
only if the commit view is backuped well.
DRAFT
If -script option is set, ppBackup returns a Tcl list: { {tag}

{successful backup passport list} {failed backup passport list} }.
Tag is equal to 0 or 1. If all passports are backuped successfully, it
returns 0. Else, it returns 1.
If -script option is not set, ppBackup prints summary information:
Global Status: Successful / Failed.
Successful Passports: passports which are successfully backuped.
Failed passports: passports which are not successfully backuped.
Errors
A warning is returned if an edit view or a current view failed to be

backuped.
An error is returned if a commit view failed to be backuped.
Examples:
>: Utran ppBackup -force
UMAINSERV1
>: RNC RNC_1 ppBackup
-s /tmp/data
-log
ppBackup.log -cluster
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-187
DRAFT

ppRestore command
...................................................................................................................................................................................................................................
ppRestore command
Use the ppRestore command to restore some passport views from a domain, a RC, or
a passport.
Table 5-165
Syntax
ppRestore command
<domain | FDN> ppRestore [-force] [-s <rootDir>]
[-log <logFileName>] [-cluster <serverName>] [script] [-cluster <clusterName>]
<domain>: restore only ortel Multiservice Switch in the
specified domain.
domain: utran is the current domain. It means to backup all
passports of this domain


For this command, it could be a RC Distinguished ame, or a
Multiservice Switch device Distinguished ame.
-force: if the -force option is set, ppRestore tries to restore all
passports and do not stop even meeting an error while restoring.

If the -force option is not set (default), ppRestore exits when
meeting an error with one of passports.
-script: if the -script option is set, ppRestore works in script
mode. It returns a Tcl list: { {tag} {successful restore passport list}

{failed restore passport list} }.
In the default mode, if the -script option is not set, ppRestore
prints summary information.
<rootDir>: root directory for restored files. The default value is
/opt/nortel/data/backup/passport.
<logFileName>: log file name of ppRestore which is in the
/opt/nortel/logs/wicl directory
<serverName>: we usually choose a specific server, not the
whole ROC.
operation.
DRAFT
Result
Restore passport views from local disk to passports
...................................................................................................................................................................................................................................
NN-20500-030
5-188

ppRestore command
...................................................................................................................................................................................................................................
Table 5-165
Return Value
ppRestore command (continued)

For a passport, ppRestore tries to restore current view, edit view
and commit view. Commit view is critical so, the passport is
restored successfully only if the commit view is restored well.
DRAFT
If the -script option is set, ppRestore returns a Tcl list: { {tag}

{successful restore passport list} {failed restore passport list} }.
Tag is equal to 0 or 1. If all the passports are restored successfully,
it returns 0. Else, it returns 1.
If the -script option is not set, ppRestore prints summary
information:
Global Status: Successful / Failed.
Successful Passports: passports which are successfully restored.
Failed passports: passports which are not successfully restored.
Errors
A warning is returned if an edit view or a current view failed to be

restored.
An error is returned if a commit view failed to be restored.
Examples:
>: Utran ppRestore -force
UMAINSERV1
>: RNC RNC_1 ppRestore
-s /tmp/data
-log
ppRestore.log -cluster
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-189
DRAFT
at commands
...................................................................................................................................................................................................................................
at commands
Use the at command to submit a job for a given date and time. The at command can be
used within a script file.
The current behavior of the at command in WICL is:
the execution of the job scheduled by at command follows a best effort strategy.
Unless submitted jobs were executed successfully or explicitly removed, they will be
persisted by WICL.
if some jobs were not successfully executed at scheduled time, they will be labeled
with "ot Executed-Time expiration" the next time WICL starts up, and the jobs will
not be executed. It is not possible to schedule two jobs at the same time.
DRAFT
The at commands are the following:
Date-and-time syntax (p. 5-191)

Eval command (p. 5-192)
Exec scripts (p. 5-193)
Get job list (p. 5-194)

Remove job (p. 5-195)
Get job result (p. 5-196)

Get job info (p. 5-197)
...................................................................................................................................................................................................................................
NN-20500-030
5-190
at commands
...................................................................................................................................................................................................................................
Table 5-166
DRAFT
The date-and-time syntax is the following: [<date>] <time> [<increment>]* with:

[<date>], optional field (default value = today) with the possible values:
today
tomorrow
yyyy-mm-dd, with yyyy a 4-digit year, mm the month (01..12) and dd the day (01..31)
<time>, mandatory field with the possible values:
midnight (that is 00:00)
noon (that is 12:00)
now
hh:mn, with hh the hours (00..23) and mn the minutes (00..59)
[<increment>], optional field (default value = "") with the possible values:
+ n min, with n the number of additional minutes (n>0)
+ n hour, with n the number of additional hours (n>0)
+ n day, with n the number of additional days (n>0)
+ n week, with n the number of additional weeks (n>0
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-191
DRAFT
at commands
Eval command
...................................................................................................................................................................................................................................
Eval command
Use the at exec command to schedule the evaluation of the command <command> for
<date&time> and returns a job-id.
A null job-id value means that an error occurred.
Table 5-167
Syntax
at eval command
at <date&time> eval <command>
<date&time>:for more information about this parameter, see
Date-and-time syntax (p. 5-191).

<command>: a WICL command string
Result
This command schedules the evaluation of the command

<command> for <date&time>
Return Value
A Job Id number
Errors
An exception is returned if any error is encountered during the

scheduling of the command
Example:
# Schedule in one minute the set WICL command for the selected RNC
>: at today now + 1 min eval Rnc 0 set rncArchitecture 44
DRAFT
ote
WICL cannot handle two schedules at the same second frame. In

this case, the second schedule will remove the first one.
...................................................................................................................................................................................................................................
NN-20500-030
5-192
at commands
Exec scripts
...................................................................................................................................................................................................................................
Exec scripts
Use the at exec command to schedule the evaluation of the <script-file> script for
<date&time> and returns a job-id. A null job-id value means that an error occurs.
Table 5-168
Syntax
DRAFT
at exec command
at <date&time> exec <script file>
<date&time>: see Date-and-time syntax (p. 5-191) for more
information on this parameter

<script file>: a WICL script file. If the command is executed
in a WICL session, the script file is encountered in the machine

where the session is launched. This means that if the SP WICL
session is opened from a PC, the script file path is the PC file
system. Otherwise, if the SP WICL session is opened in a Unix
System or by the wiclsh tool, the script file path is the Unix file
system.
Result
This command schedules the evaluation of the <command>

command for <date&time>
Return Value
A Job Id number
Errors

scheduling of the command.
Example:
# Schedule in one minute the WICL script
>: at today now + 1 min exec /tmp/rncExample.wicl
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-193
DRAFT
at commands
Get job list
...................................................................................................................................................................................................................................
Get job list

Table 5-169
at list command
at list
This command returns the list of the scheduled jobs

Syntax
at list
Result
This command gets the list of all the jobs scheduled by the
connected SP user
Return Value
A list of JobIds
Errors

Example:
# Get all the job launched by this NSP user
>: at list
1002030779000 1002030779001
Table 5-170
at listall command
at listall
This command returns the list of all the scheduled jobs by all the users
Syntax
at listall
Result
This command gets the list of all the scheduled jobs by all users
Return Value
A list of all JobIds
Errors

Example:
# Get all the jobs
>: at listall
1002030779000 1002030779001 1142411751 1150792737 1151032225
DRAFT
otes
This command returns the list of all the jobs from all the users and
all the sessions
...................................................................................................................................................................................................................................
NN-20500-030
5-194
at commands
Remove job
...................................................................................................................................................................................................................................
Remove job
Use the at result command to remove the <job-id> job from the job queue.
Table 5-171
Syntax
DRAFT
at remove command
at remove <job-id>
<job-id>: a job Id returned by at list command or by
scheduling commands
Result
This command removes the <job-id> job from the job queue
Return Value
one
Errors

Example:
# Remove the Job with the selected JobId
>: at remove 1002030779000
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-195
DRAFT
at commands
Get job result
...................................................................................................................................................................................................................................
Get job result

Use the at result command to return the result of the <job-id> job.
Table 5-172
Syntax
at result command
at result <job-id>
scheduling commands
Result
This command returns the result of the <job-id> job
Return Value
If the job is not already executed: ot executed yet

If the job is executed: the result returned by the executed
command or script
Errors

Example:
# Get the result of the Job with the selected JobIdt
>: at result 1002030779000
DRAFT
Not executed yet
...................................................................................................................................................................................................................................
NN-20500-030
5-196
at commands
Get job info
...................................................................................................................................................................................................................................
Get job info

Use the at - info command to return information about the <job-id> job.
Table 5-173
Syntax
DRAFT
at info command
at info <job-id>
scheduling commands
Result
This command returns information about the <job-id> job
Return Value
The following information:
Errors
Submission date: 2002-6-25 18:3
Execution date: 2002-6-25 18:4
State: ot Executed yet
Owner: nortel
Command: RC 1 dis

Example:
# Launch a display command
>: set id [at now + 1 min eval RNC 1 display]
1025021002000
# Get information about the command jobId
>: at info $id
Submission date: 2002-6-25 18:3
Execution date: 2002-6-25 18:4
State: Not Executed yet
Owner: nortel
Command: RNC 1 dis
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-197
DRAFT
Configuration file
...................................................................................................................................................................................................................................
Configuration file
WICL offers to script developers high-level commands to manage configuration script
files. The configuration script files depend on the script. Each scriptwriter can use a
configuration file that modifies the script behavior. These commands help the scriptwriter
to handle the configuration file and find parameter values in it.
The configuration file is based on key and value pairs. It is read from an ASCII file.
The syntax of the file is the following:
KEY1 = VALUE
KEY2 = ${KEY1}/VALUE2
KEY3 = $KEY2
MY_STRIG = "hello world"
The configuration file commands are the following:
DRAFT
WICLConfigInit command (p. 5-199)

WICLConfigGetValue command (p. 5-200)
...................................................................................................................................................................................................................................
NN-20500-030
5-198
Configuration file
...................................................................................................................................................................................................................................
Use the WICLConfigInit command to initialize a selected user config file, which
contains some keys, and values that will be used in a WICL script.
Table 5-174
Syntax
DRAFT
WICLConfigInit <filename>
<filename>: logical path using the supported file systems (dfs,
local)
Result
Set the filename as the config file and read in memory all
configurable variables
Return Value
one
Errors
An error is returned if any problem is encountered while accessing

the configuration file.
Example:
# Get the config file from the dfs file system.
>: WICLConfigInit dfs:wicl/upgrade/config.cfg
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-199
DRAFT
Configuration file
...................................................................................................................................................................................................................................
Use the WICLConfigGetValue command to get a configuration value using the param
key.
Table 5-175
Syntax
WICLConfigGetValue <param>
<param>: type this parameter name to obtain its value
Result
Get a configuration value using the param key.
Return Value
Parameter value if exists, otherwise nothing
Errors

the configuration file.
Example:
# Get the config param: param1. This config parameter has to be
>: WICLConfigGetValue param1
DRAFT
15
...................................................................................................................................................................................................................................
NN-20500-030
5-200
Trace file
...................................................................................................................................................................................................................................
Trace file
DRAFT
A user is allowed to write traces during the execution of a script. These traces can be used
to debug the script when an unexpected problem is encountered. Different levels of traces
are managed by the WICL trace commands so that not all traces are written to the same
trace file.
The trace file commands are the following:
WICLTraceInit command (p. 5-202)

WICLTrace command (p. 5-203)
WICLTraceError command (p. 5-204)

WICLTraceBegin command (p. 5-205)
WICLTraceEnd command (p. 5-206)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-201
DRAFT
Trace file
...................................................................................................................................................................................................................................
Use the WICLTraceInit command to initialize a trace file in order to write traces in it.
Table 5-176
Syntax
WICLTraceInit <fileName> <level>
<fileName>: logical path using the root path:
/opt/nortel/logs/wicl
<level>: this parameter is optional. It is the initial trace level for
writing traces. By default, it is set to 5.

Result
Initialize trace management with the specified level value and

open the trace file for appending new traces.
You can launch only once this command. Beyond, it does not have
effect anymore. Filename and level won't change.
Return Value
one
Errors

the trace file.
Example:
# Initialize the trace file using level 5
>: WICLTraceInit scriptUpgrade.log 5
DRAFT
otes
Each trace type (error, info, begin procedure, end procedure) has a
selected level of trace. The desired trace level is selected when
initializing the trace mechanism. If the level of the selected trace
type is equal to or greater than the level chosen at initialization, the
trace string is written into the file.
...................................................................................................................................................................................................................................
NN-20500-030
5-202
Trace file
WICLTrace command
...................................................................................................................................................................................................................................
WICLTrace command
Use the WICLTrace command to write a trace line in the trace file.
Table 5-177
DRAFT
WICLTrace command
Syntax
WICLTrace <string>
<string>: string to write into the trace file if the trace level is at
least equal to 3
Result
Writes the string trace into the trace file if the level set to the trace
management is at least 3, otherwise it does nothing. The trace
string will have the date and time stamped.
Return Value
one
Errors

the trace file.
Example:
# Write a trace
>: WICLTrace "Starting my script traces"
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-203
DRAFT
Trace file
...................................................................................................................................................................................................................................
Use the WICLTraceError command to write a trace error line in the trace file.
Table 5-178
Syntax
WICLTraceError <string>
<string>command.: string to write into the trace file if the trace
mechanism is activated using the init command

Result
Writes the string trace into the trace file if the level set to the trace
Management is at least 0, otherwise it does nothing. The trace
Return Value
one
Errors

the trace file.
Example:
# Write an error trace.
DRAFT
>: WICLTraceError "Error message displaying"
...................................................................................................................................................................................................................................
NN-20500-030
5-204
Trace file
...................................................................................................................................................................................................................................
Use the WICLTraceBegin command to write a begin trace line in the trace file. Use it
inside a procedure.
Table 5-179
Syntax
DRAFT
WICLTraceBegin <procName> [<string>]
<procName>: name of the procedure in which the string is
written.
<string>: string to be written in the trace file if the trace level is
at least 5.
Result
Writes the string into the trace file - if the level set for trace
management is at least 5, otherwise it does nothing. Date and time
are stamped to the trace string.
Return Value
one
Errors

the trace file.
Example:
# Write a begin trace inside a proc.
>: proc hello {} { WICLTraceBegin "this is a hello example"; }
>: hello
# The trace that is found in the trace level is:
# 16/05/2003-13:12:55 wctfs393 22232 INT
# Begin procName{}, this is a hello example
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-205
DRAFT
Trace file
...................................................................................................................................................................................................................................
Use the WICLTraceEnd command to write an end trace line in the trace file. Use this
method inside a procedure.
Table 5-180
Syntax
WICLTraceEnd <string>
<string>: string to be written in the trace file, if the trace level is
at least 5.
Result
Writes the string trace into the trace file - if the level set for trace
Management is at least 5, otherwise it does nothing. The trace
If the WICLTraceBegin command is called at the beginning of the
procedure, the WICLTraceEnd command is not called at the end of
the procedure. An automatic trace is written to the trace file to
indicate the lack of WICLTraceEnd.
Return Value
one
Errors

the trace file.
Example:
# Write an end trace.
>: proc hello {} { WICLTraceBegin "this is a hello example";
WICLTraceEnd "exiting from HelloExample"; }
DRAFT
# The trace that is found in the trace level is:

# 16/05/2003-13:12:55 wctfs393 22232 INT
# End hello{}, exiting from HelloExample
...................................................................................................................................................................................................................................
NN-20500-030
5-206
File management
...................................................................................................................................................................................................................................
File management
DRAFT
When added into a script, the file management commands allow you to perform the
following operations on files:
open a file in read only or edit mode,

read information from a file,
write information into a file.
Use the basic Tcl command puts to write information into the file.
Use the basic Tcl commands read and gets to read information from the file.
Use the Tcl command eof to check for the end of the file condition.
The files management commands are the following:
open command (p. 5-208)

close command (p. 5-209)
dir command (p. 5-210)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-207
DRAFT
File management
open command
...................................................................................................................................................................................................................................
open command
Use the open command to open a file into the managed file system.
Table 5-181
Syntax
open command
open <file system> : <relative file path> <mode>
<file system>: type of file system where the file is found. For
more details, see the Script access security (p. 6-3) table.
<relative file path>: logical path using the selected file
systems
<mode>: indicate the way in which the file (or command pipeline)
must be accessed
r: open the file for reading only; the file must already exist.
r+: open the file for both reading and writing; the file must
already exist.
w: open the file for writing only. If the file exists, truncate it. If
the file does not exist, create a new file.
w+: open the file for reading and writing. If the file exists,
truncate it. If the file does not exist, create a new file.
a: open the file for writing only. If the file does not exist,
create a new empty file. Set the initial access position to the
end of the file.
a+: open the file for reading and writing. If the file does not
exist, create a new empty file. Set the initial access position to
the end of the file.
Result
Open the selected file with the selected access mode.
Return Value
A channel identifier that will be used for later invocations of

commands like read, gets, close or puts.
Errors
An error is returned if any problem is encountered while opening

the file.
Example:
# Open a DFS file to write
DRAFT
>: set fd [open dfs:/wicl/output.txt "w"]
...................................................................................................................................................................................................................................
NN-20500-030
5-208
File management
close command
...................................................................................................................................................................................................................................
close command
Use the close command to close a file in the managed file system.
Table 5-182
Syntax
DRAFT
close command
close <file descriptor>
<file descriptor>: It is the channel identifier returned by the
command open
Result
Close the selected file
Return Value
one
Errors
An error is returned if any problem is encountered while closing

the file.
Example:
# Close the file that has the file descriptor: file25.
>: Close file 25
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-209
DRAFT
File management
dir command
...................................................................................................................................................................................................................................
dir command
Use the dir command to display a list of files in a given directory.
Table 5-183
Syntax
dir command
dir <scheme>:<scheme-specific-part>
<scheme>: dfs<scheme-specific-part>: dfs-path
Result
Display the list of files in the specified directory.
Return Value
one
Errors
An error is returned if any problem is encountered while closing

the file.
Example:
>: dir dfs:/access/neBackup
DRAFT
./dir1 ./dir2 file1.bkp file2.bkp
...................................................................................................................................................................................................................................
NN-20500-030
5-210
...................................................................................................................................................................................................................................
DRAFT
A help command is available in WICL. It gives you online information on WICL

commands.
The help commands are the following:
help command (p. 5-212)
Table 5-185, Help <wicl_command> command (p. 5-213)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-211
DRAFT

help command
...................................................................................................................................................................................................................................
help command
Use the help command to list all WICL commands which have online help information
available.
Table 5-184
Help command
Syntax
help
Result
List of commands which have help information
Return Value
List of commands which have help information
Errors
one
Example:
# Get the list of commands which have help information.
>: help
DRAFT
Available WICL help for basic commands are:

after append array break catch clock concat continue eof error eval
expr flush for foreach format gets global if incr join lappend
lindex linsert list llength lrange lreplace lsearch lsort
namespace proc puts read regexp regsub rename return scan set
source split string subst switch time trace unset update uplevel
upvar variable vwait while
Available WICL help for high level commands are:
activate abortUpgradeSession allDesynchro Audit cancelbuild close clo
...................................................................................................................................................................................................................................
NN-20500-030
5-212

...................................................................................................................................................................................................................................

Use the help <wicl_command> command to get help information about specified
WICL commands.
Table 5-185
Syntax
DRAFT
Help <wicl_command> command

help <wicl_command>
<wicl_command>: a Tcl or WICL command name
Result
Help information about specified WICL command
Return Value
Help information about specified WICL command
Errors
An exception is returned if no help information is available for the

specified command.
Examples:
# help.about createOnline WICL command
>: help createOnline
Command <createOnline> in domain <COMMON>:
SYTAX: <User D> createOnline <Attributeame1> <Value1> ... <Attributeame> <Value>
PARAMETERS:
Attributeame : the name of the attribute.
Value : the new value to set.
RESULT: Create the selected object
RETUR VALUE: The final status of the createOnline job.
ERRORS: An exception can be thrown if any problem is encountered during the execution of the command
EXAMPLE: RC RCM1_1 createOnline
# help.about get WICL command
>: help get
Command <get> in domain <COMMON>:
SYTAX: <User D> get <Attributeame>
PARAMETERS: Attributeame : the name of the attribute.
RESULT: Get an attribute value from the selected User D
RETUR VALUE: The value of the attribute
ERRORS: An exception can be thrown if any problem is encountered during the execution of the command
EXAMPLE: RC RCM1_1 get clusterId
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-213
DRAFT
...................................................................................................................................................................................................................................

For the long time-consuming commands, WICL calls Synchronous Differed Operation
(SDO) job manager to supervise the operation. After launching one of these commands,
the command manager blocks the other WICL commands for the job duration time. The
SDO result can be one of the following:
job running,
job cancelled,
job finished with error,

job paused,
job requested to pause,
job requested to cancel pause,

job requested to be cancelled,
job not yet started,

job finished without error,
job terminated with error,
job terminated with warning;

job does not exist.
This mechanism impacts the commands which involve 'SDO'. To display more detailed
information about the command execution, you need to use the -verbose parameter
with the WICL long command.
When a WICL command takes a long time to execute, all other WICL commands are
blocked and wait until the required operation is done correctly. To avoid waiting forever,
the WICL has a maximal waiting duration buit-in parameter, called timeout, of about 1h
30min. If the last command execution lasts more than this timer, WICL raises a timeout
error.
This does not cancel or abort the operation, but it implies that the WICL session does no
longer supervise the on-going operation execution: if any error occurs after the timeout
window, it is not caught by WICL and consequently, it is not sent to the WICL user.
To change the timeout value, set the <value> parameter of the setMaxTimeout
command as shown below:
Table 5-186
setMaxTimeout command
setMaxTimeout
DRAFT
Set the maximum value of timeout for long operations
...................................................................................................................................................................................................................................
NN-20500-030
5-214
...................................................................................................................................................................................................................................
Table 5-186
setMaxTimeout command (continued)

setMaxTimeout
Syntax
DRAFT
SetMaxTimeout <value>
<value>: a timeout value in minutes
Result
It modifies the default value of timeout for long commands
Return Value
othing.
Errors
one
Examples:
# Set the timeout to 3 hours: 180 minutes
>: setmaxTimeout 180
otes
This command is not case sensitive.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-215
DRAFT
...................................................................................................................................................................................................................................

To simplify OAM software management and upgrade, a WICL command exists that
generates a brief description of the currently installed OAM software. System
administrators can use this information to easily perform software maintenance.
Use the OAM command to list software markers on certain servers in ROC. The software
marker describes a message about currently installed OAM software, including the
official OAM software delivery version and newly added or removed software products
on local host after that delivery. For all the Main servers and performance servers in
ROC, this command can generated these markers and synthesize them into a complete
description.
Table 5-187
Syntax
OAM command
OAM inventory [-cluster serverName]
serverName: this parameter specifies the server from which to
retrieve software marker. If it is omitted, all the supported servers

in ROC will be examined.
Result
A descriptive message about OAM software information in ROC
Return Value
Return a string representation of software markers in ROC
Errors
Examples:
# Get OAM V5.1 software markers on all the servers in ROC
>: OAM inventory
UMAINSERV1(uctfe03m)3GPP 3gpp.5.1.0.0 installed
Missing products:
Emergency patch installed:
Unexpected patch installed:
Unexpected product installed:
Historical Fault Browser hfb.5.1.0.0 installed
DRAFT
Missing products:
...................................................................................................................................................................................................................................
NN-20500-030
5-216
...................................................................................................................................................................................................................................
Table 5-187
OAM command (continued)
Network Element Inventory ne_inventory.5.1.0.0 installed
DRAFT
Missing products:
...
# Get OAM V5.1 software marker on a specific server in ROC
>: OAM inventory -cluster UMAINSERV1
UMAINSERV1 (uctfe03m)3GPP 3gpp.5.1.0.0 installed
Missing products:
Historical Fault Browser hfb.5.1.0.0 installed
Missing products:
...
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-217
DRAFT
...................................................................................................................................................................................................................................

The environmental variable management commands allow the manipulation of the
<default_cluster> environment variable, as shown in the command examples below.
The environmental variable management commands are the following:
setEnv command (p. 5-219)
getEnv command (p. 5-220)
Some environmental variables can be manipulated by setenv and getenv commands:
DOMAI
If an input command line does not include the -domain <domainName> option, the
operation will be performed on the default domain
CLUSTER
If an input command line does not include the -cluster <clusterName> option,
the operation will be performed on the default cluster
VERBOSE_MODE
If an input command line does not include the -verbose option, the operation will
accord to the parameter value to set the verbose mode. If the value is TRUE, the
command will display detailed information for command execution
All the above variables can be used as parameters for all WICL commands:
-domain <domainName>
Use the specified domainame to distinguish Es with the same name in OAM
system, such as OAM objects
-cluster <clusterName>
Use the specified clusterame to query Es in OAM system
-verbose
DRAFT
Display more detailed information for command execution, such as errors or warnings
when executing the SDO jobs
...................................................................................................................................................................................................................................
NN-20500-030
5-218

setEnv command
...................................................................................................................................................................................................................................
setEnv command
Use the setEnv command to set environmental variables.
Table 5-188
Syntax
DRAFT
setEnv command
setEnv <varName> <varValue>
varName: name of the variable to be set.

varValue: variable value to be set.
Result
Set the environmental variable with <varValue>.
Return Value
one
Errors
An exception is returned if the varame or varValue is not correct

or is not supported.
Example:
>: setEnv default_cluster UMAINSERV1
otes
If the input command line does not include the '-cluster' option, the
operation will be performed on the default cluster.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-219
DRAFT

getEnv command
...................................................................................................................................................................................................................................
getEnv command
Use the getEnv command to get environmental variables.
Table 5-189
Syntax
getEnv command
getEnv <varName>
varName: name of the variable to get.
Result
Get the environmental <varValue>.
Return Value
The variable value.
Errors
An exception is returned if the varame is not supported.
Examples:
# get default cluster value:
>: getEnv CLUSTER
UMAINSERV1
# set default cluster as UMAINSERV2:
>: setEnv default_cluster UMAINSERV2
# get default cluster value again:
>: getEnv CLUSTER
UMAINSERV2
DRAFT
otes
If the input command line does not include the '-cluster' option, the
operation will be performed on the default cluster.
...................................................................................................................................................................................................................................
NN-20500-030
5-220
...................................................................................................................................................................................................................................
DRAFT
Use the prepareReport command to execute the user defined sql statement and store the
result in a given file.
Table 5-190
Syntax
prepareReport - sql <sql statement> -f.ile
<output file name> [-display <display number>] [cluster <cluster name>] [-verbose]
<sql>: User_defined sql statement.

<file>: The name of the output file. It can not contain path info
and any prefix such as dfs: or file:

<display>: Optional parameter. The number of lines of the result
when displaying in wicl shell. If there is no "-display" parameter,

there will not be displayed results.
Result
This command launches a TCL script at first.

Then the script launches SQL/PLUS with the role of HFBGUEST
and executes the SQL statements within a predefined stored
procedure.
Finally, the stored procedure will save the query result to the data
file. The result file is copied to UMAI SERV1:/opt/ ortel/data/
wicl/prepareReport/
Return Value
Status, FilePath and Count of the result.

If the -display parameter is specified, the specified number of
results is displayed.
For example:
Status: Successful
File: UMAI SERV1:/opt/nortel/data/wicl/prepareReport/
report.dat
Count: 353
---------------------------Result-------------------------------"xxx","xxx","xxx"
"xxx","xxx","xxx"
Errors

the trace file.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-221
DRAFT
...................................................................................................................................................................................................................................
Table 5-190
prepareReport command (continued)
Example:
>: prepareReport -sql "select count(*) from hfbmaster.view_report" file report.dat
>: prepareReport -sql "select * from hfbmaster.view_report" -file
"report.dat" -display 30
DRAFT
otes
If the user wants to get results from view_report, it must have the
prefix: hfbmaster. For example, hfbmaster.view_report.
...................................................................................................................................................................................................................................
NN-20500-030
5-222
...................................................................................................................................................................................................................................
DRAFT
Use the licenseCheck command to launch a license audit to the ROC or the specific
odeB which customer queried and version above V06 00 00.
Table 5-191
Syntax
licenseCheck -dn <NE dn> -outfile
<outputfilename> -display
licenseCheck -roc -outfile <outputfilename> display
licenseCheck -file <FilePath> -outfile
<outputfilename> -display
dn: (mutually exclusive with '-roc' and '-file' parameter). Operator
D, supported E type are 'RC' and 'BTSEquipment'. A

BTSEquipment dn for a specific BTS audit, or a RC dn for a
RS wide audit;
roc: (mutually exclusive with '-dn' and '-file' parameter, no
associated value). The flag used to confirm a ROC wide audit;

file: (mutually exclusive with '-dn' and '-roc' parameter). The file
path to store the D list which will be audited by the licenseCheck

command. It should be started with
'/opt/nortel/data/config/licenseAudit/'. Supported E type are
'RC', 'odeB' and 'BTSEquipment'.
file: optional parameter, the string is used to generate the audit
result filename. It must be alphanumeric, 16 bytes max.

display: optional parameter, the display flag (no associated
value), is used to control whether to display the audit result to the

wiclsh at end of the command execution
Result
A ".csv" file will be built in the '/opt/nortel/data/config/

licenseAudit/' to store the audit result. Be default, the
discriminator is a timestamp (YYYYMMDD-hhmmss+aabb
format) which can be replaced by a user value input from the
'-outfile' parameter
The list of E which occurred error during audit operation will be
exported to a '.err' file with the same name pattern
Return Value
By default, the command does not directly output the audit result
on the one line per-instance basis to the wiclsh display (can be
enable using "-display" option)
...................................................................................................................................................................................................................................
NN-20500-030
5-223
DRAFT
The produced file names are displayed at the end of the command
execution
DRAFT
...................................................................................................................................................................................................................................
Table 5-191
Errors
licenseCheck command (continued)

An error message can be returned when a problem is encountered:
Input file not be placed in correct directory

'ERROR: Please place the file to /opt/nortel/data/config/
licenseAudit before license check operation'
Output file name not match the rules

'SYTAX ERROR: Invalid output file name. The supported
charset of output file name is A-Z a-z 0-9'
The length of output file name over 16 bytes

'SYTAX ERROR: Invalid output file name. The supported
maximum length is 16 bytes'
Unsupported parameter value

'SYTAX ERROR: unsupported value for parameter
<parameter name>'

the execution of the command
Example:
>: licenseCheck -dn {RNC RNC3}
Result file:
/opt/nortel/data/config/licenseAudit/licusage_12646_rnc_R C3_20080630-181344+0800.csv
>: licenseCheck -roc -outfile finalResult
Result file:
/opt/nortel/data/config/licenseAudit/licusage_12646_ROC_finalResult.csv
Error file:
/opt/nortel/data/config/licenseAudit/licusage_12646_ROC_finalResult.err
>: licenseCheck -file /opt/nortel/data/config/licenseAudit/ -dis
DRAFT
RNC BTSEquipment Capacity.id version

recommended.edchNumberUserCapacityLicensing
actual.edchNumberUserCapacityLicensing <recommended.AttributeName2>
<actual.AttributeName2> ...
RNC3
2U-V2-1-- ERROR -- ERROR: The current BTS version 05_01_
00 does not be supported by licenseCheck command
RNC3
NB_17
0
06_00_00
15
15
...
RNC3
NB_24
0
06_00_00
15
15
...
...................................................................................................................................................................................................................................
NN-20500-030
5-224
...................................................................................................................................................................................................................................
DRAFT
This facade allows WICL user to request WLM server to export current license allocation
status and to send license usage report to a list of emails. The user has the possibility to
export with default name and path or custom ones
1. Check existence of WLM script: /opt/nortel/shell/wlm/wlm_cli.sh
2. According to input parameters, user can specifiy the name and path of output file, if
no input parameters, it is the WLM default name and path (see notes).
default WLM path is: /opt/nortel/data/wlm/snapshots/
default WLM name is: wlmSnapshot_YYYYMMDD-HHMM_hostname.csv
3. Call /opt/nortel/shell/wlm/wlm_cli.sh -export (user params if set) [-mail
<email list>]
This faade is visible in the WICL Script Editor GUI under treePath:
/WICL_XML_ROOT/WISCI_ASSET/License Management/licenseSnapshot
Table 5-192
Syntax
licenseSnapshot [file <file>] [-force] [-mail
[<email list>]]
file: Define the file absolute path and name of the snapshot file
force: Only applicable with custom path and file name, it allows
user to overwrite existing snapshot file

email list: Optional list of valid emails (cf. RFC 2822). If
empty, the WLM distributionList is used. ote this list follows the
Tcl syntax for list.
Result
The script end without error, snapshot file is created. License

usage report has been successfully sent.
Return Value
The result of the operation is indicated in a message:

snapshot successfully generated
snapshot successfully generated under /opt/nortel/<path>/<name>
(if specific path)
license usage report successfully sent
snapshot not generated: reason
license usage report not sent: reason
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-225
DRAFT
...................................................................................................................................................................................................................................
Table 5-192
licenseSnapshot command (continued)
Errors
An error message can be returned when a problem is encountered:
wlm_cli.sh script not found

'OPERATIO ERROR: wlm_cli.sh not found, no snapshot
generated'
File already exists: EXIT_STATUS_FILE_ALREADY_

EXIST
'OPERATIO ERROR: file {FILE_AME} already exists, no
snapshot generated, please use -force option for overwrite'
Incorrect path EXIT_STATUS_ICORRECT_FILEPATH

'OPERATIO ERROR: wrong path, no snapshot is generated'
Incorrect name EXIT_STATUS_ICORRECT_FILEAME

'OPERATIO ERROR: wrong file or path name, should not
contains: [ " * / : < > ? \ |]d'
Generation error EXIT_STATUS_IO_EXCEPTIO

'OPERATIO ERROR: wlm_cli.sh on error: I/O exception, no
snapshot generated'
Sendmail error EXIT_STATUS_SED_MAIL_ERROR

'OPERATIO ERROR: problem to sent email'
Empty distribution list EXIT_STATUS_EMPTY_DISTRIBUTIO_

LIST
'OPERATIO ERROR: empty email list'
Empty distribution list EXIT_STATUS_EMPTY_DISTRIBUTIO_

LIST
'OPERATIO ERROR: empty email list'
Invalid email syntax EXIT_STATUS_IVALID_EMAIL_

ADDRESS
OPERATIO ERROR: invalid email syntax: {bad emails}

the execution of the command
Example:
>: licenseSnapshot -file /opt/nortel/data/tmp/mySnap -force
Snapshot successfully generated under /opt/nortel/data/tmp/mySnap.csv

>: licenseSnapshot
Snapshot successfully generated

>: licenseSnapshot -file /opt/nortel/data/tmp/mySnap -mail
JohnTuttle@operator.com
Snapshot successfully generated under /opt/nortel/data/tmp/mySnap.csv

License usage report successfully sent to JohnTuttle@operator.com
DRAFT
License usage report successfully sent to {JohnTuttle@operator.com;LicMgr@operator.com}
...................................................................................................................................................................................................................................
NN-20500-030
5-226
Overview
...................................................................................................................................................................................................................................
WICL command /NE mapping
DRAFT
The following table lists the mapping between all the commands and the logical objects
(FD).
Table 5-193
WICL command mapping
Command
FDN WICL
RNC
All
Access
RAN
BTSEqptOneBTSEqpt
AccessTrace/I-Node/POC
cellTrace
abortUpgradeSession
activate
apply
audit
auditAllBts
backupImage
cancelBuild
cancelSelfSurvey
check
closeLink
cmXML export
cmXML
exportetwork
cmXML
exportRS
Commit
Confirm
Copy
createBackupImage
createCMSession
x
x
createOnLine
x
x
...................................................................................................................................................................................................................................
NN-20500-030
5-227
DRAFT
createTraceSession
DRAFT
...................................................................................................................................................................................................................................
Table 5-193
(continued)
Command
FDN WICL
RNC
All
Access
RAN
dbBackup
dbBackupRS
dbRestore
dbRestoreRS
BTSEqptOneBTSEqpt
cellTrace
x
x
x
x
x
declaration
delete
x
x
deleteOnline
deleteTraceSession
x
x
displayTraceSession
download
End
endprov
FM getAlarms
FM clearAlarm
FM
acknowledgeAlarm
fmSnapshot
x
x
get
getAll
getAllIC
getAttributes
getDescription
getStatus
getStateChange
getIC
DRAFT
diagnose
display
x
x
...................................................................................................................................................................................................................................
NN-20500-030
5-228
...................................................................................................................................................................................................................................
Table 5-193
(continued)
Command
FDN WICL
RNC
All
Access
RAN
BTSEqptOneBTSEqpt
cellTrace
getDD
getAllDD
getImageDescription
initiateSelfSurvey
List
DRAFT
x
x
listDbBackup
listImage
load
lock
MicroPicoBTS
download
MicroPicoBTS
activate
MicroPicoBTS
abortUpgradeSession
openLink
PM UnblockE
PM BlockE
PMsetodeBGranularity
PMgetodeBGranularity
powerTest
ppBackup
ppRestore
ppSynchronize
rebuild
rehome
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-229
DRAFT
...................................................................................................................................................................................................................................
Table 5-193
(continued)
Command
FDN WICL
RNC
All
Access
RAN
reset
BTSEqptOneBTSEqpt
cellTrace
x
resetMib
restoreBackupImage
rxAntenna
save
set
setAllOnline
setIC
setOnline
setOnlineAdministrativeState
setTracesession
specificAction
start
startProv
switch
switchover
synchronizeSoftware
undeclaration
unlock
getEnv
Environmental command, not for a specific FD
setEnv
Environmental command, not for a specific FD
DRAFT
(*) Reminder: The declaration / undeclaration commands are only used by the
Access side.
...................................................................................................................................................................................................................................
NN-20500-030
5-230
...................................................................................................................................................................................................................................
WICL interactions with command manager
For the long time-consuming commands, WICL calls Synchronous Differed Operation
(SDO) job manager to supervise the operation. After launching one of these commands
(for example a RC ReBuild), the command manager blocks the other WICL commands
for the job duration time. The SDO result can be one of the following:
job running,
job cancelled,
job finished with error,
job paused,
job requested to pause,
job requested to cancel pause,
job requested to be cancelled,

job not yet started,
job finished without error,

job terminated with error,
job terminated with warning;
job does not exist.
DRAFT
After the final job status, WICL automatically removes the command from the command
manager.
This mechanism impacts the commands which involve "SDO". To display more detailed
information about the command execution, you need to use the -verbose parameter
with the WICL long command.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
5-231
DRAFT
DRAFT
DRAFT

6
Overview
Purpose
Scripts are sequences of simple WMS commands that can be expressed in WICL format.
The usual file extension for WICL scripts is (*.wcl).
The edition of a script file is usually done in the local file system of the client. The script
edition or modification in any other file system requires direct access to these files (the
user must be logged on to the server) and cannot be performed by standard users.
Contents
6-3
6-3
WICL script editor
6-5
6-5
Use the command parameter wizard
6-7
Create a script
6-9
Edit a script
6-11
Save a script
6-12
WICL script browser
6-13
6-13
6-14
6-15
6-16
Move a Directory or a Script File
6-17
6-18
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-1
DRAFT
Overview
...................................................................................................................................................................................................................................
Open a Script File
6-19
6-20
Refresh a Directory Content
6-21
6-22
6-22
WICL Script Running
6-23
WICL Script Scheduling
6-24
6-27
DRAFT
6-27
Build All RC
6-28
Openlink All RC
6-29
Set All Attributes for all ode Bs
6-30
WICLConfig
6-31
WICLTrace
6-32
6-34
6-37
6-40
Access scripts
6-41
E inventory
6-42
OAM software inventory
6-46
ortel Multiservice Switch Scripts
6-47
Feature Lock Scripts
6-48
...................................................................................................................................................................................................................................
NN-20500-030
6-2
...................................................................................................................................................................................................................................
DRAFT
The WICL scripts are stored in the OAM Distributed File System (DFS). This DFS is a
logical set of directories shared by the OAM applications of all ROC servers and clients.
The benefits of using this centralized storage lie in the ability to share, archive and restore
script files.
Alcatel-Lucent delivers the scripts stored in dfs:/wicl, which points to
/opt/nortel/shell/wicl/scripts.
The customer WICL scripts are stored in dfs:/wicl/user, which points to
/opt/nortel/data/wicl/user.
The file access rights depend on the type of file system used.
The following table describes the file system managed by WICL:
Table 6-1
File System
Owner
Rights
Default Rights (at

creation)
file:
Alcatel-Lucent
Unix rights
R/W (user oamops)
dfs:
dfsnortel
R/W
R/W (user oamops)
The WICL script execution can be either immediate or scheduled once, or on hourly,
daily, weekly, monthly or yearly basis. A schedule management tool is available from the
Configuration> WICL Script Editor sub-menu of SP. In addition, a job management tool
can be launched through the Configuration> Radio Access> Job Scheduler sub-menu of
SP.
The following table describes the WICL command to execute WICL script file.
Table 6-2
exec command
exec
Use this WICL command to execute WICL script files.

This command can read WICL scripts encrypted by Alcatel-Lucent, as well as non-encrypted
scripts. This command checks whether the file script is encrypted or not and deciphers it
internally if needed. This action is transparent to the end user.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-3
DRAFT
...................................................................................................................................................................................................................................
Table 6-2
exec command (continued)

exec
Syntax
exec <file system> : <relative file path>

<params>
<file system>: type of file system where the file is located

<relative file path>: logical path using the selected file
systems
<params>: list of parameters that are passed to the script
Result
Executes the selected WICL script
Return Value
The result of the WICL script execution
Errors
An exception is returned if the file is not found or inaccessible.
Examples:
# Execute a WICL script which is found in DFS
For Alcatel-Lucent script:
exec dfs:/wicl/backup/passportbackup.wcl -h
For a user script:

1. Store the following command in the file /opt/nortel/data/wicl/user/user1.wcl: puts
[utran list rnc]
DRAFT
2. Run the script in WICL shell: exec dfs:/wicl/user/user1.wcl
...................................................................................................................................................................................................................................
NN-20500-030
6-4
WICL script editor
...................................................................................................................................................................................................................................
WICL script editor
DRAFT
The Script Editor can be launched through the SP menu by selecting Configuration >
WICL Script Editor menus.
The Script Editor is used to:
Create a script (p. 6-9)
Edit a script (p. 6-11)

Save a script (p. 6-12)
Figure 6-1 Script Editor main window
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-5
DRAFT
...................................................................................................................................................................................................................................
The ScriptEditor window displays a menu bar, an icon bar and several areas:
DRAFT
WICL script editor
The Command Wizard, which lists the WICL commands as a tree view. Open the tree
view to select a command.
The Parameter Wizard, which is activated with the command parameters of the
currently selected command. See alsoUse the command parameter wizard (p. 6-7).
The Script Editor, which displays the text of the script. Several scripts can be opened
at one time: they are displayed on different tabs.
...................................................................................................................................................................................................................................
NN-20500-030
6-6
WICL script editor

...................................................................................................................................................................................................................................

Use the parameter wizard to help building scripts. The parameter wizard is activated once
a command is selected in the tree view. It allows to input the command parameters to be
used at the script execution.
DRAFT
Procedure
...................................................................................................................................................................................................
Select a command in the tree view of the Command Wizard panel.

Result: The Parameter wizard window is displayed. It shows input area for the
command parameters.
Figure 6-2 WICL command parameter wizard
For a selected command:

A pink field is associated to a mandatory parameter.
A check box is associated to an optional parameter. When selected, the parameter
is enabled.
The Command field reminds the selected command and its parameters once
defined (see the procedure below). Point the mouse on ? to display the description
of the command in a popup window.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-7
DRAFT
WICL script editor

...................................................................................................................................................................................................................................
...................................................................................................................................................................................................
Input the mandatory parameters for the selected command, and the optional parameters if
needed.
If the FDN is present, click Object to open the Select FD window.
avigate to select the wanted FD then click Apply.
Click Make Command. The result command is displayed in the Command field.
...................................................................................................................................................................................................
Click Insert to insert the command at the cursor position of the selected script in the right
panel.
or click Add to add the command at the end of the selected script.
END
O F
S T E P S
DRAFT
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
6-8
WICL script editor

Create a script
...................................................................................................................................................................................................................................
Create a script
Use the WICL Script Editor to create new script files, by adding complete commands in
an empty file.
DRAFT
Figure 6-3 Create a new WICL script file
Procedure
...................................................................................................................................................................................................
Click File>New to create a new script.

Result: A new tab appears in the right pane of the Script Editor. It represents the new
script file.
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
6-9
DRAFT
Write the script file. If needed, add commands automatically (see Use the command
parameter wizard (p. 6-7))
DRAFT
WICL script editor

Create a script
...................................................................................................................................................................................................................................
...................................................................................................................................................................................................
To save the script file, see Save a script (p. 6-12).

...................................................................................................................................................................................................
To execute the script file, see WICL Script Running (p. 6-23)
END
O F
S T E P S
DRAFT
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
6-10
WICL script editor

Edit a script
...................................................................................................................................................................................................................................
Edit a script
Use this procedure to modify a script.
DRAFT
Procedure
...................................................................................................................................................................................................
Click File >Open.

...................................................................................................................................................................................................
Select a WICL script file in the dialog box that comes up. The file content is displayed in
the Script Editor window.
...................................................................................................................................................................................................
If any, modify the script as required.

If any, Use the command parameter wizard (p. 6-7) to add new commands
...................................................................................................................................................................................................
To save a modified script, see Save a script (p. 6-12).

END
O F
S T E P S
...................................................................................................................................................................................................
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-11
DRAFT
WICL script editor

Save a script
...................................................................................................................................................................................................................................
Save a script
Use this procedure to save the current script.
Procedure
...................................................................................................................................................................................................
Click File > Save as to save a newly created script file, or click File > Save to save
changes made in an existing script file.
...................................................................................................................................................................................................
The user directory is automatically selected. Input a file name in the dialog box that
comes up.
END
O F
S T E P S
DRAFT
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
6-12
WICL script browser
...................................................................................................................................................................................................................................
WICL script browser
DRAFT
The Script Browser is used to manage script files and user script file directories.
The Script Browser is launched from the File >Open Script Browser menu of the WICL
Script Editor.
Figure 6-4 Script Browser main window
The Provider and User folders are displayed in the left panel in a tree view.
Select a folder to display all its sub-folders and files in the right panel
Right-click on a file/folder to display the available menu items for this file/folder, and
select a menu to perform the associated operation
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-13
DRAFT
WICL script browser

...................................................................................................................................................................................................................................

Use this procedure to create a new directory or a new file under the User directory tree
view.
ote: This function is not available under the Provider directory.
Procedure
...................................................................................................................................................................................................
From the Script Browser left pane, navigate and select the parent folder
...................................................................................................................................................................................................
Right-click and select New >Directory or New > Script to create a new folder or a new
script file.
The new directory or script file is displayed in the right pane with the default name
newfolder or newfile.wcl
...................................................................................................................................................................................................
You can rename the new folder or script file as shown in Rename a Directory or a Script
File (p. 6-15).
...................................................................................................................................................................................................
Open the new file as shown in Open a Script File (p. 6-19).
END
O F
S T E P S
DRAFT
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
6-14
WICL script browser

...................................................................................................................................................................................................................................

Use this procedure to rename a user directory or a script file.
DRAFT

Procedure
...................................................................................................................................................................................................
From the Script Browser left pane, navigate and to select the directory or the script file to
be renamed
...................................................................................................................................................................................................
Right-click and select Rename

...................................................................................................................................................................................................
Enter the new name in the editing field

END
O F
S T E P S
...................................................................................................................................................................................................
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-15
DRAFT
WICL script browser

...................................................................................................................................................................................................................................

Use this procedure to delete a user directory or a script file.
Procedure
...................................................................................................................................................................................................
From the Script Browser left pane, navigate and select the directory or the script file to be
deleted
...................................................................................................................................................................................................
Right-click and select delete

...................................................................................................................................................................................................
In the Confirm Delete window, click OK to confirm

END
O F
S T E P S
DRAFT
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
6-16
WICL script browser

...................................................................................................................................................................................................................................

Use this procedure to move a directory or a script file from a directory to another one.
DRAFT

Procedure
...................................................................................................................................................................................................
moved
...................................................................................................................................................................................................
Use either the Move function or the Cut/Paste function:
Using the Move function:
Right-click and select Move

In the displayed Move Items window, navigate and select the destination directory
Click Move
Using the Cut/Paste function:
Right-click and select Cut
In the Script Browser left pane, select the destination directory
Right-click and select Paste
END
O F
S T E P S
...................................................................................................................................................................................................
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-17
DRAFT
WICL script browser

...................................................................................................................................................................................................................................

Use this procedure to duplicate a directory or a script file from a directory to another one.
ote: It is possible to duplicate data from the Provider to the User directory but it is
not possible to duplicate inside the Provider directory itself.
Procedure
...................................................................................................................................................................................................
duplicated
...................................................................................................................................................................................................
Right-click and select Copy

...................................................................................................................................................................................................
In the Script Browser left pane, navigate and select the destination directory
ote: Duplicating in the same directory is not allowed.
...................................................................................................................................................................................................
Right-click and select Paste

END
O F
S T E P S
DRAFT
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
6-18
WICL script browser

Open a Script File
...................................................................................................................................................................................................................................
Open a Script File

Use this procedure to edit the content of any script file located under the Provider or the
User directory.
DRAFT
Procedure
...................................................................................................................................................................................................
From the Script Browser left pane, navigate and select the script file to be opened
...................................................................................................................................................................................................
Right-click and select Open

Result: The Script Editor window is displayed and a new file tab is created containing
the file content.

END
O F
S T E P S
...................................................................................................................................................................................................
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-19
DRAFT
WICL script browser

...................................................................................................................................................................................................................................

Use this procedure to find a directory or a script file stored in a given directory located
under the Provider or the User directory.
Procedure
...................................................................................................................................................................................................
From the Script Browser left pane, navigate and select the directory
...................................................................................................................................................................................................
Right-click and select Find

...................................................................................................................................................................................................
In the Search window, input all or part of the file name then click Find
Result: The directory with all found files is created in the left pane. Clicking on this
directory displays all files in the right pane

END
O F
S T E P S
DRAFT
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
6-20
WICL script browser

...................................................................................................................................................................................................................................

Use this procedure to refresh information on the screen
DRAFT

Procedure
...................................................................................................................................................................................................
From the Script Browser left pane, select the directory

...................................................................................................................................................................................................
Right-click and select Refresh

Result: The right pane is refreshed
END
O F
S T E P S
...................................................................................................................................................................................................
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-21
DRAFT
...................................................................................................................................................................................................................................

Use this procedure to run or schedule WICL scripts.
DRAFT
The script execution results are displayed in the script result window which is displayed
after the script execution.
...................................................................................................................................................................................................................................
NN-20500-030
6-22

WICL Script Running
...................................................................................................................................................................................................................................
WICL Script Running

Running a WICL script file is possible:
from the Run menu item of Script Editor

from the Run now button of the Script Editor window
from the Run now menu items of Script Browser
DRAFT
Procedure
...................................................................................................................................................................................................
In the left window of either Script Editor or Script Browser, navigate and select the script
file to be run
...................................................................................................................................................................................................
To run the script:
From the Script Editor, click Run Now

or from the main menu, select Run >Run
From the Script Browser, right-click and select Run

or from the main menu, select Run >Run Now
...................................................................................................................................................................................................
In the Input Command Arguments windows, input arguments

...................................................................................................................................................................................................
Click Run Now. The script file is executed. If you click Cancel then nothing happens.
Result: The script file is executed and the result displayed in the Script Results
window
END
To save the script execution result on your PC, click Save as, select a destination
directory, input a file name and click Save
To clear the Script Results window, click Clear
O F
S T E P S
...................................................................................................................................................................................................
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-23
DRAFT

...................................................................................................................................................................................................................................

WICL Scripts can be scheduled to allow the user to prepare jobs.
Scripts scheduling is done in the Schedule Management window than can be triggered
either from the Script Editor or from the Script Browser.
Jobs can be prepared in the Create Schedule interface window, then they will be
managed in the Job Management interface window. Schedule Management and Job
Management are components of the Job Scheduler. For more information about Job
Scheduler, refer to the Alcatel-Lucent 9353 Management System - User Guide,
(-20500-032) document.
Procedure
...................................................................................................................................................................................................
In the left window of either Script Editor or Script Browser, navigate and select the script
file to be scheduled
...................................................................................................................................................................................................
To schedule the script:
DRAFT
From the Script Editor, click Schedule or from the main menu, select Run >Schedule
From the Script Browser, right-click and select Schedule or from the main menu,
select Run >Schedule
...................................................................................................................................................................................................................................
NN-20500-030
6-24

...................................................................................................................................................................................................................................
Result: The Create Schedule window is displayed:

Figure 6-5 Create Schedule main window
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-25
DRAFT
DRAFT

...................................................................................................................................................................................................................................
Three panels areas are displayed:

In the Script Argument area, input the command arguments
In the Schedule Information area, provide the parameters of the script scheduling
Recurrence allows to schedule the task. Click on the radio button to display
parameters specific to the selected recurrence
Once: the task will be run from a date and time specified in the Start Time combo
box and will last during the xx minutes set in the Estimated Duration (min) field.
Hourly: the task will be run every xx hour(s) specified in the Every <xx>
minute(s) field, from a date and time specified in the Start Time combo box to a
date and time specified in the End Time combo box
Daily: the task will be run every xx day(s) specified in the Every <xx> day(s)
field, from a date and time specified in the Start Time combo box to a date and
time specified in the End Time combo box
Weekly: the task will be run at day(s) selected in the Every week on field, from a
date and time specified in the Start Time combo box to a date and time specified
in the End Time combo box. The user can select one or more days of the week.
Monthly: the task will be run either each month at a specified day number or each
month at a specified day of a week, from a date and time specified in the Start
Time combo box to a date and time specified in the End Time combo box.
Yearly: the task will be run either each year at a specified month and day number
or each year at a specified day of a week in a month, from a date and time
specified in the Start Time combo box to a date and time specified in the End
Time combo box.
Reminder allows to create an automatic reminder by sending an email
In the Reminder before xx minutes field, input the xx minutes the email must be
sent before the script task begins
In the Email field, input the email address
In the Description field, input the subject of the email
In the Schedule Detail area, retrieve all information you have specified above to
schedule the task.
...................................................................................................................................................................................................
Click OK to validate and close the window.

END
O F
S T E P S
DRAFT
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
6-26

Overview
...................................................................................................................................................................................................................................
DRAFT
This section encompasses examples of WICL scripts that perform specific operations.
WICL supports users to create scripts by themselves according to their task logic using
WICL commands. The user scripts can be stored in /opt/nortel/shell/wicl/scripts/user,
which must be manually created by the users.
The examples of WICL scripts are:
Build All RC (p. 6-28)
Openlink All RC (p. 6-29)
Set All Attributes for all ode Bs (p. 6-30)
WICLConfig (p. 6-31)
WICLTrace (p. 6-32)
HTML table output using WICL script (p. 6-34)
Count Access Objects (p. 6-37)
Scheduled Export script (p. 6-40)
Access scripts (p. 6-41)
E inventory (p. 6-42)
OAM software inventory (p. 6-46)
ortel Multiservice Switch Scripts (p. 6-47)
Feature Lock Scripts (p. 6-48)
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-27
DRAFT

Build All RNC
...................................................................................................................................................................................................................................
Build All RNC

Use this script to retrieve all the RCs and verifies if the MIB is synchronized; if the
MIB is not synchronized, the script launches the build operation.
For example, the name of the script can be BuildAllRnc.wcl and saved in
/opt/nortel/shell/wicl/scripts/user.
The BuildAllRnc.wcl is as follows:
set rncLst [UTRAN
list rnc]
foreach rnc $rnclst {
eval $rnc rebuild
}
}
To launch this script from the SP WICL window:

>: exec dfs:/wicl/user/BuildAllRnc.wcl
To launch this script from a Unix shell:

% /opt/nortel/shell/wicl/wiclsh -u <Username> -p <Password> -f
/opt/nortel/shell/wicl/scripts/user/BuildAllRnc.wcl
To launch this script from WICL Script Editor:

Select the File/Script browser submenu
Select the user directory
Select the BuildAllRnc.wcl file
DRAFT
Click on the Run menu
...................................................................................................................................................................................................................................
NN-20500-030
6-28

Openlink All RNC
...................................................................................................................................................................................................................................
Openlink All RNC

Use this script to retrieve the list of all RCs and to open OAM link.
DRAFT
For example, the name of the script can be OpenlinkAllRnc.wcl and saved in
The OpenlinkAllRnc.wcl is as follows:
set rncLst [UTRAN list rnc]
if {![catch {$rnc getStatus} rslt]} {
foreach {statName
statValue}$rslt {
if {$statName == "unknownStatus"
&& $statValue == "true"} {
}
}
}
}

>: exec dfs:/wicl/user/OpenlinkAllRnc.wcl

/opt/nortel/shell/wicl/scripts/user/OpenlinkAllRnc.wcl

Select the BuildAllRnc.wcl file
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-29
DRAFT

Set All Attributes for all Node Bs
...................................................................................................................................................................................................................................
Set All Attributes for all Node Bs

Use this script to set the attributes startPoint and endPoint for all ode Bs.
For example, the name of the script can be setAllodeB.wcl and saved in
The setAllodeB.wcl is as follows:
set rnclst [UTRAN list RNC]
set nodeblist
[eval $rnc list
NodeB]
foreach nodeb
$nodeblist {
eval $nodeb setonline startPoint 90
endPoint 50
}
}

>: exec dfs:/wicl/user/setAllNodeB.wcl

/opt/nortel/shell/wicl/scripts/user/SetAllNodeB.wcl

Select the SetAllodeB.wcl file
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-30

WICLConfig
...................................................................................................................................................................................................................................
WICLConfig
This WICL script loads a configuration file for the script, to modify its default behavior.
DRAFT
The containment of the configuration file is as follows:

FIRST_WORD = hello
SECOD_WORD = World
IIT_MESSAGE = "${FIRST_WORD} ${SECOD_WORD} message"
For example, the name of the script can be wiclConfigEx.wcl and saved in
The wiclConfigEx.wcl is as follows:
WICLConfigInit dfs:/wicl/config/configEx.cfg
set str [WICLConfigGetValue INIT_MESSAGE]
puts $str
To launch this script from SP WICL:

>: exec dfs:wicl/user/wiclConfig.wcl

/opt/nortel/shell/wicl/scripts/user/wiclConfigEx.wcl
Example to launch the WICL script:

wjbas0fm:/tmp <124> (nortel) % /opt/nortel/shell/wicl/wiclsh -u
<Username> -p <Password> -f
/opt/nortel/shell/wicl/scripts/user/wiclConfigEx.wcl
hello World message
Disconnecting....

Select the wiclConfigEx.wclfile
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-31
DRAFT

WICLTrace
...................................................................................................................................................................................................................................
WICLTrace
Use this WICL script to perform a trace for debugging purposes.
For example, the name of the script can be wiclTraceEx.wcl and saved in
The wiclTraceEx.wcl is as follows:
proc example {} {
WICLTraceBegin "Begin of proc example"
WICLTraceEnd "End of the proc example"
}
# Set the trace level by default to 0
set
level 0
if
{$argc > 0} {
set i 0
# Find if "-trace" parameter is in argument list
while {$i $argc} {
switch - [lindex $argv $i] {
"-trace" {
incr i
set level [lindex $argv $I]
}
}
incr i
}
}
WICLTraceInit dfs:/wicl/user/traces/traceEx.tra $level
WICLTrace "This is a WICL trace example"
# Call example procedure
example
DRAFT
WICLTrace "End of script"

>: exec dfs:wicl/user/wiclTrace.wcl
...................................................................................................................................................................................................................................
NN-20500-030
6-32

WICLTrace
...................................................................................................................................................................................................................................
To launch this script from Unix shell:

/opt/nortel/shell/wicl/scripts/user/wiclTraceEx.wcl
DRAFT
Example:
Launch the WICL script with the parameter -trace to create a trace file and to set the trace
level to 5. The script analyses the -trace parameter to call the WICLTraceInit with the
selected trace level:
/opt/nortel/shell/wicl/scripts/user/wiclTraceEx.wcl
-trace 5
Disconnecting....
The result trace file in /opt/nortel/shell/wicl/scripts/user/traces/traceEx.tra is:

27/06/2002-09:00:00 wjbas0fm
This is a WICL trace example
27/06/2002-09:00:00 wjbas0fm
Begin of proc example
27/06/2002-09:00:00 wjbas0fm
End of proc example
27/06/2002-09:00:00 wjbas0fm
End of script
TRA
INT
INT
TRA

Select the wiclTraceEx.wcl file
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-33
DRAFT

...................................................................................................................................................................................................................................

This example shows how to build an output html file and display the data result in the
HTML browser
This example is not a wiclet example. It is only based on WICL commands and HTML
simply tags to show that it is also possible to generate HTML document by WICL script.
For example, the name of the script can be outputHTML.wcl and saved in
The outputHTML.wcl is as follows:
# Get all the RNC
set rncList [utran list rnc]
# Open a DFS output file
set fd [open dfs:/wicl/user/displayRnc.html "w"]
# Write HTML tags into the file
puts $fd "<html>"
puts $fd "<body>"
puts $fd "<h1>List of all RNC in the network</h1>"
puts $fd "<table BORDER BGCOLOR=\"#d3d3d3\">"
puts $fd "<tr>"
puts $fd "<td BGCOLOR = \"#cfcfcf\"><b>Attribute/Rnc</b></td>"
# Write first row with rnc userLabels
foreach rnc $rncList {
set rncUserLabel [eval $rnc get userLabel]
nortel::puts $fd "<td BGCOLOR = \"#cfcfcf\"><b>$rncUserLabel</b></td>"
}
# End the html row
puts $fd "</tr>"
DRAFT
# Get the list of attribute names

set rncFirst [lindex $rncList 0]
set attributesList [eval $rncFirst getattributes]
...................................................................................................................................................................................................................................
NN-20500-030
6-34

...................................................................................................................................................................................................................................
# Write a row with attribute names

foreach attr $attributesList {
DRAFT
puts $fd "<tr>"

# Put each RNC attribute values into a row/colon
set first 1
if {$first == 1} {
# Write in first colon the Attribute name
puts $fd "<td BGCOLOR = \"#cfcfcf\"><b>$attr</b></td>"
set first 0
} else {
# Write attribute values for each RNC
set res [catch {
set value [eval $rnc get $attr]
}]
if {$res == 0} {
puts $fd "<td BGCOLOR = \"#cfcfcf\"><b>$value</b></td>"
} else {
puts $fd "<td BGCOLOR = \"#cfcfcf\"><b>NO VALUE</b></td>"
}
}
}
# End a HTML row
puts $fd "</tr>"
}
# end HTML tags
puts $fd "</table>"
puts $fd "</body>"
puts $fd "</html>"
# close the file
close $fd
...................................................................................................................................................................................................................................
NN-20500-030
6-35
DRAFT

/opt/nortel/shell/wicl/scripts/user/outputHTML.wcl
DRAFT

...................................................................................................................................................................................................................................
After the execution of this script, a new file will be created. Use an HTML browser to
open it.
DRAFT
/opt/nortel/shell/wicl/scripts/user/displayRC.html
...................................................................................................................................................................................................................................
NN-20500-030
6-36

...................................................................................................................................................................................................................................

This WICL script counts the number of RA objects instances per class from a selected
root object.
DRAFT
For example, the name of the script can be countAccess.wcl and saved in
The countAccess.wcl is as follows:
proc GetClass {object} {
# Get the class from the object FDN
return [lindex $object [expr [llength $object] - 2]]
}
proc GetListObject {obj} {
global
count
WICLTraceBegin "Proc GetListObject: $obj"
# Get the list of classed of the selected object
set children [eval $obj list children]
WICLTrace "Class Childrens: $children"
foreach child $children {
WICLTrace "Class child: $child"
# Get the list of objects
set listObject [eval $obj list $child]
WICLTrace "List of Object of the class $child: $listObject"
foreach object $listObject {
# Obtain the class from the object FDN
set class [GetClass $object]
if {![info exists count($class)]} {
WICLTrace "New class $class"
set count($class) 1
} else {
WICLTrace "Incr the class $class"
incr count($class)
...................................................................................................................................................................................................................................
NN-20500-030
6-37
DRAFT
DRAFT

...................................................................................................................................................................................................................................
GetListObject $object
}
}
WICLTraceEnd "EndProc"
return [array get count]
}
proc RUN {obj} {
return [GetListObject $obj]
}
# Start the script. Get the first argument which contains the first root object to begin to count
if {[llength $argv] == 1} {
WICLTraceInit dfs:/wicl/traceExample.tra 5
RUN [lindex $argv 0]
} else {
error "Syntax: countAccess.wcl <FDN>"
}

>: exec dfs:wicl/user/countAccess.wcl "RNC RNCM1"

/opt/nortel/shell/wicl/scripts/user/countAccess.wcl
"RNC RNCM1"
Example:
Launch the WICL script count from a selected RC. This script returns a list of classes
and the number of instances for each class:
wjbas0fm:/tmp <124> (nortel) % /opt/nortel/shell/wicl/wiclsh -u
<Username> -p <Password> -f
/opt/nortel/shell/wicl/scripts/user/countAccess.wcl
"Rnc RNCM1"
DRAFT

UMTSFddNeighbouringCell 10 GaiCoord 10 App 10 GSMNeighbour 1 PCH 10
...................................................................................................................................................................................................................................
NN-20500-030
6-38

...................................................................................................................................................................................................................................
MtpSignPoint 1 ALCAPDistantSignallingEntity 1 ObjectTrace 1 RACH 10

FACH 10 CellSelectionInfo 10 InterFreqHhoRnc 1 CallTrace 1
DRAFT
Disconnecting....

Select the countAccess.wcl file
Input command argument in the window that comes up
Click the Run ow button
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-39
DRAFT

...................................................................................................................................................................................................................................

This script is an Alcatel-Lucent script used to export network information on a scheduled
time and has no user guide document.
The script contains the scheduledExport for Access domain, installed in:
DRAFT
/opt/nortel/shell/wicl/scripts/access/scheduledExport/cmXMLExportAccessetwork.sh
/opt/nortel/config/wicl/scripts/access/scheduledExport/config/cmXMLExportAccessetwork.cfg
...................................................................................................................................................................................................................................
NN-20500-030
6-40

Access scripts
...................................................................................................................................................................................................................................
Access scripts
The following section presents the Alcatel-Lucent access script CMXML.
DRAFT
CMXML
Use this script to export I and C parameters in an XML file. This file follows the same
structure and conventions as the CM XML snapshot. It can be exported as a separate file,
if you made the request. It is used only in the Access domain.
The CMXML script is saved in the following directory:
/opt/nortel/shell/wicl/scripts/access/cmXML
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-41
DRAFT

NE inventory
...................................................................................................................................................................................................................................
NE inventory
This functionality allows you to retrieve the E inventory information from the entire
live network for Access devices and put the inventory information to XML format file(s).
The inventory information is provided as an Inventory Report file.
Inventory reports can be generated for BTS and RC devices.
The E inventory function is directly accessible to the user using WICL scripts. The
operator can either directly query an inventory report generation (Query inventory
(p. 6-42)) or schedule it (Schedule inventory (p. 6-45)).
Query inventory
There is one inventory script available per inventory scope as described in the following
table.
Table 6-3
WICL script files

Inventory scope
WICL script
All E Inventory
getAll.wcl
All UTRA
getUTRA.wcl
All BTS
getIBTS.wcl
All OneBTS
getOneBTS.wcl
All RC
getRC.wcl
All POC
getPOC.wcl
You can launch the inventory scripts
either via the WICL console available from the SP menu bar (see WICL console
(p. 3-2)),
or via the WICL Script Editor available from the SP menu bar (see Chapter 6,
or using the wiclsh command from the WICL Line Mode shell (see WICL line
mode shell (p. 3-5)).
Example:
Launch of an inventory script by the WICL console
From the WICL interface menu bar, select Console>Exec. The Select a wcl File to
execute window opens.
DRAFT
Go to the inventory/utran directory and select the WICL script to launch.
...................................................................................................................................................................................................................................
NN-20500-030
6-42

NE inventory
...................................................................................................................................................................................................................................
Figure 6-6 Launch of the getRNC.wcl inventory script
DRAFT
Result :
The command that launches the getRC.wcl script appears in the WICL interface:
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-43
DRAFT

NE inventory
...................................................................................................................................................................................................................................
Figure 6-7 getRNC.wcl script result
Launch of the UTRA, BTS, OneBTS, RC and POC inventory scripts by the
WICL line mode (wiclsh command)
After entering your login and password, at the prompt, type the wanted command line as
follows:
>:
>:
>:
>:
>:
exec
exec
exec
exec
exec
dfs:../shell/inventory/utran/getRNC.wcl
dfs:../shell/inventory/utran/getUTRAN.wcl
dfs:../shell/inventory/utran/getIBTS.wcl
dfs:../shell/inventory/utran/getOneBTS.wcl
dfs:../shell/inventory/utran/getPOC.wcl
Execution of the UTRA inventory script by the WICL line mode (wiclsh
command)
/opt/nortel/shell/wicl/wiclsh -u <user login> -p <password> -f /opt/

nortel/shell/inventory/utran/getUTRAN.wcl
You can select the set of devices to be included in the inventory report using predefined
filters.
The table below displays the mapping between the predefined filters and the involved
devices.
Inventory scope
OneBTS
RNC
All E Inventory
All UTRA
All BTS
All OneBTS
All RC
All POC
DRAFT
BTS
POC
x
x
x
x
...................................................................................................................................................................................................................................
NN-20500-030
6-44

NE inventory
...................................................................................................................................................................................................................................
Schedule inventory
The schedule E inventory is realized by scheduling the execution of inventory WICL

scripts. The scheduling is performed by including WICL shell scripts in the UIX crontab
or by using the Schedule button of the Script Editor menu (see WICL script editor
(p. 6-5)).
DRAFT
NE Inventory information summary
The E inventory information is structured per E. One E can be based on one or
several nodes (RC made of C-ode, I-ode made of several passports). In that case the
following multinode information is aggregated below the E:
E level information.
Hardware information, related to physical equipments part of the E

Software information, related to the software running on the E
Inventory report description
The inventory report is an XML file generated by the system. The structure of the report
is as follows:
InventoryReport: the InventoryReport is the root element of the XML document

generated by the inventory request. It is characterized by a date of creation, and
carries information about the system that generated the report. It gathers all
inventoried entities.
InventoryEntity: the InventoryEntity represents a general container of inventory
information related to a hardware or software element. In the case of E inventory,
the InventoryEntity maps with a E instance. For multi node Es, there is a single
InventoryEntity gathering multiple HardwareComponent instances related to each
node.
HardwareComponent: the HardwareComponent describes the hardware characteristics
of elementary elements such as shelves and cards. The HardwareComponent carries
all hw related information (pec code, serial number, etc.).
SoftwareComponent: the SoftwareComponent describes the software characteristics
of elementary elements. It carries all software related information (identifier, running
version, fallback version, etc.).
Patch: a list of patches can be associated with a SoftwareComponent using the Patch
element.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-45
DRAFT

...................................................................................................................................................................................................................................

The script getOAMSW.sh is provides the OAM software inventory function. This
Alcatel-Lucent WICL script enables the end-user to retrieve the software level of an
OAM server. The script parses the software information and the software patch
information of the server and generates the XML format file of OAM software inventory
information. A report file is generated in XML format.
The filename of the OAM inventory file has the following format: IMSWYYYYMMDDHHMMSS.xml
IM: stands for Inventory Management (constant).
The value of the following elements depends on the time the file was generated:
YYYY: year (2000-9999).
SW: stands for OAM Software (constant).
MM: month (01-12).

DD: day (01-31).
HH: hour (00-23).
MM: minute (00-59).
SS: second (00-59).
NNN: sequence number (000-999). It starts from 000 and turns back to 000 after 999.
The inventory management software guarantees a unique name for each file. It checks
for other files using the same filename. If any is found, it increases the sequence
number of the current filename by 1.
DRAFT
For the file content see Inventory report description (p. 6-45).
...................................................................................................................................................................................................................................
NN-20500-030
6-46

Nortel Multiservice Switch Scripts
...................................................................................................................................................................................................................................
Nortel Multiservice Switch Scripts

The passportbackup.wcl and passportrestore.wcl scripts are used by all passport backup
and restore shell scripts and for end users to backup and restore passport views.
DRAFT
The parameters of the passportbackup.wcl and the passportrestore.wcl scripts are

identical.
Inventory scope
All passport
WICL script
passportbackup.wcl
passportrestore.wcl
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-47
DRAFT

...................................................................................................................................................................................................................................

This feature contains WICL scripts and WICLET interface to meet the customer's need.
Some customers do not need the total capacity provided by the E UA hardware and
want to pay just for what they really need.
The Feature Lock scripts are :
the WICL script lockHBBUCapacity.wcl

the WICL script lockxTRMCarrier.wcl
These Feature Lock scripts can only run via WICLSH by using the exec command with
the Set and Audit modes. The syntax is as in the following examples :
For the lockHBBUCapacity.wcl WICL script example,
>exec dfs:/wicl/access/ FeatureLock/lockHBBUCapacity.wcl -set -bts >

list of BTS equipment | all > -resourceMaxCapacity <value> maxNumberUserPerHBBU <value> -maxNumberUserPerNodeB <value>
>exec dfs:/wicl/access/ FeatureLock/lockHBBUCapacity.wcl -audit -bts >
list of BTS equipment | all >
For the lockxTRMCarrier.wcl WICL script example:
>exec dfs:/wicl/access/ FeatureLock/lockxTRMCarrier.wcl -set -bts >

list of BTS equipment | all > -carrierNumberPerXTRM <1 | 2>
>exec dfs:/wicl/access/ FeatureLock/lockxTRMCarrier.wcl -audit -bts >
list of BTS equipment | all >
ote:
the -resourceMaxCapacity option means percentage of CPU used per H-BBU; the
-maxNumberUserPerHBBU second option means maximum umber of HSDPA
User per H-BBU; the -maxNumberUserPerNodeB option means maximum
number of HSDPA user per BTS Equipment.

The -carrierNumberPerXTRM option means the number of carriers per xTRM in
BTS Equipment. 1 means 1 carrier per xTRM board; 2 means 2 carriers par
xTRM board.
The all key word means all the BTS Equipment in the UTRA domain.
To launch the WICL script lockHBBUCapacity.wcl from the unix shell,

Real path: /opt/ortel/shell/wicl/scripts/access/FeatureLock.
DRAFT
To launch the WICL script lockxTRMCarrier.wcl from the unix shell,

Real path: /opt/ortel/shell/wicl/scripts/access/FeatureLock.
...................................................................................................................................................................................................................................
NN-20500-030
6-48
...................................................................................................................................................................................................................................
DFS path: dfs:/wicl/FeatureLock.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
6-49
DRAFT
DRAFT
DRAFT
DRAFT
WICLET
7
Overview
Purpose
In addition to the WICL scripts that can be executed using a line mode interface or the
Job Scheduler interface, WICLET is a feature providing a web-oriented interface to these
scripts.
Contents
WICL plug-ins
7-2
7-2
7-3
WICLET management
7-6
WICLET examples
7-8
7-8

Other WICLET examples
7-9
7-19
7-23
Using WICLETs
7-23
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
7-1
DRAFT
WICLET
WICL plug-ins
...................................................................................................................................................................................................................................
WICL plug-ins
The WICLET functionality allows you to write high-level scripts based on WICL and to
execute them using a Web Browser. These high level scripts are referred to as WICLETs.
DRAFT
This section describes:
WICL server pages (WSP) (p. 7-3)
WICLET management (p. 7-6)
...................................................................................................................................................................................................................................
NN-20500-030
7-2
WICL plug-ins
...................................................................................................................................................................................................................................

The high level scripts referred to as WICLETs rely on a fusion of HTML and WICL
Server Page commands (WSP). This evolution provides a graphical web-oriented
interface to these scripts.
DRAFT
WICLET
WICL Server Pages mechanism derives from the Java Server Pages (JSP). Thus WSPs
follow the same syntax for script containment (tags), but provide the scriptwriter with full
WICL support (syntax, commands, etc.).
In the following sections, WSP scripts means " HTML embedded WICL scripts".
WSP syntax
A specific tag is introduced <WICL:Eval> ... <WICL:Eval>.

The include directive refers to an external file: <WICL: Include file="/toto.wsp">
ote the inclusion depth is limited up to eight successive includes and it must not be
possible to refer to files, which are not located under the OAM Web root directory.
WSP extensions to WICL
WICL is extended to facilitate the writing of wiclets.

HTML and WICLET facilities
These WICL commands help you to produce HTML output. Many HTML tags can be
found in WICL format.
To display a bold string in a web browser using WICL, the user can write:
puts "<b>Hello world</b>"
WICL gives also the ability to write the same command without using explicit HTML
tags:
bold "Hello world"
Wiclets look like HTML files with WICL tags. The following table gives the WICL
command of the HTML tag.
Command name
HTML tag
Displays/function
<h1 [param]> -->str</h1>
Level 1 heading
H2 [param]<str>
Level 2 heading
H3 [param] <str>
Level 3 heading
H4 [param] <str>
Level 4 heading
H5 [param] <str>
Level 5 heading
...................................................................................................................................................................................................................................
NN-20500-030
7-3
DRAFT
H1 [param] <str>
DRAFT
WICLET
WICL plug-ins
...................................................................................................................................................................................................................................
Command name
HTML tag
Displays/function
H6 [param] <str>
Level 6 heading
H7 [param] <str>
Level 7 heading
p [param] <str>
<p [param]> -->str</p>
Paragraph
bold <str>
<b>str</b>
text in bold
italic <str>
<i>str</i>
text in italic
underline <str>
<u>str</u5>
text underlined
strikout <str>
<s>str</s>
text with a line through it
blink <str>
<blink>str</blink>
text blink on and blink off in

etscape avigator
big <str>
<big>str</big>
font size value increased by 1
small <str>
<small>str</small>
font size value reduced by 1
font [params] <str>
<font [params]> -->str</font>
font size, color and typeface

change
table [params]
<command>
<table [params]>
-->command</table>
table
td [params] <str>
<td [params]> -->str</td>
text in a cell in a table
th [params] <str>
<th [params]> -->str</th>
table cell of which content is in

bolder font
table_row
[params]<command>
<tr [params]>
-->command</tr>
table row specifications
Access to CGI variables
A new array variable is available in WICL when wiclets are used: wiclCgi
This new array is composed of the following:
wiclCgi (AUTH_TYPE)
wiclCgi (QUERY_LEGTH)
wiclCgi (REMOTE_ADDR)
wiclCgi (REMOTE_HOST)
wiclCgi (REMOTE_USER)
DRAFT
For example, in a wiclet page the remote address can be obtained from this variable to
trace it.
WICLTraceInit dfs:/wicl/traces/wicletEx.tra 5
...................................................................................................................................................................................................................................
NN-20500-030
7-4
WICL plug-ins
...................................................................................................................................................................................................................................
WICLTrace "A new connection to the wicletEx from: $wiclCgi(REMOTE_ADDR)"

When the wiclet is requested from a web browser, this wiclet example writes the web
browser IP address into a trace file.
DRAFT
WICLET
Access to http form parameters
The http form parameters can also be obtained from the WSP. An HTML Form page
(POST or GET) sends these parameters to the wiclet, where they can be collected from the
WSP. See html form documentation for more information.
When you write a HTML page, each item in your form has a NAME tag. After your fill
data into these items in the form, the information is encoded into the form data. Each
value of the input items you have given is called VALUE.
Form data is a stream of NAME=VALUE pairs separated by the character "&". Each
NAME=VALUE pair is URL encoded, i.e. spaces are changed into plusses and some
characters are encoded into hexadecimal.
The mechanism for mapping has been implemented between the parameters sent retrieved
in the WSP. You can find these parameters in a tcl array inside the WSP: request_param.
The index of this tcl array is the list of names chosen by the HTML form page.
For example, in a wiclet page, the HTTP form parameter named "Action" can be retrieved
and displayed as shown below:
if {[info exists request_param(Action)]} { h1 "The selected input is: $request_param(Action)" }
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
7-5
DRAFT
WICLET
WICL plug-ins
WICLET management
...................................................................................................................................................................................................................................
WICLET management
Users can write their own wiclets and HTML pages and publish them by storing the
associated files on the main server disks. These scripts are available for any authenticated
people.
The HTML pages can embed WSP (HTML embedded WICL scripts) scripts or refer to
existing WICL scripts.
This can be considered as an OAM web site offered to the end user and powered with
WICL scripting capabilities.
WICLET edition
There is no integrated script editor to build wiclets. You can use any standard editor to
create and modify wiclets at the Client level. Some professional Web editors allow
building HTML pages including "server-side" scripts such as JSP, ASP and are suitable
for wiclet edition (Microsoft FrontPage, Macromedia Dreamweaver).
The file extension for Wiclets is .wsp.
WICLET storage
You must connect with the Alcatel-Lucent username to install the wiclet files and other
related files (image files or html files).
All files (.html, .wsp, .gif, etc.) created by Alcatel-Lucent and related to the wiclets
applications are stored in another file structure. The file path is as follows:
/opt/nortel/applications/wiclet/wiclets/nortel
You have the responsibility to download wiclet files and all related files (.html, .wsp, .gif,
etc.) into the primary Main server of the ROC. This download can be performed in
different ways, according to the network architecture and to the services provided by the
client: ftp, rcp, FS.
The simplest way to download the wiclets into the Primary Main server is to use ftp.
All the stored files can be backed up and restored with the OAM data. But the scripts are
not modified after an OAM upgrade. As a consequence, you need to modify the wiclets
manually when required.
OAM Upgrade
DRAFT
WICL scripts and wiclets created by you are kept after an OAM upgrade. This does not
mean that WICL scripts and wiclets are modified to take into account the modifications of
E commands and parameters. You are responsible for the modification of WICL scripts
and wiclets.
...................................................................................................................................................................................................................................
NN-20500-030
7-6
WICL plug-ins
WICLET management
...................................................................................................................................................................................................................................
The Alcatel-Lucent wiclets are upgraded with the new ones, which can be improved or
bug corrected in the new version.
DRAFT
WICLET
Security
Access to wiclets is restricted to authenticated users. Access to the WICL web page is
only possible after entering a password.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
7-7
DRAFT
WICLET
WICLET examples
...................................................................................................................................................................................................................................
WICLET examples
DRAFT
This section provides examples of wiclets that can be found at the following url:
http://<OAM_server>:8080/wicl/
...................................................................................................................................................................................................................................
NN-20500-030
7-8
WICLET examples
...................................................................................................................................................................................................................................

This wiclet enables users to manage UMTS neighbour cell lists and to audit capability
with detection and correction of missing reciprocities. A typical use case for this tool is
the quick neighbouring updating from WMS.
DRAFT
WICLET
This wiclet can be found in the wiclet list at the following url: http://<OAM_
server>:8080/wicl/
Figure 7-1 Header page
This wiclet provides four main operations accessible from the ONLINE NEIGHBOURING
MANAGEMENT list:
Managing the UMTS neighbour list for a specific FDDCell instance of the ROC and
optionally, the incoming links.
Managing the UMTS remote FDDCell list for a selected RC.
Managing the UMTS neighbour relation list for a selected RC.
Auditing the UMTS neighbour list for a selected RC.
The user can create, retrieve, update and delete one UMTS neighbouring link or multiple
instances at once (with one activation button only).
All operations are performed online, which means that any modification is activated on
the E as soon as the user executes this operation (i.e., OAM-MIB and E-MIB are
synchronized).
ote: This WICLET uses CreateOnline, DeleteOnline, SetOnline and GetAll WICL
commands to perform on-line neighbouring changes.
Manage an UMTS neighbour list
This section describes how to manage an UMTS neighbour list for a specific FDDCell
instance of the ROC. The first sub-section provides information about the graphical user
interface displayed while the next ones give detailed procedures to be followed when
managing the neighbour list. Displaying the UMTS neighbour list:
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
7-9
DRAFT
WICLET
WICLET examples
...................................................................................................................................................................................................................................
Use this procedure to display the UMTS neighbour links of a specific FDDCell instance
of the ROC.
...................................................................................................................................................................................................
From the ONLINE NEIGHBOURING MANAGMENT list, select the by User Label or by RNC
Id radio button, then select a RC in the RNC list
...................................................................................................................................................................................................
In the FDDCell list, select a FDD cell

...................................................................................................................................................................................................
In Display Options, select the Incoming links box to also display the incoming link table
(see below)
ote: The HCS instance option is not applicable to UA6
...................................................................................................................................................................................................
Click Submit to display the main page in the lower frame:

Figure 7-2 Displayed page of UMTS neighbour list
DRAFT
If the Incoming links box has been selected, two tables are created:
The first table called UmtsFddNeighbouringCell for the outgoing links.
The second table called Incoming_UmtsFddNeighbouringCell for the incoming links
Each row corresponds to an UMTS neighbour (ucId value) for the FDDCell (userLabel
value).
...................................................................................................................................................................................................................................
NN-20500-030
7-10
WICLET examples
...................................................................................................................................................................................................................................
In each table, an asterisk (*) in the title of the column indicates that the attribute value is
mandatory and must be manually informed.
DRAFT
WICLET
The prio column sorts the table by priority of neighbours at the RC level, within the
Intra/Inter frequency list:
If the Grouped by FA box is selected, then the priority of neighbour cells is firstly
given by groups of neighbours, intra and inter neighbour groups (FA column), then in
a second step by the value of cells in the prio column.
If the Grouped by FA box is not selected, the priority of the neighbour cells is given
only by the value of cells in the prio column.
The priority value is unique in the whole list and is in the range 0 (highest priority) to 62
(lowest priority).
The Reciprocity column indicates that the link has a reciprocal link or not (yes/no/alien).
alien means that the target is not defined in the ROC.
The other column headers use abbreviated terms with the following meaning:
Abbreviation
Meaning
Abbreviation
Meaning
PSC
primaryScramblingCode
CId
localCellId
LAC
locationAreaCode
Off
neighbouringCellOffset
RAC
routingAreaCode
QOff1
qOffset1sn
MCC
mobileCountryCode
QOff2
QOffset2sn
MC
mobileetworkCode
QQM
qQualMin
U
ulFrequencyumber
QRxLM
qRxLevMin
D
dlFrequencyumber
RC
relatedFDDCell
MaxUITx
maxAllowedUITxPower
SDU
sib11OrDchUsage
CIOff
cellIndivOffset
Info
userSpecificInfo
IFOff
intraFreqeighCellOffset
E...................................................................................................................................................................................................
N D O F S T E P S
Creating a new neighbour

...................................................................................................................................................................................................
Once the UMTS neighbour list is displayed, click Create
...................................................................................................................................................................................................................................
NN-20500-030
7-11
DRAFT
DRAFT
WICLET
WICLET examples
...................................................................................................................................................................................................................................
A new line is created at the end of the list. The yellow highlighted cells indicate that the
attribute has to be manually informed.
ote: A new row is also automatically created in the UmtsNeighbouringIntelligentMultiCarrierTrafficAllocation table accessible by clicking Display Relation
...................................................................................................................................................................................................
In the ucId cell, input the ucId of the RC.

The system automatically retrieves the value of the FDD cell and fills the attribute cells
with proper values. It also automatically fills the ucId cell in the UmtsNeighbouringIntelligentMultiCarrierTrafficAllocation table
ote: You cannot input an ucId value already used in the list, nor an ucId for a RC
which is not existing. In both cases, an error message is displayed.
...................................................................................................................................................................................................
Input the mandatory attributes values in the yellow highlighted cells.

ote: Prio column values
Input a value in the range 0 (highest priority) to 62 (lowest priority). The system
verifies that this value is not already existing in the priority list. If the value is already
used, a message is displayed to apply the priority order. Clicking yes changes the
duplicated priority order.
...................................................................................................................................................................................................
Click Check Prio to verify the priority of neighbours. If there is a duplication, the color of
all duplicated values are changed and an error message is displayed.
The verification is valid within the same intra/inter group if the Grouped by FA box is
selected.
...................................................................................................................................................................................................
Click Activate
ote: The system verifies input values:
DRAFT
Validation check - the system verifies that input data are coherent with the RA
model (for example: type, range, min/max, length)
Instance count check - the system verifies that the count of instances is not above
maximum number defined in the RA model
Intra/Inter FA count check - the system verifies that the counts of intra FA/inter FA
neighbour are not above the maximum number set to 32
Priority unicity check - the system verifies that the Check Prio button has been
clicked
...................................................................................................................................................................................................................................
NN-20500-030
7-12
WICLET examples
...................................................................................................................................................................................................................................
...................................................................................................................................................................................................
If the verifications are successful, a popup dialog is opened. Click OK to confirm

activation. The WICL commands are then executed and the result is displayed.
DRAFT
WICLET
If the verifications fail, the invalid input data is changed to red color in the table. Modify
it and click Activate for verification.
E...................................................................................................................................................................................................
N D O F S T E P S
Creating a new neighbour with its reciprocal neighbour

...................................................................................................................................................................................................
Once the UMTS neighbour list is displayed, click Create with R

A new line is created at the end of the list. The yellow highlighted cells indicate that the
attribute has to be manually informed.
ote: A new line is also automatically created:
in the UmtsFddNeighbouringCell table

in the UmtsNeighbouringIntelligentMultiCarrierTrafficAllocation table
in the Incoming_UmtsFddNeighbouringCell table

in the Incoming_UmtsNeighbouringIntelligentMultiCarrierTrafficAllocation
table
...................................................................................................................................................................................................
In the ucId cell, input the ucId of the RC.

The system automatically retrieves the value of the FDD cell and fills the attribute cells
with proper values.
ote: You cannot input an ucId value already used in the list, nor an ucId for a RC
which is not existing. In both cases, an error message is displayed.
...................................................................................................................................................................................................
Input the mandatory attributes values in the yellow highlighted cells.

...................................................................................................................................................................................................
Click Activate
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
7-13
DRAFT
WICLET
WICLET examples
...................................................................................................................................................................................................................................
clicked
...................................................................................................................................................................................................

E....................................................................................................................................................................................................................................
N D O F S T E P S
Updating the attributes of a selected neighbour

...................................................................................................................................................................................................
Once the UMTS neighbour list is displayed, select the box next to the ucId value to select
the neightbour. Several boxes can be select at once
...................................................................................................................................................................................................
Click Update
The selected rows are changed to writable mode:
the box changes to green color

the yellow highlighted cells indicate the value that can be modified
...................................................................................................................................................................................................
Modify the values

DRAFT
...................................................................................................................................................................................................
Click Activate
...................................................................................................................................................................................................................................
NN-20500-030
7-14
WICLET examples
...................................................................................................................................................................................................................................
DRAFT
WICLET
clicked
...................................................................................................................................................................................................

E...................................................................................................................................................................................................
N D O F S T E P S
Deleting selected neighbours

...................................................................................................................................................................................................
Once the UMTS neighbour list is displayed, select the box next to an ucId value to select
the neighbour. Several boxes can be select at once
...................................................................................................................................................................................................
Click Delete
The box(es) of the selected rows are highlighted in red color.
...................................................................................................................................................................................................
Click Activate
...................................................................................................................................................................................................
A popup dialog is opened. Click OK to confirm activation. The WICL commands are then
executed and the result is displayed.
ote: If the neighbour has child neighbours, then these last ones are also deleted.
E...................................................................................................................................................................................................
N D O F S T E P S
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
7-15
DRAFT
WICLET
WICLET examples
...................................................................................................................................................................................................................................
Deleting selected neighbours with its reciprocal neighbour

...................................................................................................................................................................................................
Once the UMTS neighbour list is displayed, select the box closed to an ucId value to
select the neighbour. Several boxes can be select at once
...................................................................................................................................................................................................
Click Delete with R

The box(es) of the selected rows and of the reciprocal rows are highlighted in red color.
...................................................................................................................................................................................................
Click Activate
...................................................................................................................................................................................................
A popup dialog is opened. Click OK to confirm activation. The WICL commands are then
executed and the result is displayed.
ote: If the deleted neighbour has child neighbours, then these last ones are also
deleted.
E....................................................................................................................................................................................................................................
N D O F S T E P S
Manage an UMTS remote FDDCell list
Use this procedure to display and manage an UMTS remote FDDCell list for a selected
RC.
...................................................................................................................................................................................................
Select the by User Label or by RNC Id radio button, then select a RC in the RNC list
...................................................................................................................................................................................................
Click Submit to display the main page in the lower frame

...................................................................................................................................................................................................
You can select the box closed to the ucId value and click Display UmtsFddNeighbouringCell to display the list of UMTS neighbour cells wich refer to this specific UMTS
neighbour relation instance
DRAFT
E....................................................................................................................................................................................................................................
N D O F S T E P S
...................................................................................................................................................................................................................................
NN-20500-030
7-16
WICLET examples
...................................................................................................................................................................................................................................
Manage an UMTS neighbour relation list
Use this procedure to display and manage an UMTS neighbour relation list for a selected
RC.
DRAFT
WICLET
...................................................................................................................................................................................................
...................................................................................................................................................................................................

...................................................................................................................................................................................................
You can select the box closed to the rdnId value and click Display UmtsFddNeighbouringCell to display the list of UMTS neighbour cells which refer to this specific UMTS
neighbour relation instance
E...................................................................................................................................................................................................
N D O F S T E P S
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
7-17
DRAFT
WICLET
WICLET examples
...................................................................................................................................................................................................................................
Audit an UMTS neighbour list
Use this procedure to display and audit an unidirectional UMTS neighbour of a selected
RC.
...................................................................................................................................................................................................
Figure 7-3 Audit of unidirectional neighbour list
...................................................................................................................................................................................................

According to the number of FDD cells, the audit operation can take a long time. In this
case, a message with partial results is displayed
...................................................................................................................................................................................................
DRAFT
Once the audit is finished, you can click Delete audit result to suppress results and
refresh the page
END
O F
S T E P S
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
7-18
WICLET examples
...................................................................................................................................................................................................................................

This section encompasses some examples of WICLET scripts, with some detailed basic
steps to illustrate how to create a script and place it on the server.
DRAFT
WICLET
Hello World in WICLET
This is the "Hello World" example written using WICLET.

<%@ include file="/services/main.wsp" %>
<html><head><title>WICLET Example</title></head>
<body bgcolor="#c0c0c0">
<WICL:EVAL> h1 "Hello World" </WICL:EVAL>
</body></html>
Launching this wiclet gives the following result:
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
7-19
DRAFT
WICLET
WICLET examples
...................................................................................................................................................................................................................................
List All BTSEquipment in WICLET
This example returns the BTS Equipment and attributes in an html table.
h1 "A WICL html example"
set rncList [UTRAN List Rnc]
table {BORDER BGCOLOR="#d3d3d3"} {
table row {
#Attribute Name
td {BGCOLOR = "#cfcfcf"} "<b><FONT FACE=\"Verdana\" Size=3>
Attributes/Rnc</FONT><:b>"
# Write first row with rnc userLabels
set rncUserLabel [eval $rnc get userLabel]
td {BGCOLOR = "#cfcfcf"} "<b><FONT FACE=\"Verdana\"
Size=3>$rncUserLabel</FONT><:b>"
}
}
set rncFirst [lindex $rncList 0]
set attributesList [eval $rncFirst getattributes]
foreach attr $attributesList {
table_row {
set first 1
if {$first == 1} {
# Write in first colon the Attribute name
td {BGCOLOR = "#e9e9e9"} "<FONT FACE=\"Verdana\"
Size=2>$attr</FONT>"
set first 0
} Else {
# Write attribute values for each RNC
set value [eval $rnc get $attr]
DRAFT
td {BGCOLOR = "#e9e9e9"} "<FONT FACE=\"Verdana\"

Size=2>$value</FONT>"
}
...................................................................................................................................................................................................................................
NN-20500-030
7-20
WICLET examples
...................................................................................................................................................................................................................................
}
}
DRAFT
WICLET
}
}
Figure 7-4 A WICL html example
UTRAN Workorder Scheduler wiclet
server>:8080/wicl/
Use this Wiclet to:
Monitor Workorder activation jobs
Add a Workorder activation job in the scheduler
Cancel a Workorder activation job
...................................................................................................................................................................................................................................
NN-20500-030
7-21
DRAFT
DRAFT
WICLET
WICLET examples
...................................................................................................................................................................................................................................
UTRAN link states wiclet
server>:8080/wicl/
This wiclet provides a summary view of UTRA interface statuses for each RC in the
network (Operational State, Administrative State, Usage Status).
UTRAN VPI/VCI Occupancy Rate Monitoring wiclet
server>:8080/wicl/
DRAFT
This wiclet provides views of the occupancy rate of the ATM RC / POC interfaces (IuB,
IuR, IuCS, IuPS).
...................................................................................................................................................................................................................................
NN-20500-030
7-22
Overview
...................................................................................................................................................................................................................................
Using WICLETs
DRAFT
WICLET
This section describes how to write a simple wiclet and how to make it available through
the UMTS OAM server. Follow the procedure below to create a simple wiclet:
Procedure
...................................................................................................................................................................................................
Enter the following lines in any text editor:

<%@ include file="/services/main.wsp" %>
<html>
<head>
<title>WICLET Example</title>
</head>
<body bgcolor="#c0c0c0">
<WICL:EVAL>
h1 "Hello World"
</WICL:EVAL>
</body>
</html>
...................................................................................................................................................................................................
Save the file on your local disk.

...................................................................................................................................................................................................
Transfer the file from your local disk to the Primary Main server using ftp. Put it in the
folder: /opt/nortel/applications/wiclet/wiclets/user
...................................................................................................................................................................................................
Launch the wiclet using a Web Browser. Type the WICL web page address in the address
field of the browser.
Example: http://zrc2s0mu:8080/wicl/
The following welcome page appears:
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
7-23
DRAFT
WICLET
Using WICLETs
...................................................................................................................................................................................................................................
...................................................................................................................................................................................................
DRAFT
Click into the "LIST OF WICLET" link to display the available wiclets.
...................................................................................................................................................................................................................................
NN-20500-030
7-24
Using WICLETs
...................................................................................................................................................................................................................................
Result: The list of wiclets appears:
DRAFT
WICLET
...................................................................................................................................................................................................
Click once on the wiclet to execute it.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
7-25
DRAFT
WICLET
Using WICLETs
...................................................................................................................................................................................................................................
Result: The following result appears in the Web Browser:
END
O F
S T E P S
DRAFT
...................................................................................................................................................................................................
...................................................................................................................................................................................................................................
NN-20500-030
7-26
DRAFT
Error dictionary
8
Overview
Purpose
This section lists the WICL error messages. There are three types of messages: error
messages, warning messages and information messages.
These messages are classified according to their type and the components that generates
the error messages. These components are the following:
WICL Server (p. 8-3)

WICL Facade (p. 8-10)
WICL Client (p. 8-50)
WICL Scripts (p. 8-53)
The keys to the dictionary tables are provided below:
"\n" represents a carriage return

"\t" represents a tab input
Words quoted with the symbol "<>" are variables. They can be different each time the
output message is generated.
"|" used within the symbol "<>" is used to split the variable into different possible
values
Contents
8-3
WICL Server
8-3
8-10
WICL Facade
8-10
8-50
8-50
...................................................................................................................................................................................................................................
NN-20500-030
8-1
DRAFT
WICL Client
DRAFT
DRAFT
Error dictionary
Overview
...................................................................................................................................................................................................................................
8-53
WICL Scripts
8-53
...................................................................................................................................................................................................................................
NN-20500-030
8-2
WICL Server
...................................................................................................................................................................................................................................
WICL Server
DRAFT
Error dictionary
The WICL Server generates the following message types:
WICL Server error messages (p. 8-3)

WICL Server warning messages (p. 8-8)
WICL Server error messages

Message
Cause
Context
"run" or "exec" method in

scheduledJob.cc failed
running commands
Callback request not

implemented yet
Callback request is not

implemented yet
running commands
Memory allocation failed

during create WICL result
Cannot allocate memory for

generate TCL list
running commands

parameters

parameters
running commands

userContext

user context
running commands
Cannot decode a null typecode
Cannot decode a null type code
running commands
Cannot decode exception

<exception id>
Cannot decode an exception
running commands
Cannot decode user exception
Cannot decode an user

exception
running commands
Cannot decode array
Cannot decode array
running commands
Cannot decode enum
Cannot decode enum
running commands
Cannot decode enum for index:

<value>. The enum max is:
<parameter count>
Cannot decode enum for an

index
running commands
Cannot decode parameter for

request
Cannot decode a parameter for

a request
running commands
Cannot get UserContext from

WICL to send CORBA
command
Cannot get user context from

WICL to send CORBA
command
running commands
Cannot obtain the tcl object

index <index> from the object:
<object name>
Cannot obtain the TCL object

index from the object
running commands
...................................................................................................................................................................................................................................
NN-20500-030
8-3
DRAFT
Application Error
DRAFT
Error dictionary
WICL Server
...................................................................................................................................................................................................................................
Message
Cause
Context
Cannot set variable <variable

name> while extracting
parameter <parameter name>
Cannot set the variable while

extracting a parameter
running commands
Exception caught: <CORBA

exception>
CORBA exception caught
running commands
Decode typecode principal not

implemented
Decode type code principal not

implemented
running commands
Decode typecode of type

typecode is not supported
Decoding of type code with

type "type-code" is not
supported
running commands
DFSFile not found in dfsMap

structure
DFS file not found in DFS map

structure
running commands
Encode typeCode not supported
Encoding of type code is not

supported
running commands
Encoding object reference

internal error
Internal error while encoding

object reference
running commands
<object name>: error opening

file <file name>
Error while opening a file
running commands
Error while creating the IOR

from object <object name>
Error while creating the IOR

from an object
running commands
Error while decoding
running commands
Error while initializing CORBA

orb
Error while initializing CORBA

orb
running commands
Error while resolving interface

repository
Error while resolving the

interface repository
running commands
Exception arrived while

encoding the request
Exception arrived while

encoding the request
running commands
Get results of a request failed
Get results of a request failed in

CORBA TCL
running commands
Error: cannot create <file

name> handler
Instantiate a CORBA object in

a TCL command with the
marker name failed
running commands
Error: cannot create <new

command name> command
Instantiate object method error

for new command
running commands
DRAFT
Unexpected Corba Exception:

<exception>
...................................................................................................................................................................................................................................
NN-20500-030
8-4
WICL Server
...................................................................................................................................................................................................................................
Message
Cause
Context
Condition variable internal

error
Internal error occurred while

waiting for an IFR accessing
condition variable
running commands
Error: CORBA exception:

Invalid_Object_Reference
<system exception>
Invalid object reference
running commands
Invoke request failed
Invoke a request failed in

CORBA TCL
running commands
Invoke failed
Invoke failed
running commands
Error: list_initial_services has

failed: <system exception>
List initial services failed
running commands
malloc failed
Malloc option failed
running commands
Error: -callback needs a

parameter
o parameter after "-callback"
running commands
o type information for

<command name>
o type information for a

command
running commands
ot enough parameters in the

typecode Union for encoding
Lacking parameters in the type

code Union for encoding
running commands
ot enough resource to obtain

mutex lock
Lacking resource to obtain

mutex lock
running commands
Error: unknown object: <object

name>
Object not found in

CORBATCL
running commands
DRAFT
Error dictionary
The object name is not an

object
Error: parameter to trader
lookup not known <parameter
name>
Parameter to trader lookup

unknown
running commands
o value for parameter 0 of

tk_sequence TypeCode.
Parameter (0) of the sequence is

empty
running commands
Unexpected exception: <system

exception>
Unexpected exception received
running commands
error: Unexpected exception

Received an unexpected
exception: <exception>
Unknown exception caught
...................................................................................................................................................................................................................................
NN-20500-030
8-5
DRAFT
System Exception caught:

<system exception>
DRAFT
Error dictionary
WICL Server
...................................................................................................................................................................................................................................
Message
Cause
Context
Error: resolve_initial_
references has failed
Resolve initial references failed
running commands
Error: string_to_object has

failed
String to object failed
running commands
Tcl interpreter is not initialized
TCL interpreter is not

initialized
running commands
tcl object not found in the index

<index> from the object
<object name>
TCL object not found in the

index from the object
running commands
Does not match sequence long

(<TCL length>)
The length of a sequence- type

parameter does not match the
TCL sequence length
running commands
<parameter> does not match

<struct | struct name>: wrong #
of elements (got <TCL length>
expected <parameter length>)
The length of a structure-type

parameter does not match that
of the TCL structure
running commands
<object name> does not match

item count of <array length>
The length of an array-type

parameter does not match the
TCL array length
running commands
The method <operation name>

is not in the operation list of
<object name>
The method is not in the

operation list of the object
running commands
Error: the ORB is not initialized
The ORB is not initialized
running commands
Error: Cannot get trading

service
The ORBIX command

resolve_initial_references for
Trading Service failed
running commands
<parameter> does not match

<short | long | ushort | ulong |
float | double | Boolean | char |
octet>
The parameter does not match

the parameter type
running commands
Encoding internal error
The TCL object or type code

used while encoding is null
running commands
Cannot encode array
The type code for the array is

null
running commands
Cannot encode enum
The type code for the enum is

null
running commands
DRAFT
The methods are: <commands>
...................................................................................................................................................................................................................................
NN-20500-030
8-6
WICL Server
...................................................................................................................................................................................................................................
Message
Cause
Context
Cannot encode sequence
The type code for the sequence

is null
running commands
<parameter> is not a structure
The type code is a structure

while the parameter is not
running commands
<object name> is not a union
The type code is a union while

the parameter is not
running commands
the value <<<object name> >>

is not an array
The type code is an array while

the parameter is not
running commands
This typecode is not supported

for union switch: <TCL kind>
The type code is not supported

for union switch
running commands
Encode exception not

supported
The type code type is tk_except
running commands
error: expecting void, but got

<object name>
Type code kind is tk_void while

the CORBA object is not void
running commands
Type of parameter mode is

unknown <mode>
The type of parameter mode is

unknown
running commands
Type unexpected to encode
Type to encode is unexpected
running commands
Unknown error in change IFR

accessing condition variable
Unknown error in change IFR

accessing condition variable
running commands
Unknown error in IFR

accessing test
Unknown error in IFR

accessing test
running commands
Unknown option <option

name>
Unknown option
running commands
Unknown typecode to decode
Unknown type code to decode
running commands
Cannot setup parameters to the

operation
_req->setup returns 1 or throws

an exception
running commands
Cannot setup to get attribute
_req->setupGet or setupSet
returns 1
running commands
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-7
DRAFT
Error dictionary
DRAFT
Error dictionary
WICL Server
...................................................................................................................................................................................................................................
Message
Cause
Context
Wrong arguments for a

command
running commands
Connection failed
Engine not found
WICL login
Initialization info search failed
Initialization info search failed
WICL login
User authentication failed
User authentication failed
WICL login
wrong # args: should be

"<object name> op
?arguments?"
"<object name>"
"<object name> service"
"<object name> param
paramValue"
"<object name> objectId"
"<object name> IOR"
"<object name> <message>
<level>"
"<object name> DfsPath"
"<object name> user password"
WICL Server warning messages
DRAFT
Message
Cause
Context
Tcl working thread has been

cancelled
TCL working thread has been

cancelled during IFR accessing
test
running commands
Attribute <attribute name> is

readonly
The attribute is read only
running commands
Your WICL session has been

ended by the Security
Administrator, please login
again.
The WICL session has been

Administrator
running commands
...................................................................................................................................................................................................................................
NN-20500-030
8-8
WICL Server
...................................................................................................................................................................................................................................
Message
Cannot be performed during
Backup & Restore execution
Cause
Backup and Restore is running
Context
WICL login
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-9
DRAFT
Error dictionary
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
WICL Facade
ote: A facade is an object that provides a single, simplified interface to the more
general facilities of a subsystem.
The WICL Facade generates the following message types:
WICL Facade error messages (p. 8-10)

WICL Facade warning messages (p. 8-48)
WICL Facade information messages (p. 8-49)
WICL Facade error messages
DRAFT
Message
Cause
Context
Command
Cannot create form

(or isindex) with
form already in
progress.
A form or isindex is
already being created
WICLET execution
_wicl_form_multiple_
check
In response to a
request for a
multipart form, your
browser generated a
part header without a
name field. Please
upgrade (or fix) your
browser.
Client browser
generated a part
header without a
name field, in
response to a request
for a multipart form.
WICLET execution
_wicl_input_multipart<_
wicl_input_multipart_
binary
Your browser failed

to generate a
"boundary=" line in a
multipart response
(COTET_TYPE:
<content type
value>). Please
browser.
Client browser failed

to generate a
"boundary=" line in a
multipart response
WICLET execution
_wicl_input_multipart<_
wicl_input_multipart_
binary>
Your browser failed

to provide an ending
boundary (<initial
value>) in a multipart
response. Please
browser.

to provide an ending
boundary in a
multipart response.
WICLET execution
_wicl_input_multipart_
binary
...................................................................................................................................................................................................................................
NN-20500-030
8-10
WICL Facade
...................................................................................................................................................................................................................................
Context
Command
DRAFT
Error dictionary
Message
Cause
Your browser failed

to provide an initial
boundary (<initial
value>) in a multipart
response. Please
browser.

to provide an initial
boundary in a
multipart response.
WICLET execution
_wicl_input_multipart_
binary
Multiple definitions
of <variable name>
encountered in input.
Multiple definitions
of a variable
WICLET execution
_wicl_set_uservar
The upgrade is
cancelled for
BTSEquipment
<label> ->
<message>
BTS upgrade job

cancelled
Job supervisor
<BTS D>
download/
downloadAndActivate/activate/fal
The upgrade is failed

for BTSEquipment
<label> -><message>
BTS upgrade job

failed
Job supervisor
<BTS D>
download/
Job supervisor
<BTS D>
download/
If you're trying to do
this intentionally
(such as with select),
the variable must
have a "List" suffix.
<The upgrade is
BTS upgrade job
completed with
finished with error
errors|<BTSEquipment
message>>for
BTSEquipment
<label>\n<E error
messages>
The upgrade is KO
for BTSEquipment
<label> ->
<message>
BTS upgrade job

SDO status is KO
Job supervisor
<BTS D>
download/
The upgrade state is

not known for
BTSEquipment
<label>
Unknown SDO state
Job supervisor
<BTS D>
download/
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-11
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
A software version is
necessary to
<command>
BtsEquipment\
nSyntax:
<BtsObjectD>
<command>
<version>
Cause
Software version is
not given
DRAFT
Internal error: cannot Syntax error of BTS

upgrade commands
match <command>
with existing
methods: download,
downloadAndActivate,
activate or fallback
Context
Command
Parameter validation
<BTS D>
download/
downloadAndActivate/activate/fallbac
<BTS D>
download/
downloadAndActivate/activate/fallbac
The -mode parameter

is mandatory for the
RC activate
command.
The -mode parameter

is not given for the
RC activate
command.
RC upgrade
<RC D> activate
The -version
parameter is
mandatory for the
RC activate
command.
The -version
parameter is not
given for the RC
activate command.
RC upgrade
<RC D> activate
The upgrade is
cancelled for RC
<label> ->
<message>
RC upgrade job is

cancelled
Job supervisor
<RC D>
download/activate/
fallback
The upgrade is KO
for RC <label> ->
<message>
An error occurred
during RC upgrade
job
Job supervisor
<RC D>
download/activate/
fallback
The upgrade is failed

for RC <label>
-><message>
RC upgrade job

failed
Job supervisor
<RC D>
download/activate/
fallback
<The upgrade is
completed with
errors|<RC
message>> for RC
<label>
RC upgrade job

finished with error
Job supervisor
<RC D>
download/activate/
fallback
<I/A error
messages>
...................................................................................................................................................................................................................................
NN-20500-030
8-12
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
The upgrade state is

not known for RC
<label>
Unknown SDO state
Job supervisor
<RC D>
download/activate/
fallback
The activation mode

"<mode>" is not
supported, use the
following instead:
type3, type6 or type7.
The input mode is not

supported
RC upgrade
<RC D>
download/activate/
fallback
Internal Error:
<command> not
known
RC upgrade
command executed
with an unknown
command
RC upgrade
<RC D>
download/activate/
fallback
Internal Error: Action

type of alarms not
known: <command
type>
Error while launching

a command
Parse command
format
ackAlarms
Cannot find
MORetriever
interface
Cannot get
FMK_UM_
ItMORetriever server
Get object proxy
all
Cannot find
MORetriever
interface with
constraint
<constraint>
Cannot get
FMK_UM_
ItMORetriever server
with the specified
constraint
Get object proxy
all
Object not found in

Roc Configuration
Cannot get object

proxy with its
Distinguished ame
Get object proxy
all
Object not found in

the ROC or constraint
<cluster> is incorrect
(or time out on
request)
Cannot get the object

proxy with the
specified constraint or
timeout while trying
to get the object
proxy
Get object proxy
all
Class <id> not known

in RA Model
Unknown Class <id>

in RA Model
getClassoCase
all
Unknown attribute
type, only
[ALL|PRIMARY]
allowed
Invalid input
parameter for
getModelAttributeame proc
getModelAttributeame
all
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-13
DRAFT
Error dictionary
DRAFT
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Attributeame <id>
not found in known
classes
Cause
Attributeame <id>
cannot be found in
RA Model
Context
Object Distinguished
ame construction
Command
all
...................................................................................................................................................................................................................................
NN-20500-030
8-14
WICL Facade
...................................................................................................................................................................................................................................
Message
These are the
available operations
in Objects Managed
by WICL. For more
help, use Help
command or use the
TP WICL
documentation.
D3GPP Set
(attributeame
attributeValue)*
Cause
This message
provides information
about available
operations. It is
generate when a
wrong command or
parameter is entered
after a valid
Distinguished ame
Context
User input wrong
command or
parameter after a
valid Distinguished
ame
Command
all Distinguished
ame operation
commands
DRAFT
Error dictionary
D3GPP SetIC
(attributeame
attributeValue)*
D3GPP SetOnLine
(attributeame
attributeValue)*
D3GPP Get
<attributeame>
D3GPP GetIC
<attributeame>
D3GPP GetAll
<attrTable>
D3GPP GetAllIC
<attrTable>
D3GPP SetAll
<class>
<attributeame>
<value>
D3GPP Create
D3GPP Delete
D3GPP List
<children/
classame>
D3GPP
GetAttributes
D3GPP activate
D3GPP cancelbuild
...................................................................................................................................................................................................................................
D3GPP
NN-20500-030
8-15
Issue 12.01/EN October
2009
getdesription
<params>
D3GPP openlink
D3GPP closelink
DRAFT
D3GPP
buildUpgrade
DRAFT
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Error while adding a

job: <exception>
Error while adding a

job
Job scheduler
at
Error while getting

job <job id>:
<exception>
Error while getting a

job
Job scheduler
at
Error while getting

info for job <job id>:
<exception>
Error while getting

information for a job
Job scheduler
at
Error while removing

job: <exception>
Error while removing

a job
Job scheduler
at
The job id <job id>

does not exist
The job ID does not

exist
Job scheduler
at
Syntax error: at list
Syntax error of the at

command
at
Syntax error: at
remove <job_id>

command
at
Syntax error: at result

<job_id>

command
at
Syntax error: at
<date&time> (eval |
exec)
<command>|<script
file>

command
at
MIB audit failed.

<exception>
MIB audit failed
MIB audit
audit
Syntax error: <FD>

audit [-cluster
<clusterame>] [-file
<filename>]
Syntax error of audit

command
audit
Cancel build failed.

<exception>
Cancel build failed
Cancel build
cancelbuild
cmXML export
failed. <Exception
Message>
cmXML export failed
Any exception occurs

when launching
cmXML export
cmXML export
Internal Error:
Cannot generate
report: <report>
Cannot create the

report or store the
result
Any exception occurs

when storing the
report for cmXML
export
cmXML export
...................................................................................................................................................................................................................................
NN-20500-030
8-16
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Syntax Error: The

parameter -file should
be present only once
More than one

parameter "-f"
Parse arguments for

cmXML export
cmXML export
Syntax Error: E
type <class name> is
not supported by
cmXML export
E type is not
supported by cmXML
export
Parse arguments for

cmXML export
cmXML export
Syntax Error: D..

<argument> cannot
be used in command
exportRS
E type is not
supported by
exportRS
Parse arguments for

cmXML export
cmXML export
Syntax Error: The

parameter -dn is
incompatible with
command
exportetwork
Parameter -dn"
entered in command
exportetwork
Parse arguments for

cmXML export
cmXML export
Syntax Error: The

parameter -<domain>
can only be used in
cmXML
exportetwork
Wrong Distinguished
ame entered
Parse arguments for

cmXML export
cmXML export
Syntax Error: The

parameter <domain>
is not recognized
Wrong domain
entered
Parse arguments for

cmXML export
cmXML export
Syntax Error: The

parameter -dn should
More than one

parameter "-dn"
entered
Parse arguments for

cmXML export
cmXML export
Syntax Error:
FD_list is
mandatory if the
command is not
Exportetwork
When user forgets to

input Distinguished
ame for export
Parse arguments for

cmXML export
cmXML export
Syntax Error: Either

or both of parameter
-c.ustomer and
-m.anufacturer must
be selected
either "-c" nor "-m"

parameters entered
Parse arguments for

cmXML export
cmXML export
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-17
DRAFT
Error dictionary
DRAFT
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Syntax Error: Either

or both of parameter
-p.rovisioning and
-s.tateAndStatus must
be selected
either "-p" nor "-s"

parameters entered
Parse arguments for

cmXML export
cmXML export
Set ERROR_MSG:
Error encountered:
<Error Message>
cmXML
import/export failed
on the server side
cmXML
import/export failed
but returned
cmXML
import/export
Syntax Error: The

parameter
<argument> is not
recognized
Error arguments of
cmXML commands
cmXML
import/export
Syntax Error: The

parameter -file is
mandatory
o "-file" option for

import
cmXML
import/export
Syntax Error: The

command <command
name> is not known
for cmXML
operations
Error command of
cmXML operations
Parse command
format
cmXML
import/export
Syntax Error: The file

<file name> should
obey the DFS format
File name does not

comply with the
format "dfs:/..."
Parse DFS file name
cmXML
import/export
Report retrieval
failed. <Exception
Message>
Cannot generate
report on the server
side
Report generation
cmXML
import/export
Internal Error: The

cmXML service is
not available. Check
the SMC console
cmXML service does

not run
Retrieve trader
cmXML
import/export
Internal Error: Final

State for <Sdo job
state> is not known
SDO server returns

unknown state for the
job
SDO server returns

unknown state for the
job
cmXML
import/export
bad number of
parameters:
<arguments>
The number of input

parameters for
create* command is
not even (cannot be
recognized as an
attribute value pair)
XML Encoding
create, createSession
...................................................................................................................................................................................................................................
NN-20500-030
8-18
WICL Facade
...................................................................................................................................................................................................................................
Cause
Context
Command
TraceSession creation
failed. <exp>
XML attributes
encoding failed or
Trace session creation
was refused by CP
due to <exp>
Parameter encoding
before CORBA call
or TraceSession
creation through
CORBA call
createSession
ERROR: ueIdType
and ueId information
are mandatory for
AccessSession
ueIdType and/or ueId

information is
missing; both
ueIdType and ueId
are mandatory for the
AccessSession.
createSession
ERROR: objectList
and ueId options can
not exist
simultaneously for
one session.
The objectList and

ueId options have
been set at the same
time; they are
mutually exclusive.
createSession
ERROR: objectList
information is
mandatory for
CellSession
The objectList option

is missing; it is
mandatory for the
CellSession
createSession
ERROR: objectList
information is
mandatory for
GeographicalSession
objectList option is
mandatory for
GeographicalSession
while it was missing
from the input
createSession
ERROR: RC <D

object> in rncList has
no cluster
information\n
One of RC list has

no cluster information
when creating a trace
session
createSession
ERROR: rncList
attribute is
mandatory.
RC list attribute is

missing; it is
mandatory
createSession
ERROR: Sessionote
can not be empty or
over 32 character!
Session note should

not be empty or
exceed 32 characters
createSession
ERROR: o
SessionType
specified!
sessionType
information is
missing: it is
mandatory to create a
TraceSession object
createSession
...................................................................................................................................................................................................................................
NN-20500-030
8-19
DRAFT
Message
DRAFT
Error dictionary
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
ERROR:
SessionType
<sessionType> is
unknown.
The sessionType
entered is not in
AccessSession,
CellSession or
GeographicalSession
createSession,
createTraceSession
ERROR: The
userlabel already
exists.
The input userLabel

of the TraceSession is
already in use
createSession,
createTraceSession
ERROR: Object
<obj> in objectList
cannot be matched to
any rnc in rncList
The values entered in

objectList and rncList
do not match
createSession
ERROR: Invalid
object <obj>
The object format in

objectList is not
correct
createSession
ERROR: Unable to
find the cluster
information for RC
<D object>
Unable to find the

cluster information
for a RC
createSession
succeeded but
activation failed
<errInfo>
The activation on the

corresponding RC
object was failed
TraceSession
activation on RC
createSession
ERROR: Cannot
create TraceSession
because
Object_Access server
not found for
CLUSTER <cluster>
The corresponding
CP server is not
available for the
specific <cluster>
Trying to get the

CORBA server for
createSession
Invalid value:
<value> for attribute:
<name>, comma
character is not
allowed here.
The userLabel of
TraceSession object
should not contain a
","(comma) symbol
XML Encoding
createSession
ERROR:
Unrecognised
callType
unrecognised
callType:
createTraceSession
DRAFT
$callType
...................................................................................................................................................................................................................................
NN-20500-030
8-20
WICL Facade
...................................................................................................................................................................................................................................
Message
ERROR:
Problem encountered
Cause
Context
Command
Can not activate

workorder file
createTraceSession
Can not read the

template file
createTraceSession
Max session number

reached on the
specified RC for the
specified sessionType
createTraceSession
Can not get cluster

information for
specified RC
createTraceSession
Can not create CM

session
createTraceSession
DRAFT
Error dictionary
to activate workorder
$woFile through
CM Session.\n
$exception
ERROR:
Reading the template
file
$TPL_LOCATIO/
$template.tpl
failed: $ex
ERROR:
o more
$sessionType
can be created on
\"$rnc\".
Max session number
reached
ERROR:
RC $rnc
in rncList
has no cluster
information\n
ERROR:
Got problem
when create
CM session for
TraceSession.\
$exception
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-21
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
ERROR:
workorder file
Cause
Context
Can not create the

workorder file
Command
createTraceSession
can not
be created
due to
DRAFT
$exception
The command is
failed: <errorStr>
<warningStr>
The SDO job failed

during execution
SDO jobs execution
createSession/
setOnline/reset/audit
Job with jobId: <job

ID> does not exist in
all the JobMgrs
Trying to supervise a
job which does not
exists in SDO job
management server
SDO jobs supervision
createSession/
setOnline/reset/audit
dbBackup failed.
<Corba exception>
CPUmts server failed

dbBackup on the E
CPUmts server
execution
dbBackup
Error: This
Operation: dbBackup,
apply only for: RC
BTSEQUIPMET
Trying to use
dbBackup command
on E other than
"RC" or
"BTSEquipment"
dbBackup
Error: The E has no

cluster information
Cannot get the cluster

with which the E
enrolled
E information
retrieving
dbBackup/dbRestore/
dbBackupRS/
dbRestoreRS
Error: This
Operation:
dbBackupRS, apply
only for RC
Apply dbBackupRS
command to wrong
Distinguished ame
type
dbBackupRS
Cannot get associated

BTSEquipment for
<nodeB>
Cannot Get
Associated
BTSEquipment for a
ode B
dbBackupRS/
dbRestoreRS
execution
dbBackupRS
dbRestore failed.
<Corba exception>
CPUmts server can

not successfully
perform dbRestore on
the E
CPUmts server
execution
dbRestore
dbRestoreRS
...................................................................................................................................................................................................................................
NN-20500-030
8-22
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Error: o Available
files for <D.>, only
directory existed.
Cannot find a DFS

file with correct name
in the DFS path
specified by the user
DFS file validation
dbRestore
File system <prefix>

is not supported in
this version
The DFS file

does not begin with
dfs: or a path
separator
DFS file validation
dbRestore
The file <dfsFile>

does not exist in DFS
file system
The DFS file

does not exists
DFS file validation
dbRestore
Error: o Available
files for <D.> can
be used for
dbRestore.
Cannot find any file

in the DFS path
DFS path validation
dbRestore
Error: invalid path

"<dfs path>", check
Es userLabel.
The DFS path to

dbRestore command
is not valid
DFS path validation
dbRestore
Error: This
Operation: dbRestore,
apply only for: RC
BTSEQUIPMET
Trying to use the

dbRestore command
on E other than
"RC" or
"BTSEquipment"
dbRestore
Error: Only userLabel

key is supported for
dbRestore command
Using a key other

than "userLabel" to
execute the dbRestore
command
dbRestore
Error: This
Operation:
dbRestoreRS, apply
only for RC
Applying
thedbRestoreRS
command to the
wrong Distinguished
ame type
dbRestoreRS
ERROR:
Cannot find the

specified
TraceSession into the
ROC
TraceSession
$userLabel
Context
Command
DRAFT
Error dictionary
deleteTraceSession
does not exist
...................................................................................................................................................................................................................................
NN-20500-030
8-23
DRAFT
into the ROC
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
ERROR:
Problem encountered
Cause
Context
Command
Can not activate

workorder file
deleteTraceSession
Can not create CM

session
deleteTraceSession
Can not create the

workorder file
deleteTraceSession
to activate workorder
$woFile throug
CM Session.
\n $exception
ERROR:
Got problem
when create
CM session
for TraceSession.
\n $exception
ERROR:
Workorder file
can not be
created
due to
DRAFT
$exception
Permission is not
right: <permission>
The permission of
operating files is not
valid
DFS::open/
DFS::close
Syntax error: <FD>

download -version
<softVer>
Syntax error of
download command
download
Cannot handle
<command> to the
class <class> : <D
name>
Syntax error of BTS

upgrade commands
download/activate/
fallback
Internal error: cannot

match <command>
with existing
methods: download,
activate or fallback
Syntax error of
upgrade commands
download/activate/
fallback
Exception caught:
<exception>
Upgrade IDL server

failed
Upgrade execution
download/activate/
fallback
...................................................................................................................................................................................................................................
NN-20500-030
8-24
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Invoke upgrade IDL

server failed
Upgrade execution
download/activate/
fallback
End probative failed.

<exception>
Calling or executing
upgrade IDL server
failed
End probative
execution
endprobative
File <fileame> does

not exist in DFS file
system
The DFS file does not

exist
Exec the DFS file

which does not exist.
exec
File does not exist in

local file system:
/opt/nortel/data/wicl/
tmp
The file does not exist
Exec the local file

which does not exist
exec
<exception>
Execute the content

of file fails
File execution
exec
The input cluster

<argValue> cannot be
found in ROC.
The variable value is

an invalid cluster.
Cluster id validation
FMK::checkArgs
Error during execute

shell script
/opt/nortel/shell/
sysmgt/wam_
softwaremarker.sh
Execution of shell
script failed
Using the shell to

retrieve the local
software mark
FMK::GetLocalSoftwareMarker
Error: The shell script

/opt/nortel/shell/
sysmgt/wam_
softwaremarker.sh
does not exist!
The shell script does

not exist.
Using the shell to

retrieve the local
software mark
FMK::GetLocalSoftwareMarker
Error during execute

GetListOfCluster
FMK::getlistofclusters failed
Using
FMK::getlistofclusters to retrieve all
cluster information
FMK::GetServerInRoc
Get session ID
failed.<exception>
The FMK sessionid

service failed
Using the FMK

sessionid service to
get an unique Id
FMK::GetSessionId
Error: no supported
server exists in ROC,
or the cluster name
<clusterame> is
unknown
one of marker
information is
retrieved
The marker
information is empty
FMK::GetSoftwareMarker
...................................................................................................................................................................................................................................
NN-20500-030
8-25
DRAFT
<Command> failed.
<exception>
DRAFT
Error dictionary
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Error while getting

software marker on
<hostType>
::session::Session
failed
Use ::session::Session
to execute
FMK::getlocalsoftwaremarker in
specified server
Error: Cannot get the

server list in ROC
FMK::getserverinroc
failed
Use
FMK::getserverinroc
to retrieve all the
server information
Error: no cluster
information found in
ROC
Get nothing by
FMK::getserverinroc
Using
FMK::getserverinroc
to retrieve all the
server information
Procedure <proc
name> is not known
The procedure name

is not found in
internal FMK::procs
database
Get the standard

name of the specified
proc
FMK::GetValidProc
This command was

never supported for
internal traces.
The FMK::Trace is
launched for internal
trace.
Calling the procedure

for internal trace
FMK::Trace
::Corbatcl::trader
service does not exist.
Checking whether the

CORBA tcl service is
available before
launching it to
retrieve the
corresponding trader.
FMK_RocTrader
For activate WICL

internal traces, use
the Preside way.
Change the trace
level via Preside for
the cli_controller.x
task. This change will
modify all cli_engine
trace level, and each
engine will write
WICL traces in his
trace file
DRAFT
The trader service is

not available in
WICL
...................................................................................................................................................................................................................................
NN-20500-030
8-26
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
umber of
parameters for Roc
Trading has to be
pair: <argument>
The number of
arguments is not valid
FMK_RocTrader
The trader service is

not disponible in
WICL
::Corbatcl::trader
service does not exist.
Check whether the

CORBA tcl service is
available before
launch it to retrieve
the corresponding
trader.
FMK_Trader
invalid command
name <method>
The specified
command is unknown
Check if the specified

command is an valid
command for WICL
general
Error: There are more

than 1 instance of this
OAM object.
The user did not

appoint a specified
cluster for objects
which have more than
one instance
Getting instances of
an object
general
Invalid Distinguished
ame in:
<arguments>.
Comma character
cannot be contained
in Distinguished
ame
Distinguished ame
string error
general
The command <

<command> > does
not exist in WICL
Command name error
general
The command <

<command> > is not
available for this
Distinguished ame:
<D wicl>
Command name error

for the given
Distinguished ame
general
Please use -cluster

option or use "setenv
default_cluster
<value>" to set a
default_cluster.
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-27
DRAFT
Error dictionary
DRAFT
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Cannot create Ran

Object because
not found for
CLUSTER <cluster
id>
Cannot find the

for the given cluster
RA object creation
general
Object creation
failed. <encode XML
attributes error>
Encode XML
attributes failed
RA object creation
general
Cannot delete Ran

Object because
not found
Cannot find
RA object deletion
general
Cannot delete Ran

Object <dn3gpp>
because the object is
not found
Cannot find the

object to be deleted
RA object deletion
general
The name of the

attribute is not in the
XML Stream
The attribute XML

string does not
contain the name of
the attribute
XML Decoding
get*, set*, display
The class name or

Distinguished ame
is not in the XML
Stream
The XML string does

not contain the class
or Distinguished
ame
XML Decoding
get*, set*, display
Object attributes
retrieval failed.
<Corba exception>
CPUmts server
cannot return the
attribute of a E
Trying to get the

attribute value of a
E, or to display all
the attribute of a E
get/getAll/display/
getAttributes
Attribute not found

for RA Object
<D.>
The attribute name

entered does not
exists
Trying to get a
attribute value which
does not exists on the
E
get/getIC
Syntax Error: E
type <rootClass>
The E entered is not

supported
Constructing the
request to retrieve the
alarm
getAlarms
ObjectClassIdType
not known:
<objectClassIdType>
Unknown
objectClassIdType
Decoding attributes
getAlarms
...................................................................................................................................................................................................................................
NN-20500-030
8-28
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
The attribute value

has not the right
format
(YYYYMMDDhhmmssZ):
<AttributeValue>
The time format for

the alarm is not
correct
Decoding data and

time of alarm
getAlarms
thresholdInfo is not
implemented
Function for decoding

thresholdInfo is not
implemented
Decoding
thresholdInfo
getAlarms
The type <type> is

not found as
ObjectIdType
Unknown type name
Getting object id
class
getAlarms
The type
<attributeType> is
not found as
AttributeIdType
Unknown attribute
type
Getting object
instance name
getAlarms
The parameter
eventtimebegin has
not the right format
(YYYYMMDDhhmmss or
YYYYMMDDhhmm): <value>
Wrong beginTime
entered for
GetAlarms
Parsing arguments for

GetAlarms
getAlarms
The parameter
eventtimeend has not
the right format
(YYYYMMDDhhmmss or
YYYYMMDDhhmm): <value>
When user inputs

error endTime for
GetAlarms

GetAlarms
getAlarms
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-29
DRAFT
Error dictionary
DRAFT
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Wrong eventType
This eventType
entered for
<value> is not
GetAlarms
known, use instead:
qualityOfServiceAlarm,
communicationAlarm,
environmentalAlarm,
processingErrorAlarm,
equipmentAlarm,
attributeValueChangeEvent,
objectCreationEvent,
objectDeletionEvent
or stateChangeEvent
Context
Command

GetAlarms
getAlarms
This parameter
<type> is not correct
for this method.
Check the help
The parameter
entered is not
supported by
GetAlarms

GetAlarms
getAlarms
The alarm parameter

has not the right
format
(YYYYMMDDhhmmss): <value>
The time format is

not correct.
Parsing the alarm

returned by server
getAlarms
Error while getting

alarm list from
FMBB: <Exception
Message>
Any exception is
thrown when
retrieving iterator
proxy
Retrieving iterator
proxy
getAlarms

XML attributes
description stream
Decoding the XML

attributes description
stream failed
XML Decoding
getAttributes,
getDescription
The type of the

XML Stream
The XML string does

not contain a type for
the ATOMIC tag
XML Decoding
getAttributes,
getDescription
The classname or
version is not in the
XML Stream
The XML string does

not contain a
classname for the
CLASSDEF tag
XML Decoding
getAttributes,
getDescription
The enumname of the

XML Stream
The XML string does

not contain an
enumname for the
EUM tag
XML Decoding
getAttributes,
getDescription
...................................................................................................................................................................................................................................
NN-20500-030
8-30
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Get attribute
description failed.
<Corba exception>
Cannot retrieve the

description of the
attributes of the E
CPUmts server
execution
getDescription
Syntax error: <FD>

getDescription
<attributeame> tab
-cluster
<clusterame>
Syntax error in
command line. Must
provide at least the
attribute name and an
output variable
getDescription
o information for
this Distinguished
ame: <D name>
Cannot get a
description of the
specific
Distinguished ame
XML Decoding
getDescription
The attribute
<attribute name> is
not found for FD:
<D name>
The specific attribute

does not belong to the
specified
Distinguished ame
XML Decoding
getDescription
<exception>
CORBA call failed

with an exception
CORBA call failed
getDescription,
create, createSession
I&C parameters
retrieval failed.
<Corba exception>
Cannot get the I&C

parameter through
CPUmts server (Link
state error, CPUmts
server down, etc.)
CPUmts server
execution
getIC/getAllIC
Get state change

failed. <check and get
Distinguished ame
operator exception>
Checking and getting

the Distinguished
ame operator failed
Getting state change
getStateChange
Cannot retrieve the

stateChange server
check SMC console
Calling stateChange
server failed
Invoking stateChange
server
getStateChange
Error : Beginning
date must be before
the end Date
From date is anterior

to To date
getStateChange
<option> param must

on command
An option has been

entered several times
getStateChange
DRAFT
Error dictionary
Error option <option>

must be present only
once
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-31
DRAFT
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Error <value> is not

defined for <option>
filter
The value entered is

not correct
getStateChange
o value entered for

<option> param
o value provided for

an option
getStateChange
otification id must
be an integer
otification id
parameter is not an
integer
getStateChange
Cannot find value

<parameter> for
<status string>
Parameter error
getStateChange
Cannot find field

<field name>
Parameter error
getStateChange
This part of command

is not recognized
:<command>
Parameter error
getStateChange
<parsing time data

error>
Parsing user
parameter failed
getStateChange
From Date filter

value is not valid
Parsing user
parameter failed
getStateChange
To Date filter value is

not valid
Parsing user
parameter failed
getStateChange
Error : Cannot get

state change
notification for period
larger than 8 days
The duration between

From date and To
date is higher than 8
days
getStateChange
Error while accessing

to proxy information:
<D.>
CPUmts server can

not get the status of
the E
CPUmts server
execution
getStatus
Syntax error: <FD>

getStatus [-cluster
<clusterame>]
[-type <type>]
Syntax error in
command line, the
argument number is
not correct, or option
error
getStatus
Help for <command>

does not exist. Try to
use "Help search
<keyword>"
The help message for

a command does not
exist
help
...................................................................................................................................................................................................................................
NN-20500-030
8-32
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Syntax error for help

command.\n\tHelp
<helpCmd>\n\tHelp
search <keyword>
Syntax error of the

help command
help
info: bad option

<option>
The option of the

command is invalid
Using info command

with bad option
info
ot a valid class

name: <class>
User input an invalid

class for list
command
list
Error: This
Operation:
listDbBackup, apply
only for: RC
BTSEQUIPMET
Applying
listDbBackup
command to wrong
Distinguished ame
type
listDbBackup
Error: Only userLabel

key is supported for
listDbBackup
command
The key entered is not

a userLabel key
listDbBackup
amespace: bad
option <option>
The option of the

command is not valid
Using the namespace

command with a bad
option
namespace
wrong args # should

be: "oam inventory
?-cluster name?"
The format of the

command is wrong
OAM
Only the "inventory"

operation is available
for OAM command
The subcommand for

OAM is invalid
OAM
Only the "-cluster"

option is available for
OAM command
There are
unsupported
arguments in the
parameters
OAM
File system
<fileSystem> is not
supported in this
version
The file system is not

known
DFS file/path
validation
open/exec/dir
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-33
DRAFT
Error dictionary
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Error while activating

passport <Passport
ame>. Changes
have not taken effect
in passport
After activating the

edit view, the
Provisioning Activity
attribute of the
Passport prov
component should be
waiting for
confirmation. If not,
this error is raised.
The Passport edit
view is not properly
activated.
In passport endprov
command, after the
activation of passport
view
Passport <Passport
ame> EndProv
passport <passport
name> prov Check
'Checkprov
commands should be
executed in
provisioning mode
'Check prov' in
operational mode
Passport <Passport
ame> EndProv
End prov command
Trying to run
'end prov ' in
operational mode
Passport <Passport
ame> EndProv
Only one session at a

time can be in
passport provisioning
mode.
Trying to enter
provisioning mode
while another session
is in provisioning
mode
Passport <Passport
ame> StartProv
Passport
backup/restore can
only take -log and -s
option. This error is
raised if the option
entered is not correct.
Syntax checking for

passport backup
command
Passport <PPame>
backup -s
/opt/nortel/data -log
passportbr.log -other
Command Failed:
You must be in
provisioning mode to
use this command.
Passport <passport
name> prov end
Command Failed:
should be executed in
provisioning mode
Passport <Passport
ame> Prov Check
You must be in
provisioning mode to
use this command.
Passport <passport
name> prov start
Command Failed:
Session mis Fmip
Session/11 (userid
MDMADMI) is in
provisioning mode.
DRAFT
Create command
syntax: Passport
<PP_name> backup
-log <logfile>
Command
Passport <Passport
ame> Prov End
Passport <Passport
ame> Prov Start
...................................................................................................................................................................................................................................
NN-20500-030
8-34
WICL Facade
...................................................................................................................................................................................................................................
Message
Syntax error: EM"
component should
not exist in WICL
Distinguished ame
Cause
EM is a passport root
object. It is not
required at WICL
level.
Context
Command
Syntax checking for

Passport command
Passport <PPame>
EM/<PPame> shelf
list card
DRAFT
Error dictionary
It should not exist in

Passport
Distinguished ame
at WICL level.
bad -timeout option
in the WICL
command
The -timeout value

should be numeric. If
not, this error is
raised.
Syntax checking for

-timeout option.
Passport <PPame>
prov start -timeout
11ab
These are the

available operations
in MDM Passports:
The command is not

recognized or it i's not
a passport-dedicated
command
Syntax Checking for

passport command
Passport <PPame>
Backup commit view

failure
Backup commit view
Passport <PPame>
backup
<objRef> Set
(attributeame
attributeValue)*
<objRef> Get [-p]
[-o] <attributeame>
<objRef> GetAll [-p]
[-o] <attributeTable>
<objRef> Delete
<objRef> Create
<objRef> list
<children/
componentType>
Error: unable to
backup commit view
<view name>
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-35
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Incorrect number of
parameters for the
Passport Declaration:
Passport <name>
declaration <IP
Addr> <Group
ame> (<cluster>)
(<enrollByAccess>)
The command syntax

for passport
declaration is:
Passport <PPame>
declaration <IP
Addr> <Group
ame> [cluster] [0|1].
So the number of
parameters should be
between 2 and 4.
Context
Command
Syntax checking for

passport declaration
Passport <PPame>
declaration
This error is raised if

the the number of
parameters entered
overcrossesthe limits.
Passport declaration
failed. <detailed error
message of corba>
Passport declaration
error raised by the
IT_MDM
controller.
Declaring passport
Passport <PPame>
declaration
47.153.152.11
FMGROUP
Option
enrollByAccess
should be 0 or 1
The command syntax

for passport
declaration is:
Passport <PPame>
declaration <IP
Addr> <Group
ame> [cluster] [0|1].
Syntax checking for

passport declaration
Passport <PPame>
declaration
47.153.152.11
FMGROUP
UMAISERV1
enrollebyaccess
Restoring commit
view
Passport <PPame>
restore
The last parameter

must be 0 or 1. If not,
this error is raised.
DRAFT
Error: unable to
restore commit view
<view name>
Restore commit view

failure
...................................................................................................................................................................................................................................
NN-20500-030
8-36
WICL Facade
...................................................................................................................................................................................................................................
Message
Syntax error: In get
command, "*" is not
allowed in
Distinguished ame
Cause
Get command cannot
be applied to
Multi-Distinguished
ame.
Context
Command
Syntax checking for

passport get
command
Passport <PPame>
shelf card/* get
adminState
DRAFT
Error dictionary
Multi-Distinguished
ame means
Distinguished ame
with "*". For example
Passport <PPame>
shelf card/* means all
cards in the shelf.
Syntax error: In list
children command,
"*" is not allowed in
Distinguished ame
List Children
command cannot be
applied to
Multi-Distinguished
ame.
Muti-Distinguished
ame means
Distinguished ame
with "*". For example
Passport <PPame>
shelf card/* means all
cards in the shelf.
Syntax checking for

passport list
command
Passport <PPame>
shelf card/* list
children
Attribute
<Attributeame>
does not exist in
Passport <Passport
ame>
The attribute name

does not exist
Passport Get
Command
Passport <PPame>
Shelf card/0 get abc
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-37
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Passport PFT Shelf
Card/5 display
Command Failed:
adminState =
unlocked
Cause
Passport CAS
Command failed. The
detail error
information returned
by the passport is
displayed.
Context
Run CAS command
but get error.
Command
Passport <PPame>
Shelf display
operationalState =
disabled
usageState = idle
availabilityStatus =
failed
proceduralStatus =
controlStatus =
alarmStatus = crit
standbyStatus =
notSet
unknownStatus =
false
currentLP =
failureCause =
cannotLoadSoftware
selfTestFault = none
sparingConnectionStatus =
notApplicable
hardwareAlarm =
none
insertedCardType =
6mPktServSP
productCode =
THW18BA-F01
pmRevisionCode =
THW19BA-D01
imRevisionCode =
/A
DRAFT
serialumber =
TM03508BR9
activeFirmwareVersion = RI42010
...................................................................................................................................................................................................................................
inactiveFirmwareVerAlcatel-Lucent Internal
NN-20500-030
sion = RI41063
8-38
memoryCapacity =
sharedMsgBlockCapacity = ? kbyte
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Syntax error when

executing the
passport display
command, which
means that more
options are provided
in the get command.
Syntax checking for

passport display
command
Passport <PPame>
Shelf display -a -b -c
Syntax error: Get

operation can take -o
or -p as parameters
Syntax error when

executing the
passport get attribute
command, which
means that more
options are provided
in the get command.
Syntax checking for

passport get
command
Passport <PPame>
shelf get -a -b -c
numberOfSlots
Syntax error:
getattributes
operation does not
take parameters
Getattributes
command cannot get
any parameters.
Syntax checking for

passport getattributes
command
Passport <PPame>
shelf getAttributes
abc
Passport
undeclaration failed.
<detailed error
message of corba>
passport
undeclaration
command
successfulbut error
returned from the
IT_MDM controller
Undeclaration
passport
Passport <PPame>
undeclaration
UMAISERV1
Incorrect number of
parameters for the
Passport
Undeclaration:
Passport <name>
undeclaration
(<cluster>)
Run passport
undeclaration
command with
incorrect parameter
number. It can only
take one optional
parameter.
Syntax checking for

passport
undeclaration
Passport <PPame>
undeclaration
UMAISERV1 abc
ITERAL ERROR:
The selected passport
<Passport ame> is
not declared into
MDM
The target passport is

not declared in the
ROC environment
Check whether
passport is declared
or not.
Passport Command
ITERAL ERROR:
The selected passport
<Passport ame> is
not declared into
server <server name>
The target passport is

not declared in the
target server
Checking whether
passport is declared
or not.
Passport Command
...................................................................................................................................................................................................................................
NN-20500-030
8-39
DRAFT
Syntax error: Display

operation can take -o
or -p as parameters
DRAFT
Error dictionary
DRAFT
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Any IT_MDM
services available in
the ROC. Check
SMC console
Cannot get MDM

Controller through
Trader Service
Connecting MDM
Engine.
Passport Command
Error while
connecting to MDM
for passport
<Passport ame>:
<detailed error
message of corba>
connectMDM method
invoked on MDM
Engine, but CORBA
error returned
Connecting MDM
Engine.
Passport Command
Get IT_MDM
engine
failed.<detailed error
message of corba>
Cannot get
IT_MDM engine
Disconnecting MDM
Engine
Passport Command
Free IT_MDM
engine failed.
<detailed error
message of corba>
Cannot free
IT_MDM engine
Disconnecting MDM
Engine.
Passport Command
Error while
disconnecting to
MDM for passport
<Passport ame>:
<detailed error
message of corba>
disconnectMDM
method invoked on
MDM Engine but
CORBA error retuned
Disconnect MDM
Engine...
Passport Command
Cannot find primary

Main server
When executing
passport backup, the
WICL facade cannot
find the primary Main
server in the roc
configuration file
Getting
UMAISER1 IP
address
Passport Command
Cannot retrieve any

cluster names : check
the
wam_topology.cfg
file
Cannot retrieve the

cluster name and the
ip in roc
configuration file
GetListCluster
Passport Command
There is no
connection with a
Passport to send
commands
Trying to send CAS

to passport, but
theIT_MDM engine
does not exist.
Sending CAS
command to passport
Passport Command
...................................................................................................................................................................................................................................
NN-20500-030
8-40
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Syntax error
passport ppbackup
SYTAX ERROR:
mandatory value for
parameter -s
Syntax error
passport ppbackup
SYTAX ERROR:
mandatory value for
parameter -cluster
Syntax error
passport ppbackup
SYTAX ERROR:
Only options -s, -log,
-force, -script,
-cluster are allowed.
Syntax error
passport ppbackup
SYTAX ERROR:
this operation can
only be applied on
RC, Aode or
I-ode.
Wrong Distinguished
ame type of
ppBackup/ppRestore
command, the type
could only be RC,
Aode or I-ode
ppBackup/ppRestore
Syntax error:
BTSEquipment
<bts_name> reset
[-cluster
<clusterame>]
[-type <reset_type>]
Syntax error of reset

command
Reset
This type of reset is

not known. Use
instead: WholeBts,
ActiveCcm or
PassiveCcm
Unknown reset
command type
Reset
Reset failed.
<exception>
Reset or resetMib
failed
Reset or resetMIB
operation
reset/resetMib
This parameter is not

available in ROC
command. See help
ROC to know the
available parameters
The parameter for

ROC list is not valid
ROC
Only the "list"

operation is available
for ROC command
The subcommand for

ROC is not valid
ROC
...................................................................................................................................................................................................................................
NN-20500-030
8-41
DRAFT
SYTAX ERROR:
mandatory value for
parameter -log
DRAFT
Error dictionary
DRAFT
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
State not known
The SDO state

entered is not valid
Checks if the SDO

state value defines
that the job is end or
not
SDO::callback
Delete SDO job

failed. <exception>
Delete SDO jobs

failed
Using the SDO

service to delete an
job
SDO::deleteJob
SDO server is not

initialized
The SDO::server does

not exist
Using the SDO

service with the SDO
not initialized.
SDO::getFollowUp
TIMEOUT attempt
waiting the job to
finishes and the job
has been cancelled.
The time limit is

reached: SDO::timer
and SDO::nbretrymax
SDO supervision
SDO::JobSupervisor
TIMEOUT attempt to
wait for the job to
finish and job
cancellation failed
due to <exception>
The SDO cancellation

failed
Using the SDO

service to cancel an
job
SDO::JobSupervisor
The
SDO::setbRetry
command does not
exist. Use instead the
setMaxTimeout
command
The SDO::setnbretry
is launched.
The SDO::setnbretry
is launched.
SDO::setbRetry
Internal error: cannot

know in which
controller the engine
is: <engine>
Getting the controller

of a engine failed
Free engine
Session
Cannot find a
cli_controller in
trader
Cannot find a
controller
Get engine
Session
Cannot find a
cli_controller in
trader for
CLUSTER=<cluster>
Cannot find a
controller for a
specific cluster
Get engine
Session
Cannot get an engine

from the controller
<controller>
Cannot get an engine

from a controller
Get engine
Session
...................................................................................................................................................................................................................................
NN-20500-030
8-42
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
Syntax error of
Session command
Session
Syntax error of
Session command
SessionId [-c
clusterId] exec body
Internal error: Cannot

get attribute Id from
Distinguished ame:
<D.>
Internal RA model

data error, cannot find
a key for the E
Trying to update the

attribute of a E, but
the key name of the
E cannot be found
in the RA model
Set
Cannot handle in
XML the
<command> type
The attribute type is

not supported by
XML
XML Encoding
set*
Bad number of
parameters for the
operation SET:
<arguments>
The number of input

parameters for set*
command is not even
(can not be
recognized as an
attribute value pair)
XML Encoding
set*
Union type must have

a discriminator type
and the value:
<values>
The format of Union

type in XML is not
correct
XML Encoding
set*, create,
createSession
Object update failed.

<Corba exception>
CPUmts server
cannot successfully
update the attribute of
a E (ew value type
error, attribute is
read-only, CPUmts
server down, etc.)
CPUmts server
execution
set/setIC/setOnline
Command syntax
error. Parameter
<option> is not
known
DRAFT
Error dictionary
Session [-c clusterId]

exec body\nSession
[-c clusterId] new
Command syntax
error. Parameter
<option> is not
known
SessionId [-c
clusterId] exec body
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-43
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Command
Invalid env variable

name: <varame>
The variable name

does not exist
default_cluster
environment
manipulation
setEnv
o cluster has the

name as <varValue>
The variable value is

an invalid cluster
default_cluster
environment
manipulation
setEnv
Syntax Error: the

parameter should be 0
or 1.
Wrong parameter
entered for
setFmbbCache
Parse arguments for

setFmbbCache
setFmbbCache
FAILED
SDO jobs finished

with status "FAILED"
SDO jobs execution
setOnline
Internal Error: Type

<type> is not known
Passing error types

internally
Passing error types

internally
Should not be called
utran
Syntax error in
Only the "list",
command line. An
"getuserlabelrdnidmapping",
unknown operation
"ppBackup" and
name was
"ppRestore"
operation is available encountered in the
"utran" command
for the utran
command
DRAFT
Context
getEnv
This option <option

name> is not
available in utran
command. Available
options are: -cluster,
-errStr, -mapTab
Syntax error in
command line. An
unknown option
name was
encountered
utran
This parameter
<parameter name> is
not available in utran
command. See help
utran to know the
or other related helps:
oamlinkbreaks,
alldesynchro,
necriticalalarms
Syntax error in
command line. An
unknown parameter
name was
encountered in "list"
operation of "utran"
command
utran
...................................................................................................................................................................................................................................
NN-20500-030
8-44
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
This parameter
<type> is not
available in utran
command. See help
utran to know the
Syntax error in
command line. An
unknown parameter
name was
encountered in
"getUserLabelrdnIdMapping" operation
of "utran" command
utran
Lack of Serverame:
should be: -cluster
Serverame
Syntax error in
command line. Must
provide a cluster
name after "-cluster"
option
utran
o error message
variable was given
for -errStr option
Syntax error in
command line. Must
provide an output
variable name after
"-errStr" option
utran
o mapping table
variable was given
for "-mapTab" option
Syntax error in
command line. Must
provide an output
variable name after
the "-mapTab" option
utran
Error: "-mapTab"
option can only be
used for
getuserlabelrdnidmapping cmd
Syntax error in
command line. The
"-mapTab" option is
only applicable to the
"getUserLabelrdnIdMapping" operation
of the "utran"
command
utran
Syntax error: utran

getUserLabelrdnIdMapping
{RC|BTSEquipment}
-maptab outputTable
Syntax error in
command line. The
"-mapTab" option is
only applicable to the
"getuserlabelrdnidmapping" operation
of the "utran"
command
utran
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-45
DRAFT
Error dictionary
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
OMCR/B is not
installed. See ROC
list children
command
access_primary group
was not properly
started
Trying to execute the

utran command
before a specific
process was started in
the access_primary
group
utran
Cannot get role/host

information in the
ROC configuration
The ROC
configuration file
/opt/nortel/config/
sysmgt/wam_
topology.cfg does not
exists, or the file was
not properly
formatted
Trying to list root

objects in utran
through the
utran
utran list
command, or list all

the desynchronized
E through the
utran list
alldesynchro
DRAFT
command
Cannot connect to
server
ot any CPUmts

server in the ROC can
successfully return a
root objects list of the
required E type
CPUmts server
execution
utran list
Object navigation
failed. <Corba
exception>
Cannot get the

children class name
of a E, or cannot get
the children objects
of a E
Trying to list the

content of a E of
which version is not
supported, or the
CPUmts server is
down
utran/dbBackupRS/
ppBackup
'<variable name>'
isn't an array
Executing wicl_array
command failed
WICLET execution
wicl_array
Cookies must be set

from within
wicl_http_head.
Cookies are not set

from within
wicl_http_head
WICLET execution
wicl_cookie_set
An internal error was

detected in the
service software. The
diagnostics are being
emailed to the service
system administrator
<WICL administrator
email>
Executing wicl_eval
command failed
WICLET execution
wicl_eval
...................................................................................................................................................................................................................................
NN-20500-030
8-46
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
wicl_file_button
requires that
wicl_form have the
argument
enctype=multipart/
form-data
Argument "enctype"
missing, when it is
necessary
WICLET execution
wicl_file_button
<Error message>
Executing
wicl_http_head/wicl_
buffer/wicl_body
command failed
WICLET execution
wicl_http_head
Your browser
generated a
content-length of -1
during a POST
method.
COTET_
LEGTH is -1 when
executing a POST
command
WICLET execution
wicl_input
Your browser failed

to generate the
content-length during
a POST method.
Environment variable
COTET_
LEGTH does not
exist when executing
a POST command
WICLET execution
wicl_input
<Wrong answer
messages>
Socket connection
error
Mail send operation
wicl_mail_end
wicl_pragma must be
set from within
wicl_http_head.
Executing
wicl_pragma
command failed
WICLET execution
wicl_pragma
wicl_refresh must be
set from within
wicl_http_head. Try
using
wicl_http_equiv
instead.
Executing
wicl_refresh
command failed
WICLET execution
wicl_refresh
When selecting
multiple options,
select variable must
end in "List" to allow
the value to be
recognized as a list
when it is processed
later.
Parameter error of
wicl_select
wicl_select
DRAFT
Error dictionary
wicl_buffer
wicl_body
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-47
DRAFT
Error dictionary
WICL Facade
...................................................................................................................................................................................................................................
Message
Cause
Context
Command
wicl_target must be
set from within
wicl_http_head.
Executing wicl_target
command failed
WICLET execution
wicl_target
Parameter <param>
not defined in config
file: <configFile>
Unknown parameter
name
Retrieving the value

of a parameter which
has to be stored in the
config file
WICLConfigGetValue
Error while reading

the config file
<configFile>:
<exception>
Error while reading

the config file
Opening the
configure file
WICLConfigInit
<filename> cannot be
used as a trace file
The filename entered

is an invalid log file
WICLTraceInit
The parameter is not

known: <argument>
More than one

argument entered
WICLTraceInit
WICL Facade warning messages
DRAFT
Message
Cause
Context
Command
Warning: Cannot
contact any FMBB
Services. Maybe All
servers are Down.
cmXML service does

not run
Retrieve trader
getAlarms
Warning: unable to
backup current view
<view name>
Backup current view

failure
Backup current view
Passport <PPame>
backup
Warning: unable to
backup edit view
<view name>
Backup edit view

failure
Backup edit view
Passport <PPame>
backup
Warning: unable to
restore current view
<view name>
Restore current view

failure
Restore current view
Passport <PPame>
restore
Warning: unable to
restore edit view
<view name>
Restore edit view

failure
Restore edit view
Passport <PPame>
restore
...................................................................................................................................................................................................................................
NN-20500-030
8-48
WICL Facade
...................................................................................................................................................................................................................................
Message
Warning: This WICL
script expects to run
with uid '<user ID>'.
However, this script
is running as
'<current ID>'.
Cause
Illegal user ID
Context
User ID validation
Command
wicl_uid_check
DRAFT
Error dictionary
WICL Facade information messages

Message
Context
Command
The command is cancelled
SDO jobs execution
createSession/setOnline/
reset/audit
Ignore
WICLET execution
wicl_debug
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-49
DRAFT
Error dictionary
WICL Client
...................................................................................................................................................................................................................................
WICL Client
The WICL Client generates the following message types:
WICL Client error messages (p. 8-50)

WICL Client warning messages (p. 8-51)
WICL Client error messages

Message
Cause
Context
File ot Found <error

message>
The file entered to be checked

cannot be found
Checking WICLET mode
Fatal error
I/O exception returned during

interactive authentication
Interactive authentication
Error:<bad command format

error message>
Bad command format exception

returned
Invoking WICLSH
Syntax wiclsh [-check file*]

[-u login [-p password [-m
workingMode] [-f file
[--params]] [-c command]]]
Syntax error when using
Invoking WICLSH
WICLSH
(The workingMode can be

either "default" or "backup")
File contains unbalanced Tags
Cannot find the end tag or a
Parsing WICLET files
DRAFT
begin tag
I/O error when creating temp

file: <error message>
I/O error when creating a temp

file
Parsing WICLET files
Unable to request wicl server:

Check SMC console please
Exception returned when

requesting a WICL server
Requesting a WICL server
Problem when reading script

file
I/O exception returned when

reading script files
SDO script evaluation
Config file is corrupted

<exception>
URL configuration file failed
Trying to redirect to an
error page in WICLET
execution
<Serverlet exception>
Redirecting to a URL failed
Trying to redirect to an
error page in WICLET
execution
Wrong # args: should be

'<command strings> <correct
parameters>'
Incorrect parameter number for

the TCL command
Using basic TCL

commands
...................................................................................................................................................................................................................................
NN-20500-030
8-50
WICL Client
...................................................................................................................................................................................................................................
Message
Cause
Context
<TCL exception>
Incorrect parameter value of a

basic TCL command
Using basic TCL

commands
Unexpected error
Unexpected error when

manipulating string
Command entered in
WICL client
WICL client login
I/O Error <IO exception>
I/O error occurred when getting

the file content; this error is part
of the bad command format
exceptions
WICL script execution
Bad command format : '--'

needed to pass parameter
'--' missing before the

parameters while invoking
WICL through WICL scripts;
this error is part of the bad
command format exceptions
WICL script execution
Unable to open a wicl session :

Check SMC console please
Exception returned when

initializing a WICL session
WICL session initiation
Session is invalid : Please open

a new WICL session
WICL session is not valid
WICL session
management
Cause : ot connected to

server.\n\nHint : try again
Corrupted engine found
WICLET execution
Error type : Maximum web

users reached.\n\nHint : try to
reconnect later.
Max number of Web clients

reached
WICLET login process
Cause : on authenticated

user.\n\nHint : Close your
current browser session and
open a new one.
Session is not valid when

executing WICLET scripts
WICLET scripts execution
<Applicative exception>
WICLET server path or file

does not exist
WICLET server file

validation
DRAFT
Error dictionary
WICL Client warning messages

Message
Cause
Context
Time out when login
WICL client login
Your user session has been

Administrator
WICL session has been ended

by the Security Administrator
WICL session is destroyed
...................................................................................................................................................................................................................................
NN-20500-030
8-51
DRAFT
Timeout when login
DRAFT
DRAFT
Error dictionary
WICL Client
...................................................................................................................................................................................................................................
Message
Timeout: Your session expired
(session inactive for more than
30 mn). Please open a new
WICL session.
Cause
WICL session expired
Context
WICL session
management
...................................................................................................................................................................................................................................
NN-20500-030
8-52
WICL Scripts
...................................................................................................................................................................................................................................
WICL Scripts
DRAFT
Error dictionary
The WICL scripts generate the following message types:
WICL scripts error messages (p. 8-53)

WICL scripts information messages (p. 8-60)
WICL scripts error messages

Message
o parameters from
command-line.
Syntax:
Cause
o parameters
entered in the comand
line
Context
Script
GetBtsIC.wcl
execution
cmXML
./wiclsh -u
<username> -p
<password> -f
<scriptfilePath> --f.ile
<exportfileame>
[-dn <FD>]
[-comp.ressed]
[-r.eport
<reportfile>]???Parameter:
exportfileame:
exported DFS file
path
FD: list of
BTSEquipment
compressed: Enable
to compress the
generated file
reportfile: export
IandC report DFS file
path
Cannot find the
specified filter: <filter
id>
Cannot find the

specified filter
configExtractor.sh
execution
Config extractor
Access Error: <error

message>
Accessing a file
failed
configExtractor.sh
execution
Config extractor
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-53
DRAFT
DRAFT
Error dictionary
WICL Scripts
...................................................................................................................................................................................................................................
Message
Cause
Context
Script
The filter file has a

physical root error
The filter data

structure does not
have a root
configExtractor.sh
execution
Config extractor
The filter include

circle, that is invalid.
The filter include

circle, which is
invalid.
configExtractor.sh
execution
Config extractor
The filter include id:

<child name> that
does not exist.
The filter includes an

id that does not exist
configExtractor.sh
execution
Config extractor
Syntax Error: <error

message>
Syntax error of
configExtractor.sh
configExtractor.sh
parameter validation
Config extractor
Error while releasing

the key: <key>
Cannot release the

lock
commonServices_wicl_ Passport Backup &

Restore
post_backup.sh
execution
***ERROR ***
cannot connect to
primary Main server,
maybe it is down,
backup will be
stopped
Cannot connect to the

primary Main server.
It may be down.

Restore
pre_backup.sh
execution
***ERROR ***
Internal errors
occurred, backup will
be stopped
Internal errors have

occurred

Restore
pre_backup.sh
execution
***ERROR ***
Unknown errors has
occurred, backup will
be stopped
Unknown errors have

occurred

Restore
pre_backup.sh
execution
***ERROR ***
WICL service is
running, backup will
be stopped
WICL service is
running

Restore
pre_backup.sh
execution
Action failure:
<exception>
Connection to
WICLSH failed
PPView_backup_
restore.sh execution
Passport Backup &

Restore
The common
configuration file
does not exist: <file
name>
The common
configuration file
does not exist
PPView_backup_
Passport Backup &

Restore
...................................................................................................................................................................................................................................
NN-20500-030
8-54
WICL Scripts
...................................................................................................................................................................................................................................
Message
Cause
Context
Script
An unexpected error
occurred while
reading the common
config file
PPView_backup_
Passport Backup &

Restore
Option <argument> is
not recognized
Unrecognized option
PPView_backup_
restore.sh
Passport Backup &

Restore
o input parameters
provided, please refer
to usage :
o input parameters
provided
POC
Iub_PP7K4.1_DropInsert_
Spvc_Msa32.wcl
execution
Error: UMTS odeB

must be configured
for at least 12 E1
timeslots, please
Check "-droppedTs"
parameters
The parameter after

"-droppedTs" should
have at least 12 E1
timeslots
POC
Spvc_Msa32.wcl or
Spvc_Msa32.wcl
execution
Error: UMTS odeB

must be configured
for at least 12 E1
timeslots, please
Check "-droppingTs"
parameters
The parameter after

"-droppingTs" should
have at least 12 E1
timeslots
POC
Spvc_Msa32.wcl or
Spvc_Msa32.wcl
execution
Error: cannot find

AtmIf associated with
odeB: '<nodeB>' on
Poc '<POC name>'
Cannot find AtmIf

associated with
odeB
Iub_PP7K4.1_Spvc_
Msa32Stm1.wcl or
Iub_PP7K5.2_Spvc_
Msa32.wcl execution
POC
Cannot retrieve
holdingPriority Value
Cannot retrieve the

holdingPriority Value
Iub_PP7K5.2_Spvc_
2pSTM1.wcl
execution
POC
-addLinks or
-deleteLinks must be
set:
-addLinks or
-deleteLinks is not set
POC parameter
validation
POC
AtmIf id is a
mandatory parameter
for Manual mode
AtmIf id is missing
POC parameter
validation
POC
Cannot extract atmIf

Id for dropped
odeB or dropping
odeB
Cannot extract atmIf

Id for dropped odeB
or dropping odeB
POC scripts
execution
POC
...................................................................................................................................................................................................................................
NN-20500-030
8-55
DRAFT
Some unexpected
error has produced
during the reading of
the common config
file <file name>,
check it: <exception>
DRAFT
Error dictionary
DRAFT
DRAFT
Error dictionary
WICL Scripts
...................................................................................................................................................................................................................................
Message
Cause
Context
Script
Cannot extract
AtmIfId from
<atmif>
Cannot extract
AtmIfId from an
atmif
POC scripts
execution
POC
Cannot extract id
value from
Distinguished
ame:<D name>
Cannot extract the id

value from
Distinguished ame
name
POC scripts
execution
POC
Cannot extract IMA

Group Id from
<variable>
Cannot extract IMA

Group Id
POC scripts
execution
POC
Cannot extract lp id
from <atmIfLabel>
Cannot extract lp id
POC scripts
execution
POC
Cannot extract nodeB

name from
<correlation tag>
Cannot extract nodeB

name
POC scripts
execution
POC
Cannot extract slot id

from <atmIfLabel>
Cannot extract slot id
POC scripts
execution
POC
Cannot retrieve
<attribute> on vcd tm
Attributes
Cannot retrieve an
attribute on vcd tm
Attributes
POC scripts
execution
POC
Cannot retrieve AtmIf

from This value :
<value>
Cannot retrieve AtmIf

from a given value
POC scripts
execution
POC
Cannot retrieve
calledAddress from
<vcc>. Check your
<I name>
configuration
Cannot retrieve
calledAddress
POC scripts
execution
POC
Cannot retrieve
calledVpiVci on src
attributes
Cannot retrieve
calledVpiVci on src
attributes
POC scripts
execution
POC
Cannot retrieve
correlationTag on
<vcc Inode> vcd
attributes
Cannot retrieve
correlation tag on an
vcd attributes
POC scripts
execution
POC
Cannot retrieve
correlationTag on vcd
attributes
Cannot retrieve
correlation tag on vcd
attributes
POC scripts
execution
POC
...................................................................................................................................................................................................................................
NN-20500-030
8-56
WICL Scripts
...................................................................................................................................................................................................................................
Message
Cause
Context
Script
Error: cannot find

AtmIf associated with
odeB '<nodeB>' on
POC side
Cannot find the AtmIf

associated with
odeB
POC scripts
execution
POC
Cannot find key

<value> from config
file
Cannot find the key

from the config file
POC scripts
execution
POC
Error: cannot get

interfaceame
attribute from
passport <pocame>
lp/<lp Id> ima/<ima
Id> sub-components
Cannot get the

interface name
attribute
POC scripts
execution
POC
Error cannot load Poc

library: <error
message>
Cannot load the POC

library
POC scripts
execution
POC
cannot progress IMA

addLinks/deleteLinks
on none IMA case
Cannot progress IMA

addLinks/deleteLinks
on any IMA case
POC scripts
execution
POC
IMA is not used,

nbPcm or size of e1
shouldn't be larger
than 1
IMA is not used,

nbPcm or size of e1
should not be larger
than 1
POC scripts
execution
POC
getextAtmIf Proc,
get result: k:<value>
>3, invalid
K value of
getextAtmIf proc is
invalid
POC scripts
execution
POC
parseAtmIfId proc:
atmif:<atmif>, get
result k:<k value> >3,
invalid
K value of
parseAtmIfId proc is
invalid
POC scripts
execution
POC
-LpId value must be

set in manual option
-LpId value is not set

in manual option
POC scripts
execution
POC
-LpId value must be

1,3,5,7,9,11,13
-LpId value is not in

{1,3,5,7,9,11,13}
POC scripts
execution
POC
Mandatory parameter
<variable> is missing
A mandatory
parameter is missing
POC scripts
execution
POC
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-57
DRAFT
Error dictionary
DRAFT
DRAFT
Error dictionary
WICL Scripts
...................................................................................................................................................................................................................................
Message
Cause
Context
Script
Mandatory parameter
of manual option
'<variable>' is
missing
A mandatory
parameter for the
manual option is
missing
POC scripts
execution
POC
nbPcm is used only

after -withIMA is set
to true
nbPcm is used before

-withIMA is set to
true
POC scripts
execution
POC
o AtmIf Uni Side

etwork on Passport
<I name>
o AtmIf Uni Side

etwork on Passport
POC scripts
execution
POC
RC: o Source
SPVCs associated
with odeB <name>
found on I-ode.
Check your VCCs
correlationTags
o Source SPVCs
associated with a
odeB
POC scripts
execution
POC
-poc and -nb must be

activated for remove
action
-poc and -nb are not

activated for the
remove action
POC scripts
execution
POC
-SdhPortId value
must be set in manual
option
-SdhPortId value is
not set in the manual
option
POC scripts
execution
POC
In auto mode,
'<variable>' shouldn't
be set:
A variable should not

be set in auto mode
POC scripts
execution
POC
-SS option value

must be TRUE or
FALSE
-SS option value is

not TRUE or FALSE
POC scripts
execution
POC
The size of e1List

should equals nbPcm
The size of e1List

does not equal nbPcm
POC scripts
execution
POC
The size of vc12list

should equals nbPcm
The size of vc12list

does not equal nbPcm
POC scripts
execution
POC
Mode <mode> is not

known :
Unknown mode
parameter
POC scripts
execution
POC
Parameter
<argument> not
known
Unknown parameter
POC scripts
execution
POC
Parameter not known

<argument>
Unknown parameter
POC scripts
execution
POC
...................................................................................................................................................................................................................................
NN-20500-030
8-58
WICL Scripts
...................................................................................................................................................................................................................................
Message
Cause
Context
Script
Syntax Error:
variable <restriction>
The variable value

does not comply with
the restriction
POC scripts
execution
POC
-vc12list value must

be set in manual
option
-vc12list value is not

set in manual option
POC scripts
execution
POC
-withIMA option
value must be TRUE
or FALSE
-withIMA option
value was not TRUE
or FALSE
POC scripts
execution
POC
There is no tool
configuration file, the
application can not
assemble the WICL
commands!
Cannot find the tool

config file
Scheduled export
scripts execution
Scheduled export
Encounter error when

generating the config
file!
Error encountered
while generating the
config file
Scheduled export
scripts execution
Scheduled export
Option <argument> is
not recognized!
The option is not

recognized
Scheduled export
scripts execution
Scheduled export
There is no common
configuration file:
<file name>
There is no common
configuration file
Scheduled export
scripts execution
Scheduled export
Some unexpected
error occurred when
reading the common
config file <file
name>, check it:
<exception>
An unexpected error
occurred when
reading the common
config file
Scheduled export
scripts execution
Scheduled export
Some unexpected
error has produced
during the reading of
the config file <file
name>, check it:
<exception>
An unexpected error
occurred when
reading the tool
config file
Scheduled export
scripts execution
Scheduled export
Error while opening

the tool config file
<file name> :
<exception>
An error occurred
while opening the
tool config file
Scheduled export
scripts
Scheduled export
DRAFT
...................................................................................................................................................................................................................................
NN-20500-030
8-59
DRAFT
Error dictionary
DRAFT
Error dictionary
WICL Scripts
...................................................................................................................................................................................................................................
WICL scripts information messages

Message
DRAFT
passportbackup.wcl: The
backup of following
passport are failed (<fail
list>), please look into the
BR_WICL_TRACE.log
and passportbackup.log
file to have more details.
Context
passportbackup.wcl execution
Script
Passport Backup & Restore
...................................................................................................................................................................................................................................
NN-20500-030
8-60

WICL Commands STD 101513024289001

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

WICL Commands STD 101513024289001

Uploaded by

Copyright:

Available Formats

Proprietary Use pursuant to Company instruction

Proprietary Use pursuant to Company instruction

ot to be used or disclosed except in accordance with applicable agreements.

How this publication is organized

Roadmap to W-CDMA Customer Documentation

New in this release

WICL line mode shell

WICL command description

Typographic conventions in the description of the WICL commands

UTRA list <param> command ........................................................................................................................................ 5-11

ECriticalAlarms command ............................................................................................................................. 5-15

UTRA getObjectListFrom3gppD command

Object selection ........................................................................................................................................................................ 5-20

createOnline command .......................................................................................................................................................... 5-26

SetOnlineAdministrativeState command ........................................................................................................................ 5-44

SetIC command ........................................................................................................................................................................ 5-47

iR C commands ...................................................................................................................................................................... 5-60

CM createSession command ............................................................................................................................................. 5-118

CM getImpactedConfig odes command ..................................................................................................................... 5-133

Performance manager commands

PM block E command ....................................................................................................................................................... 5-141

PM get odeBGranularity command

recoverObs command .......................................................................................................................................................... 5-149

PM exportCounterList command .................................................................................................................................... 5-151

Fault manager commands

FM setFmbbCache command ........................................................................................................................................... 5-159

SEC EncryptSecret command

I-ode and POC commands

save command ........................................................................................................................................................................ 5-177

apply command ...................................................................................................................................................................... 5-179

switch command .................................................................................................................................................................... 5-184

Date-and-time syntax ........................................................................................................................................................... 5-191

Get job result

WICLConfigGetValue command .................................................................................................................................... 5-200

WICLTraceError command ............................................................................................................................................... 5-204

Help command management

help <wicl_command> command ................................................................................................................................... 5-213

Long command management ............................................................................................................................................ 5-214

OAM software management

Environmental variable management

getEnv command ................................................................................................................................................................... 5-220

licenseSnapshot command ................................................................................................................................................. 5-225

WICL command / E mapping

WICL script management

Script access security ................................................................................................................................................................ 6-3

Use the command parameter wizard ................................................................................................................................... 6-7

WICL script browser

Create a Directory or a Script File

Rename a Directory or a Script File

Move a Directory or a Script File ...................................................................................................................................... 6-17

Open a Script File .................................................................................................................................................................... 6-19

WICL Script Running

WICL script examples

Scheduled Export script

Access scripts ............................................................................................................................................................................ 6-41

OAM software inventory ...................................................................................................................................................... 6-46

WICL server pages (WSP)

Online neighbouring management wiclet

Using WICLETs ....................................................................................................................................................................... 7-23

WICL Server ................................................................................................................................................................................ 8-3

ROC command ......................................................................................................................................................... 5-10

UTRA list <param> command

UTRA OAMLinkBreaks command .............................................................................................................. 5-13