m2000 northbound mml command interface developer guide

M2000

V200R009

Northbound MML Command InterfaceDeveloper Guide

Issue 01

Date 2009-08-29

Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Huawei Technologies Co., Ltd. provides customers with comprehensive technical support and service. For anyassistance, please contact our local office or company headquarters.

Huawei Technologies Co., Ltd.Address: Huawei Industrial Base

Bantian, LonggangShenzhen 518129People's Republic of China

Website: http://www.huawei.com

Email: [email protected]

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

and other Huawei trademarks are the property of Huawei Technologies Co., Ltd.All other trademarks and trade names mentioned in this document are the property of their respective holders. NoticeThe information in this document is subject to change without notice. Every effort has been made in thepreparation of this document to ensure accuracy of the contents, but the statements, information, andrecommendations in this document do not constitute a warranty of any kind, express or implied.

Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

http://www.huawei.com

mailto:[email protected]

Contents

About This Document.....................................................................................................................1

1 Introduction to Northbound MML Command Transparent Transmission Interface...........................................................................................................................................................1-1

1.1 Definition of Northbound Interface.................................................................................................................1-21.2 Implementation of the MML Command Transparent Transmission Interface...............................................1-2

2 Transparent Transmission of the Northbound MML Command.....................................2-12.1 Connecting the MML Command Transparent Transmission..........................................................................2-2

2.1.1 Login......................................................................................................................................................2-22.1.2 Listing Operable NEs.............................................................................................................................2-22.1.3 Registering an NE..................................................................................................................................2-3

2.2 Maintaining the MML Command Transparent Transmission.........................................................................2-52.2.1 MML Command Transparent Transmission..........................................................................................2-52.2.2 Issuing MML Commands in Batches.....................................................................................................2-62.2.3 Sending Handshake Messages...............................................................................................................2-82.2.4 Sending Disconnection Messages when Disconnecting........................................................................2-8

2.3 Disconnecting the MML Command Transparent Transmission.....................................................................2-82.3.1 Deregistering an NE...............................................................................................................................2-92.3.2 Logout..................................................................................................................................................2-10

3 Interconnection Commissioning of the Northbound MML Interface.............................3-13.1 Negotiating the Interconnection Parameters of the Northbound MML Interface...........................................3-23.2 Preparations for the Commissioning of the MML Interface...........................................................................3-2

3.2.1 Creating a User.......................................................................................................................................3-33.2.2 Binding an NE when Creating a User....................................................................................................3-53.2.3 Binding a New NE.................................................................................................................................3-83.2.4 Querying an Authorized MML Command...........................................................................................3-11

3.3 Commissioning the Interconnection of the Northbound MML Interface ....................................................3-123.3.1 Simulating the Interconnection with the NMS (MML Interface)........................................................3-133.3.2 Checking the Interconnection...............................................................................................................3-13

3.4 Usage of the Northbound MML Interface.....................................................................................................3-13

4 Troubleshooting for the Northbound MML Interface.......................................................4-14.1 Common Troubleshooting and Information Collection (MML Interface)......................................................4-2

M2000Northbound MML Command Interface Developer Guide Contents

Issue 01 (2009-08-29) Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

i

4.2 Handling the Failure of Issuing MML Commands.........................................................................................4-2

ContentsM2000

Northbound MML Command Interface Developer Guide

ii Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 01 (2009-08-29)

Figures

Figure 1-1 Location of the northbound interface.................................................................................................1-2Figure 1-2 Transparent transmission process of an NMS command...................................................................1-4Figure 3-1 Security Management.........................................................................................................................3-3Figure 3-2 User.....................................................................................................................................................3-4Figure 3-3 New User............................................................................................................................................3-5Figure 3-4 Security Management.........................................................................................................................3-6Figure 3-5 User.....................................................................................................................................................3-6Figure 3-6 New User............................................................................................................................................3-7Figure 3-7 Binding an NE....................................................................................................................................3-8Figure 3-8 Security Management.........................................................................................................................3-9Figure 3-9 MMLUser user information................................................................................................................3-9Figure 3-10 Bound NE list.................................................................................................................................3-10Figure 3-11 Bind NE..........................................................................................................................................3-10Figure 3-12 NE User Management....................................................................................................................3-11Figure 3-13 MML command assigned to the rights...........................................................................................3-12

M2000Northbound MML Command Interface Developer Guide Figures


iii

Tables

Table 1-1 Process for implementation..................................................................................................................1-3Table 3-1 Information provided by the M2000....................................................................................................3-2Table 3-2 Usage of the northbound MML interface...........................................................................................3-14Table 4-1 Troubleshooting...................................................................................................................................4-2Table 4-2 Information to be collected..................................................................................................................4-2

M2000Northbound MML Command Interface Developer Guide Tables


v

About This Document

Purpose

This document provides the guide to the M2000 Northbound MML command transparenttransmission interface. It consists of the following contents: meaning and interconnectionparameters of the Northbound MML command transparent transmission interface,interconnection of the Northbound MML command transparent transmission interface, andNorthbound MML command transparent transmission.

