Professional Documents
Culture Documents
Trace Server Guide to the Development of Northbound Trace Result File Interface
Issue Date 01 2010-12-10
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.
Issue 01 (2010-12-10)
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Preface
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 M2000 Product Version V200R011
Intended Audience
This document is intended for: Network administrators
Change History
01 (2010-12-10) Initial release.
Issue 01 (2010-12-10)
iii
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Preface
Organization
z z
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 Danger Warning Caution Description Indicates a hazard with a high level of risk that, if not avoided, could result in death or serious injury. Indicates a hazard with a medium or low level of risk that, if not avoided, could result in minor or moderate injury. Indicates a potentially hazardous situation that, if not avoided, could cause equipment damage, data loss, and performance degradation, or unexpected results. Indicates a tip that may help you solve a problem or save time. Provides additional information to emphasize or supplement the main text by important points.
Tip Note
Issue 01 (2010-12-10)
iv
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Preface
Description First-level, second-level, and third-level titles are in Book Antiqua. Information displayed on the screen is in Courier
New.
Italic
[] { x | y | ... } [ x | y | ... ] { x | y | ... }*
[ x | y | ... ]*
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.
Issue 01 (2010-12-10)
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Preface
Issue 01 (2010-12-10)
vi
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Contents
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
5 FAQ ...............................................................................................................................................5-1
5.1 About This Chapter .......................................................................................................................................5-1 5.2 How Do I Obtain Files Using SFTP? ............................................................................................................5-1
Issue 01 (2010-12-10)
vii
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Figures
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
Issue 01 (2010-12-10)
viii
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Tables
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
Issue 01 (2010-12-10)
ix
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
1
z z
Issue 01 (2010-12-10)
1-1
M2000 Trace Server Guide to the Development of Northbound Trace Result File 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.
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.
Issue 01 (2010-12-10)
1-2
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
2.2 Management of Northbound Trace Result Files This section describes the storage path, naming conventions, storage time, generation period, and compression mode of trace result files.
2.3 Format of Northbound Trace Result Files This section describes the format of northbound trace result files. 2.3.4 Obtaining Northbound Trace Result Files Using SFTP This section describes how to obtain the northbound trace result files using SFTP.
Cell trace directory name: celltrace/eNodeB/trace reference where, trace reference indicates the trace reference number of a cell trace task. For example, if the reference number of a cell trace task is 12345, the storage directory of the result file is /export/home/omc/var/fileint/trace/celltrace/eNodeB/12345/.
Issue 01 (2010-12-10)
2-1
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
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 the result file is /export/home/omc/var/fileint/trace/usertrace/eNodeB/12345/.
Cell trace: BStartdate.Starttime-eNodeB.SenderName.TraceReference.zip where, Startdate.Starttime: Time when a file is created. Startdate is in the format of YYYYMMDD, 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 hour, MM is the minute, and SS is the second. The time is a local time. SenderName: NE name on the M2000. TraceReference: Trace reference number of a cell trace task. For example, if a file is created at 17:30:30, May 11, 2010, the NE name is Test, and the trace reference number is 12345, the file name is B20100511.173030-eNodeB.Test.12345.zip.
If an NE name contains the following special characters (\, /, :, *, ?, ", <, >, |, and ), the system automatically replaces them with _.
Issue 01 (2010-12-10)
2-2
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
File SN
4 4 4 4
NE type
Name
Issue 01 (2010-12-10)
2-3
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Length (Byte) 4 1 4 4 40
Description Length of the data block following this field. Fill in 1. NE type ID. This value is obtained from the M2000 Fill in nver. Length of the data block following this field. Fill in 40. It is a string describing the NE version. This version is obtained from the M2000 Fill in ndep. Length of the data block following this field. Fill in 1. The values are as follows: 0: Maximum depth 1: Medium depth 2: Minimum depth
Trace depth
4 4 1
MSG_HEAD_LENGTH
MSG_CALLID
MSG_CELL ID
Issue 01 (2010-12-10)
2-4
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Field MSG_TIMESTAMP_YEAR
Length (Byte) 2
Description Year when the signaling is created (this and all the time below are the UTC time) Month when the signaling is created Day when the signaling is created Hour when the signaling is created Minute when the signaling is created Second when the signaling is created Reserved field, which is meaningless Time in the unit of tick after the board is started Message direction Reserved field, which is meaningless Message length Message body. At the maximum depth saves the ASN.1 original signaling, and at the medium/minimum depth saves the key event information
1 1 1 1
MSG_TIMESTAMP_SECOND 1 Reserved MSG_TIMESTAMP_TICK MSG_DIRECTION Reserved MSG_LENGTH MSG_BODY 1 4 1 1 2 Its length is determined by the value of the previous field
Prerequisites
z The IP address, user name, and password of the Trace Server FTP server have been obtained. By default, 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."
z z
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?"
Issue 01 (2010-12-10)
2-5
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
3
Prerequisites
The northbound trace result file interface is connected to the Trace Server of the M2000 server through the M2000 client.
Procedure
1. Choose Monitor > Signaling Trace > Signaling Trace Management to open the trace task management graphic user interface (GUI). 2. Double-click LTE Cell Trace to display the cell trace task creation window. 3. Click on the right of Select Cell(s), select the NE and the cell for which the task is to be executed in the displayed cell selection window, and then click OK. 4. Select the event to be traced in the cell trace task creation window. 5. Enter the task name in Trace Name and a trace reference number in Reference No.
Issue 01 (2010-12-10)
3-6
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
6. Set the start time and end time of the task. If Start Time or End Time is not set, the task is started at the current time. To set the start time and end time of the task, select them from the Start Time drop-down list box and the End Time drop-down list box. 7. Click Finish to start the task. ----End
Prerequisites
You need to start a user trace task by sending the user trace task to the mobility management entity (MME) through the M2000.
Procedure
The procedure for starting a user trace task on the M2000 is not described here. The wireless side passively receives the user trace result data.
3.3 Commissioning the Interconnection with the Northbound Trace Result File Interface
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 interconnection with the NMS according to the obtained trace result file.
Issue 01 (2010-12-10)
3-7
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Prerequisites
z
The network connection between the NMS and the Trace Server is normal.
z The IP address, user name, and password of the Trace Server FTP server have been obtained. The default user name is nbftpuser and the default password is nbftpuser.
You know the name and path of a file according to the rules described in section 2.2 "Management of Northbound Trace Result Files."
z
Background Information
The NMS obtains northbound trace result files only in one way, that is, accesses the corresponding path on the LTE SAU server using SFTP.
Procedure
1. Obtain a northbound result file. For details, see section 5.2 "How Do I Obtain Files Using SFTP?" 2. Check the obtained trace result file. 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 section 2.3 "Format of Northbound Trace Result Files." 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.
b.
----End
Issue 01 (2010-12-10)
3-8
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Common Troubleshooting
Table 4-1 lists the common fault occurs during the acquisition of LTE trace results and the handling method. Table 4-1 Troubleshooting Common Fault Failed to generate northbound trace result files. Handling Method See section 4.3 "Troubleshooting Failure in Generating Northbound Trace Result Files."
Information Collection
If any uncommon fault occurs when the NMS attempts to obtain the LTE NE trace result data, collect the fault-related information. Table 4-2 lists the specific information and the information collecting method.
Issue 01 (2010-12-10)
4-1
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
Table 4-2 Information to be collected Information Operation Version IP address Log Description Operations that are performed before the fault and the measures that are taken after the fault. Versions of the Trace Server, the M2000, the NE mediation, and NE. IP addresses of the Trace Server and the M2000 server. Logs saved in the following directory on the Trace Server: /opt/SAU/var/log/ SauSvr.SAUService.trace.
Problem Description
No northbound trace result file is generated in the corresponding path. Therefore, the NMS cannot obtain the LTE trace result data.
Problem Analysis
The failure in generating trace result files is caused by NE disconnection.
Troubleshooting 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. 2. Verify that the network connection is normal. 3. Verify that the NE mediation is normal. To reinstall the NE mediation, see the Commissioning Guide of the corresponding M2000 networking mode. ----End
Issue 01 (2010-12-10)
4-2
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
5 FAQ
5
5.1 About This Chapter 5.2 How Do I Obtain Files Using SFTP?
FAQ
This chapter describes the questions about interface development and the corresponding solutions.
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 situation on site.
Procedure
1. Choose Start > All Programs > WinSCP> WinSCP. The WinSCP login interface is displayed, as shown in Figure 5-1.
Issue 01 (2010-12-10)
5-1
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
5 FAQ
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. The successful login window is displayed, as shown in Figure 5-3. Figure 5-2 Connecting and adding host key to the cache
Issue 01 (2010-12-10)
5-2
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
5 FAQ
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. In the displayed dialog box as shown in Figure 5-5, enter the save path for copying the file to a local PC and then click Copy.
Issue 01 (2010-12-10)
5-3
M2000 Trace Server Guide to the Development of Northbound Trace Result File Interface
5 FAQ
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
Issue 01 (2010-12-10)
5-4