FMS Commands Reference Guide

NN-20500-175 Wireless Service Provider Solutions
W-CDMA
Alcatel-Lucent 9353 Management System for Femto
Commands Reference Guide (WICL)

NN-20500-175 02.04/EN Preliminary June 2009
Wireless Service Provider Solutions
W-CDMA
Alcatel-Lucent 9353 Management System for Femto

Document number: Document issue: Document status: Product release: Date: NN-20500-175 02.04/EN Preliminary FMS2.2 June 2009
Alcatel-Lucent - Internal - Proprietary - Use pursuant to Company instruction
Copyright 2008-2009 Alcatel-Lucent, All Rights Reserved UNCONTROLLED COPY: The master of this document is stored on an electronic database and is "write protected"; it may be altered only by authorized persons. While copies may be printed, it is not recommended. Viewing of the master electronically ensures access to the current issue. Any hardcopies taken must be regarded as uncontrolled copies. ALCATEL-LUCENT CONFIDENTIAL: The information contained in this document is the property of Alcatel-Lucent. Except as expressly authorized in writing by Alcatel-Lucent, the holder shall keep all information contained herein confidential, shall disclose the information only to its employees with a need to know, and shall protect the information from disclosure and dissemination to third parties. Except as expressly authorized in writing by Alcatel-Lucent, the holder is granted no rights to use the information contained herein. If you have received this document in error, please notify the sender and destroy it immediately. Alcatel-Lucent, Alcatel, Lucent Technologies and their respective logos are trademarks and service marks of Alcatel-Lucent, Alcatel and Lucent Technologies. All other trademarks are the property of their owners.
Publication history
PUBLICATION HISTORY
SYSTEM RELEASE: FMS2.2 June 2009
Issue 02.04/EN Draft Update after internal review
May 2009
Issue 02.03/EN Draft Update after internal review
March 2009
Issue 02.02/EN Preliminary Update after internal review
February 2009
Issue 02.01/EN Draft Update for FMS 2.2
SYSTEM RELEASE: FMS2.1 October 2008

Issue 01.03/EN Standard Standard update
March 2008
Issue 01.02/EN Preliminary Updated after internal review
February 2008
Issue 01.01/EN Draft Creation
Copyright 2008-2009 Alcatel-Lucent
Table of contents
1 About this publication................................................................................................................................................. 11 2 Femto Management System Documentation Roadmap........................................................................................... 13 3 New in this release....................................................................................................................................................... 14 4 WICL Access.................................................................................................................................................................15 4.1 WICL Console..........................................................................................................................................................16 4.2 WICL Line mode shell..............................................................................................................................................19 5 WICL Basic Syntax.......................................................................................................................................................24 6 WICL Command Description.......................................................................................................................................31 6.1 Typographic Conventions in the Description of the WICL Commands .................................................................... 32 6.2 Object Discovery.......................................................................................................................................................33 6.2.1 ROC list children Command............................................................................................................................... 34 6.2.2 UTRAN list Command........................................................................................................................................ 35 6.2.3 UTRAN AllDesynchro Command....................................................................................................................... 36 6.2.4 UTRAN getObjectListFrom3gppDN Command.................................................................................................. 37 6.2.5 List Command.................................................................................................................................................... 38 6.3 Object Selection........................................................................................................................................................39 6.4 Object Edition........................................................................................................................................................... 41 6.4.1 CreateOnline Command.....................................................................................................................................42 6.4.2 DeleteOnline Command..................................................................................................................................... 43 6.4.3 CreateRootObject Command............................................................................................................................. 44 6.4.4 DeleteRootObject Command............................................................................................................................. 45 6.5 Parameter Manipulation............................................................................................................................................46 6.5.1 Display Command.............................................................................................................................................. 47 6.5.2 Get Command.................................................................................................................................................... 48 6.5.3 GetAlarms Command.........................................................................................................................................49 6.5.4 GetAttributes Command.....................................................................................................................................51 6.5.5 GetAll Command................................................................................................................................................ 52 6.5.6 GetDescription Command.................................................................................................................................. 53 6.5.7 SetAllOnline Command...................................................................................................................................... 55 6.5.8 SetOnline Command.......................................................................................................................................... 56 6.6 UTRAN Commands.................................................................................................................................................. 58 6.6.1 IPC/BSG Commands......................................................................................................................................... 59 6.6.2 BSG Commands................................................................................................................................................ 64 6.6.3 SR7710/SR7750 Commands............................................................................................................................. 69 6.6.4 FemtoCluster/Femto Commands....................................................................................................................... 72
Table of contents
6.7 Work Order Manipulation..........................................................................................................................................75 6.7.1 WO Export Command........................................................................................................................................ 76 6.7.2 WO Display Command.......................................................................................................................................77 6.7.3 WO CreateObject Command............................................................................................................................. 78 6.7.4 WO setObject Command................................................................................................................................... 79 6.7.5 WO deleteObject Command.............................................................................................................................. 80 6.8 Configuration Manager Commands..........................................................................................................................81 6.8.1 CM createSession Command............................................................................................................................ 82 6.8.2 CM terminateSession Command....................................................................................................................... 83 6.8.3 CM abortSession Command.............................................................................................................................. 84 6.8.4 CM Validate Command...................................................................................................................................... 85 6.8.5 CM listSession Command.................................................................................................................................. 86 6.8.6 CM displaySession Command........................................................................................................................... 87 6.8.7 CM preActivateCommand.................................................................................................................................. 88 6.8.8 CM Activate Command...................................................................................................................................... 89 6.8.9 CM Resume Command......................................................................................................................................90 6.8.10 CM setActivationType Command..................................................................................................................... 91 6.8.11 CM getAvailableConfigModels Command........................................................................................................92 6.8.12 CM export Command....................................................................................................................................... 93 6.8.13 CM exportRNS Command................................................................................................................................95 6.8.14 CM getImpactedConfigNodes Command.........................................................................................................97 6.8.15 CM getImpactedConfigNodesInfo Command...................................................................................................98 6.8.16 CM excludeNodes Command.......................................................................................................................... 99 6.8.17 CM fallback Command................................................................................................................................... 100 6.8.18 CM exportCluster Command.......................................................................................................................... 101 6.9 AT Commands........................................................................................................................................................103 6.9.1 Date and Time Syntax......................................................................................................................................104 6.9.2 at exec Command............................................................................................................................................ 105 6.9.3 at list Command............................................................................................................................................... 106 6.9.4 at eval Command............................................................................................................................................. 107 6.9.5 at listall Command............................................................................................................................................108 6.9.6 at remove Command........................................................................................................................................109 6.9.7 at result Command........................................................................................................................................... 110 6.9.8 at info Command.............................................................................................................................................. 111 6.10 East West Interface.............................................................................................................................................. 112
Table of contents
6.10.1 EW ewWmsRetrieve...................................................................................................................................... 113 6.10.2 EW ewWmsGenerateWO...............................................................................................................................115 6.11 Configuration File..................................................................................................................................................116 6.11.1 WICLConfigInit Command..............................................................................................................................117 6.11.2 WICLConfigGetValue Command................................................................................................................... 118 6.12 Trace File..............................................................................................................................................................119 6.12.1 WICLTraceInit Command...............................................................................................................................120 6.12.2 WICLTrace Command....................................................................................................................................121 6.12.3 WICLTraceError Command............................................................................................................................122 6.12.4 WICLTraceBegin Command.......................................................................................................................... 123 6.12.5 WICLTraceEnd Command............................................................................................................................. 124 6.13 File Management.................................................................................................................................................. 125 6.13.1 open Command..............................................................................................................................................126 6.13.2 close Command............................................................................................................................................. 127 6.13.3 dir Command..................................................................................................................................................128 6.14 Help Commands................................................................................................................................................... 129 6.14.1 help Command............................................................................................................................................... 130 6.14.2 help <wicl_command> Command.................................................................................................................. 131 6.15 Long Command Management.............................................................................................................................. 133 6.16 OAM Software Management................................................................................................................................ 135 6.17 Environmental Variable Management...................................................................................................................137 6.17.1 setEnv Command...........................................................................................................................................138 6.17.2 getEnv Command...........................................................................................................................................139 7 WICL - Script Management........................................................................................................................................140 8 WICL Script examples................................................................................................................................................142 8.1 Open Link IPC....................................................................................................................................................... 143 8.2 WICLConfig example.............................................................................................................................................144 8.3 WICLTrace.............................................................................................................................................................145 9 WICL Script Editor - InTerm...................................................................................................................................... 147 9.1 WICL script editor................................................................................................................................................... 148 9.1.1 WICL command parameter wizard................................................................................................................... 149 9.1.2 WICL Script editing...........................................................................................................................................151 9.1.3 WICL script modification...................................................................................................................................153 9.1.4 WICL script saving........................................................................................................................................... 154 9.2 WICL script management....................................................................................................................................... 155
Table of contents
9.2.1 Create a Directory or a Script File.................................................................................................................... 156 9.2.2 Rename a Directory or a Script File................................................................................................................. 157 9.2.3 Delete a Directory or a Script File.................................................................................................................... 158 9.2.4 Move a Directory or a Script File...................................................................................................................... 159 9.2.5 Duplicate a Directory or a Script File................................................................................................................ 160 9.2.6 Open a Script File.............................................................................................................................................161 9.2.7 Search for a Directory or a Script File.............................................................................................................. 162 9.2.8 Refresh a Directory Content.............................................................................................................................163 9.3 WICL Script Running and Scheduling.................................................................................................................... 164 9.3.1 WICL Script Running........................................................................................................................................165 9.3.2 WICL Script Scheduling................................................................................................................................... 166 9.4 Job Scheduler.........................................................................................................................................................169 10 Wiclets.......................................................................................................................................................................174 10.1 WICL Plug-Ins.......................................................................................................................................................175 10.2 WICLET examples................................................................................................................................................179 10.3 Using Wiclets........................................................................................................................................................ 181
List of figures
Figure 1 - WICL Console - Main Window.............................................................................................. ............. ......... 16 Figure 2 - WICL Console - Script Selection........................................................................................................ ......... 18 Figure 3 - Script Editor main window.................................................................................................................. ....... 148 Figure 4 - WICL command parameter wizard....................................................................................... ............. ....... 149 Figure 5 - Create a new WICL script file............................................................................................... ............. ....... 151 Figure 6 - Script Browser main window.............................................................................................................. ....... 155 Figure 7 - Create Schedule main window............................................................................................. ............. ....... 167 Figure 8 - Schedule list window.......................................................................................................................... ....... 170 Figure 9 - Pending job view................................................................................................................................ ....... 171 Figure 10 - Running job window......................................................................................................................... ....... 172 Figure 11 - Historical job window.......................................................................................................... ............. ....... 173
List of tables
Table 1 - ROC command...................................................................................................................... ............. ......... 34 Table 2 - UTRAN list command.......................................................................................................................... ......... 35 Table 3 - UTRAN AllDesynchro command......................................................................................................... ......... 36 Table 4 - UTRAN getObjectListFrom3gppDN command...................................................................... ............. ......... 37 Table 5 - list command.......................................................................................................................... ............. ......... 38 Table 6 - UTRAN objects...................................................................................................................... ............. ......... 39 Table 7 - FDN mapping table................................................................................................................ ............. ......... 39 Table 8 - CreateOnline command......................................................................................................... ............. ......... 42 Table 9 - DeleteOnline command....................................................................................................................... ......... 43 Table 10 - CreateRootObject command............................................................................................................. ......... 44 Table 11 - DeleteRootObject command................................................................................................ ............. ......... 45 Table 12 - Display command.............................................................................................................................. ......... 47 Table 13 - Get command.................................................................................................................................... ......... 48 Table 14 - GetAlarms command........................................................................................................... ............. ......... 49 Table 15 - GetAttributes command....................................................................................................... ............. ......... 51 Table 16 - GetAll command................................................................................................................................ ......... 52 Table 17 - GetDescription command.................................................................................................................. ......... 53 Table 18 - SetAllOnline command...................................................................................................................... ......... 55 Table 19 - SetOnline command.......................................................................................................................... ......... 56 Table 20 - openLink command........................................................................................................................... ......... 59 Table 21 - closeLink command............................................................................................................. ............. ......... 60 Table 22 - getLatestPMFiles command.............................................................................................................. ......... 61 Table 23 - fmSnapshot command......................................................................................................... ............. ......... 64 Table 24 - download command............................................................................................................. ............. ......... 65 Table 25 - activate command................................................................................................................ ............. ......... 66 Table 26 - fallback command................................................................................................................ ............. ......... 67 Table 27 - abortUpgradeSession command....................................................................................................... ......... 68 Table 28 - fmSnapshot command......................................................................................................... ............. ......... 69 Table 29 - openLink command........................................................................................................................... ......... 70 Table 30 - closeLink command............................................................................................................. ............. ......... 71 Table 31 - cancelSynchroErrorEvent command................................................................................................. ......... 72 Table 32 - synchronizeConfigData command....................................................................................... ............. ......... 73 Table 33 - WO Export command........................................................................................................................ ......... 76 Table 34 - WO Display command......................................................................................................... ............. ......... 77 Table 35 - WO CreateObject command................................................................................................ ............. ......... 78 Table 36 - WO setObject command...................................................................................................... ............. ......... 79 Table 37 - WO deleteObject command................................................................................................. ............. ......... 80 Table 38 - CM createSession command............................................................................................... ............. ......... 82 Table 39 - CM terminateSession command.......................................................................................... ............. ......... 83 Table 40 - CM abortSession command.............................................................................................................. ......... 84 Table 41 - CM Validate command...................................................................................................................... ......... 85
List of tables
10
Table 42 - CM listSession command.................................................................................................................. ......... 86 Table 43 - CM displaySession command........................................................................................................... ......... 87 Table 44 - CM preActivate command................................................................................................................. ......... 88 Table 45 - CM Activate command......................................................................................................... ............. ......... 89 Table 46 - CM Resume command........................................................................................................ ............. ......... 90 Table 47 - CM setActivationType command......................................................................................... ............. ......... 91 Table 48 - CM getAvailableConfigModels command............................................................................ ............. ......... 92 Table 49 - CM export command......................................................................................................................... ......... 93 Table 50 - CM exportRNS command.................................................................................................... ............. ......... 95 Table 51 - CM getImpactedConfigNodes command............................................................................. ............. ......... 97 Table 52 - CM getImpactedConfigNodesInfo command....................................................................... ............. ......... 98 Table 53 - CM excludeNodes command............................................................................................... ............. ......... 99 Table 54 - CM fallback command....................................................................................................................... ....... 100 Table 55 - CM exportCluster command................................................................................................ ............. ....... 101 Table 56 - Date-and-time syntax........................................................................................................... ............. ....... 104 Table 57 - at - exec command............................................................................................................................ ....... 105 Table 58 - at - list command............................................................................................................................... ....... 106 Table 59 - at - eval command............................................................................................................................. ....... 107 Table 60 - at - listall command.............................................................................................................. ............. ....... 108 Table 61 - at - remove command.......................................................................................................... ............. ....... 109 Table 62 - At - result command............................................................................................................. ............. ....... 110 Table 63 - at - info command................................................................................................................ ............. ....... 111 Table 64 - EW ewWmsRetrieve command........................................................................................... ............. ....... 113 Table 65 - EW ewWmsGenerateWO command................................................................................................. ....... 115 Table 66 - WICLConfigInit command.................................................................................................... ............. ....... 117 Table 67 - WICLConfigGetValue command.......................................................................................... ............. ....... 118 Table 68 - WICLTraceInit command..................................................................................................... ............. ....... 120 Table 69 - WICLTrace command.......................................................................................................... ............. ....... 121 Table 70 - WICLTraceError command.................................................................................................. ............. ....... 122 Table 71 - WICLTraceBegin command................................................................................................. ............. ....... 123 Table 72 - WICLTraceEnd command................................................................................................................. ....... 124 Table 73 - open command.................................................................................................................... ............. ....... 126 Table 74 - close command.................................................................................................................... ............. ....... 127 Table 75 - dir command........................................................................................................................ ............. ....... 128 Table 76 - help command................................................................................................................................... ....... 130 Table 77 - Help <wicl_command> command........................................................................................ ............. ....... 131 Table 78 - setMaxTimeout command................................................................................................................. ....... 134 Table 79 - OAM command.................................................................................................................... ............. ....... 135 Table 80 - setEnv command................................................................................................................. ............. ....... 138 Table 81 - getEnv command................................................................................................................. ............. ....... 139 Table 82 - Script access security.......................................................................................................... ............. ....... 140 Table 83 - Exec command.................................................................................................................... ............. ....... 140
11
About this publication

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 NE 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)
Applicability
This publication applies to the Femto Management Solution 2.2 .
Audience
This document is intended for the UMTS network controllers.
Related documents
Alcatel-Lucent 9353 Management System for Femto - Introduction and Documentation guide Overview (NN-20500-177) Alcatel-Lucent 9353 Management System for Femto - User Guide (NN-20500-208)
How this publication is organized

