You are on page 1of 7

To:

HARNOIS, SEBASTIEN (SEBASTIEN); BRUGALIERES, SEBASTIEN (SEBASTIEN); MAJCHER, HERVE-JULIEN (HERVE-JULIEN); Santos, Luis (Luis); Clemente, Joseph (Joseph); BODEA, SORIN (SORIN); SCARAZZINI, FABRICE (FABRICE); CHAMAYOU, FREDERIC (FREDERIC); BOURET, XAVIER (XAVIER); VIEILLE, BERTRAND (BERTRAND); O'Sullivan, Richard J (Rich); Palik, Anthony (Tony); Couch, William Garrant, JR (Garry); ARNAUD, PIERRE (PIERRE); Schmuckal, Robin R (Robin); LTE-TEC IRIMESCU, ADRIAN (ADRIAN) 18/01/2011 V01 eNBLoad script delivery

From: Date: Edition: Subject:


All rights reserved. Passing on and copying of this document, use and communication of its contents not permitted without written authorization from Alcatel-Lucent.

REQUIREMENTS:
1 Since counters for eNB PO will be provided only in LE 4.0, for LE 3.0 releases Alcatel-Lucent shall provide a temporary solution based on prompting each eNB for PO using CLI commands. 2 If possible, the script shall be based on a current existing server in the OA&M cloud (SAM, NPO, etc). If not, a new standalone server implemented on a laptop shall be used. 3 The script shall be activated in such a way that it will not produce large occupancy surges on any LTE network element or LTE transmission elements. 4 The PO measurements shall be collected for eCCM, with the flexibility to be expanded to eCEM for internal ALU studies; The PO values collected after each poll are the last 1, 5 and 10 minute average numbers and are already computed internally in the eNB; 5 The weekly customer PO reports shall be one of the following: 6-24 hour 1 minute PO histograms for individual eNB studies; 24 hour 5 minute PO histograms for a limited (50) number of eNBs; 24 hour 15 minute PO histograms for more than 50 eNB to be reported;

A common PO weekly report shall be: A short report which includes the histogram of the busiest weekday (Thursday) made up of 1(one) minute averaged values for each eNB queried; A long report which includes 7(seven) histograms, one for each weekday, made up with 5 min averaged values for each eNB; The local trial/FSA team will decide which reports are to be presented, if not both. 6 the list of eNBs to be reported on (names and IP addresses) shall be included in a separated file the format of the file will be defined by the scripts developer; changes to this file shall be done by common editing procedures;

USAGE:
This document describes the installation, configuration and usage for the eNBLoad application. It purpose is to provide processor occupancy(PO) based on remotely querying each eNB using command-line interface(CLI). The application has two components: a jar file which handles the data connection, gathering and formatting

Getting eNB PO by remote connection

Ed.03

1/7

a control script for Unix-like environments and two control batch files for Windows environments Only one instance of the jar file is allowed to run!

PRE-REQUISITES:
Hardware:
All rights reserved. Passing on and copying of this document, use and communication of its contents not permitted without written authorization from Alcatel-Lucent.

One available machine in the OAM cloud with: at least 512 MB RAM, at least 1 GHz processor at least 40 Gbytes hard drive.

The size of the collected data depends of the number of eNBs to query. Software: Java Runtime Environment 1.6 If used in Windows environments: Microsoft Resource Kit Toolbox (rktools), included in the .zip file Others:

User and password, write access to a part of the filesystem, network usage rights on the machine above OAM IP addresses and friendly names of all eNBs to be queried

INSTALLATION AND USAGE:


Unix-like environments: The application is provided as a .zip archive. Installation: Unpack on an appropriate place on the filesystem. It is preferred to unpack in a subfolder of the /home folder. Make sure the script has the executable bit set: 1 root root 3297 Jan 13 18:13 eNBLoad.sh

#ls -la -rwxr-xr-x

If the executable bit is not set, then set it using the chmod command

#chmod 755 eNBLoad.sh Continue to the Configuration section. Getting eNB PO by remote connection

Ed.03

2/7

Windows environments: Unpack the .zip archive anywhere on the disk. It is preferred to unpack in a users folder, the same user which will run the application. Run the rktools.exe installer. If the user does not have the privileges to install programs, then run the rktools installer as another user which has the privilege to install programs. If you want the tool to start automatically after login, locate the file start_eNBLoad.bat, right click it and choose Create shortcut. Move the shortcut to the Start->Programs->Startup folder. (optional) For your convenience, create a shortcut of the file stop_eNBLoad.bat and move it on the Desktop.
All rights reserved. Passing on and copying of this document, use and communication of its contents not permitted without written authorization from Alcatel-Lucent.

CONFIGURATION:
Before the application is run it needs to be configured. Depending of the installation environment, several configuration files need to be edited. The files ENBLoad.ini and IPList.txt need editing regardless of the environment. These are part of the common configuration and are explained below. Common configuration: ENBLoad.ini The file ENBLoad.ini is structured as follows: [ENBLoad] IPListPath = ./IPList.txt delimiter = , [ENBLoad] is the section providing details for the jar file IPListPath provides the path to the IPList.txt file which contains the eNBs IP addresses and friendly names. Usually the IPList.txt file resides in the application directory and is advisable to keep it there unless there is a strong reason for it to reside elsewhere. delimiter is the delimiter to be used when outputting data into the csv file. DO NOT USE [a-z], [A-Z], [0-9] or whitespaces as separators!

IPList.txt The file IPList.txt is structured as follows:

Getting eNB PO by remote connection

Ed.03

3/7

