RNC Log Collection Tool

download RNC Log Collection Tool

of 15

Transcript of RNC Log Collection Tool

  • 7/29/2019 RNC Log Collection Tool

    1/15

    NN-20500-100

    Wireless Service Provider Solutions

    UMTS

    RNC Log Collection ToolUMTS 4.1, UMTS 5 0 01.03/EN Preliminary July 2006

  • 7/29/2019 RNC Log Collection Tool

    2/15

    UMTS

    RNC LOG COLLECTION TOOL

    Document number: NN-20500-100Document issue: 01.03/ ENDocument status: PreliminaryProduct Release: UMTS 4.1, UMTS 5.0Date: July 2006

    Copyright 2006 Nortel Networks, All Rights Reserved

    Originated in France

    NORTEL CONFIDENTIAL

    The information contained in this document is the property of Nortel Networks. Except as specifically authorized in

    writing by Nortel Networks, the holder of this document shall keep the information contained herein confidential

    and shall protect same in whole or in part from disclosure and dissemination to third parties and use same for

    evaluation, operation and maintenance purposes only.

    The content of this document is provided for information purposes only and is subject to modification. It does not

    constitute any representation or warranty from Nortel Networks as to the content or accuracy of the information

    contained herein, including but not limited to the suitability and performances of the product or its intended

    application.

    This is the Way. This is Nortel, Nortel, the Nortel logo, and the Globemark are trademarks of Nortel Networks. All

    other trademarks are the property of their owners.

  • 7/29/2019 RNC Log Collection Tool

    3/15

    Nortel Confidential Publication history i

    Copyright

    2006 Nortel Networks RNC Log Collection Tool

    PUBLICATION HISTORY

    July 2006

    Issue 01.03 / EN, PreliminaryInternal review and editorial update

    July 2006

    Issue 01.02 / EN, Preliminary

    Internal review and editorial update

    June 2006

    Issue 01.01 / EN, Draft

    Document creation

  • 7/29/2019 RNC Log Collection Tool

    4/15

    Nortel Networks Confidential ii

    NN-20500-100 01.03/ EN Preliminary J uly 2006 Copyright

    2006 Nortel Networks

    TABLE OF CONTENTS

    1. INTRODUCTION .........................................................................................................................1

    1.1. OBJECT.................................................................................................................................1

    1.2. APPLICABILITY .......................................................................................................................1

    1.3. AUDIENCE .............................................................................................................................1

    2. REFERENCE DOCUMENTS.......................................................................................................1

    2.1. APPLICABLE DOCUMENTS........................................................................................................1

    2.2. REFERENCE DOCUMENTS .......................................................................................................1

    3. GENERAL DESCRIPTION..........................................................................................................2

    3.1. TOOL DESCRIPTION ................................................................................................................2

    3.2. LOGS TYPES ..........................................................................................................................2

    4. PRE-REQUISITES ......................................................................................................................3

    5. PACKAGE DELIVERY DESCRIPTION.......................................................................................4

    6. RUNNING THE TOOL.................................................................................................................5

    6.1. WHEN TO RUN THETOOL.......................................................................................................5

    6.2. HOW TO RUN THETOOL.........................................................................................................5

    6.3. TOOL PROGRESS DESCRIPTION ...............................................................................................6

    6.4. TOOLRESULTS..................................................................................................................86.5. TOOL PRE-CHECKS ...............................................................................................................8

    7. ABBREVIATIONS AND DEFINITIONS.......................................................................................9

    7.1. ABREVIATIONS .......................................................................................................................9

    7.2. DEFINITIONS ..........................................................................................................................9

  • 7/29/2019 RNC Log Collection Tool

    5/15

    Nortel Confidential 1

    Copyright

    2006 Nortel Networks RNC Log Collection Tool

    1. INTRODUCTION

    1.1. OBJECT

    This document aims at describing the log collection tool.

    This tool must be run from an OAM main server. It collects all the needed traces/logs from

    an RNC to allow case of investigation.

    1.2. APPLICABILITY

    This tool is designed for both Nortel RNC 1000 and RNC 1500.

    This tool is relevant for RNC Release 4.1 and 5.0.

    1.3. AUDIENCE

    This document is intended to operational teams.

    2. REFERENCE DOCUMENTS

    2.1. APPLICABLE DOCUMENTS

    None

    2.2. REFERENCE DOCUMENTS

    None

  • 7/29/2019 RNC Log Collection Tool

    6/15

    Nortel Confidential 2

    ___________________________________________________________________________________________________________________

    NN-20500-10001.03/ EN Preliminary July 2006 Copyright

    2006 Nortel Networks

    3. GENERAL DESCRIPTION

    3.1. TOOL DESCRIPTION

    This documents aims at describing the use of the RNC Log Collection tool.

    This tool collects and stores all the required log files, and commands results from RNC (1000

    or 1500) into an OAM compressed file, in order to allow RNC issue investigation.

    The logs to collect are listed into a command file.

    It is highly recommended to attach such log to any RNC case.

    3.2. LOGS TYPES

    Three configuration files are delivered with the tool. They contain the commands to apply

    and the files to retrieve from RNC.

    The three files are:

    gps_EmergencyLogCommands.cfg:

    This file contains a set of commands to retrieve all the information which will be lost

    in a case of equipment restart. This command file is available for both RNC 1000

    and RNC 1500.

    gps_ClassicRNCLogCommands.cfg:

    This file contains the full log collection commands for an RNC 1000.

    gps_CompactRNCLogCommands.cfg:

    This file contains the full log collection commands for an RNC 1500.

  • 7/29/2019 RNC Log Collection Tool

    7/15

    Nortel Confidential 3

    Copyright

    2006 Nortel Networks RNC Log Collection Tool

    4. PRE-REQUISITES

    To run the tool, the user needs:

    A UNIX session on the OAM main server opened by a user that belongs to nortel

    group.

    The Login and associated password for WICL connection.

    The Login and associated password for RNC-CN & omu user password (only when

    running the tool against an RNC1000).

    The RNC label (declared in OAM database) having an issue.

    The Start date for log collection.

    The End date for log collection. (Optional, if not provided, the current date will be used

    as the end date).

    In addition to that, the user may be asked for the following data when the tool can not

    retrieve them:

    RNC-IN IP address

    RNC-IN Login & password.

  • 7/29/2019 RNC Log Collection Tool

    8/15

    Nortel Confidential 4

    ___________________________________________________________________________________________________________________

    NN-20500-10001.03/ EN Preliminary July 2006 Copyright

    2006 Nortel Networks

    5. PACKAGE DELIVERY DESCRIPTION

    The tool is present within the OAM software delivery. The tool is localized in the

    /opt/nortel/shell/support_tools/LogCollection/ directory.

    The delivered package contains the following components:

    The tool utilities

    The command file to retrieve logs from RNC 1500

    The command file to retrieve logs from RNC 1000

    The command file to retrieve all logs removed after an RNC restart.

    . . . % l s l a / opt/ nort el / shel l / support _tool s/ LogCol l ect i on/ t ot al 230

    - r w- r - - r - - 1 nor t el nor t el 2834 Apr 20 12: 29 gps_Cl assi cRNCLogCommands. cf g- r w- r - - r - - 1 nor t el nor t el 2393 Apr 20 12: 29 gps_Compact RNCLogCommands. cf g- r w- r - - r - - 1 nor t el nor t el 14401 Apr 20 19: 15 gps_Connect i ons. t cl- r w- r - - r - - 1 nor t el nor t el 1433 Apr 14 13: 56 gps_EmergencyLogCommands. cf g- r w- r - - r - - 1 nor t el nor t el 2723 Apr 20 17: 49 gps_getCommands. t cl- r w- r - - r - - 1 nor t el nor t el 1419 Apr 20 17: 50 gps_get RNCI nf o. wcl- r w- r - - r - - 1 nor t el nor t el 7005 Apr 20 17: 49 gps_l ogTr aces. t cl- r w- r - - r - - 1 nor t el nor t el 37914 Apr 20 19: 07 gps_r et r i eveI nf o. t cl- r wxr- xr- - 1 nor t el nor t el 39106 Apr 20 19: 15 gps_r ncLogCol l ect i on. t cl- r w- r - - r - - 1 nor t el nor t el 2334 Apr 20 17: 50 gps_wi cl Commands. t cl. . . %

  • 7/29/2019 RNC Log Collection Tool

    9/15

    Nortel Confidential 5

    Copyright

    2006 Nortel Networks RNC Log Collection Tool

    6. RUNNING THE TOOL

    6.1. WHEN TO RUN THE TOOL

    The RNC Log collection tool needs to be run when any issue occurs on the RNC. This

    collection enables the issue investigation.

    The log collection must be executed following those steps:

    1. If an equipment restart is required, need to collect all logs which will be

    removed at the restart. This is performed by using the

    gps_EmergencyLogCommands.cfg command file.

    2. After the equipment restart, need to collect the full set of logs. This is

    performed by using:

    gps_ClassicRNCLogCommands.cfg for RNC 1000 logs collection.

    gps_CompactRNCLogCommands.cfg for RNC 1500 logs collection.

    Both collected logs collected on steps 1 and 2 must be attached to RNC cases.

    6.2. HOW TO RUN THE TOOL

    The RNC Log collection tool is present in the

    /opt/nortel/shell/support_tools/LogCollection directory. Its launched by the TCL script

    gps_rncLogCollection.tcl.

    Launching the tool with -help option gives its usage.

  • 7/29/2019 RNC Log Collection Tool

    10/15

    Nortel Confidential 6

    ___________________________________________________________________________________________________________________

    NN-20500-10001.03/ EN Preliminary July 2006 Copyright

    2006 Nortel Networks

    Several tool inputs can be provided in command line. Otherwise, the user is asked to

    provide them when needed.

    The tool collects logs within the time period between Start Date and End Date. Those

    dates must be provided in format DD/MM/YYYY.

    If End Date isnt provided, the current date will be used as the End Date.

    6.3. TOOL PROGRESS DESCRIPTION

    Once the tool is launched, the tool first connects to WICL to retrieve all the available

    RNC on the OAM. The user is then invited to choose the one on which the log

    collection needs to be executed:

    In the example detailed below, the WICL connection user and password are provided

    in the command line.

    W

    h

    e

    n

    r

    u

    n

    n

    i

    n

    g

    ,

    t

    h

    e

    Once the target RNC is selected, the tool retrieves all the needed connection data.

    In the example above, the user chose the option 6 corresponding to RNC_1202.

    Depending on RNC Architecture, a list of command files is provided to select which

    one must be used during log collection.

    As the RNC selected in the example above is an RNC 1000, the tool offers the choice

    between a complete log collection for an RNC 1000 and a light log collection)

  • 7/29/2019 RNC Log Collection Tool

    11/15

    Nortel Confidential 7

    Copyright

    2006 Nortel Networks RNC Log Collection Tool

    Once the command file is chosen, the tool requests the missing information for the

    equipment connection, and then starts the log collection showing the tool progress. At

    the end of the execution, the tool displays results summary.

  • 7/29/2019 RNC Log Collection Tool

    12/15

    Nortel Confidential 8

    ___________________________________________________________________________________________________________________

    NN-20500-10001.03/ EN Preliminary July 2006 Copyright

    2006 Nortel Networks

    6.4. TOOL RESULTS

    The tool execution provides the two following files as output:

    The tool execution trace file. This file is named as follows:

    ExternalLogCollection_RNC_DateOfExecution.log, where DateOfExecutionrepresent the date of tool execution given on the following format:

    DDMMYYYY_HHMMSS.

    This file must be provided to the tool development team if any problem occurs

    during tool execution.

    The tool resulting file. This file is a compression of all logs collected.

    This file is named as follows:

    ExternalLogCollection_RNCLabel_StartDate_EndDate_DateOfExecution.tar.Z

    where:

    o RNCLabel is the label of the RNC on which log collection is performed;

    o StartDate is the start date of log collection period in format DDMMYYYY;

    o EndDate is the end date of log collection period in format DDMMYYYY;

    o DateOfExecution is the date of tool execution given on the following

    format: DDMMYYYY_HHMMSS

    The tool logs are stored in the /opt/nortel/logs/support_tools/ExternalLogCollection

    directory.

    Only the 20 last execution traces are kept.

    The tool result files are stored in the

    /opt/nortel/data/support_tools/ExternalLogCollection directory.

    No purge mechanism exists on this directory, so the user must remove files

    periodically.

    6.5. TOOL PRE-CHECKS

    When the tool is run, it generates a result file stored in directory

    /opt/nortel/data/support_tools/ExternalLogCollection.

    There is no purge mechanism on OAM for this directory, so the user has to clean it.

    To force this behavior, the tool checks that the directory occupation is less than 80%

    of its capacity, and that there are less than 40 resulting files present in the directory.

    If any of those conditions is not met, the tool asks the user to remove files.

    Example:

  • 7/29/2019 RNC Log Collection Tool

    13/15

    Nortel Confidential 9

    Copyright

    2006 Nortel Networks RNC Log Collection Tool

    7. ABBREVIATIONS AND DEFINITIONS

    7.1. ABREVIATIONS

    CN Control Node

    IN Interface Node

    RNC Radio Network Controller

    WICL Wireless Internet Command Language

    7.2. DEFINITIONS

    None

  • 7/29/2019 RNC Log Collection Tool

    14/15

  • 7/29/2019 RNC Log Collection Tool

    15/15

    Wireless Service Provider SolutionsUMTSRNC Log Collection Tool

    To order documentation from Nortel Wireless Knowledge Services from all countries except North America, contact:

    Tel.: (1) (615) 432-4848

    To order documentation from Nortel Wireless Knowledge Services from North America, contact:

    Tel.: (1) (877) 662-5669 [Option 4] or (1) (919) 997-8015

    To report a problem in this publication from all countr ies except North America, contact:

    NortelDocumentation DepartmentParc d'Activit de Magny-ChteaufortChteaufort78928 Yvelines Cedex 9FranceFax: (33) (1) 39-44-50-29

    To report a problem in this publication fr om North America, contact:

    NortelGlobal Knowledge Services2221 Lakeside BoulevardRichardson TX 75082USA

    Tel.: (1) (800) 466-7838 or (1) (972) 684-5935

    From any country, you can also use the "Contact Us" link from the Nortel Networks Customer Documentation WorldWide Web site at:

    http://www.nortel.com/documentation

    Copyright 2006 Nortel Networks, All Rights Reserved

    NORTEL CONFIDENTIAL

    The information contained in this document is the property of Nortel Networks. Except as specifically authorized inwriting by Nortel Networks, the holder of this document shall keep the information contained herein confidential

    and shall protect same in whole or in part from disclosure and dissemination to third parties and use same for

    evaluation, operation and maintenance purposes only.

    The content of this document is provided for information purposes only and is subject to modification. It does not

    constitute any representation or warranty from Nortel Networks as to the content or accuracy of the information

    contained herein, including but not limited to the suitability and performances of the product or its intended

    application.

    This is the Way. This is Nortel, Nortel, the Nortel logo, and the Globemark are trademarks of Nortel Networks. All

    other trademarks are the property of their owners.

    Document number: NN-20500-100Document issue: 01.03/ENDocument status: PreliminaryProduct Release: UMTS 4.1, UMTS 5.0Date: J uly 2006

    Originated in France