The document consists of the following modules: WICL Access WICL Basic Syntax WICL Command Description WICL - Script Management WICL Script examples WICL Script Editor - InTerm Wiclets
12
Vocabulary conventions
The terms used in this document are listed in 9300 W-CDMA Product Family Terminology (NN-20500-002). For specific Femto terms, see Alcatel-Lucent 9353 Management system for Femto - Introduction & documentation Guide (NN-20500-177). In a Femto context, the WMS and WPS terms respectively refer to 9353 WMS for Femto and 9352 WPS for Femto. All over the document Femto stands for UMTS Femto BSR equipment The specific terms used in this publication include the following: BSR cluster: it is a "logical" NE grouping several Femto BSRs (up to 64 000). BSG: BSR Signalling Gateway. The BSG connects a Femto-BSR cluster to the macro network and performs common subscriber management with the macro network. The BSG is declared and managed as a separate network element. IPC: Iu-CS Protocol Converter for ATM-IP FS: File Server
13
Femto Management System Documentation Roadmap

For the Femto Management System Documentation Roadmap, see Alcatel-Lucent 9353 Management System for Femto - Introduction & Documentation Guide (NN-20500-177).
14
New in this release

The following sections detail what is new in Alcatel-Lucent 9353 Management System for Femto Commands Reference Guide (WICL) (NN-20500-175) for FMS 2.2. It is split into: Feature Other changes
Feature
FRS 80666 - HNM-WMS synchronization enhancement
Other changes
N/A
New commands
synchronizeConfigData cancelSynchroErrorEvent
15
WICL Access
Access to the WICL is provided via the Network Service Platform (NSP) Graphical User Interface, where a WICL command or a script of WICL commands can be executed interactively from the WICL Console or the WICL Script Editor - InTerm tool. Access is also possible from the Main server by using WICL Line mode shell.
16
4.1
WICL Console
To open the WICL console, select Configuration > Wireless Internet Command Language (WICL) from the opened NSP Graphical User Interface (GUI). To know how to open the NSP GUI, refer to the Alcatel-Lucent 9353 Management System - User Guide document (NN-20500-208)
Figure 1 WICL Console - Main Window
The WICL console allows: to type and execute WICL commands then to receive answers to select and execute script files.
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 from the WICL Console:
17
Command line edition: word or character navigation and modification Select Edit > Copy and Edit > Paste menus (or use Control-C and Control-V keys) to duplicate a previously selected text Select History > Previous or Next (or use up and down arrow keys) to insert the previous or the next command at the cursor position Select 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
18
Figure 2 WICL Console - Script Selection
19
4.2
WICL Line mode shell

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 NSP user name and password. Note: 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 '<script 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
Line mode execution

Once the wiclsh tool is launched in interactive mode, the user has to provide the NSP user name and NSP 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) >:
20
Example: user authentication fails uctfe024:/opt/nortel/shell/wicl <37> (nortel) >% ./wiclsh Starting Wireless Internet Command Language Command mode launched login John password **** ... wait please User Authentication failed Exiting... uctfe024:/opt/nortel/shell/wicl <38> (nortel) >%
21
Script execution
The wicl scripts can be launched from the wiclsh tool on the Main server: Example : /opt/nortel/shell/wicl/wiclsh -u <Username> -p <Password> -f /opt/nortel/shell/wicl/scripts/test1.wcl - - param1 param2 Note: The parameter -f indicates that the file path is the 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: Example: % /opt/nortel/shell/wicl/wiclsh -u <Username> -p <Password> -f /opt/nortel/shell/wicl/scripts/test1.wcl -- 'IPC ipc1' Starting Wireless Internet Command Language Script mode launched aliasName clusterId ipcId mgrIpAddress mimVersion OAMlinkAdministrativeState rdnId siteName unknownStatus userSpecificInfo Disconnecting....
UNSET Cluster/UMAINSERV1 2 192.68.1.3 BCR-02-01-IPC-XMIM-1.3.6 locked UNSET Site/SITE_aaa_IPC unknownstatustrue my_FIRST_IPC
22
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 'IPC ipc1 display' Starting Wireless Internet Command Language
Non interactive command mode launched aliasName clusterId ipcId mgrIpAddress mimVersion OAMlinkAdministrativeState rdnId siteName unknownStatus userSpecificInfo Disconnecting....
UNSET Cluster/UMAINSERV1 2 192.68.1.3 BCR-02-01-IPC-XMIM-1.3.6 locked UNSET Site/SITE_aaa_IPC unknownstatustrue my_FIRST_IPC
WICL script syntax check