# comment 135.243.14.130 # the following IP is not accessible 135.243.11.130 this is friendly name #the following IP is OK 135.243.14.131 # other comment 135.243.14.134 this_is_friendly_name The file holds the IP addresses and friendly names of the eNBs which will be queried by the script. Rules: The IPs are to be written each on its own line. Anything that follows the IP address and is separated by whitespaces is considered to be the friendly name of the eNB. Any line beginning with the pound character (#) is considered to be a comment.
All rights reserved. Passing on and copying of this document, use and communication of its contents not permitted without written authorization from Alcatel-Lucent.

Unix-like environment configuration: Before running the application, you need to edit the file eNBload.sh and make the changes that suit your configuration best. Locate the following variables in the file(see example below): PIDFILE=eNBLoad.pid LOGFILE=/dev/null ERRFILE=/dev/null WAIT_TIME=600 PIDFILE is the file to which the process id of the script is written to. Usually this is a file in the same directory in which the application resides but it can be changed to any writable path. o i.e. PIDFILE=/var/run/eNBLoad_v3.pid

LOGFILE is the file to which the jar file will output its progress (data are output in .csv files). Usually this is a file in the same directory in which the application resides but it can be changed to any writable path. It is set to /dev/null by default(no logging) o i.e. LOGFILE=/var/log/eNBLoad_v3.log. Be aware that the log file may very easily grow to large size.

ERRFILE is the file to which the errors of the script are written to. Usually this is a file in the same directory in which the application resides but it can be changed to any writable path. It is set to /dev/null by default(no error logging)

Getting eNB PO by remote connection

Ed.03

4/7

i.e. ERRFILE=/home/enb/error.log. This file also may grow to large size if frequent errors are encountered.

WAIT_TIME is the duration in seconds between two consecutive runs of the jar file. By default this is set to 600 seconds (10 minutes).

Windows environment configuration: Before running the application you need to edit the file start_eNBLoad.bat. Locate the following variables in the file (see example below)
All rights reserved. Passing on and copying of this document, use and communication of its contents not permitted without written authorization from Alcatel-Lucent.

set WAIT_TIME=600 set ERRFILE=NUL set LOGFILE=NUL WAIT_TIME is the duration between two consecutive runs of the jar file. After the java process finishes running the batch script will wait WAIT_TIME seconds before launching the jar again. By default this is set to 600 seconds (10 minutes). Set according to your needs. ERRFILE is the file to which the process id of the script is written to. Usually this is a file in the same directory in which the application resides but it can be changed to any writable path. It is set to NUL by default (no error logging) o i.e. ERRFILE=c:\enb\error.log. This file also may grow to large size if frequent errors are encountered.

LOGFILE is the file to which the jar file will output its progress (data are output in .csv files). Usually this is a file in the same directory in which the application resides but it can be changed to any writable path. It is set to NUL by default(no logging) o i.e. LOGFILE=c:\enb\output.log. Be aware that the log file may very easily grow to large size.

RUNNING THE APPLICATION:


Assuming you have installed and configured the application in an environment of your choice, it is now ready to be run. Unix-like environments: Login as chosen user and change directory to the application location. Running the tool: ./eNBLoad.sh start. If the application is already running a warning message will be issued and the application will not start. Stopping the tool: ./eNBLoad.sh stop Checking the status: ./eNBLoad.sh status

Note: stopping the script will allow the java process to complete its run(i.e. no java process will be killed while querying the eNBs).

Getting eNB PO by remote connection

Ed.03

5/7

Windows environments: If the tool was prepared to run at startup, then it will start each time the current user logs in. If not, go to the folder where the application was unpacked and run the file start_eNBLoad.bat. If the tool is already running then a warning will appear and the application will not start.

All rights reserved. Passing on and copying of this document, use and communication of its contents not permitted without written authorization from Alcatel-Lucent.

If everything is OK, an information message will confirm that the application is running:

If you want to stop the application then go to the folder where the application was unpacked and run the file stop_eNBLoad.bat. If the application is running, confirmation will be asked before terminating the application:

Type y followed by Enter key to confirm or n followed by Enter key to continue running the application. The user will be informed on the result of the actions: Continue if choosing n:

Terminating if choosing y:

If the application is not running, a warning message will appear:

Getting eNB PO by remote connection

Ed.03

6/7

REMARKS:
CSV file structure The matching between the .csv file header and the /pltf/pltf/lec/load command output is described below:

CSV Header
All rights reserved. Passing on and copying of this document, use and communication of its contents not permitted without written authorization from Alcatel-Lucent.

/pltf/pltf/lec/load line and row output (or other explanation) (The time at which the connection was started) (The time at which the connection was ended) (The IP of the eNB which was queried for PO) CPU load average: Load Last 1 mn CPU load average: Min Last 1 mn CPU load average: Max Last 1 mn CPU load average: Load Last 5 mn CPU load average: Min Last 5 mn CPU load average: Max Last 5 mn CPU load average: Load Last 10 mn CPU load average: Min Last 10 mn CPU load average: Max Last 10 mn CPU load: Load User CPU load: Min User CPU load: Max User CPU load: Load System CPU load: Min System CPU load: Max System CPU load: Load Idle CPU load: Min Idle CPU load: Max Idle

Start Date/Time End Date/Time IP CPUavgLd1mn CPUavgMin1mn CPUavgMax1mn CPUavgLd5mn CPUavgMin5mn CPUavgMax5mn CPUavgLd10mn CPUavgMin10mn CPUavgMax10mn CPULdUsr CPUMinUsr CPUMaxUsr CPULdSys CPUMinSys CPUMaxSys CPULdIdle CPUMinIdle CPUMaxIdle

Getting eNB PO by remote connection

Ed.03

7/7