Related Versions

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

Product Name Version

M2000 V200R009

Intended Audience

The intended audiences of this document are:

l Network administrator

Update History

01 (2009-06-30)

Initial release. Also, the first formal release.

Organization

1 Introduction to Northbound MML Command Transparent Transmission Interface

This describes the definition of the Northbound interface, and the implementation andinterconnecting parameters of the Northbound MML command transparent transmissioninterface.

2 Transparent Transmission of the Northbound MML Command

M2000Northbound MML Command Interface Developer Guide About This Document


1

This describes the transparent transmission of the Northbound MML command, which consistsof connecting the MML command transparent transmission, maintaining the MML commandtransparent transmission, and disconnecting the MML command transparent transmission.

3 Interconnection Commissioning of the Northbound MML Interface

Before interconnecting the NMS with the M2000, you must conduct an interconnectioncommissioning. Based on the commissioning result, determine whether the northbound MMLinterface meets the conditions for interconnecting with the NMS.

4 Troubleshooting for the Northbound MML Interface

This describes how to troubleshoot the northbound MML interface. If a fault occurs when theNMS is interconnected to the M2000 through the northbound MML interface, refer to thischapter for handling the fault.

ConventionsSymbol Conventions

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

Symbol Description

Indicates a hazard with a high level of risk, which if notavoided,will result in death or serious injury.

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

Indicates a potentially hazardous situation, which if notavoided,could result in equipment damage, data loss,performance degradation, or unexpected results.

Indicates a tip that may help you solve a problem or savetime.

Provides additional information to emphasize or supplementimportant points of the main text.

General Conventions

The general conventions that may be found in this document are defined as follows.

Convention Description

Times New Roman Normal paragraphs are in Times New Roman.

Boldface Names of files, directories, folders, and users are inboldface. For example, log in as user root.

Italic Book titles are in italics.

About This DocumentM2000


2 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 01 (2009-08-29)


Courier New Examples of information displayed on the screen are inCourier New.

Command Conventions

The command conventions that may be found in this document are defined as follows.


Boldface The keywords of a command line are in boldface.

Italic Command arguments are in italics.

[ ] Items (keywords or arguments) in brackets [ ] are optional.

{ x | y | ... } Optional items are grouped in braces and separated byvertical bars. One item is selected.

[ x | y | ... ] Optional items are grouped in brackets and separated byvertical bars. One item is selected or no item is selected.

{ x | y | ... }* Optional items are grouped in braces and separated byvertical bars. A minimum of one item or a maximum of allitems can be selected.

[ x | y | ... ]* Optional items are grouped in brackets and separated byvertical bars. Several items or no item can be selected.

GUI Conventions

The GUI conventions that may be found in this document are defined as follows.


Boldface Buttons, menus, parameters, tabs, window, and dialog titlesare in boldface. For example, click OK.

> Multi-level menus are in boldface and separated by the ">"signs. For example, choose File > Create > Folder .

Keyboard Operations

The keyboard operations that may be found in this document are defined as follows.

Format Description

Key Press the key. For example, press Enter and press Tab.

M2000Northbound MML Command Interface Developer Guide About This Document


3

Format Description

Key 1+Key 2 Press the keys concurrently. For example, pressing Ctrl+Alt+A means the three keys should be pressed concurrently.

Key 1, Key 2 Press the keys in turn. For example, pressing Alt, A meansthe two keys should be pressed in turn.

Mouse Operations

The mouse operations that may be found in this document are defined as follows.

Action Description

Click Select and release the primary mouse button without movingthe pointer.

Double-click Press the primary mouse button twice continuously andquickly without moving the pointer.

Drag Press and hold the primary mouse button and move thepointer to a certain position.

About This DocumentM2000


4 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 01 (2009-08-29)

1 Introduction to Northbound MMLCommand Transparent Transmission Interface

About This Chapter

This describes the definition of the Northbound interface, and the implementation andinterconnecting parameters of the Northbound MML command transparent transmissioninterface.

1.1 Definition of Northbound InterfaceThe northbound interface is an interface between the Element Management System (EMS) andthe Network Management System (NMS).

1.2 Implementation of the MML Command Transparent Transmission InterfaceThe M2000 provides the MML command transparent transmission interface for the NMS. Onthis interface, the NMS connects to and manages NEs that are managed by the M2000 server.This describes the process for implementation and the transparent transmission process of anNMS command.

M2000Northbound MML Command Interface Developer Guide

1 Introduction to Northbound MML Command TransparentTransmission Interface


1-1

1.1 Definition of Northbound InterfaceThe northbound interface is an interface between the Element Management System (EMS) andthe Network Management System (NMS).

On the northbound interface, the NMS obtains the information about the NEs managed by theEMS and delivers operation commands. The NE information includes the alarm, configuration,performance and inventory data. The Northbound interface is as shown in Figure 1-1.

Figure 1-1 Location of the northbound interface

