Huawi

M2000 V200R011

Trace Server Guide to theDevelopment of NorthboundTrace Result File Interface

Issue 01

Date 2010-12-10

HUAWEI TECHNOLOGIES CO., LTD.

Copyright © Huawei Technologies Co., Ltd. 2010. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of Huawei Technologies Co., Ltd. Trademarks and Permissions

and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd. All other trademarks and trade names mentioned in this document are the property of their respective holders. Notice The purchased products, services and features are stipulated by the contract made between Huawei and the customer. All or part of the products, services and features described in this document may not be within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information, and recommendations in this document are provided "AS IS" without warranties, guarantees or representations of any kind, either express or implied. The information in this document is subject to change without notice. Every effort has been made in the preparation of this document to ensure accuracy of the contents, but all statements, information, and recommendations in this document do not constitute the warranty of any kind, express or implied.

Huawei Technologies Co., Ltd.

Address: Huawei Industrial Base Bantian, Longgang Shenzhen 518129 People's Republic of China

Website: http://www.huawei.com

Email: [email protected]

Issue 01 (2010-12-10) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd

i

http://www.huawei.com/

mailto:[email protected]

M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface Preface


iii

Preface

Overview The trace server system is a solution provided by Huawei to collect necessary data for optimizing the LTE network. This solution provides uniform data access and storage for the M2000 and other applications. In addition, the M2000 mediation service is used for connecting NEs so that the NE versions do not need to be adapted with each other. The trace server system is deployed on the LTE service aware unit (SAU).

This document describes the Trace Server northbound trace result file interface and provides guidance for interconnecting the interface with the network management system (NMS).

Product Version The following table lists the product versions related to this document.

Product Name Product Version

M2000 V200R011

Intended Audience This document is intended for:

Network administrators

Change History 01 (2010-12-10)

Initial release.



iv

Organization 1 This chapter defines the northbound interface and the northbound trace result file

interface that is provided by the Trace Server. 2 Management and Format of Northbound Trace Result Files

This chapter describes the management and format of northbound trace result files. 3 Interconnection Commissioning of Northbound Trace Result File Interface

You can conduct interconnection commissioning before interconnecting the NMS with the Trace Server, and then determine whether the northbound trace result file interface meets the requirement for interconnection with the NMS according to the interconnection commissioning result.

4 Troubleshooting Northbound Trace Result File Interface The NMS interconnects with the Trace Server through the northbound trace result file interface. For any problem arising from the acquisition of LTE trace results, see this chapter for solutions.

5 FAQ This chapter describes the questions about interface development and the corresponding solutions.

Conventions Symbol Conventions

The symbols that may be found in this document are defined as follows:

Symbol Description

Danger Indicates a hazard with a high level of risk that, if not avoided, could result in death or serious injury.

Warning Indicates a hazard with a medium or low level of risk that, if not avoided, could result in minor or moderate injury.

Caution Indicates a potentially hazardous situation that, if not avoided, could cause equipment damage, data loss, and performance degradation, or unexpected results.

Tip Indicates a tip that may help you solve a problem or save time.

Note Provides additional information to emphasize or supplement the main text by important points.

General Format Conventions

Symbol Description

Times New Roman

The main text in Times New Roman.



v

Symbol Description

Book Antiqua First-level, second-level, and third-level titles are in Book Antiqua.

Courier New Information displayed on the screen is in Courier New. In addition, the displayed information that is entered by users is in boldface.

Command Format Conventions

Format Description

Keywords in a command line are in boldface. The keywords refer to the contents that must be retained in a command line.

Boldface

Parameters in a command line are in Italic. The parameters refer to the contents that must be replaced by actual contents.

Italic

[ ] Items in square brackets [ ] are optional during command configuration.

{ x | y | ... } Two or more alternative items are grouped in braces and separated by vertical bars. One is selected.

[ x | y | ... ] Two or more alternative items are grouped in square brackets and separated by vertical bars. One or none is selected.