This script checker helps you to create WICL scripts and find errors before executing these scripts. This option 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. The WICL syntax check is not integrated in a GUI and is available using the wiclsh tool only. The script files must contain the full command name, and not the abbreviated forms, such as 'dis' for 'display', for example. In the following example, a wiclsh command is used to trace execution and to check a file stored in /tmp/exa.wcl: Example: # /opt/nortel/shell/wicl/wiclsh -check /tmp/exa.wcl Starting Wireless Internet Command Language Check Mode launched Checking file /tmp/exa.wcl Line 4: Line 6: Line 12: Unknown command 'settt' Unknown WICL SubCommand for class IPC Could not complete statement.
23
One close brace would complete the first line. One close brace would complete the script body at line 15. Assuming completeness for further processing. # In the above example, the tool finds the three errors of the WICL script. Options in commands Example: When the command can be executed with certain options : IPC IPC1 list child The tool can only guarantee that the command itself, for example list, is correct: but the improper option 'child' is ignored. 'UTRAN' is an special command because everything following it is treated as an option, so the tool cannot find any errors in such a command: utran listss rer.
24
WICL Basic Syntax

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 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}
Command
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.
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
25
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: > set x \$foo $foo > set y $x $foo
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. You can delay the substitutions to a later stage by grouping with braces. > set s "Hello world"
26
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. proc factorial {n} { if {$n<0} {return} elseif {$n<=1} {return 1} else { return [expr n * [factorial [expr $n - 1]] }
27
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 this example, if the eval command is omitted, the sum procedure returns an error because the eval command requires a one-string argument only ('45.0 65.0 78.0 55.0' in this example) while sum expects numerical arguments.
Basic commands
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 append: adds a value to a variable array: manipulates array variables
28
break: aborts looping command catch: evaluates the script clock: obtains and manipulates time concat: merges lists continue: skips to the next iteration of a loop eof: checks the end condition of a channel error: generates an error eval: evaluates a WICL script expr: evaluates an expression flush: flushes buffered output for a channel foreach: iterates over all elements in one or more lists format: formats a string in the form of sprintf gets: reads a line from a channel global: accesses global variables incr: increments the value of a variable info: returns information about the state of the Tcl interpreter join: creates a string by joining list elements together lappend: adds list elements to a variable lindex: retrieves an element from a list linsert: adds elements to a list list: creates a list llength: counts the number of elements in a list lrange: returns one or more adjacent elements from a list lreplace: replaces elements in a list with new elements lsearch: checks if a list contains a particular element lsort: sorts the elements of a list namespace: creates and manipulates contexts for commands and variables proc: creates a WICL procedure puts: displays messages read: reads from a channel regexp: matches a regular expression against a string regsub: performs substitution based on regular expression pattern matching rename: renames and deletes a command return: returns from a procedure
29
scan: parses strings using conversion specifiers in the form of sscanf set: reads and writes variables source: evaluates a file or resource as a WICL script split: splits a string into a complete WICL list string: manipulates strings subst: performs backslash, command and variable substitution switch: evaluates one of several scripts, according to a given value time: times the execution of a script trace: monitors variable accesses unset: deletes variables update: processes pending events and idle callbacks uplevel: executes a script in a different stack frame upvar: creates links to variables in different stack frames variable: creates and initializes a name space variable vwait: processes events until a variable is written
WICL limits certain Tcl default commands for security reasons. These commands are: info: for this command, the only available sub-command is exists namespace: for this command, the only available sub-commands 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_IPC1 set longitude 0x45' >: Site site_IPC1 set longitude [format "%d" 0x45] >: Site site_IPC1 display altitude class clusterId dn latitude location longitude name 1300 Site Cluster/UMAINSERV1 (Site, 0) 50 NONE 69 site_IPC1
30
note operatorId siteManager userSpecificInfo
Test_IPC_ISS SKT_LG_Nortel NONE USI
# here is an example how to display the value >: puts [format "0x%x" [Site site_IPC1 get longitude]] 0x45 # here is an example how to set a variable with the correct hexadecimal typing >: set a [format "0x%x" [Site site_IPC1 get longitude]] 0x45 # an example of error that will occur if the data type is not fully handled >: Site site_IPC1 setonline altitude 0x1300 Exception FMK_UNM_ItManagedObject::XmlStringCheckErrors: altitude : Bad attribute type, use INT type instead of Unknown Object update failed.
31
WICL Command Description

WICL can manage objects stored in different main servers of a Regional Operational Center (ROC) system. As a whole, WICL allows to: Create/set/get/delete/list managed objects and some NEs Handle cmXML OAM files and commands Synchronize the OAM database with UTRAN NEs Access to OAM file systems Schedule command/script execution
32
6.1 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: <User DN> switch [-force] {protectionToWorking | workingToProtection} [-timeout <timevalue>]
33
6.2
Object Discovery
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 list children Command UTRAN list Command UTRAN AllDesynchro Command UTRAN getObjectListFrom3gppDN Command List Command
34
6.2.1
ROC list children Command

Note: The UTRAN network is available using WICL when the UMTS ACCESS OAM is installed on the Main server.
Use the ROC list children command to host the UTRAN domain managed by WICL.
Table 1 ROC command Syntax Result Return Value Errors Example: # This is the result in an UMTS Access Network >: ROC list children UTRAN ROC list children Gets the list of domains that are found at the ROC. Returns the list of domains which are found at the ROC. An exception is returned if an error is encountered.
35
6.2.2
UTRAN list Command
Use the UTRAN list command to get objects managed by WICL at the UTRAN level. Table 2 UTRAN list command 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 If the keyword children is used as a parameter: returns the list of NE types that are found at the UTRAN level. If the NE type is used as a parameter: returns the list of objects of the selected type. Return Value If the keyword children is used as a parameter: returns a list of NE types. If the NE type is used as a parameter: returns the list of objects of the selected type. Errors Examples: # Get all the classes managed at the UTRAN level >: UTRAN list children BSG BSRProfile FemtoCluster FemtoNetwork IPC Locations MacroCells Site # Get all the IPC objects at the UTRAN level >: UTRAN list IPC {IPC FIRST_IPC} {IPC SECOND_IPC} An exception is returned if an error is encountered.
36
6.2.3
UTRAN AllDesynchro Command
Use the UTRAN AllDesynchro command to get a list of all desynchronized NEs from the OAM database. Table 3 UTRAN AllDesynchro command Syntax UTRAN list AllDesynchro [-cluster <serverName>] <serverName>: this parameter specifies a server for an object search. Result Return Value Errors Examples: >: UTRAN list AlLDesynchro {IPC IPC1} IPC that are desynchronized from the OAM database. Returns a list of IPC FDNs. An exception is returned if an error is encountered.
37
6.2.4
UTRAN getObjectListFrom3gppDN Command
Use the UTRAN getObjectListFrom3gppDN command to retrieve objects that are identified by the input 3GPPDN. Table 4 UTRAN getObjectListFrom3gppDN command Syntax UTRAN getObjectListFrom3gppDN -dn <3GPPDN> -mode <mode> <3GPPDN>: this parameter is a kind of Distinguished Name that uses the primary key as a part of the identifier. <mode>: this parameter can be all or first. Result Return Value Errors Examples: >: utran getObjectListFrom3gppDN -dn IPC ipc1 -mode first This command searches objects that are identified by the input 3GPPDN. Returns the objects that are identified by the input 3GPPDN. An exception is returned if an error is encountered.
38
6.2.5
List Command
The list command applies to a FDN. It is used to navigate through the model tree of a Network Element and to retrieve other sub-objects. Table 5 list command Syntax <FDN> list <param> [-cluster <clusterName>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <param>: this parameter can be one of the following values: Result the keyword children a sub-class of the selected object
<clusterName>: select a specific cluster to perform the operation. 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 FDN. Return Value If 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 Examples: # Get all the IPC in the UMTS Access Network >: UTRAN list IPC {IPC FIRST_IPC} {IPC SECOND_IPC} An exception is returned if an error is encountered.
39
6.3
Object Selection
Use WICL to interact with the managed UTRAN objects. To be accessible with WICL, these NEs must be managed in the same Regional Operation Center (ROC). You can use all the managed objects (and their associated parameters) related to the containment trees of these NEs. A Full Distinguished Name (FDN) identifies each object in WICL. Even if WICL manages objects in each domain in a specific way, all the different types of Distinguished Names used in each domain are homogeneous.
Distinguished Name for UTRAN objects

For more details on the managed objects, see the RAN Model description in 9300 W-CDMA Product Family Parameters Reference Guide (NN-20500-027). A FDN identifies each RAN Model object in WICL. This FDN is a sequence of Relative Distinguished Names (RDN): Table 6 UTRAN objects FDN Syntax RDN Result ObjClassName RDN1 RDN2 ... RDNn ObjClassName Identifier Name 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. Value uniquely identifying the object relatively to its parent
Identifier Example:
>: IPC ipc1 SNMPParamv3 1
FDN Mapping
The FDN mapping table provides a summary of the object types used in the FDN syntax: Table 7 FDN mapping table Object type UTRAN Access RDN1 RDN2 ...RDNn FDN syntax
In all the command descriptions, the FDN or technology corresponds to all UTRAN RAN model objects. Use the defined FDN for each command when required.
40
3GPP Distinguished Name detection and conversion

WICL supports 3GPP Distinguished Name. 3GPP Distinguished Name will be detected in the WICL command line and converted to Operator Distinguished Name. So continue to launch the corresponding command by putting FDN followed by the name of the command. Examples: IPC.rdnId 430 display IPC IPC430 display IPC.rdnId 430 SNMPParamv3 SNMPParamv3_430_002 display IPC 430 SNMPParamv3 SNMPParamv3_430_002 display IPC IPC430 SNMPParamv3.rdnId 259 display IPC 430 SNMPParamv3 SNMPParamv3_430_002 display
41
6.4
Object Edition
Use the commands described in this section to manage all types of objects. Note: 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.
The object edition commands are the following: CreateOnline Command DeleteOnline Command CreateRootObject Command DeleteRootObject Command
42
6.4.1
CreateOnline Command
Table 8 CreateOnline command CreateOnline Use this command to set default values to the attributes when a new object is created. WICL can manage different UTRAN Network Element versions. Use this command to select a given version of the Network Element and of the Main server in which the object will be created. The creation is performed online. Syntax <FDN> createOnline <Attribute1> <value1> ... <AttributeN> <valueN> [-cluster <clusterName>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <Attribute>: name of an attribute of the specified FDN. This parameter is optional. <Value>: new value set at creation time to the selected attribute. This parameter is optional. <clusterName>: select a specific cluster to perform the 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 FDN. When using the userLabel to select the UTRAN object IPC (for example), this label is used as the attribute of the IPC. UTRAN objects are created online. Return Value Errors Examples: # Create a equiPLMN object online >: FemtoCluster Paris_VI equiPLMN 1 createOnline Notes When creating an object that does not have a parent object, an exception is returned If the externalSessionId attribute is selected during the creation, the object is not generated automatically. Its creation depends on the selected value. The final status of the CreateOnline job. An exception is returned if an error is encountered.
43
6.4.2
DeleteOnline Command
Table 9 DeleteOnline command DeleteOnline Use this command to delete a specified object and all its subtrees. The deletion is performed online. Syntax <FDN> deleteOnline [-cluster <clusterName>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <clusterName>: select a specific cluster to perform the operation. Result Return Value Errors Examples: # Delete a equiPLMN object online >: FemtoCluster Paris_VI equiPLMN 1 deleteOnline Delete the selected object and all subtree objects. The final status of the DeleteOnline job. An exception is returned if an error is encountered.
44
6.4.3
CreateRootObject Command
Table 10 CreateRootObject command CreateRootObject This command creates a root object on clusterID based the attributes list. Syntax createRootObject -cluster <clusterID> -dn <FDN> [-version <version>] [-a.ttribute <attributeName1 value1...attributeNamen valuen>] <clusterID>: this parameter is mandatory. Select the cluster name where the object will be created. The possible values are: UMAINSERV1, UMAINSERV2,.These values depend on the number of Main Servers available in the ROC system <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <version>: this parameter is optional. Version of the NE. <Attribute value>: this parameter is optional. Result If no attribute values are done at the creation time, the default attribute values are used to create the object. Otherwise, the selected attributes are used. The object identifier is taken from the user DN. If no error occurs, the selected root object is created, if any error, the command fails. "Create root object finished" or some error message
Return Value Errors Examples:
# Create a root object BSG BSG101 >: createRootObject -cluster UMAINSERV1 -dn {BSG BSG101} -version OAM
45
6.4.4
DeleteRootObject Command
Table 11 DeleteRootObject command DeleteRootObject This command deletes a root object. Syntax deleteRootObject -cluster <clusterID> -dn <FDN> [-version <version>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <clusterID>: this parameter is mandatory. Select the cluster name where the object will be deleted. The possible values are: UMAINSERV1, UMAINSERV2....These values depend on the number of Main Servers available in the ROC system <version>: this parameter is optional. Version of the NE. Result Return Value Errors Examples: # Delete a root object BSG BSG101 >: deleteRootObject -cluster UMAINSERV1 -dn {BSG BSG101} -version OAM Deletes the selected object. "Delete root object finished" or some error message
46
6.5

Parameter Manipulation
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 NEs. The parameter manipulation commands are the following: Display Command Get Command GetAlarms Command GetAttributes Command GetAll Command GetDescription Command SetAllOnline Command SetOnline Command
47
6.5.1
Display Command
Use the Dis.play command to display the list of the attribute names and values of the selected FDN. Table 12 Display command Syntax <FDN> Dis.play [-cluster <clusterName>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <clusterName>: select a specific cluster to perform the operation. Result Return Value Errors Examples: # Display IPC information attributes and values >: IPC FIRST_IPC dis aliasName IPC_1 clusterId Cluster/UMAINSERV1 ipcId 0 mgrIpAddress 192.68.1.1 mimVersion BCR-02-01-IPC-XMIM-1.3.6 OAMlinkAdministrativeState locked siteName Site/SITE_FIRST_IPC rdnId UNSET unknownStatus unknownstatustrue userSpecificInfo USI FIRST IPC Notes This command cannot be used in a WICL script because it displays the attributes' 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. Displays the list of the attribute names and values. None. An exception is returned if an error is encountered.
48
6.5.2
Get Command
Use the Get command to get an attribute value from the selected FDN. Table 13 Get command Syntax <FDN> Get <AttributeName> [-cluster <clusterName>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <AttributeName>: name of an attribute of the selected FDN <clusterName>: select a specific cluster to perform the operation. Result Return Value Errors Examples: Get the IPC attribute value and save it in a tcl variable. At the next command, displays the value of the attribute >: set theSiteName [IPC FIRST_IPC Get siteName] >: puts the 'siteName is $theSiteName' the siteName is Site/SITE_FIRST_IPC Retrieve the value of the attribute. The attribute value. An exception is returned if an error is encountered.
49
6.5.3
GetAlarms Command
Use the GetAlarms command to get alarms from the selected Network Element. Apply Filter criteria to get only a subset of existing alarms in FMBB. Table 14 GetAlarms command Syntax <FDN> GetAlarms -dn <FDN> [-perceivedSeverity <severity>] [-eventType <type>][- probableCause <cause> ] [-additionalText <text>][-specificProblems <text>][-clfi <clfi> ] [-alarmedComponent <DN component>] [-notificationIdentifier <id>] [-eventTimeBegin <time>] [-eventTimeEnd <time>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. perceivedSeverity: the possible values are: CRITICAL, MAJOR, MINOR, WARNING or CLEARED eventType: the possible values are 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 Name of the component where the alarm is generated. This Distinguished Name is a Distinguished Name operator as follows: Root Object uses the userLabel. All other sub-objects use the rdnId attribute value. For example: IPC.userLabel IPCM1_31 SNMPParamv3 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. Result Return Value Retrieve the list of alarms using FMBB server that match the selected criteria. A list of alarms. Each alarm is composed by a list of pairs of type/value. The possible types are: AlarmedComponent, notificationIdentifier, eventTime, eventType, probableCause, perceivedSeverity, probableCause, specificProblems, additionalText and clfi. The eventType value is as follows: yyyymmddHHMMSSZ (yyyy for year,
50
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). Not every alarm has all these types filled, so, only those who are filled in the FMBB database are returned by WICL. Errors Examples: Notes All the filters works 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 are displayed or with eventTime less than eventTimeEnd value. An exception is returned if an error is encountered.
51
6.5.4
GetAttributes Command
Use the GetAttributes command to retrieve the list of attribute names for the selected FDN Table 15 GetAttributes command Syntax <FDN> GetAttributes [-cluster <clusterName>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <clusterName>: select a specific cluster to perform the operation. Result Return Value Errors Examples: # Get all the attributes from the selected UTRAN FDN and save into a tcl variable >: set theAttributeList [IPC FIRST_IPC GetAttributes] { aliasName clusterId ipcId mgrIpAddress mimVersion OAMlinkAdministrativeState rdnId siteName unknownStatus userSpecificInfo} # Get all the attributes from the selected SNMPParamv3 >: IPC FIRST_IPC SNMPParamv3 0 getattributes {AuthenticationFlag contextEngineId contextName description DeviceIpAddress DeviceIpport mibVersion SecurityModel} Note Retrieves the list of all attribute names List containing all attribute names An exception is returned if an error is encountered.
52
6.5.5
GetAll Command
Use the GetAll command to retrieve all the attribute values in a Tcl array for the selected FDN. Table 16 GetAll command Syntax <FDN> GetAll <tclArray> [-cluster <clusterName>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <tclArray>: a Tcl array <clusterName>: select a specific cluster to perform the operation. Result Fill AttributeTable with the object attributes and their values. 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 UNSET will be the value for this attribute. A list of all tha attribute names. An exception is returned if an error is encountered.
Return Value Errors Examples:
# Get all the attribtute values and save it in a tcl array. Display the contextName value using the tcl array information.. >: IPC FIRST_IPC SNMPParamv3 0 getall theParameters >: puts 'the contextName is $theParameters(contextName)' the contextName is FMS Notes The index of the tcl array is case sensitive. You can obtain the exact attribute name using the WICL command GetAttributes.
53
6.5.6
GetDescription Command
Use the GetDescription command to get the description of the selected attribute for the selected FDN Table 17 GetDescription command Syntax <FDN> GetDescription <AttributeName> <TclArray> [-cluster <clusterName>] [-verbose] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <AttributeName>: attribute name of the selected FDN object <TclArray>: a Tcl array. <clusterName>: select a specific cluster to perform the operation. -verbose: retrieves the problems encountered during the execution Result Fill TclArray with the object attribute description. The index attributes are case sensitive. Return Value Errors Examples: >: IPC SECOND_IPC getDescription ipcId testArray >: parray testArray >: >: parray testArray testArray(accessRight) = writeAtCreation testArray(domain) = OAM testArray(enumList) = locked unlocked testArray(name) = ipcId testArray(presence) = required testArray(qualifier) = standard Number class datatype ranges will be rangeList item in the array. Number 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.
None An exception is returned if an error is encountered.
54
testArray(rangeList) = {min=0 max=9999} testArray(stateCategory) = Equipment testArray(type) = Decimal testArray(visibility) = customer Notes 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 testArray (valueList)=412 437 462 487 512 537 562 587 612 637 662 687 testArray (rangeList)={min=10562 max=10838} {min=9662 max=9938}
55
6.5.7
SetAllOnline Command
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 18 SetAllOnline command Syntax <FDN> SetAllOnline <class> <AttributeName> <value> [-cluster <clusterName>] [-verbose] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <class>: a correct child class depending on the specified object <attribute>: name of the attribute <value>: new value to set <clusterName>: select a specific cluster to perform the operation. -verbose: retrieve problems encountered during the execution. Result Return Value Errors Examples: Set the SNMPParamv3 contained in the selected IPC >: SECOND_IPC SetAllOnline SNMPParamv3 DeviceIpport 3001 -cluster UMAINSERV1 {{{IPC SECOND_IPC SNMPParamv3 0} {job finished without error}} Display a list of all objects that have been set and their set result. The list of all objects that have been set and their set result. An exception is returned if an error is encountered
56
6.5.8
SetOnline Command
Use the SetOnline command to modify the attribute in the selected NE, including the modification of the value in the OAM database. This command can also set the value of the administrativeState attribute, so has the function of the setOnlineAdministrativeState command. Table 19 SetOnline command Syntax <FDN> SetOnline <AttributeName1> <Value1>... <AttributeNameN> <ValueN> [-cluster <clusterName>] [-verbose] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <AttributeName>: name of the attribute <Value>: new value to set <clusterName>: select a specific cluster to perform the operation. -verbose: retrieve problems encountered during the execution. Result Change the value of the attribute online for the UTRAN object and if an error is encountered during the execution, an exception is raised. No 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 Errors Examples: # Modify the attribute rdnId in the IPC. If rdnId cannot be set online, an exception is displayed >: IPC IPC1 SetOnline rdnId 3 Notes Only class-2 and class-3 attributes support modification of the NEs. 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 RAN Model description in 9300 W-CDMA Product Family Parameters Reference Guide (NN-20500-027),. When you put a value in a list, surround it with quotes. If the attribute cannot be modified, an exception is returned. This is a long operation: For more details, see Long Command Management. SDO result: For more details, see Long Command Management. An exception is returned if an error is encountered.
57
58
6.6

UTRAN Commands
The UTRAN commands are the following: IPC/BSG Commands BSG Commands SR7710/SR7750 Commands FemtoCluster/Femto Commands
59
6.6.1
IPC/BSG Commands
The IPC/BSG commands are the following: openLink command closeLink command getLatestPMFiles command
Table 20 openLink command openLink Use this command to launch an open OAM link administrative state operation on a specified IPC/BSG. Launching this command does not mean that the link is really opened. The link is opened (after several seconds) if the unknownStatus of the Equipment object is False. Syntax <FDN> openLink [-cluster <clusterName>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <clusterName>: select a specific cluster to perform the operation. Result Return Value Launch an open OAM link administrative state operation on a IPC/BSG. In case of success: Successful Description: [success information] In case of failure: Failed Error description: [detail error information] Errors Example: >: IPC IPC1 openLink Successful Description: IPC IPC1 is unlocked >: IPC IPC1 openLink Failed Error Description: Errors happened during unlocking operation An exception is returned if an error is encountered.
60
Table 21 closeLink command closeLink Use this command to launch a close OAM link administrative state operation on a specified IPC/BSG. Launching this command does not mean that the link is really closed. The link is closed (after several seconds) if the unknownStatus of the IPC/BSG Equipment object is True. Syntax <FDN> closeLink [-cluster <clusterName>] <FDN>: <clusterName>: select a specific cluster to perform the operation. Result Return Value Launch a close OAMlink administrative state operation on an IPC In case of success: Successful Description: [success information] In case of failure: Failed Error description: [detail error information] Errors Example: >: IPC IPC1 CloseLink Successful Description: IPC IPC1is locked >: IPC IPC1 CloseLink Failed Error Description: Errors happened during locking operation An exception is returned if an error is encountered.
61
Table 22 getLatestPMFiles command getLatestPMFiles Use this command to retrieve the counter collection files on BSG or IPC. The default directory is defined in configuration file counters_retrieval.cfg 1. Identifies the last retrieved file in the default PM files directory or the specified targetPath directory 2. Check unknownStatus 3. Check duration 4. Open sftp session with IPC and BSG user (ex: sftp ipc_user@host_ip_adress) 5. Lists the files on NE specified by user DN 6. Compute new files 7. Check duration 8. Retrieves all new files limited by [currentDate - CATCH_UP_PERIOD, currentDate] with mget in case of multiple files and get in case of unique file 9. Close sftp session 10 Compress file if option is selected . 11 Move the files from the temporary directory to final one . case of default directory or target path is empty, it retrieves all files from (current date) to In (current date - CATCH_UP_PERIOD) If the value for the parameter -targetPath is the same as the default directory: 1. If the -all option is not enabled Retrieve the files later than recording timestamp to the default directory and update the timestamp file 2. If the -all option is enabled Prompt the following to the user and stop: -all is only applicable to a directory other than the default one. If the value for the parameter -targetPath is different from the default directory: 1. If the -all option is not enabled Retrieve the files later than recording timestamp to the targetPath, no update on the timestamp file 2. If the -all option is enabled, Retrieve the files within CATCH_UP_PERIOD to the targetPath, no update on the timestamp file Syntax <FDN> getLatestPMFiles -host host_ip_address [-targetPath <filepath>] [-comp.ressed] [-all] [-verbose]
62
getLatestPMFiles <FDN>: specifies the FDN of which work order will be exported. <host>: the ip address of BSG or IPC targetPath: absolute directory path to store the files. If this parameter is not present use the default directory compressed: compress retrieved file. If the retrieved file is already compressed no need to compress again at FMS level all: retrieve all the files in catch up period if enabled and targetPath is different from the default directory verbose: this parameter is used to output the encountered problem during the execution Result Return Value The performance counter files of specified DN is successfully downloaded on FMS. For each file, indicate the operation result: Errors file successfully retrieved file not found host unreachable transfer error
An exception is returned if an error is encountered The following error cases can occur, with the associated message: parameter errors "SYNTAX ERROR: the right format is <FDN> getLatestPMFiles targetPath <filepath>] [-all] [-verbose]" confliction error "ERROR: -all is only applicable to a directory other than the default one" invalid DN "OPERATION ERROR: invalid User DN : "$dn", only IPC or BSG " host unreachable "OPERATION ERROR: Host at "$host_ip_address" is unreachable" IPC or BSG link state is down (unknown status) "OPERATION ERROR: IPC or BSG [ipAddress] unknownStatus is true, no counter retrieval is performed" inconsistency between DN and ipaddress "OPERATION ERROR: Inconsistency between User DN and ip adress :
63
getLatestPMFiles "$userDN" # "$ipadress" " It could be found during authentications like user unknown invalid targetPath "OPERATION ERROR: invalid target file path : "$path" " duration exceeds granularity period "OPERATION ERROR: Counters file retrieval duration too long, , <date-time file/NE name> , abort process" Example: :> getLatestPMFiles host 123.221.111.222 Successful Notes For 2, at each beginning of the faade a due time is computed, at each check duration the faade should compare current time and due time, if it is exceeded logs error (NE and file name that can#t be retrieved) and stops the processing For 3, no need of password because we use key for authentication. The default user is "nortel" in WICL for FMS 2.1. The keys generation is done on FMS with "nortel" user and the public key is deployed on the server user used by sftp command. Ex: if the public key is deployed on ipcUser server side, the command should be sftp ipcUser@ip_adress.
64
6.6.2

BSG Commands
fmSnapshot command download command activate command fallback command abortUpgradeSession command
The PSG commands are the following:
Table 23 fmSnapshot command fmSnapshot Use this command to retrieve the snapshot BSG Syntax <FDN> fmSnapshot <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. Result Return Value Errors Example: >: BSG FIRST_BSG fmSnaphot Note It only requests the Global State to the BSG and gets the SDO result Retrieve the snapshot of BSG. SDO result An exception can be thrown if any problem is encountered during the execution of the command.
65
Table 24 download command download Use this command to download the specified software from SRS to BSG Syntax <FDN> download -version <SoftVer> \[-automatic\] [-verbose] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. SoftVer: version of the software to download automatic: if this option is enabled, the download software is done automatically else it must be done manually verbose: this parameter is used to output the encountered problem during the execution Result Return Value Errors Download the selected Software version from the SRS into BSG. SDO result An exception can be thrown if any problem is encountered during the execution of the command. The parameter error can occur with the following error messages Example: >: BSG BSG_002 download -version "APP004_P4-1-11" -automatic Job finished without error Note This command is blocked until the software is downloaded into the BSG This is a long operation, see for more information: Long Command Management 'SYNTAX ERROR: Missing parameter "-version". Please refer to the help with command 'help download'.' 'SYNTAX ERROR: unrecognizable parameter <arg>'
66
Table 25 activate command activate Use this command to activate the downloaded software on BSG Syntax <FDN> activate [-verbose] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. verbose: this parameter is used to output the encountered problem during the execution Result Return Value Errors Activate the downloaded version in the BSG. SDO result An exception can be thrown if any problem is encountered during the execution of the command. The parameter error can occur with the following error messages Example: >: BSG BSG_002 activate Job finished without error Note This command is blocked until the activation of the software is done into the BSG. This is a long operation, see for more information: Long Command Management 'SYNTAX ERROR: The "activate" operation for <class> doesn't support any parameter.'
67
Table 26 fallback command fallback Use this command to fallback the downloaded software from the SRS server for BSG Syntax <FDN> fallback [-verbose] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. verbose: this parameter is used to output the encountered problem during the execution Result Return Value Errors Fallback the downloaded version in the BSG. SDO result An exception can be thrown if any problem is encountered during the execution of the command. The parameter error can occur with the following error messages Example: >: BSG BSG_002 fallback Job finished without error Note This command is blocked until the fallback of the software is done into the BSG. This is a long operation, see for more information: Long Command Management 'SYNTAX ERROR: The "fallback" operation for <class> doesn't support any parameter.'
68
Table 27 abortUpgradeSession command abortUpgradeSession Use this command to cancel the upgrade session created by previous 'download' operation of the BSG Syntax <FDN> abortUpgradeSession[-verbose] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. verbose: this parameter is used to output the encountered problem during the execution Result Return Value Errors Example: >: BSG BSG_002 abortUpgradeSession Abort download for 'BSG/BSG_002' successfully. Cancel the upgrade session created by previous 'download' operation of the BSG Abort download for '<internalDn>' successfully An exception can be thrown if any problem is encountered during the execution of the command.
69
6.6.3

SR7710/SR7750 Commands
fmSnapshot command openLink command closeLink command
The SR7710/SR7750 commands are the following:
Table 28 fmSnapshot command fmSnapshot Use this command to retrieve the snapshot 7710/7750SR Syntax <FDN> fmSnapshot <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. Result Return Value Errors Example: >: SR7710 SR7710_002 fmSnaphot >: SR7750 SR7750_002 fmSnaphot Note It only requests the Global State tto the SR 7710/ SR7750 and gets the SDO result Retrieve the snapshot of 77XX. SDO result An exception can be thrown if any problem is encountered during the execution of the command.
70
Table 29 openLink command openLink Use this command to launch an open OAM link administrative state operation on the selected NE. The order to open the link is launched, but this does not mean that the link is opened after the WICL command. To be sure that the link is opened (after some seconds), the unknownStatus of the equipment object has to be verified. The status has to be false to verify if the link is opened. See examples. Syntax <FDN> openLink [-cluster <clusterName>] <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. <clusterName>: select a specific cluster to perform the operation. Result Return Value Launch an open OAM link administrative state operation on a SR 7710/ SR7750. In case of success: Successful Description: [success information] In case of failure: Failed Error description: [detail error information] Errors An exception can be thrown if any problem is encountered during the execution of the command. The following error cases can occur, with the associated message: cannot retrieve NeServices Server 'INTERNAL ERROR: The service is not available. Please check the SMC console' Example: >: SR7710 SR7710_002 openLink Successful Description: SR7710 SR7710_002 is unlocked >: SR7750 SR7750_002 openLink Failed Error Description: Errors happened during unlocking operation
71
Table 30 closeLink command closeLink Use this command to launch a close OAM link administrative state operation on the selected NE. The order to close the link is launched, but this doesn#t mean that the link is closed after the WICL command. To be sure that the link is closed (after some seconds), the unknownStatus of the equipment object has to be verified. The status has to be true to verify if the link is closed. See example. Syntax <FDN> closeLink [-cluster <clusterName>] <FDN>: <clusterName>: select a specific cluster to perform the operation. Result Return Value Launch a close OAM link administrative state operation on the SR7710/SR7750 In case of success: Successful Description: [success information] In case of failure: Failed Error description: [detail error information] Errors An exception can be thrown if any problem is encountered during the execution of the command. The following error cases can occur, with the associated message: cannot retrieve NeServices Server 'INTERNAL ERROR: The service is not available. Please check the SMC console' Example: >: SR7710 SR7710_002 closeLink Successful Description: SR7710 SR7710_002 is locked >: SR7750 SR7750_002 CloseLink Failed Error Description: Errors happened during locking operation
72
6.6.4

FemtoCluster/Femto Commands
cancelSynchroErrorEvent command synchronizeConfigData command
These commands are used to FemtoCluster/Femto or its children objects:
Table 31 cancelSynchroErrorEvent command cancelSynchroErrorEvent Use this command to remove error events coming from Femto to avoid calling repeatedly a rejected command for a Femto during a manual re-synchronization. WMS launches a get on HNM in order to re-synchronize the data Syntax cancelSynchroErrorEvent -dn {dn list} or cancelSynchroErrorEvent -all dn: define list of femtos that will be removed from the desyncho file. all: removes all Femtos from the desynchro file Result Return Value Errors The script ends without error Job result An exception can be thrown if any problem is encountered during the execution of the command. If there is no connection on HNM, the following error message is displayed: OPERATION ERROR: {Error message coming from FAL} Example: > cancelSynchroErrorEvent dn {FemtoNetwork 1 Femto 1} { FemtoNetwork 1 Femto 40 } Job finished without error > cancelSynchroErrorEvent all Job finished with warning
73
Table 32 synchronizeConfigData command synchronizeConfigData Use this command to request a synchronization on a Femto or on a Femto cluster Syntax <FDN> synchronizeConfigData -mode upSync/downSync -type fast/full -verbose <FDN>: to understand the FDN identifiers in UMTS WICL, see FDN Mapping. mode: define the synchronization way upSync is from HNM to WMS downSync is from WMS to HNM fast synchronizes only the de-synchronized Femtos No fast re-synchronization is possible if mode is set to upSync Result Return Value Errors full synchronizes all Femtos verbose: displays more messages The script ends without error Job status An exception can be thrown if any problem is encountered during the execution of the command. The following error cases can occur, with the associated message: DN not found - DN does not exist 'OPERATION ERROR: Exception occurs when retrieving the tradingInfo for {User DN}, no synchronization is launched' DN not found - DN class is not Femto nor FemtoCluster 'OPERATION ERROR: the command <synchronizeConfigData > is not available for {User DN}, no synchronization is launched ' Forbidden mode - if mode is to upSync and type to fast, error should be raised 'OPERATION ERROR: Forbidden mode, no fast type with upSync mode' No connection to HNM 'OPERATION ERROR: {Error message coming from FAL}' Example: > FemtoNetwork 1 Femto 1 synchronizeConfigData mode downSync type full
type: define the synchronization type
74
synchronizeConfigData Job finished without error > FemtoCluster 20 synchronizeConfigData mode upSync verbose Job finished with error Synchronize config data on "femto 1" failed (the message comes from other components)
75
6.7

Work Order Manipulation

The Work Order commands are the following: WO Export Command WO Display Command WO CreateObject Command WO setObject Command WO deleteObject Command
76
6.7.1
WO Export Command
Use the WO Export command to export the work order of a specified FDN. Table 33 WO Export command Syntax WO export -dn <FDN> -f <DFSFile> <FDN>: specifies the FDN of which work order will be exported. <DFSFile>: specifies where the exported work order will be stored. Result Return Value Errors Examples: >: WO export -dn {IPC IPC1} -f dfs:/tmp/Nietzsche.wo The work order is exported to the file. None An exception is returned if an error is encountered.
77
6.7.2
WO Display Command
Use the WO Display command to display the work order of a specified FDN. Table 34 WO Display command Syntax WO display -dn <FDN> <FDN>: specifies the FDN of which work order will be displayed. Result Return Value Errors Examples: >: WO display -dn {IPC IPC1} The formatted contents of the work order of the specified FDN is displayed. The contents of the work order. An exception is returned if an error is encountered.
78
6.7.3
WO CreateObject Command
Use the WO CreateObject command to create an object from a specified FDN, in offline mode. Table 35 WO CreateObject command Syntax WO CreateObject -dn <FDN> <AttributeName1> <Value1> ... <AttributeNameN> <ValueN> <FDN>: specifies the FDN from which will be created an object. <AttributeName>: name of the attribute <AttributeValue>: value of the attribute Result Return Value Errors Examples: >: WO createObject -dn {IPC IPC1 SNMPParamv3 1} Create a specified object in the WO which has been loaded. The final status of the creating job. An exception is returned if an error is encountered.
79
6.7.4
WO setObject Command
Use the WO setObject command to change the value of an attribute. Table 36 WO setObject command Syntax WO setObject -dn <FDN> <AttributeName1> <Value1> ... <AttributeNameN> <ValueN> <FDN>: specifies the FDN of which attribute value will be defined. <AttributeName>: name of the attribute <AttributeValue>: value of the attribute, the new value to set. Result Return Value Errors Examples: >: WO setObject -dn {IPC IPC1 SNMPParamv3 1} Set the attribute value of a specified object in the WO which has been loaded. The final status of the setting job. An exception is returned if an error is encountered.
80
6.7.5
WO deleteObject Command
Use the WO deleteObject command to delete objects in offline mode Table 37 WO deleteObject command Syntax WO deleteObject -dn <FDN> <FDN>: specifies the FDN of which specified object will be deleted. Result Return Value Errors Examples: >: WO deleteObject -dn {IPC IPC1} Delete a specified object in the WO which has been loaded. The final status of the deleting job. An exception is returned if an error is encountered.
81
6.8

Configuration Manager Commands

The Configuration Manager Commands are the following: CM createSession Command CM terminateSession Command CM abortSession Command CM Validate Command CM listSession Command CM displaySession Command CM preActivateCommand CM Activate Command CM Resume Command CM setActivationType Command CM getAvailableConfigModels Command CM export Command CM exportRNS Command CM getImpactedConfigNodes Command CM getImpactedConfigNodesInfo Command CM excludeNodes Command CM fallback Command CM exportCluster Command
82
6.8.1
CM createSession Command
Use the CM createSession command to create new sessions in the Configuration Manager. Table 38 CM createSession command Syntax CM createSession <sessionName> -file <DFSFile> [-excludeDN <list of exclude confignodes>] <sessionName>: specifies the name of the session which will be created. <DFSFile>: specifies the DFS path of the work order. <list of exclude confignodes>: list of ConfigNodes to exclude from the session Result Return Value Errors Examples: >: CM createSession sess1 -f dfs:/tmp/test.xwo Create a new session with a specified name. SDO result: seeLong Command Management for more details. An exception is returned if an error is encountered.
83
6.8.2
CM terminateSession Command
Use the CM terminateSession command to remove a specific session in the Configuration Manager. Table 39 CM terminateSession command Syntax CM terminateSession <sessionName> <sessionName>: specifies the name of the session to be removed. Result Return Value Errors Examples: >: CM terminateSession sess1 Remove a specific session. None An exception is returned if an error is encountered.
84
6.8.3
CM abortSession Command
Use the CM abortSession command to abort a specific session in the Configuration Manager. Table 40 CM abortSession command Syntax CM abortSession <sessionName> <sessionName>: specifies the name of the session to be aborted. Result Return Value Errors Examples: >: CM abortSession sess1 Abort a specific session. SDO result: seeLong Command Management for more details. An exception is returned if an error is encountered.
85
6.8.4
CM Validate Command
Use the CM Validate command to validate in the Configuration Manager a specified session Table 41 CM Validate command Syntax CM Validate <sessionName> [-dn <list of nodes>] <sessionName>: specifies the name of the session which will be validated. <list of nodes>: specifies the list of nodes which will be validated. An empty list should mean all the nodes of the session. Result Return Value Errors Examples: >: CM validate sess1 Node job information: {IPC IPC1} {job finished without error} Validate in the Configuration Manager a specified session and specified nodes into this session. The result for each node. An exception is returned if an error is encountered.
86
6.8.5
CM listSession Command
Use the CM listSession command to list sessions and their activation status in the Configuration Manager. Table 42 CM listSession command 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 Return Value Returns session names and their activation status. Session names and their activation status. The activation status should be one of the following values: Idle, InProgress, Activated or FallbackCompleted. An exception is returned if an error is encountered.
Errors Examples:
>: CM listSession {sess1 Idle} {sess2 Activated}
87
6.8.6
CM displaySession Command
Use the CM displaySession command to display all the attributes of a specified session in the Configuration Manager. Table 43 CM displaySession command Syntax CM displaySession <sessionName> [-dn <node list>] <sessionName>: specifies the name of the session that is to be displayed. <node list>: specifies the name of the nodes to query. Result Return Value Errors Examples: >: CM displaySession CT_create_ipc1_1193645053 activationStatus Activated node {IPC IPC1} currentStatus Activated validateStatus Passed allowedActivationTypes Default currentActivationType Default report { } stepHistory Load 100% availableOperations Fallback, Exclude Returns all the attributes of a specified session. All the attributes of the specified session. An exception is returned if an error is encountered.
88
6.8.7
CM preActivateCommand
Use the CM preActivate command to launch the pre-activate operation in the Configuration Manager. Table 44 CM preActivate command Syntax CM preActivate <sessionName> [-dn <node list>] <sessionName>: specifies the name of the session to be pre-activated. <node list>: specifies the name of the nodes to query. Result Return Value Errors Examples: >: CM preActivate sess1 -dn {IPC IPC1} Node job information: {IPC IPC1} {job finished without error} Launch the pre-activate operation in the Configuration Manager. The result for each node. An exception is returned if an error is encountered.
89
6.8.8
CM Activate Command
Use the CM Activate command to launch the activate operation in the Configuration Manager. Table 45 CM Activate command Syntax CM Activate <sessionName> [-dn <rootDn list>] <sessionName>: specifies the name of the session to be activated. <rootDn list>: specifies the list of Root DNs. An empty sequence for rootObjects should mean all rootObjects. Result Return Value Errors Examples: >: CM activate sess1 -dn {IPC IPC1} Node job information: {IPC IPC1} {job finished without error} Launch the activate operation in the Configuration Manager. The result for each node. An exception is returned if an error is encountered.
90
6.8.9
CM Resume Command
Use the CM Resume command to resume a specified session and specified nodes into this session in the Configuration Manager. Table 46 CM Resume command Syntax CM resume <sessionName> [-dn <node list>] <sessionName>: specifies the name of the session which will be resumed. <node list>: specifies the list of nodes to be resumed. An empty list should mean all nodes of the session. Result Return Value Errors Examples: >: CM resume sess1 Node job information: {IPC IPC1} {job finished without error} Resume a specified session and specified nodes into this session in the Configuration Manager. The result for each node. An exception is returned if an error is encountered.
91
6.8.10
CM setActivationType Command
Use the CM setActivationType command to set the activation type in the Configuration Manager. Table 47 CM setActivationType command Syntax 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: No check on impacts (SEPE: build offline/online depending on initial state, PP: activation without check if the NE will restart) ONLINE : 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. SINGLESTEP: 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 Return Value Errors Examples:
Set the activation type in the Configuration Manager. The result for each node. An exception is returned if an error is encountered.
>: CM setActivationType sess1 {IPC IPC1} critical Successful Nodes: {IPC IPC1}
92
6.8.11
CM getAvailableConfigModels Command
Use the CM getAvailableConfigModels command to retrieve list of domains that can be exported by the Configuration Manager Table 48 CM getAvailableConfigModels command Syntax Result Return Value Errors Examples: >: CM getAvailableConfigModels {UTRAN} {standard statesAndStatus inventory AdditionalInformation} CM getAvailableConfigModels Displays information on Config Model. Returns information on Config Model. An exception is returned if an error is encountered.
93
6.8.12
CM export Command
Use the CM export command to export all NE information or domain network information into a given XML format file. Table 49 CM export command Syntax CM export -file <dfsFilePath> -dn <FDN_List> [-p|-s|-inv|-ai] [-customer|-manufacturer] [-compressed] [-errStr <errMsg>] CM export -file <dfsFilePath> -dn <FDN_List> -iandc [-compressed] [-errStr <errMsg>] CM export -file <dfsFilePath> -domain <domainList> [-p|-s|-inv|-ai] [-customer|-manufacturer] [-compressed] [-errStr <errMsg>] CM export -file <dfsFilePath> -domain <domainList> -iandc [-compressed] [-errStr <errMsg>] <dfsFilePath>: logical Path of the generated XML files (in DFS) <FDN_list>: a specific section to export. <domainList>: the UTRAN 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. -customer: visibility on Customer data. -manufacturer: visibility on Manufacturer data. <errMsg>: a Tcl variable to retrieve problems encountered during the execution of the command. Result Return Value Export NE information or domain network information into a given XML format file. SUCCEEDED, COMPLETED_WITH_WARNING, COMPLETED_WITH_ERRORS, FAILED or CANCELLED. If the export is all completed well: SUCCEEDED If any warnings are encountered during the export: COMPLETED_WITH_WARNING. If any errors are encountered during the export: COMPLETED_WITH_ERRORS If the export is failed: FAILED If the job is cancelled: CANCELLED
94
Errors Examples:
An exception is returned if any problem is encountered during the execution of the command or if the export is not totally well done.
# export a specific Distinguished Name information >: CM export -f /cmXML/IPCC_0.xml -dn {IPC FIRST_IPC} -p -c Job finished without error Notes One of '-m' and '-c' parameters is mandatory, i.e., you must input '-m', '-c' or '-m -c' in command line.
95
6.8.13
CM exportRNS Command
Use the CM exportRNS command to export RNS information of the associated root subtree into a given XML format file, or only a specific section of the Network. Table 50 CM exportRNS command Syntax CM exportRNS -f.ile <dfsFilePath> -dn <FDN_List> [-p|-s|-inv|-ai] [-customer|-manufacturer] [-compressed] [-errStr <errMsg>] CM exportRNS -f.ile <dfsFilePath> -dn <FDN_List> -iandc [-compressed] [-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. -customer: visibility on Customer data. -manufacturer: visibility on Manufacturer data. <errMsg>: aTcl variable to retrieve problems encountered during the execution of the command. Result Return Value Export NE information into a given XML format file. Errors Examples: >: CM exportRNS -f /cmXML/IPC_1.xml -dn {IPC FIRST_IPC} -p -c job finished without error Note One of '-m' and '-c' parameters is mandatory, i.e., user must input '-m', '-c' or '-m -c' in command line If the export is all completed well: job finished without error If any warnings are encountered during the export: job terminated with warning. If any errors are encountered during the export: job terminated with error If the export is failed: job finished with error If the job is cancelled: job cancelled
An exception is returned if any problem is encountered during the execution of the command
96
97
6.8.14
CM getImpactedConfigNodes Command
Use the CM getImpactedConfigNodes command to get the list of Config Nodes impacted by a specified work order. Table 51 CM getImpactedConfigNodes command Syntax CM getImpactedConfigNodes -file <DFSFile> <DFSFile>: specifies the DFS path of the work order. Result Return Value Errors Examples: >: CM getImpactedConfigNodes -f /cmXML/IPC_0.xml {IPC FIRST_IPC} Find the list of Config Nodes in the work order. The list of Config Nodes found in the work order.. An exception is returned if an error is encountered.
98
6.8.15
CM getImpactedConfigNodesInfo Command
Use the CM getImpactedConfigNodesInfo command to get the list of Config Nodes impacted by a specified work order and their activation steps. Table 52 CM getImpactedConfigNodesInfo command Syntax CM getImpactedConfigNodesInfo -file <DFSFile> <DFSFile>: specifies the DFS path of the work order. Result Return Value Errors Examples: >: CM getImpactedConfigNodes -f /cmXML/IPC_0.xml {{IPC IPC1} AtSessionCreation} {{IPC IPC22} InSession} {{IPC IPC3} AtSessionCreationAndInSession} Find the list of Config Nodes in the work order and their activation steps. The list of Config Nodes found in the work order and their activation steps. An exception is returned if an error is encountered.
99
6.8.16
CM excludeNodes Command
Use the CM excludeNodes command to exclude specified nodes from a given session. Table 53 CM excludeNodes command Syntax CM excludeNodes<sessionName> [-dn <node list>] <sessionName>: specifies the name of the given session. <node list>: specifies the list of nodes which will be excluded. An empty list should mean all nodes of the session. Result Return Value Errors Examples: >: CM excludeNodes sess1 -dn {IPC IPC1} Node job information: {IPC IPC1} {job finished without error} Exclude the specified nodes from a given session. The result for each node. An exception is returned if an error is encountered.
100
6.8.17
CM fallback Command
Use the CM fallback command to fallback the activation of specified nodes for a given session. Table 54 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 which will be fallbacked. An empty list should mean all nodes of the session. Result Return Value Errors Examples: >: CM fallback sess1 -dn {IPC IPC1} Node job information: {IPC IPC1} {job finished without error} Launch the fallback operation in the Configuration Manager. The result for each node. An exception is returned if an error is encountered.
101
6.8.18
CM exportCluster Command
Use the CM exportCluster command to export the information of the associated root subtree into a given XML format file, or only a specific section of the Network. Table 55 CM exportCluster command Syntax CM exportCluster -f.ile <dfsFilePath> -dn <userDnList> [-p|-s|-inv|-ai][-c.ustomer][-m.anufacture][-comp.ressed][-errStr <errMsg>] CM exportCluster -f.ile <dfsFilePath> -dn <userDnList> -iandc [-comp.ressed][-errStr <errMsg>] <dfsFilePath>: logical Path of the XML file (in the Distributed File System) <userDNList>: a specific section to be exported <compressed>: enable to compress the generated file <p>: attribute qualifier of standard <s>: attribute qualifier of statesAndStatus <iandc>: attribute qualifier of installationAndCommisioning <inv>: attribute qualifier of inventory <ai>: attribute qualifier of AdditionalInformation <customer>: visibility on Customer data <manufacture>: visibility on Manufacturer data <errMsg>: tcl variable to store the list of problems found when executing the CM export Result Return Value Export NE information into a given XML format file. Errors Example If the export is all completed well: job finished without error If any warnings are encountered during the export: job terminated with warning If any errors are encountered during the export: job terminated with error If the export is failed: job finished with error If the job is cancelled: job cancelled
An exception can be thrown if any problem is encountered during the execution of the command. >: CM exportCluster -f /cmXML/FemtoCluster_1.xml -dn {FemtoCluster 1} -p -c job finished without error
Note
One of '-m' and '-c' parameters is mandatory, i.e., user must input '-m', '-c' or '-m -c' in command line
102
103
6.9
AT Commands
Use the 'at' command to submit a job for a given date and time. The current behavior of the command 'at' 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 'Not Executed-Time expiration' the next time WICL startup, and the jobs won't be executed. It is not possible to schedule two jobs at the same time.
The 'at' commands are the following: at exec Command at list Command at eval Command at listall Command at remove Command at result Command at info Command
104
6.9.1
Date and Time Syntax
Table 56 Date-and-time syntax 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)
105
6.9.2
at exec Command
Use the at exec command schedules the evaluation of the script <script-file> for <date&time> and returns a job-id. A null job-id value means an error occurs. Table 57 at - exec command Syntax at <date&time> exec <script file> <date&time>: seeDate-and-time syntax 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. Which means that if the NSP WICL session is opened from a PC, the script file path is the PC file system. Otherwise, if the NSP WICL session is opened in a Unix System or by the wiclsh tool, the script file path is the Unix file system. Result Return Value Errors Example: # Schedule in one minute the WICL script >: at today now + 1 min exec /tmp/ipcExample.wicl This command schedules the evaluation of the command <command> for <date&time> A Job Id number An exception is returned if any error is encountered during the scheduling of the command.
106
6.9.3
at list Command
Use the at list command to retrieve the list of scheduled jobs Table 58 at - list command Syntax Result Return Value Errors Example: # Get all the job launched by this NSP user >: at list 1002030779000 1002030779001 at list This command gets the list of all jobs scheduled by the connected NSP user A list of JobIds An exception is returned if any error is encountered during the execution of the command.
107
6.9.4
at eval Command
Use the at eval command to schedule the evaluation of the command <command> for <date&time> and returns a job-id. A null job-id value means an error occurs. Table 59 at - eval command Syntax at <date&time> eval <command> <date&time>:for more information about this parameter, see Date and Time Syntax. <command>: a WICL command string Result Return Value Errors Example: # Schedule in one minute the set WICL command for the selected IPC >: at today now + 1 min eval IPC 0 set userSpecificInfo 44 This command schedules the evaluation of the command <command> for <date&time> A Job Id number An exception is returned if any error is encountered during the scheduling of the command
108
6.9.5
at listall Command
Use the at listall command to retrieve the list of all scheduled jobs by all users Table 60 at - listall command Syntax Result Return Value Errors Example: # Get all the jobs >: at listall 1002030779000 1002030779001 1142411751 1150792737 1151032225 Notes This command returns the list of all jobs from all users and all sessions at listall This command gets the list of all scheduled jobs by all users A list of all JobIds An exception is returned if any error is encountered during the execution of the command.
109
6.9.6
at remove Command
Use the at remove command to delete the job <job-id> from the job queue. Table 61 at - remove command Syntax Result Return Value Errors Example: # Remove the Job with the selected JobId >: at remove 1002030779000 at remove <job-id> <job-id>: a job Id returned by at list command or by scheduling commands This command removes the job <job-id> from the job queue None An exception is returned if any error is encountered during the execution of the command.
110
6.9.7
at result Command
Use the at result command to retrieve the result of the job <job-id>. Table 62 At - result command Syntax Result Return Value at result <job-id> <job-id>: a job Id returned by at list command or by scheduling commands This command returns the result of the job <job-id> If the job is not already executed: Not 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 Not executed yet An exception is returned if any error is encountered during the execution of the command.
111
6.9.8
at info Command
Use the at info command to retrieve information about a job. Table 63 at - info command Syntax Result Return Value at info <job-id> <job-id>: a job Id returned by at list command or by scheduling commands This command returns information about the job <job-id> The following information: Errors Example: # Launch a display command >: set id [at now + 1 min eval ipc 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: IPC 1 dis Submission date: 2002-6-25 18:3 Execution date: 2002-6-25 18:4 State: Not Executed yet Owner: nortel Command: IPC 1 dis
An exception is returned if any error is encountered during the execution of the command.
112
6.10

East West Interface

Two commands are available to manage the East West interface: EW ewWmsRetrieve EW ewWmsGenerateWO
113
6.10.1
EW ewWmsRetrieve
Use the EW ewWmsRetrieve command to parse the FMS E/W interface configuration file /opt/nortel/data/custom/eastwest/ewWmsItf.cfg and iterate over the records corresponding to the specified group, if provided, or over all the records, to retrieve the CMXML snapshot files exported on each remote WMS server. The command decrypts the encrypted password by using the /opt/nortel/exe/fmk/fmk_crypto.x utility, then gives this password as argument to the ftpGet command to trigger the CMXML snapshot file retrieval for each WMS server specified in the E/W interface configuration file. The command uses: the appropriate remote WMS hostname, the FTP account login and password, the filepath based on the FTP path specified in the E/W interface configuration file and on the desired snapshot date the appropriate target path based on the remote WMS hostname and session name.
Prior to retrieving the CMXML snapshot files from the WMS servers, the command creates the appropriate directory structure (<date>/<session name>/<WMS hostname>) Table 64 EW ewWmsRetrieve command Syntax EW ewWmsRetrieve [-session <session name>] -date <desired snapshot date> [group <group id>] <desired snapshot date>: date the CMXML snapshot files to retrieve corresponds to. The syntax is: YYYYMMDD. <session name>: name of the session that is to be associated with the retrieved snapshots. If this parameter is not provided, the default value "WmsMacroCellSynchronization" must be considered. Optional parameter. <group id>: Id of the group specified for each record defined in the E/W interface configuration file. Optional parameter. Result Return Value The snapshot files from the WMS servers corresponding to the specified filter are successfully retrieved. For each file, indicates the operation result: Errors file successfully retrieved file not found host unreachable transfer error
An error is returned if any problem is encountered during the execution of the command.
114
Example: >: EW ewWmsRetrieve -session mySession2 -date 20070806 group 2
115
6.10.2
EW ewWmsGenerateWO
Use the EW ewWmsGenerateWO command to trigger the parsing of the CMXML snapshots retrieved for the specified session name, the identification of the MacroCell updates, the generation of the corresponding WO and reverse WO. This command uses a service provided by CP_FMS, performing the MacroCell update identification and WO/reverse-WO generation operations. The command provides the CP_FMS service with the following parameters: List of local CMXML snapshot file paths (ex: dfs:/eastwest/cmxml/<date>/<session name>/<WMS hostname>/<CMXML snapshot filename>). There is one CMXML file path for each WMS server. If several CMXML snapshots are present in the same WMS directory, the latest one has to be chosen. The command recurses the WMS folders under the date folder corresponding to the <session date> parameter. If no <session date> was specified, the current date is used. dfs path of the workorder file that is generated by the CP_FMS service. If no <workorder filepath> was specified, the one to use is formatted as dfs:/cmXML/<date>_<session name>.xwo, where date is the <session date> passed as parameter if present, or the current date otherwise.
Table 65 EW ewWmsGenerateWO command Syntax EW ewWmsGenerateWO -session <session name> [-date <desired snapshot date>] [[-outputfile <workorder filepath>] <desired snapshot date>: date corresponding to the desired session. Format is: YYYMMDD. <session name>: name of the session previously associated to the retrieved CMXML snapshots. Optional parameter. <workorder filepath>: dfs path to the workorder file to be generated. Optional parameter. Result Return Value Errors Example: >: EW ewWmsGenerateWO -session mySession2 >: EW ewWmsGenerateWO -session mySession2 -date 20070917 >: EW ewWmsGenerateWO -session mySession2 -date 20070917 -outputfile dfs:/cmXML/20070917_customEWSynchro.xwo The WO and corresponding reverse WO are successfully generated and stored in the FMS /opt/nortel/data/cmxml folder Path of the generated WO file. An error is returned if any problem is encountered during the execution of the command.
116
6.11
Configuration File
WICL offers to the 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_STRING = 'hello world' The configuration file commands are the following: WICLConfigInit Command WICLConfigGetValue Command
117
6.11.1
WICLConfigInit Command
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 66 WICLConfigInit command Syntax WICLConfigInit <filename> <filename>: logical path using the supported file systems (dfs, local) Result Return Value Errors Example: # Get the config file from the dfs file system. >: WICLConfigInit dfs:wicl/upgrade/config.cfg Set the filename as the config file and read in memory all configurable variables None An error is returned if any problem is encountered while accessing the configuration file.
118
6.11.2
WICLConfigGetValue Command
USe the WICLConfigGetValue command to get a configuration value using the param key. Table 67 WICLConfigGetValue command Syntax WICLConfigGetValue <param> <param>: type this parameter name to obtain its value Result Return Value Errors Example: # Get the config param: param1. This config parameter has to be >: WICLConfigGetValue param1 15 Get a configuration value using the param key. Parameter value if exists, otherwise nothing An error is returned if any problem is encountered while accessing the configuration file.
119
6.12
Trace File
WICL offers some commands to handle a trace file. A user must be able to write traces during the execution of the 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 WICLTrace Command WICLTraceError Command WICLTraceBegin Command WICLTraceEnd Command
120
6.12.1
WICLTraceInit Command
Use the WICLTraceInit command to initialize a trace file in order to write traces in it. Table 68 WICLTraceInit command 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 Errors Example: # Initialize the trace file using level 5 >: WICLTraceInit scriptUpgrade.log 5 Notes 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 initialisation, the trace string is written into the file. None An error is returned if any problem is encountered while accessing the trace file.
121
6.12.2
WICLTrace Command
Use the WICLTrace command to write a trace line in the trace file. Table 69 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. None An error is returned if any problem is encountered while accessing the trace file.
Return Value Errors Example: # Write a trace
>: WICLTrace 'Starting my script traces'
122
6.12.3
WICLTraceError Command
Use the WICLTraceError command to write a trace error line in the trace file. Table 70 WICLTraceError command 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 string will have the date and time stamped. None An error is returned if any problem is encountered while accessing the trace file.
Return Value Errors Example:
# Write an error trace. >: WICLTraceError 'Error message displaying'
123
6.12.4
WICLTraceBegin Command
Use the WICLTraceBegin command to write a begin trace line in the trace file. Use it inside a procedure. Table 71 WICLTraceBegin command Syntax 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. None An error is returned if any problem is encountered while accessing the trace file.
Return Value Errors 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
124
6.12.5
WICLTraceEnd Command
Use the WICLTraceEnd command to write an end trace line in the trace file. Use this method inside a procedure. Table 72 WICLTraceEnd command 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 string will have the date and time stamped. 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 the WICLTraceEnd command. Return Value Errors Example: # Write an end trace. >: proc hello {} { WICLTraceBegin 'this is a hello example'; WICLTraceEnd 'exiting from HelloExample'; } # The trace that is found in the trace level is: # 16/05/2003-13:12:55 wctfs393 22232 INT # End hello{}, exiting from HelloExample None An error is returned if any problem is encountered while accessing the trace file.
125
6.13
File Management
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 close Command dir Command
126
6.13.1
open Command
Use the open command to open a file into the managed file system. Table 73 open command Syntax 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 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 Result Return Value Errors Example: # Open a DFS file to write >: set fd [open dfs:/wicl/output.txt 'w'] 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.
Open the selected file with the selected access mode. A channel identifier that will be used for later invocations of commands like read, gets, close or puts. An error is returned if any problem is encountered while opening the file.
127
6.13.2
close Command
Use the close command to close a file in the managed file system. Table 74 close command Syntax close <file descriptor> <file descriptor>: It is the channel identifier returned by the command open Result Return Value Errors Example: # Close the file that has the file descriptor: file25. >: Close file 25 Close the selected file None An error is returned if any problem is encountered while closing the file.
128
6.13.3
dir Command
Use the dir command to display a list of files in a given directory. Table 75 dir command Syntax dir <scheme>:<scheme-specific-part> <scheme>: dfs<scheme-specific-part>: dfs-path Result Return Value Errors Example: >: dir dfs:/access/neBackup ./dir1 ./dir2 file1.bkp file2.bkp Display the list of files in the specified directory. None An error is returned if any problem is encountered while closing the file.
129
6.14
Help Commands
A help command is available in WICL. It gives you online information on the WICL commands. The help commands are the following: help Command help <wicl_command> Command
130
6.14.1
help Command
Use the help command to display the list of all the WICL commands which have online help information available. Table 76 help command Syntax Result Return Value Errors Example: # Get the list of commands that have help information. >: help Available WICL help for basic commands: after append array break catch clock concat continue eof error eval exists 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: allDesynchro close closeLink dir display exec get getAlarms GetAll GetAttributes GetDescription getEnv mpggExec open openLink ROC setEnv SetOnline utran WICLConfigGetValue WICLConfigInit WICLTrace WICLTraceBegin WICLTraceEnd WICLTraceError WICLTraceInit Available help information for all the commands in domain <UTRAN>: createRootObject deleteRootObject utran help List of commands which have help information List of commands which have help information None
131
6.14.2
help <wicl_command> Command
Use the help <wicl_command> command to get help information about specified WICL commands. Table 77 Help <wicl_command> command Syntax help <wicl_command> <wicl_command>: a Tcl or WICL command name Result Return Value Errors Examples: #help.about createOnline WICL command >: help CreateOnline Command <createOnline> in domain <COMMON> Syntax: <User DN> createOnline <AttributeName1> <Value1>...<AttributeNameN> <ValueN> Parameters: AttributeName : the name of the attribute. Value : the new value to set. Result: create the selected object. Return Value: the final status of the createOnline job. Errors: An exception is returned if an error is encountered. Example: IPC IPC_1 createOnline # help.about get WICL command >: help get Command <get> in domain <COMMON> Syntax: <User DN> get <AttributeName> Parameters: AttributeName: Name of the attribute Result: get an attribute value from the selected User DN Return Value: the attribute value Errors: An exception can be returned if an error is encountered. RNC RNCM1_1 get clusterId Help infomation about specified WICL command Help infomation about specified WICL command An exception is returned if no help information is available for the specified command.
132
133
6.15
Long Command Management

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.
134
To change the timeout value, set the <value> parameter of the setMaxTimeout command as shown below: Table 78 setMaxTimeout command setMaxTimeout Set the timeout max for long operations Syntax SetMaxTimeout <value> <value>: a timeout value in minutes Result Return Value Errors Examples: # Set the timeout to 3 hours: 180 minutes >: setmaxTimeout 180 Notes This command is not case sensitive. It modifies the default value of timeout for long commands Nothing. None
135
6.16
OAM Software Management

To simplify OAM software management and upgrade, a WICL command generates a brief description of the currently installed OAM software. System administrators can use this information to easily perform software maintenance. Table 79 OAM command OAM This command lists 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 servers in ROC, this command can generate these markers and synthesize them into a complete description. Syntax OAM inventory [-cluster serverName] serverName: specify the server from which to retrieve software marker. If it is omitted, all the supported servers in ROC will be examined. Result Return Value Errors A descriptive message about OAM software information in ROC Return a string representation of software markers in ROC An exception is returned if an error is encountered. If wrong command or parameters are used, the following error messages are displayed: Examples: # Get software markers on all the servers in ROC >: OAM inventory UMAINSERV1 (zctfs317)3GPP 3gpp.2.1.0.0 installed Missing products: Emergency patch installed: Unexpected patch installed: Unexpected product installed: Historical Fault Browser hfb.2.1.0.0 installed Missing products: Emergency patch installed: "SYNTAX ERROR: Wrong args # should be: "oam inventory ?-cluster name?" "SYNTAX ERROR: Only the "inventory" operation is available for OAM command" "SYNTAX ERROR: Only the "-cluster" option is available for OAM command"
136
OAM Unexpected patch installed: Unexpected product installed: ... # Get software marker on specific server >: OAM inventory -cluster UMAINSERV1 UMAINSERV1 (zctfs317)3GPP 3gpp.2.1.0.0 installed Missing products: Emergency patch installed: Unexpected patch installed: Unexpected product installed: Historical Fault Browser hfb.2.1.0.0 installed Missing products: Emergency patch installed: Unexpected patch installed: Unexpected product installed: ...
137
6.17
Environmental Variable Management

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 getEnv Command
Some environmental variables can be manipulated by setenv and getenv commands: DOMAIN 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 domainName to distinguish NEs with the same name in OAM system, such as OAM objects -cluster <clusterName> Use the specified clusterName to query NEs in OAM system -verbose Display more detailed information for command execution, such as errors or warnings when executing the SDO jobs
138
6.17.1
setEnv Command
Use the setEnv command to set environmental variables. Table 80 setEnv command Syntax setEnv <varName> <varValue> varName: name of the variable to be set. varValue: variable value to be set. Result Return Value Errors Example: >: setEnv default_cluster UMAINSERV1 Notes If the input command line does not include the '-cluster' option, the operation will be performed on the default cluster. Set the environmental variable with <varValue>. None An exception is returned if the varName or varValue is not correct or is not supported.
139
6.17.2
getEnv Command
Use the getEnv command to get environmental variables. Table 81 getEnv command Syntax getEnv <varName> varName: name of the variable to get. Result Return Value Errors 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 Notes If the input command line does not include the '-cluster' option, the operation will be performed on the default cluster. Get the environmental <varValue>. The variable value. An exception is returned if the varName is not supported.
140
WICL - Script Management

Scripts are sequences of simple WMS commands that can be expressed in WICL format. To create or modify script files the user can use any standard editor or the WICL Script Editor InTerm interface which is the WICL Script Editor accessible from the NSP GUI window. The execution of the scripts can be done instantly or scheduled once, on hourly, daily, weekly, monthly or yearly basis. In addition, theJob Scheduler tool can be used. It is a job management tool to be launched from the NSP GUI. Script Edition and Storage The edition of a script file (*.wcl) 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 in to the server) and cannot be performed by standard users. Alcatel-Lucent recommends to store the WICL scripts in the OAM Distributed File System (DFS). This Distributed File System 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. The WICL scripts are backed up by the OAM Backup and Restore function By default, the scripts are currently stored in two directories: in 'dfs:/wicl', which points to /opt/nortel/shell/wicl/scripts, for the Alcatel-Lucent delivered scripts in 'dfs:/wicl/user', which points to /opt/nortel/data/wicl/user, for the customer scripts These scripts are kept after an upgrade of the OAM software. Access to the scripts is protected by file access rights which depend on the type of file system used. The following table describes the file system managed by WICL: Table 82 Script access security File System Owner Rights Default Rights (at creation) R/W (user nortel) R/W (user nortel)
file: dfs: Script Execution
nortel dfsnortel
Unix rights R/W
A WICL script file is executed via the Exec command described in the following table. Table 83 Exec command
141
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. 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 Error Example An exception is returned if the file is not found or inaccessible. # Execute a WICL script which is found in DFS exec dfs:/wicl/Upgrade/Upgrade010302.wcl exec dfs:/wicl/nortelScript.wcl exec dfs:/wicl/user/userScript.wcl Note When using the exec command, the WICL directory is added automatically into the read dfs path. The real path in the examples is as follows: /opt/nortel/shell/wicl/scripts/Upgrade/Upgrade010302.wcl /opt/nortel/shell/wicl/scripts/nortelScript.wcl /opt/nortel/data/wicl/user/userScript.wcl The script can retrieve the parameters using the tcl argv variable
142
WICL Script examples

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. WICL provides three methods to run the user scripts. The examples of WICL scripts are: Open Link IPC WICLConfig example WICLConfig WICLTrace
143
8.1
Open Link IPC

The following script retrieves the list of all IPCs and opens the OAM link: OpenlinkAllipc.wcl is saved in /opt/nortel/shell/wicl/scripts/user: set ipclst [utran list IPC] foreach ipc $ipclst { if {![catch {$ipc getStatus} rslt]} { foreach {statName statValue}$rslt { if {$statName == "unknownStatus" && $statValue == "true"} { eval $ipc openlink } } } } To launch this script from UNIX: % /opt/nortel/shell/wicl/wiclsh -u <Username> p <Password> -f /opt/nortel/shell/wicl/scripts/user/OpenlinkAllipc.wcl Or via NSP WICL console: >: exec dfs:wicl/user/OpenlinkAllipc.wcl
144
8.2
WICLConfig example
This WICL script loads a configuration file for the script, to modify its default behavior. The containment of the configuration file is as follows: FIRST_WORD = hello SECOND_WORD = World INIT_MESSAGE = '${FIRST_WORD} ${SECOND_WORD} message' For example, the name of the script can be wiclConfigEx.wcl and saved in /opt/nortel/shell/wicl/scripts/user. The wiclConfigEx.wcl is as follows: WICLConfigInit dfs:/wicl/config/configEx.cfg set str [WICLConfigGetValue INIT_MESSAGE] puts $str To launch this script from NSP WICL: >: exec dfs:wicl/user/wiclConfig.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/wiclConfigEx.wcl Example: 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 Starting Wireless Internet Command Language Script mode launched hello World message Disconnecting.... To launch this script from WICL Script Editor: Select the File/Script browser submenu Select the user directory Select the wiclConfigEx.wclfile Click Run
145
8.3
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 /opt/nortel/shell/wicl/scripts/user. 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 WICLTrace 'End of script' To launch this script from the NSP WICL window: >: exec dfs:wicl/user/wiclTrace.wcl To launch this script from Unix shell: % /opt/nortel/shell/wicl/wiclsh -u <Username> -p <Password> -f /opt/nortel/shell/wicl/scripts/user/wiclTraceEx.wcl
146
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/wiclsh -u <Username> -p <Password> -f /opt/nortel/shell/wicl/scripts/user/wiclTraceEx.wcl -trace 5 Starting Wireless Internet Command Language Script mode launched Disconnecting.... The result trace file in /opt/nortel/shell/wicl/scripts/user/traces/traceEx.tra is: 27/06/2002-09:00:00 wjbas0fm TRA This is a WICL trace example 27/06/2002-09:00:00 wjbas0fm INT Begin of proc example 27/06/2002-09:00:00 wjbas0fm INT End of proc example 27/06/2002-09:00:00 wjbas0fm TRA End of script To launch this script from WICL Script Editor: Select the File/Script browser submenu Select the user directory Select the wiclTraceEx.wcl file Click Run
147
WICL Script Editor - InTerm

Use the graphical interface InTerm to edit, run and manage WICL scripts and script directories. The Interm graphical interface is accessed from the Configuration > WICL Script Editor submenu of NSP. With InTerm you can perform: WICL script editing WICL script management WICL script running and scheduling
148
9.1
WICL script editor

Use the graphical WICL Script Editor to create, edit and save WICL scripts.
Figure 3 Script Editor main window
The WICL commands are displayed in the top left panel in a tree view. You can expand the tree to find the target command. You can select a command, input parameters for this command, and insert/add it to a script file. While selecting a command, the WICL command parameter wizard window is initialized. You can input parameters to make a complete WICL command, and insert/add it to the script file which is opened and currently active in the right panel. Then you can search, delete or move text fragments using the Edit sub-menus.
149
9.1.1
WICL command parameter wizard
This window appears after selecting a command in the tree of the command wizard window. It shows selected command parameter information and acceptable parameters input. Attribute-value parameters are enabled after a FDN is selected. Optional fields have related check boxes. They are only available when related check boxes are selected. Figure 4 WICL command parameter wizard
Procedure
Step Action
1. Select a command in the tree of the command wizard window. The Parameter wizard window appears. It shows input areas for parameters. 2. Input parameters and option values. Use FDN Select Dialog to input the FDN parameters. 3. Click Make Command. The result command is displayed in the Command field.
150
4. Click Insert to insert the command string into the current file, or click Add to add the command string to the end of the current file. Note: Note that a description of the command appears when you click the question mark (?) button. --End--
151
9.1.2
WICL Script editing
Use the WICL Script Editor to edit new script files, by adding complete commands in an empty file. The command parameter wizard windows help the user to enter command parameters. See WICL command parameter wizard Figure 5 Create a new WICL script file
Procedure
Step Action
1. Click File>New to create a new script. 2. A new file tab appears in Script Editor. It represents an empty file ready to be edited. 3. Add command lines in the new file (see WICL command parameter wizard)
152
4. or Add an existing script by using File>Open and selecting a script file. 5. Perform modifications as shown in WICL script modification. 6. Save the new file as shown in WICL script saving. --End--
153
9.1.3
WICL script modification
You can modify the script files opened in the WICL script Editor, by deleting, moving or adding commands in this file. The command wizard window helps the user to enter command parameters. See WICL command parameter wizard
Procedure
Step Action
1. Click File >Open. 2. Select a WICL script file in the dialog box that comes up. The file content is displayed in the Script Editor window. 3. Search and move segments of text or text lines by the sub/menus of the Edit menu, and add command lines. 4. When modified, save the script file as shown in WICL script saving. --End--
154
9.1.4
WICL script saving
The modified script files can be saved in a user directory.
Procedure
Step Action
1. Click File > Save as to save a newly created script file, or click File > Save to save changes made in an existing script file. 2. The user directory is automatically selected. Input a file name in the dialog box that comes up. --End--
155
9.2
WICL script management

Use the Script Browser 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 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
156
9.2.1
Create a Directory or a Script File

Note: This function is not available under the Provider directory.
Use this procedure to create a new directory or a new file under the User directory tree view.
Procedure
Step Action
1. From the Script Browser left pane, navigate and select the parent folder 2. 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 3. You can rename the new folder or script file as shown in Rename or Delete a user WICL script directory. 4. Open the new file as shown in Open a user WICL script file. --End--
157
9.2.2
Rename a Directory or a Script File

Use this procedure to rename a user directory or a script file.
Procedure
Step Action
1. From the Script Browser left pane, navigate and to select the directory or the script file to be renamed 2. Right-click and select Rename 3. Enter the new name in the editing field --End--
158
9.2.3
Delete a Directory or a Script File

Use this procedure to delete a user directory or a script file.
Procedure
Step Action
1. From the Script Browser left pane, navigate and select the directory or the script file to be deleted 2. Right-click and select delete 3. In the Confirm Delete window, click OK to confirm --End--
159
9.2.4
Move a Directory or a Script File

Use this procedure to move a directory or a script file from a directory to another one.
Procedure
Step Action
1. From the Script Browser left pane, navigate and select the directory or the script file to be moved 2. 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--
160
9.2.5
Duplicate a Directory or a Script File

Note: 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.
Use this procedure to duplicate a directory or a script file from a directory to another one.
Procedure
Step Action
1. From the Script Browser left pane, navigate and select the directory or the script file to be duplicated 2. Right-click and select Copy 3. In the Script Browser left pane, navigate and select the destination directory Note: Duplicating in the same directory is not allowed. 4. Right-click and select Paste --End--
161
9.2.6
Open a Script File
Use this procedure to edit the content of any script file located under the Provider or the User directory.
Procedure
Step Action
1. From the Script Browser left pane, navigate and select the script file to be opened 2. Right-click and select Open The Script Editor window is displayed and a new file tab is created containing the file content. --End--
162
9.2.7
Search for a Directory or a Script File
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
Step Action
1. From the Script Browser left pane, navigate and select the directory 2. Right-click and select Find 3. In the Search window, input all or part of the file name then click Find The directory with all found files is created in the left pane. Clicking on this directory displays all files in the right pane --End--
163
9.2.8
Refresh a Directory Content

Use this procedure to refresh information on the screen
Procedure
Step Action
1. From the Script Browser left pane, select the directory 2. Right-click and select Refresh The right pane is refreshed --End--
164
9.3
WICL Script Running and Scheduling

Use this procedure to run or schedule WICL scripts. The script execution results are displayed in the script result window which is displayed after the script execution.
165
9.3.1

WICL Script Running

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
Running a WICL script file is possible:
Procedure
Step Action
1. In the left window of either Script Editor or Script Browser, navigate and select the script file to be run 2. 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
3. In the Input Command Arguments windows, input arguments 4. Click Run Now. The script file is executed. If you click Cancel then nothing happens. The script file is executed and the result displayed in the Script Results window 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 --End--
166
9.3.2
WICL Script Scheduling
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 Job Scheduler.
Procedure
Step Action
1. In the left window of either Script Editor or Script Browser, navigate and select the script file to be scheduled 2. To schedule the script: 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 The Create Schedule window is displayed:
167
Figure 7 Create Schedule main window
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
168
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.
3. Click OK to validate and close the window. --End--
169
9.4
Job Scheduler
The Job Scheduler window allows to manage the created scheduled jobs. To find how to create scheduled job, refer to WICL script scheduling Access to the Job Scheduler is provided via the NSP Graphical User Interface by selecting Configuration > Radio Access > Job Scheduler from the main menu With Job Scheduler you can: retrieve scheduled jobs matching filters, display general and detailed information about these jobs, reschedule a scheduled job, delete a scheduled or a pending job, modify a pending job, abort a running job, display an historical list of accomplished jobs, print or export the retrieved results
The Job Scheduler interface displays four tabs: Schedule list, to retrieve the list of scheduled tasks matching the date and user filters Pending Job, to retrieve the list of scheduled tasks matching a given date period Running Job, to retrieve the jobs currently running Historical Job, to retrieve an historical list of jobs previously performed
170
Schedule List
Use this view to retrieve a list of scheduled tasks matching date and user filters. Figure 8 Schedule list window
The left pane of the window displays the date and user filters. From the Start Date and End Date combo boxes, select the period to be used to retrieve the scheduled tasks. If no period is indicated, all tasks will be retrieved for a given user profile. From the Task Type combo box, select which type of task has to be retrieved In the Select User(s) panel, select the user boxes for user profiles whose jobs has to be retrieved. Select the Select All box, to select all user profiles Click Clear Filter to clear all selected user profiles Click Retrieve to display all tasks scheduled in the given period and associated to the user profile and the task type The right pane of the window displays the list of all scheduled tasks. Click on a line to display details in the Schedule Detail part. Note: To modify the parameters of a schedule job, you must modify the WICL Script Scheduling. To refresh the current view, click Refresh To reschedule a task, select only one line and click Reschedule
171
To delete a task, select only one line and click Delete To print the list of scheduled tasks, click Print. The PC printing window opens. To export the file in csv format, click Export and save the file. Note the file can be opened using Microsoft Excel.
Pending Job
Use this view to retrieve the pending jobs on 1, 5 or 7 days Figure 9 Pending job view
The left pane of the window displays the task type, the user filter and the calendar. From the Task Type combo box, select which type of task has to be retrieved In the Select User(s) panel, select the user boxes for user profiles whose jobs has to be retrieved. Select the Select All box to select all user profiles From the calendar, select the first day of the research Click Retrieve to display all pending jobs associated to a selected user profile, from the given first day and for the given number of days selected in the right pane.
The right pane of the window displays the day-by-day pending job result . Each pending job is shown as a blue rectangle. Click on a rectangle to display job details in the Job detail panel Click on 1, 5 or7 buttons to modify to number of days From the Zoom Type combo box, select how to display results: horizontal or vertical In the Zoom Type part, use the button to zoom in, zoom out and reset zoom to the initial view
172
Running Job
Use this view to list all running jobs for a specified user profile. Figure 10 Running job window
The left pane of the window displays the task type and the user filter. From the Task Type combo box, select which type of task has to be retrieved In the Select User(s) panel, select the user boxes for user profiles whose jobs has to be retrieved. Select the Select All box to select all user profiles Click Retrieve to display all jobs currently running for the selected user profile.
The right pane of the window displays the jobs currently running. Click on a line to display job running details in the Job detail panel Click Print to print the list of running tasks Click Export export the file in csv format. Note the file can be opened using Microsoft Excel.
Historical Job
Use this view to display an historical list of jobs performed by a user profile during a given period.
173
Figure 11 Historical job window
In the left pane: From the Start Time From and Start Time To combo boxes, define the starting date range of the search From the End Time From and End Time To combo boxes, define the ending date range of the search From the Task Type combo box, select which type of task has to be retrieved From the Job Result combo box, select the type of result to be displayed In the Select User(s) panel, select the user boxes for user profiles whose historical jobs has to be retrieved. Select the Select All box to select all user profiles Click Retrieve to display all jobs currently running for the selected user profile Click Clear Filter to clear all selected user profiles
The right pane of the window displays the historical jobs currently retrieved. Click Refresh to refresh the current view Click on a line to display job running details in the Job detail panel Click Print to print the list of running tasks Click Export export the file in csv format. Note the file can be opened using Microsoft Excel.
174
10
Wiclets
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. This 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. They rely on a fusion of HTML and WICL Server Page commands (WSP). This evolution provides a graphical web-oriented interface for these scripts. This chapter is split in three parts: WICL Plug-Ins WICLET examples
175
10.1
WICL Plug-Ins
This section describes the WICL Server Pages (WSP) mechanism, how to write WICLETS and the WICLET management.
WICL Server Pages (WSP)

The 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.).
WSP syntax
A specific tag is introduced <WICL:Eval> ... <WICL:Eval>. The include directive refers to an external file: <WICL: Include file='/toto.wsp'> Note 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 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 are like HTML files with WICL tags. The following table gives the WICL command of the HTML tag. Command name H1 [param] <str> H2 [param]<str> H3 [param] <str> H4 [param] <str> H5 [param] <str> H6 [param] <str> HTML tag <h1 [param]> -->str</h1> <h2 [param]> -->str</h2> <h3 [param]> -->str</h3> <h4 [param]> -->str</h4> <h5 [param]> -->str</h5> <h6 [param]> -->str</h6> Displays/function Level 1 heading Level 2 heading Level 3 heading Level 4 heading Level 5 heading Level 6 heading
176
Command name H7 [param] <str> p [param] <str> bold <str> italic <str> underline <str> strikout <str> blink <str> big <str> small <str> font [params] <str> table [params] <command> td [params] <str> th [params] <str> table_row [params]<command>
HTML tag <h7 [param]> -->str</h7> <p [param]> -->str</p> <b>str</b> <i>str</i> <u>str</u5> <s>str</s> <blink>str</blink> <big>str</big> <small>str</small> <font [params]> -->str</font> <table [params]> ->command</table> <td [params]> -->str</td> <th [params]> -->str</th> <tr [params]> -->command</tr>
Displays/function Level 7 heading Paragraph text in bold text in italic text underlined text with a line through it text blink on and blink off in Netscape Navigator font size value increased by 1 font size value reduced by 1 font size, color and typeface change table text in a cell in a table table cell of which content is in bolder font 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 by the following: wiclCgi (AUTH_TYPE) wiclCgi (QUERY_LENGTH) wiclCgi (REMOTE_ADDR) wiclCgi (REMOTE_HOST) wiclCgi (REMOTE_USER) 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 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.
177
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)' }
WICLET management
Users can write their own WICLETs and HTML pages and publish them by putting the associated files on the primary 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 WICLET 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
178
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, NFS. 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
WICL scripts and WICLETs that the user create are kept after an OAM upgrade. This does not mean that WICL scripts and WICLETs are modified to take into account the modifications of NE commands and parameters. The user is responsible for the modification of WICL scripts and WICLETs. The Alcatel-Lucent WICLETs are upgraded with the new ones, which can be improved or bug corrected in the new version.
Security
The access to WICLETs is restricted to authenticated users. The access to the WICL web page is only possible after entering a password.
179
10.2
WICLET examples
This section encompasses an example of 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:
180
181
10.3
Using Wiclets
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
Step Action
1. 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> 2. Save the file on your local disk. 3. 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 4. 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:
182
5. Click into the LIST OF WICLET link to display the available wiclets.
183
6. Click once on the wiclet to execute it. The following result appears in the Web Browser:
184
--End--
185
Wireless Service Provider Solutions W-CDMA Alcatel-Lucent 9353 Management System for Femto Commands Reference Guide (WICL)
Alcatel-Lucent - Internal - Proprietary - Use pursuant to Company instruction
Copyright 2008-2009 Alcatel-Lucent, All Rights Reserved UNCONTROLLED COPY: The master of this document is stored on an electronic database and is "write protected"; it may be altered only by authorized persons. While copies may be printed, it is not recommended. Viewing of the master electronically ensures access to the current issue. Any hardcopies taken must be regarded as uncontrolled copies. ALCATEL-LUCENT CONFIDENTIAL: The information contained in this document is the property of Alcatel-Lucent. Except as expressly authorized in writing by Alcatel-Lucent, the holder shall keep all information contained herein confidential, shall disclose the information only to its employees with a need to know, and shall protect the information from disclosure and dissemination to third parties. Except as expressly authorized in writing by Alcatel-Lucent, the holder is granted no rights to use the information contained herein. If you have received this document in error, please notify the sender and destroy it immediately. Alcatel-Lucent, Alcatel, Lucent Technologies and their respective logos are trademarks and service marks of Alcatel-Lucent, Alcatel and Lucent Technologies. All other trademarks are the property of their owners. Document number: Document issue: Document status: Product Release: Date: NN-20500-175 02.04/EN Preliminary FMS2.2 June 2009

FMS Commands Reference Guide

Transféré par

Informations du document

Description originale:

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

FMS Commands Reference Guide

Transféré par

Droits d'auteur :

Formats disponibles

NN-20500-175 Wireless Service Provider Solutions

Commands Reference Guide (WICL)

Wireless Service Provider Solutions

Commands Reference Guide (WICL)

Alcatel-Lucent - Internal - Proprietary - Use pursuant to Company instruction

SYSTEM RELEASE: FMS2.1 October 2008

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent

About this publication

How this publication is organized

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent

Femto Management System Documentation Roadmap

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

New in this release

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

Figure 1 WICL Console - Main Window

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

Figure 2 WICL Console - Script Selection

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent

WICL Line mode shell

Line mode execution

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent

UNSET Cluster/UMAINSERV1 2 192.68.1.3 BCR-02-01-IPC-XMIM-1.3.6 locked UNSET Site/SITE_aaa_IPC unknownstatustrue my_FIRST_IPC

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

One command execution

UNSET Cluster/UMAINSERV1 2 192.68.1.3 BCR-02-01-IPC-XMIM-1.3.6 locked UNSET Site/SITE_aaa_IPC unknownstatustrue my_FIRST_IPC

WICL script syntax check

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent

Copyright 2008-2009 Alcatel-Lucent

Commands Reference Guide (WICL)

WICL Basic Syntax

NN-20500-175 02.04/EN Preliminary June 2009

Copyright 2008-2009 Alcatel-Lucent