In the mobile communication network, the M2000 is an EMS. The M2000 reports the alarm,configuration, performance and inventory data to the NMS through the northbound interface.

1.2 Implementation of the MML Command TransparentTransmission Interface

The M2000 provides the MML command transparent transmission interface for the NMS. Onthis interface, the NMS connects to and manages NEs that are managed by the M2000 server.This describes the process for implementation and the transparent transmission process of anNMS command.

ImplementationTable 1-1 describes the process for implementation.



1-2 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

Issue 01 (2009-08-29)

Table 1-1 Process for implementation

Brief Description

Log in to the M2000 server as userM2000. Establish the remoteconnection between the NMS and theM2000. For example, through telnet.

Currently, the MML command interface supportsa maximum of 64 remote connections. If thenumber of connections is greater than 64, thesystem denies the connection.

The M2000 authenticates the receivedinformation about the user account.

l If the authentication is successful, the loginsuccess message is displayed.

l If the authentication fails, the NMS disconnectsthe NE.

Users can query the list of all theauthorized NEs and select an NE tooperate.

For the direct running of scripts, the defaultoperation object is the M2000.

The M2000 transparently transmits anMML command sent by users to the NE.

The packet of the NE is displayed to the NMS.

NOTE

Using a command, the NMS can switch to operate another NE at any time. The NMS, however, can operateone NE at a time.

For details of the process, refer to Figure 1-2.




1-3

Transparent Transmission Process

Figure 1-2 Transparent transmission process of an NMS command

No. Operation

1 The NMS establishes Telnet connection with the M2000.

2 The NMS sends the name and password of the user who logs in to the system tothe M2000 for authentication.

3 The authentication result is displayed.

4 If the authentication is successful, the NMS sends an NE list command.

5 The operable NE list information is displayed.

6 The NMS registers an NE to be operated.

7 The M2000 queries whether the NE is connected.

8 The connection result is displayed.

9 If the connection fails, the M2000 replies the northbound with the connectionfailure message.

10 If the connection is successful, the NMS sends an MML command.

11 The MML command is transparently transmitted to the NE.




Issue 01 (2009-08-29)

No. Operation

12 The result of the operation is displayed.

13 The operation result is displayed to the NMS.




1-5

2 Transparent Transmission of theNorthbound MML Command

About This Chapter

This describes the transparent transmission of the Northbound MML command, which consistsof connecting the MML command transparent transmission, maintaining the MML commandtransparent transmission, and disconnecting the MML command transparent transmission.

ContextStrictly conform to the format of MML commands when using the MML commands. Thesymbols : and ; are mandatory for the MML commands. Type all the MML commands and pressEnter to end.

2.1 Connecting the MML Command Transparent TransmissionThis describes the connecting the MML command transparent transmission, which consists oflogin, listing operable NEs, and registering an NE.

2.2 Maintaining the MML Command Transparent TransmissionThis describes the procedure for maintaining the MML command transparent transmission,which consists of MML command transparent transmission, sending handshake messages, andsending disconnection messages when disconnecting.

2.3 Disconnecting the MML Command Transparent TransmissionThis describes the procedure for disconnecting the MML command transparent transmission,which consists of deregistering an NE and logout.


2 Transparent Transmission of the Northbound MMLCommand


2-1

2.1 Connecting the MML Command TransparentTransmission

This describes the connecting the MML command transparent transmission, which consists oflogin, listing operable NEs, and registering an NE.

2.1.1 LoginThe NMS remotely logs in to the M2000 server through the MML service port to connect to theM2000 server.

2.1.2 Listing Operable NEsThis describes the procedure for listing operable NEs.

2.1.3 Registering an NEWhen the user selects an NE from an NE list to maintain, the NMS sends a registration commandto the M2000.

2.1.1 LoginThe NMS remotely logs in to the M2000 server through the MML service port to connect to theM2000 server.

PrerequisiteThe M2000 user is created on the M2000 M2000 client. For details, see 3.2.1 Creating aUser.

Procedure

Step 1 Remotely connect to port 31114 of the M2000 server.For example, telnet 10.121.77.248 31114

Step 2 Run the following command to log in to the M2000 server:

The command syntax is as follows:

LGI:OP="MML user", PWD="password of MML user";

For example, LGI:OP="MMLUser",PWD="M2000nbi";

l If the M2000 returns RETCODE = 0 Success, you can infer that logging in to theM2000 server is successful.

l If the M2000 returns RETCODE = 1 Error Message, you can infer that logging in tothe M2000 server fails.The possible reasons for the failure are as follows: The M2000 user is not created, theM2000 user and password are incorrect, and the M2000 user is locked.

----End

2.1.2 Listing Operable NEsThis describes the procedure for listing operable NEs.




Issue 01 (2009-08-29)

Procedure

Step 1 Use the telnet command to connect to the port 31114 of the M2000 server.

Step 2 The NMS sends the command for logging in to the M2000.For details about how to log in to the M2000, see 2.1.1 Login.