{ x | y | ... }* Two or more alternative items are grouped in braces, separated by vertical bars, and followed by a star mark. A minimum of one or a maximum of all can be selected.

[ x | y | ... ]* Two or more alternative items are grouped in square brackets, separated by vertical bars, and followed by a star mark. More or none can be selected.

GUI Conventions

Format Description

Control names on the GUI and data table names are in boldface. For example, click OK.

""

Cascading menus are separated by >. For example, File > New > Folder indicates that the Folder menu item is chosen from the New submenu of the File menu.

>



vi

Keyboard Operation Conventions

Format Description

Indicates the names of keys. For example, Enter, Tab, Backspace, and a indicate the Enter key, the Tab key, the Backspace key, and the a key, respectively

Characters in boldface

Key 1+Key 2 Press several keys concurrently. Ctrl+Alt+A indicates that the Ctrl, Alt, and A keys are concurrently pressed.

Key 1, Key 2 Press keys in turn. For example, Alt,F indicates that the Alt key is pressed and released and then the F key is pressed and released.

Mouse Operation Conventions

Format Description

Click Quickly press and release the primary mouse button without moving the pointer.

Double-click Quickly press and release the primary mouse button continuously twice without moving the pointer.

Drag Press and hold the primary mouse button, and then move the pointer.

M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface Contents


vii

Contents

1 Overview of Northbound Trace Result File Interface ........................................................1-1 1.1 About This Chapter .......................................................................................................................................1-1 1.2 Definition of the Northbound Interface.........................................................................................................1-1 1.3 Definition of the Northbound Trace Result File Interface.............................................................................1-2

2 Management and Format of Northbound Trace Result Files............................................2-1 2.1 About This Chapter .......................................................................................................................................2-1 2.2 Management of Northbound Trace Result Files............................................................................................2-1 2.3 Format of Northbound Trace Result Files .....................................................................................................2-2

2.3.1 Overview of the Northbound Trace Result File Format.......................................................................2-3 2.3.2 Format of Northbound Trace Result File Header.................................................................................2-3 2.3.3 Format of a Single Signaling Message in the LTE NE Trace Result....................................................2-4 2.3.4 Obtaining Northbound Trace Result Files Using SFTP .......................................................................2-5

3 Interconnection Commissioning of Northbound Trace Result File Interface ...............3-6 3.1 Starting a Cell Trace Task..............................................................................................................................3-6 3.2 Starting a User Trace Task.............................................................................................................................3-7 3.3 Commissioning the Interconnection with the Northbound Trace Result File Interface ................................3-7

4 Troubleshooting Northbound Trace Result File Interface ................................................4-1 4.1 About This Chapter .......................................................................................................................................4-1 4.2 Common Troubleshooting and Information Collection.................................................................................4-1 4.3 Troubleshooting Failure in Generating Northbound Trace Result Files........................................................4-2

5 FAQ...............................................................................................................................................5-1 5.1 About This Chapter .......................................................................................................................................5-1 5.2 How Do I Obtain Files Using SFTP?............................................................................................................5-1

M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface Figures


viii

Figures

Figure 1-1 Northbound interface ........................................................................................................................1-2

Figure 2-1 Trace file format ...............................................................................................................................2-3

Figure 5-1 WinSCP login interface.....................................................................................................................5-2

Figure 5-2 Connecting and adding host key to the cache ...................................................................................5-2

Figure 5-3 Successful login window ..................................................................................................................5-2

Figure 5-4 Copying a file ...................................................................................................................................5-3

Figure 5-5 Selecting the save path......................................................................................................................5-4

M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface Tables


ix

Tables

Table 2-1 Format of northbound trace result file header ....................................................................................2-3

Table 2-2 Format of a single signaling message in the LTE NE trace result ......................................................2-4

Table 4-1 Troubleshooting..................................................................................................................................4-1

Table 4-2 Information to be collected.................................................................................................................4-2

M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface 1 Overview of Northbound Trace Result File Interface


1-1

1 Overview of Northbound Trace Result File Interface

1.1 About This Chapter This

i

S.

The northbound trace result file interface provided by the Trace Server is a northbound ace result data from the

1.2 Definit

The NMS obtains the information (such as alarm data, configuration data, performance data, lt data) of NEs managed by the EMS through the he related operation commands. Figure 1-1 shows the

chapter defines the northbound interface and the northbound trace result file interface that s provided by the Trace Server.

1.2 Definition of the Northbound Interface The northbound interface links the Element Management System (EMS) and the NM1.3 Definition of the Northbound Trace Result File Interface

interface. The NMS can obtain the LTE user trace and cell trTrace Server through northbound trace result file interface.

ion of the Northbound Interface The northbound interface links the EMS and the NMS.

inventory data, and NE trace resunorthbound interface and issues tnorthbound interface.

M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface 1 Overview of Northbound Trace Result File Interface


1-2

Figure 1-1 Northbound interface

As part of the M2000 of the EMS in a mobile communications network, the Trace Server processes trace data. The NMS then obtains the trace result data from the Trace Server.

1.3 DefinitInterface

The NMS can obtain the cell trace and user trace result data from the Trace Server through the northbound trace result file interface.

Cell Trace The EMS issues a command to an eNodeB for triggering a trace start. The eNodeB randomly selects several users in its cells to trace according to its selection method. It then reports the trace data to the Trace Server of the M2000 for processing. The NMS obtains the trace result data from the Trace Server.

User Trace

For a single user trace, the trace of specific IMSI/IMEI is originated on the EMS. The trace parameters are transmitted through the S1 link to the eNodeB, which then reports the signaling data compliant with the trace parameters to the Trace Server in the M2000. The Trace Server processes trace data. The NMS then obtains result data from the Trace Server.

ion of the Northbound Trace Result File

M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface

2 Management and Format of Northbound Trace Result Files


2-1


2.1 About hThis rthbound trace result files.

Files e time, generation

This section describes the format of northbound trace result files. 2.3.4 Obtaining Northbound Trace Result Files Using SFTP

SFTP.

2.2 Management of Northbound Trace Result Files conventions, and storage time of northbound

Storage Path orace Server automatically generates result eint/trace/ directory. This path is the root

irectories in this directory

The

ace task. ple, if the reference number of a cell trace task is 12345, the storage directory

2345/.

T is Chapter chapter describes the management and format of no

2.2 Management of Northbound Trace Result This section describes the storage path, naming conventions, storagperiod, and compression mode of trace result files. 2.3 Format of Northbound Trace Result Files

This section describes how to obtain the northbound trace result files using

This section describes the storage path, namingtrace result files.

f Northbound Trace Result Files After collecting the trace data of the LTE NEs, the Tfiles and saves them to the /export/home/omc/var/fildirectory of all trace result files. The Trace Server will create subdaccording to the information of each trace task.

rules of creating subdirectories are as follows:

Cell trace directory name: celltrace/eNodeB/trace reference where, trace reference indicates the trace reference number of a cell trFor examof the result file is /export/home/omc/var/fileint/trace/celltrace/eNodeB/1User trace directory name: usertrace/eNodeB/trace reference




2-2

where, trace reference indicates the trace reference number of a user trace task. For example, if the user trace reference number is 12345, the storage directory of thresult file is /export/home/omc/var/fileint/trace/usertrace/eNodeB/12345/.

e

Naming Conv tiThe ing conv conv

.SenderName.TraceReference.zip

the format of

is the hour, MM is the minute, and SS

enderName: NE name on the M2000. erence: Trace reference number of a cell trace task.

d the the file name is

B20100511.173030-eNodeB.Test.12345.zip.

en ons of Northbound Trace Result Files Trace Server creates file names for the cell trace and user trace tasks. The namentions of cell trace tasks and user trace tasks are similar. Following is the namingention of cell trace tasks:

Cell trace: BStartdate.Starttime-eNodeBwhere, Startdate.Starttime: Time when a file is created. Startdate is inYYYYMMDD, where YYYY is the year, MM is the month, and DD is the date. Starttime is in the format of HHMMSS, where HH is the second. The time is a local time. STraceRefFor example, if a file is created at 17:30:30, May 11, 2010, the NE name is Test, antrace reference number is 12345,

If an NE name contains the following special characters (\, /, :, *, ?, ", <, >, |, and ‘ ’), the system automatically replaces them with ‘_’.

Compression d trace result files can be and.

100920.194301-eNodeB.test497.1111111.zip, 01-eNodeB.test497.1111111 after running the

11111.zip

Storage Time The northbound trace result files are saved on the Trace Server for seven days by default.

2.3 Formatscribes the format of northbound trace result files.

mode of Northbound Trace Result Files The extension of northbound trace result files is .zip. The northbounresolved only after being decompressed by running the gunzip comm

For example, if the compressed file name is B20the decompressed file name is B20100920.1943following command:

gunzip -S .zip B20100920.194301-eNodeB.test497.11

of Northbound Trace Result Files

Generation Period of Northbound Trace Result Files The northbound trace result files are generated every five minutes.

of Northbound Trace Result Files This section de




2-3

2.3.1 Overview of the Northbound Trace Result File Format hat is, header and body. The header l the signaling messages reported by the

A northbound trace result file consists of two parts, tcontains the file information. The body consists of alNE at a time.

Figure 2-1 Trace file format

Trace File Header

message 1

message 2

……

message n-1

message n

2.3.2 Format rth nd T e lt File H

T un t fi

of No bou race R su eader

able 2-1 Format of northbo d trace resul le header

TLV Type LeData Block ngth (Byte) Description

File start flag

Value DWORD 4 Start flag of a file. Fill in 0xF634F634.

Fill in fver. Name DWORD 4 File version

Length DWORD 4 Length of the data block following this field. Fill in 2.

Value WORD 2 Fill in 300, indicating the file version is 3.0

Name DWORD 4 ttyp. Fill in

Length e data block 2.

DWORD 4 Length of thfollowing this field. Fill in

Trace task

Value WORD 2

type

Value 121 indicates cell trace and value 235 indicates user trace.

Name DWORD 4 Fill in fno.


File SN

Value DWORD . 4 The file SN ascends from 0

NE type Name DWORD 4 Fill in ntyp.




2-4

Data Block TLV Type Length (Byte) Description


Value BYTE 1 NE type ID. This value is obtained from the M2000

Name DWORD 4 Fill in nver.

Length DWORD 4 Length of the data block 40.following this field. Fill in

NE version

Value CHAR[40] 40

000

It is a string describing the NE version. This version isobtained from the M2

Name DWORD 4 Fill in ndep.

Length DWORD 4 lock following this field. Fill in 1. Length of the data b

Trace depth

1: Medium depth 2: Minimum depth

Value BYTE 1 The values are as follows: 0: Maximum depth

2.3.3 Format ngle Signalin Message TE NE Trace Result

Table 2-2 Format of a single signaling message in the LT result

of a Si g in the L

E NE trace

Field Length (Byte) Description

Separator 4 Fill in msg0.

MSG_TYPEID 4 Message type ID, which is unique at different depth and among different interfaces.

MSG_HEAD_LENGTH 2 , all fields from the

o the field before the e

)