Step 3 The NMS sends the LST NE command to list all the NEs that can be operated by the currentuser.

Thus, the user can select one NE to maintain.

The format of the command is as follows:

LST NE:;

If the LST NE command runs successfully, the following packet is displayed by the M2000:

+++ NMS SERVER 2006-03-02 12:09:25O&M #2304%%LST NE:;%%RETCODE = 0 SuccessLST NE Info-----------------------------

NE Type NE Name IP address

RNC RNC_czh 10.161.198.208NodeB NodeB_czh. 10.161.214.209MGW MGW_czh 10.71.28.53

--- END

If the LST NE command runs unsuccessfully, the following packet is displayed by the M2000:

+++ NMS SERVER 2006-03-02 12:09:25O&M #2304%%LST NE:;%%RETCODE = 1 Error MessageError Message--- END

NOTE

l If RETCODE is successful, the displayed value is 0; if RETCODE fails, an error code is displayed.

l Error Message indicates the detailed error message.

l To type the parameter for Info, refer to the parameter that is different during the registration of theNMS.

TIP

The LST NE command is optional. If the NMS needs to maintain the IP of an NE, the NMS can directlysend the registration command.

----End

2.1.3 Registering an NEWhen the user selects an NE from an NE list to maintain, the NMS sends a registration commandto the M2000.




2-3

Procedure


Step 2 The NMS sends the login command to log in to the M2000.For details, refer to 2.1.1 Login.

Step 3 Registering an NE.l Registering an NE Through IP Address

The format of the command is as follows:REG NE:IP="10.161.198.243";Based on the parameters in the REG NE command, the M2000 analyzes the IP address ofan NE and establishes the connection to the NE.– If the connection is successful, a success message is sent to the NMS.

– If the connection fails, an error message is sent to the NMS.

If the connection is successful, the following packet is displayed by the M2000:+++ NMS SERVER 2006-03-02 11:57:11O&M #2304%% REG NE:IP="10.161.198.243";%%RETCODE = 0 Success

Success

--- END

If the connection fails, the following packet is displayed by the M2000:+++ NMS SERVER 2006-03-02 12:09:25O&M #2304%% REG NE:IP="10.161.198.243";%%RETCODE = 1 Error MessageError Message--- END

NOTE



l Registering an NE Through NE NameThe format of the command is as follows:REG NE:NAME="NodeB_czh";Based on the parameters in the REG NE command, the M2000 obtains an NE name andestablishes the connection to the NE.– If the connection is successful, the success message is sent to the NMS.

– If the connection fails, the error message is sent to the NMS.

If the connection is successful, the following packet is displayed by the M2000:+++ NMS SERVER 2006-03-02 11:57:11O&M #2304%% REG NE: NAME ="NodeB_czh";%%RETCODE = 0 Success

Success

--- END

If the connection fails, the following packet is displayed by the M2000:




Issue 01 (2009-08-29)

+++ NMS SERVER 2006-03-02 12:09:25O&M #2304%% REG NE: NAME ="NodeB_czh";%%RETCODE = 1 Error MessageError Message--- END

NOTE



TIP

l If the user knows the IP address of the NE or the name of the NE, the LST NE command need notbe used. You can register the NE based on the IP address or the NE name.

l The NMS can maintain only one NE at a time. The NMS, however, can send the REG commandto switch to a different NE. After the NMS sends the REG command, the M2000 automaticallydisconnects the previous NE that is maintained.

----End

2.2 Maintaining the MML Command TransparentTransmission

This describes the procedure for maintaining the MML command transparent transmission,which consists of MML command transparent transmission, sending handshake messages, andsending disconnection messages when disconnecting.

2.2.1 MML Command Transparent TransmissionThis describes the procedure for MML command transparent transmission.

2.2.2 Issuing MML Commands in BatchesThe M2000 can activate a script to issue multiple MML commands to NEs in batches. Thus, theM2000 can operate and maintain the NEs.

2.2.3 Sending Handshake MessagesTo ensure smooth connection, the NMS sends a handshake message to MML commandtransparent transmission interface every 300 seconds.

2.2.4 Sending Disconnection Messages when DisconnectingWhen an NE disconnects the M2000, the M2000 sends an NE disconnection message to theNMS.

2.2.1 MML Command Transparent TransmissionThis describes the procedure for MML command transparent transmission.

PrerequisiteOnly when an MML command transparently transmitted is authorized.

Procedure

Step 1 Use the telnet command to connect to the port 31114 of the M2000 server.After the connection is successful, the transparent transmission can be performed.




2-5

Step 2 The NMS sends a command to an NE.

After receiving a command, the M2000 immediately forwards it to a specific NE, The formatof the command is as follows:

GET OFI:;+++ HW-MSOFTX 2008-09-12 10:40:25+08:00O&M #969842%%/*2881@CMM_SID=1@*/GET OFI:;%%RETCODE = 0 Operation succeeded--- End

NOTE

l If the MML command is authorized, the Success can be displayed.