Length of the message header, that isthe total length ofnext field tMSG_LENGTH field (thMSG_LENGTH field is not included

MSG_CALLID 4 l. If there is no call ID,

A unique ID assigned by the NE to each user calFill in 0xffffffff.

MSG_CELL ID 4 Cell ID




2-5

Field Length (Byte) Description

MSG_TIMESTAMP_YEAR 2 Year when the signaling is created (this and all the time below are the UTC time)

MSG_TIMESTAMP_MONTH 1 Month when the signaling is created

MSG_TIMESTAMP_DAY g is created 1 Day when the signalin

MSG_TIMESTAMP_HOUR 1 Hour when the signaling is created

MSG_TIMESTAMP_MINUTE 1 Minute when the signaling is created

MSG_TIMESTAMP_SECOND 1 Second when the signaling is created

Reserved 1 Reserved field, which is meaningless

MSG_TIMESTAMP_TICK 4 Time in the unit of tick after the board is started

MSG_DIRECTION 1 Message direction

Reserved 1 Reserved field, which is meaningless

MSG_LENGTH 2 Message length

MSG_BODY Its length is determined by the value of the

Message body. At the maximum depth saves the ASN.1 original signaling, and at the medium/minimum depth

previous field saves the key event information

2.3.4 Obtaining Northbound Trace Result Files Using SFTP T

es

lt, the user name is nbftpuser and the password is nbftpuser, which are created during installation.

You know the name and path of a file according to the rules described in section 2.2 "Management of Northbound Trace Result Files."

The network connection between the NMS and the LTE SAU server is normal.

Procedure For details about how to obtain northbound result files, see section 5.2 "How Do I Obtain Files Using SFTP?"

his section describes how to obtain the northbound trace result files using SFTP.

Prerequisit The IP address, user name, and password of the Trace Server FTP server have been

obtained. By defau


3 Interconnection Commissioning of Northbound Trace Result File Interface


3-6


3.1 Starting a Cell Trace Task

Prerequisites 0

You need to start a cell trace task before obtaining the LTE cell trace result file.

The northbound trace result file interface is connected to the Trace Server of the M200server through the M2000 client.

Procedure

window.

to be

5. ference No.

1. Choose Monitor > Signaling Trace > Signaling Trace Management to open the trace taskmanagement graphic user interface (GUI).

2. Double-click LTE Cell Trace to display the cell trace task creation

3. Click … on the right of Select Cell(s), select the NE and the cell for which the task isexecuted in the displayed cell selection window, and then click OK.

4. Select the event to be traced in the cell trace task creation window.

Enter the task name in Trace Name and a trace reference number in Re




3-7

6. Set the start time and end time of the task. If Start Time or End Time is not set, the task is t the current time. To set the start time and end time of the task, select them from the

e drop-down list box and the End Time drop-down list box.

7. Click Finish to start the task.

g a User Trace Task

Prerequisites ent

started aStart Tim

----End

3.2 StartinThis section describes how to start a user trace task.

You need to start a user trace task by sending the user trace task to the mobility managementity (MME) through the M2000.

Procedure . The wireless

3.3 CommNorthboun

The NMS obtains the trace result file generated by the Trace Server using SFTP, and determines whether the northbound trace result file interface meets the requirement for in

The procedure for starting a user trace task on the M2000 is not described hereside passively receives the user trace result data.

issioning the Interconnection with the d Trace Result File Interface

terconnection with the NMS according to the obtained trace result file.




3-8

Prerequisites

race Server FTP server have been obtained. The default user name is nbftpuser and the default password is nbftpuser.

he name and path of a file according to the rules described in section 2.2

Background InfThe NMS obtains northbound trace result files only in one way, that is, accesses the

Procedure 1. ta

2. Chec e result file.

b. ction 2.3 "Format of Northbound Trace Result s." If the result data in the file are consistent with the signaling message subscribed

by the customer, the northbound trace result file interface meets the interconnection requirement and can be interconnected.

----End

The network connection between the NMS and the Trace Server is normal.

The IP address, user name, and password of the T

You know t"Management of Northbound Trace Result Files."

ormation

corresponding path on the LTE SAU server using SFTP.

Ob in a northbound result file. For details, see section 5.2 "How Do I Obtain Files Using SFTP?"

k the obtained trac

a. The filename records the NE information, the trace reference number, and the time information. Such information corresponds to the information of the trace task delivered by the customer. Analyze the result file by referring to seFile

M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface 4 Troubleshooting Northbound Trace Result File Interface


4-1

4 Troubleshooting Northbound Trace Result File Interface

4.1 About This Chapter The NMS interconnects with the Trace Server through the northbound trace result file

4.2 Common Troubleshooting and Information Collection when the NMS obtains the LTE NE trace result data through the esult file interface, see this section for troubleshooting. For any uncommon

.

Common Troubleshooting fault occurs during the acquisition of LTE trace results and the

h

T

interface. For problems arising from the acquisition of LTE trace results, see this chapter for troubleshooting.

If any fault occurs northbound trace rfault, collect the fault-related information and contact Huawei engineers for troubleshooting

Table 4-1 lists the commonandling method.

able 4-1 Troubleshooting

Common Fault Handling Method

Failed to generate northbound trace See section 4.3 "Troubleshooting Failure in Generating Northbound Trace Result Files." result files.

ollection Information Ce NMS attempts to obtain the LTE NE trace result data,

Table 4-2 lists the specific information and the i ec

If any uncommon fault occurs when thcollect the fault-related information. nformation coll ting method.

M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface 4 Troubleshooting Northbound Trace Result File Interface


4-2

Table 4-2 Informa ted tion to be collec

Information Description

Operation Operations that are performed before the fault and the mtaken after the fault.

easures that are

Version Versions of the Trace Server, the M2000, the NE mediation, and NE.

IP address IP addresses of the Trace Server and the M2000 server.

Log Logs saved in the following directory on the Trace Server: /opt/SAU/var/log/ SauSvr.SAUService.trace.

4.3 Troubleshooting Failure in Generating Northbound es

Problem Description rthbound trace result file is generated in the corresponding path. Therefore, the NMS

Troublesho

2. at the network connection is normal.

3. Verify that the NE mediation is normal. To reinstall the NE mediation, see the Commissioning uide of the corresponding M2000 networking mode.

----End

Trace Result FilThe failure in generating northbound trace result files is caused by NE disconnection.

No nocannot obtain the LTE trace result data.

Problem Analysis The failure in generating trace result files is caused by NE disconnection.

oting NE Disconnection 1. Choose Topology > Main Topology on the M2000 client, right-click the disconnected NE,

and then choose Enable Ne Connection from the shortcut menu.

Verify th

G

M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface 5 FAQ


5-1

5 FAQ

5.1 About This Chapter pment and the corresponding

5.2 How Do I Obtain Files Using SFTP? This section describes how to obtain files from the Trace Server using SFTP. The following uses the SFTP tool, WinSCP, as an example. Select the SFTP tool according to the actual

Procedure 1. inSCP> WinSCP. The WinSCP login interface is

This chapter describes the questions about interface develosolutions.

situation on site.

Choose Start > All Programs > Wdisplayed, as shown in Figure 5-1.



5-2

Figure 5-1 WinSCP login interface

2. Enter the IP address of the Trace Server in Host name, enter nbftpuser in User name, keep the default password nbftpuser, select SFTP from File protocol, and then click Login. Click Yes in the displayed dialog box as shown in Figure 5-2.

Figure 5-2 Connecting and adding host key to the cache

The successful login window is displayed, as shown in Figure 5-3.

Figure 5-3 Successful login window



5-3

3. Right-click a file to be copied and then choose Copy, as shown in Figure 5-4.

Figure 5-4 Copying a file

4. wn in Figure 5-5, enter the save path for copying the file to In the displayed dialog box as shoa local PC and then click Copy.



5-4

Figure 5-5 Selecting the save path

5. Verify whether the file has been copied to the path D:\test successfully. If the file exists, the file has been copied successfully. Otherwise, the file failed to be copied.

----End

Huawi

Documents

Transcript of Huawi