l If the MML command is not authorized, the authentication fails.

----End

2.2.2 Issuing MML Commands in BatchesThe M2000 can activate a script to issue multiple MML commands to NEs in batches. Thus, theM2000 can operate and maintain the NEs.

Prerequisitel The script contains only the MML commands that are authorized to be used on the

corresponding NE.l The script is uploaded to the /export/home/sysm/ftproot/itf_n/nms_mml_server/script

directory on the M2000 server.

Contextl The script must be in .txt format. The M2000 needs to maintain the script that is uploaded

in ASC mode and saved in the /export/home/sysm/ftproot/itf_n/nms_mml_server/script directory.

l The file containing the script execution results is saved in the /export/home/sysm/ftproot/itf_n/nms_mml_server/result directory. The M2000 automatically deletes the result filesgenerated three days ago.

l The M2000 automatically names the result files. The name convention is as follows: nameof the script to be activated_time when the script is activated_the name of the user thatremotely logs in to the M2000 server for using the MML service_random number.rst.The format of the time when the script is activated is YYYYMMDDHHMMSS. YYYYindicates year, MM indicates month, DD indicates date, HH indicates hour (24-hourformat), MM indicates minute, and SS indicates second. For example, 20090511171950indicates that the script is activated at 17:19:50 on 2009-5-11.Multiple results files aregenerated when multiple users remotely and simultaneously log in to the M2000 server toactive a certain script by using the same user account. In this case, the random numberparameter can be used to distinguish between these results files.

l If the current user is activating a script, he or she cannot activate another script at the sametime.

l You can specify the NE on which the MML command is to be used in either the activationcommand or the script. After you specify an NE in the activation command, the MMLcommand is to be used on this NE no matter whether you specify the NE in the script or




Issue 01 (2009-08-29)

not. If you do not specify an NE in the activation command, the MML command is to beused on the NE that is specified in the script.

l In the script, different MML commands are located in different lines. {} is added to eachMML command to specify the NE to which the command is to be issued. If you need notspecify any NE, no {} is required. For example, if you need to issue the LST CELL:;command to the NEs named rnc_l and rnc_2 and the LST PRACH:; command to the NEnamed rnc_l, but you need not specify any NE to which the LST BRD:; command is issued,the script is as follows:LST CELL:; {rnc_l,rnc_2}LST PRACH:; {rnc_l}LST BRD:;

Procedure

Step 1 Remotely log in to the port numbered 31114 on the M2000 server. For example, log in to theport through telnet.

Step 2 Specify the NEs in the activation command or script. Run the following command to activatethe script:l Specify the NEs to which the MML commands are to be issued in the activation command.

Run the following command to deliver the script named testMML2.txt to the NEs namedrnc_1 and rnc_2 and save the execution results to the file named name of the script to beactivated_time when the script is activated_the name of the user that remotely logs in tothe M2000 server for using the MML service_random number.rst. For example, a file isnamed testMML2_20090511171950_UserName_102.rst.S_ACTIVATE: FILE="testMML2.txt", NELIST="{rnc_1,rnc_2}";If the system output is as follows, you can infer that the script is executed successfully.

S_ACTIVATE OK; RESULFILE=testMML2_20090511171950_UserName_102.rst 10% ACCOMPLISHED 50% ACCOMPLISHED 100% ACCOMPLISHED S_ACTIVATE SUCCESS;If the system output is as follows, you can infer that the script is failed. Rectify the faultaccording to the error message.S_ACTIVATE FAILED; REASON=insufficient privilege

l Specify the NEs to which the MML commands are to be issued in the script.Run the following command to deliver the script named test1.txt to the specified NEs andsave the execution results to the file named name of the script to be activated_time whenthe script is activated_the name of the user that remotely logs in to the M2000 server forusing the MML service_random number.rst. For example, a file is namedtest1_20090511171950_UserName_102.rst.S_ACTIVATE: FILE="test1.txt";If the system output is as follows, you can infer that the script is executed successfully.S_ACTIVATE OK; RESULFILE=test1_20090511171950_UserName_102.rst 10% ACCOMPLISHED 50% ACCOMPLISHED 100% ACCOMPLISHED S_ACTIVATE SUCCESS;If the system output is as follows, you can infer that the script is failed. Rectify the faultaccording to the error message.S_ACTIVATE FAILED; REASON=insufficient privilege

----End




2-7

2.2.3 Sending Handshake MessagesTo ensure smooth connection, the NMS sends a handshake message to MML commandtransparent transmission interface every 300 seconds.

Procedure


Step 2 Run the following command.

SHK HAND:;

The packet displayed by the NE is as follows:

+++ NMS SERVER 2006-03-02 15:18:59 DSTO&M #0%%SHK HAND:;%%RETCODE = 0 Success

--- END

----End

2.2.4 Sending Disconnection Messages when DisconnectingWhen an NE disconnects the M2000, the M2000 sends an NE disconnection message to theNMS.

Procedure

Step 1 The M2000 sends an NE disconnection message to the NMS.

The packet sent by the M2000 is as follows:

+++ NMS SERVER 2006-03-02 11:57:11SYNC #2304NE Disconnect Information--------------------IP="10.161.198.243";--- END

----End

2.3 Disconnecting the MML Command TransparentTransmission

This describes the procedure for disconnecting the MML command transparent transmission,which consists of deregistering an NE and logout.

2.3.1 Deregistering an NERegistering an NE requires the system resource. Thus, if the NMS does not maintain an NE, youneed to deregister the NE to release the resource.

2.3.2 LogoutWhen you log out of the M2000 and disconnect the M2000, you need send theLGO:OP="MMLUser"; command.




Issue 01 (2009-08-29)

2.3.1 Deregistering an NERegistering an NE requires the system resource. Thus, if the NMS does not maintain an NE, youneed to deregister the NE to release the resource.

PrerequisiteYou have registered an NE and obtained the IP address or name of the NE.

ContextYou can use the IP address or the name of an NE to degegister the NE.

ProcedureStep 1 Use the telnet command to connect to the port 31114 of the M2000 server.

Step 2 The NMS sends the login command to log in to the M2000.For details, refer to 2.1.1 Login.

Step 3 Deregistering an NE.l Deregistering an NE Through IP Address

The format of the command is as follows:UNREG NE:IP="10.161.198.243";If the logout is successful, the packet displayed by the M2000 is as follows:+++ NMS SERVER 2006-03-02 11:57:11O&M #2304%% UNREG NE:IP="10.161.198.243";%%RETCODE = 0 Success

Success

--- ENDIf the logout fails, the packet displayed by the M2000 is as follows:+++ NMS SERVER 2006-03-02 12:09:25O&M #2304%% UNREG NE:IP="10.161.198.243";%%RETCODE = 1 Error MessageError Message--- END

NOTE



l Deregistering an NE Through NE NameThe format of the command is as follows:UNREG NE:NAME ="NodeB_czh";If the logout command runs successfully, the packet displayed by the M2000 is as follows:+++ NMS SERVER 2006-03-02 11:57:11O&M #2304%% UNREG NE:NAME ="NodeB_czh";%%RETCODE = 0 SuccessSuccess--- ENDIf the logout command is run unsuccessfully, the packet displayed by the M2000 is as follows:




2-9

+++ NMS SERVER 2006-03-02 12:09:25O&M #2304%% UNREG NE:NAME ="NodeB_czh";%%RETCODE = 1 Error MessageError Message--- END

NOTE


l Error Message indicates the detailed error message. You can handle related problemsaccording to the error message. If it is not possible to handle a problem, contact Huawei for technicalsupport.

----End

2.3.2 LogoutWhen you log out of the M2000 and disconnect the M2000, you need send theLGO:OP="MMLUser"; command.

PrerequisiteYou have logged in to port 31114 of the M2000 server.

Procedure

Step 1 In the login window, run the following command.

LGO:OP="MMLUser";

If the logout is successful, the packet displayed by the M2000 is as follows:

+++ NMS SERVER 2006-03-02 11:57:11O&M #2304%%LGO:OP="MMLUser";%%RETCODE = 0 SuccessSuccess--- END

If the logout fails, the packet displayed by the M2000 is as follows:

+++ NMS SERVER 2006-03-02 11:57:11O&M #2304%%LGO:OP="MMLUser";%%RETCODE = 1 Error MessageError Message--- END

NOTE


l Error Message indicates the detailed error message. You can handle related problems accordingto the error message. If it is not possible to handle a problem, contact Huawei for technical support.

----End




Issue 01 (2009-08-29)

3 Interconnection Commissioning of theNorthbound MML Interface

About This Chapter

Before interconnecting the NMS with the M2000, you must conduct an interconnectioncommissioning. Based on the commissioning result, determine whether the northbound MMLinterface meets the conditions for interconnecting with the NMS.

3.1 Negotiating the Interconnection Parameters of the Northbound MML InterfaceThis describes the relevant information that the M2000 needs to provide to the NMS before theinterconnection.

3.2 Preparations for the Commissioning of the MML InterfaceBefore simulating the interconnection, you need to create a user that is authorized to use theMML commands for NEs on the M2000 client.

3.3 Commissioning the Interconnection of the Northbound MML InterfaceIn the commissioning of the MML interface interconnection, you need to simulate theinterconnection, check the interconnection result, and determine whether the MML interfacemeets the conditions for interconnecting with the NMS based on the interconnection result.

3.4 Usage of the Northbound MML InterfaceThis describes how to use the northbound MML interface when the M2000 system adoptsdifferent networking modes.


3 Interconnection Commissioning of the Northbound MMLInterface


3-1

3.1 Negotiating the Interconnection Parameters of theNorthbound MML Interface

This describes the relevant information that the M2000 needs to provide to the NMS before theinterconnection.

Checking LicenseBefore interconnecting the M2000 and the NMS, check whether the NMS is licensed to use theMML interface.

1. Log in to the M2000 client.2. Choose Help > License Information. The License Information window is displayed.3. Click the Function control item tab. If License name contains Command Line

Interface, you can infer that the NMS is authorized to use the MML interface.

Negotiating the Interconnection ParametersThe following information needs to be provided to the NMS by the M2000: the IP address andport number of the M2000 server, and the user name and password of the specified port of theM2000 server for login. Table 3-1provides a group of MML interface parameters. The followinginterconnection operations are based on these parameters.

Table 3-1 Information provided by the M2000

Parameter Parameter Value Description

IP address of the M2000server

10.121.77.248 You can change the parametervalue as required.

Port number of the M2000 31114 Indicates the number of the portthat is used to receive NMSconnection requests and MMLcommands.Use the default parameter value.

User name MMLUser You can change the parametervalue as required, which can beany user on the M2000 client.

Password M2000nbi You can change the parametervalue as required.

3.2 Preparations for the Commissioning of the MMLInterface

Before simulating the interconnection, you need to create a user that is authorized to use theMML commands for NEs on the M2000 client.




Issue 01 (2009-08-29)

3.2.1 Creating a UserThis describes the procedure for creating a user on the M2000 client.

3.2.2 Binding an NE when Creating a UserThis describes the procedure for binding an NE when creating a user on the M2000 client.

3.2.3 Binding a New NEThis describes the procedure for binding an new NE on the M2000 client.

3.2.4 Querying an Authorized MML CommandThis describes the procedure for querying an authorized MML command on the M2000 client.

3.2.1 Creating a UserThis describes the procedure for creating a user on the M2000 client.

Procedure

Step 1 Choose Security > Security Management.The Security Management window is displayed, as shown in Figure 3-1.

Figure 3-1 Security Management

Step 2 Select the User node from the navigation tree, as shown in Figure 3-2.




3-3

Figure 3-2 User

Step 3 Click New User in the right pane.The New User dialog box is displayed, as shown in Figure 3-3.




Issue 01 (2009-08-29)

Figure 3-3 New User

Step 4 Type the user name MMLUser and the password M2000nbi.

For other information, use the default system settings.

----End

3.2.2 Binding an NE when Creating a UserThis describes the procedure for binding an NE when creating a user on the M2000 client.

Procedure





3-5


Step 2 Select the User node from the navigation tree, as shown in Figure 3-5.

Figure 3-5 User

Step 3 Click New User in the right pane.The New User dialog box is displayed, as shown in Figure 3-6.




Issue 01 (2009-08-29)

Figure 3-6 New User

Step 4 In the New User dialog box, select Binded NE tab.

Step 5 Select an NE Type to be bound from the drop-down list, as shown in Figure 3-7.All the NEs of the type are shown on the left and the MML command group that the NE belongsto is shown on the right. You can bind the NE and the command group.




3-7

Figure 3-7 Binding an NE

Step 6 Click OK.

----End

3.2.3 Binding a New NEThis describes the procedure for binding an new NE on the M2000 client.

Procedure





Issue 01 (2009-08-29)


Step 2 Select MMLUser under the User node to view the detailed user information, as shown in Figure3-9.

Figure 3-9 MMLUser user information

Step 3 Select the Binded NE tab to view the bound NE list, as shown in Figure 3-10.




3-9

Figure 3-10 Bound NE list

Step 4 Click Bind NE....The Bind NE dialog box is displayed, as shown in Figure 3-11.

Figure 3-11 Bind NE




Issue 01 (2009-08-29)

Step 5 Select MMLUser to bind the NE and the command group.

----End

3.2.4 Querying an Authorized MML CommandThis describes the procedure for querying an authorized MML command on the M2000 client.

Procedure

Step 1 Choose Security > NE User Management.The NE User Management window is displayed, as shown in Figure 3-12.

Figure 3-12 NE User Management

Step 2 Expand the NE node in the Security Management navigation tree.

Step 3 Expand the NE type and NE name to be queried.

Step 4 Select MMLUser, as shown in Figure 3-13.

The command group that can be operated by the user is displayed on the top right of the GUI.Select a command group and the MML command assigned to the rights is displayed.




3-11

Figure 3-13 MML command assigned to the rights

NOTE

For details of the operation method, refer to the Managing NE Users in M2000 Operator Guide.

----End

3.3 Commissioning the Interconnection of the NorthboundMML Interface

In the commissioning of the MML interface interconnection, you need to simulate theinterconnection, check the interconnection result, and determine whether the MML interfacemeets the conditions for interconnecting with the NMS based on the interconnection result.

3.3.1 Simulating the Interconnection with the NMS (MML Interface)When the NMS successfully logs in to the specified port of the M2000 by using the provideduser information, you can infer that the interconnection is complete.

3.3.2 Checking the InterconnectionIssue an MML command that you are authorized to use. Then, check whether the interconnectionis successful based on the returned information.




Issue 01 (2009-08-29)

3.3.1 Simulating the Interconnection with the NMS (MMLInterface)

When the NMS successfully logs in to the specified port of the M2000 by using the provideduser information, you can infer that the interconnection is complete.

Procedure

Step 1 Remotely log in to port 31114 of the M2000 server.

For example, enter telnet IP address of the M2000 server 31114 for the remote login.

Step 2 Log in to the port by using the information about the user that is already created.

For example, enter LGI:OP="MMLUser",PWD="M2000nbi"; for the login.

----End

3.3.2 Checking the InterconnectionIssue an MML command that you are authorized to use. Then, check whether the interconnectionis successful based on the returned information.

PrerequisiteThe simulation of the NMS interconnection is complete. The NMS have successfully logged into the specified port of the M2000 server.

Procedure

Step 1 Issue an MML command and check the returned information.For example, issue the LST NE:; command and check whether the returned information includesthe types, names, and IP addresses of the NEs that you are authorized to query. If the returnedinformation includes the types, names, and IP addresses of the relevant NEs, you can infer thatthe interconnection is successful. Otherwise, you can infer that the interconnection fails. Fordetails about how to handle the interconnection failure, see 4 Troubleshooting for theNorthbound MML Interface.

Step 2 To exit the interconnection, see 2.3 Disconnecting the MML Command TransparentTransmission.

----End

3.4 Usage of the Northbound MML InterfaceThis describes how to use the northbound MML interface when the M2000 system adoptsdifferent networking modes.

The M2000 system can adopt the following networking modes: single-server system, HAsystem, remote HA system, and SLS system. For details about how to use the northbound MMLinterface in different networking modes, see Table 3-2.




3-13

Table 3-2 Usage of the northbound MML interface

M2000 System Type Use Reference

Single-server system Refer to this document.

HA system Refer to this document.

Remote HA system Refer to this document and the relevant documents ofthe remote HA system.

SLS system Refer to this document and the relevant documents ofthe SLS system.




Issue 01 (2009-08-29)

4 Troubleshooting for the Northbound MMLInterface

About This Chapter

This describes how to troubleshoot the northbound MML interface. If a fault occurs when theNMS is interconnected to the M2000 through the northbound MML interface, refer to thischapter for handling the fault.

4.1 Common Troubleshooting and Information Collection (MML Interface)If a fault occurs when the NMS interconnects to the M2000 through the northbound MMLinterface, rectify the fault according to common troubleshooting methods. If it is not possible torectify the fault by using the common troubleshooting methods, collect the fault information andcontact Huawei engineers for assistance.

4.2 Handling the Failure of Issuing MML CommandsThis describes how to handle the failure of issuing MML commands due to NE disruption.

M2000Northbound MML Command Interface Developer Guide 4 Troubleshooting for the Northbound MML Interface


4-1

4.1 Common Troubleshooting and Information Collection(MML Interface)

If a fault occurs when the NMS interconnects to the M2000 through the northbound MMLinterface, rectify the fault according to common troubleshooting methods. If it is not possible torectify the fault by using the common troubleshooting methods, collect the fault information andcontact Huawei engineers for assistance.

Troubleshooting

For the common troubleshooting methods, see Table 4-1.

Table 4-1 Troubleshooting

Common Fault Troubleshooting Method

Issuing MML commands fails. See 4.2 Handling the Failure of Issuing MMLCommands.

Information Collection

If a fault not included in Table 4-1 occurs when the NMS is obtaining the data, you need tocollect relevant information for fault localization. Table 4-2 lists the information that needs tobe collected and the collection methods.

Table 4-2 Information to be collected

Related Information Description

Operation information The operation information records the operationsperformed before a fault occurs and the troubleshootingmeasures taken later.

Version information You need to obtain the information about the M2000version, NE mediation version, and NE version.

IP address information You need to obtain the IP address information aboutthe M2000 server.

Log information You can obtain logs from the /opt/OMC/var/logsdirectory. The .trace file of the MML interface isiMAP.nms_mml_agent.trace.

4.2 Handling the Failure of Issuing MML CommandsThis describes how to handle the failure of issuing MML commands due to NE disruption.

4 Troubleshooting for the Northbound MML InterfaceM2000



Issue 01 (2009-08-29)

Problem DescriptionThe NMS fails to issue an MML command.

TroubleshootingThe NMS fails to issue the MML command possibly due to NE disruption.

Handling the Fault of NE Disconnection1. On the M2000 client, choose Topology > Main Topology. In the Main Topology window,

right-click the disconnected NE and then choose Reconnect NE.2. Check the network and rectify the network fault.3. Rectify the fault on the NE mediation. If you have to reinstall the NE mediation, see the

Commissioning Guide of the corresponding M2000 networking mode.

SolutionContact Huawei engineers for assistance.

M2000Northbound MML Command Interface Developer Guide 4 Troubleshooting for the Northbound MML Interface


4-3

m2000 northbound mml command interface developer guide

Documents

huawei trademarks

huawei proprietary

mml commands

huawei industrial basebantian

noticethe information

local office

company headquarters

trade names