You are on page 1of 39

M2000 V200R008C01

Northbound MML Command Interface Developer Guide

Issue Date Part Number

01 2008-03-20 00407977

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

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

Huawei Technologies Co., Ltd.


Address: Huawei Industrial Base Bantian, Longgang Shenzhen 518129 People's Republic of China http://www.huawei.com support@huawei.com

Website: Email:

Copyright Huawei Technologies Co., Ltd. 2008. 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 the property of Huawei Technologies Co., Ltd. All other trademarks and trade names mentioned in this document are the property of their respective holders.

Notice
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 the statements, information, and recommendations in this document do not constitute a warranty of any kind, express or implied.

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

M2000 Northbound MML Command Interface Developer Guide

Contents

Contents
About This Document.....................................................................................................................1 1 Introduction to Northbound MML Command Transparent Transmission Interface ...........................................................................................................................................................1-1
1.1 Definition of Northbound Interface.................................................................................................................1-2 1.2 Northbound MML Command Transparent Transmission Interface................................................................1-2 1.2.1 Implementation of the MML Command Transparent Transmission Interface......................................1-2 1.2.2 Interconnection Parameters of the MML Command Transparent Transmission Interface....................1-5

2 Interconnecting Northbound MML Command Transparent Transmission Interface ...........................................................................................................................................................2-1


2.1 Creating a User................................................................................................................................................2-2 2.2 Binding an NE.................................................................................................................................................2-4 2.2.1 Binding an NE when Creating a User....................................................................................................2-4 2.2.2 Binding a New NE.................................................................................................................................2-6 2.3 Querying an Authorized MML Command......................................................................................................2-9

3 Transparent Transmission of the Northbound MML Command.....................................3-1


3.1 Connecting the MML Command Transparent Transmission..........................................................................3-2 3.1.1 Login......................................................................................................................................................3-2 3.1.2 Listing Operable NEs.............................................................................................................................3-3 3.1.3 Registering an NE..................................................................................................................................3-4 3.2 Maintaining the MML Command Transparent Transmission.........................................................................3-5 3.2.1 MML Command Transparent Transmission..........................................................................................3-6 3.2.2 Sending Handshake Messages...............................................................................................................3-6 3.2.3 Sending Disconnection Messages when Disconnecting........................................................................3-6 3.3 Disconnecting the MML Command Transparent Transmission.....................................................................3-7 3.3.1 Deregistering an NE...............................................................................................................................3-7 3.3.2 Logout....................................................................................................................................................3-8

Index.................................................................................................................................................i-1

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

M2000 Northbound MML Command Interface Developer Guide

Figures

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

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

iii

M2000 Northbound MML Command Interface Developer Guide

Tables

Tables
Table 1-1 Process for implementation..................................................................................................................1-3

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

M2000 Northbound MML Command Interface Developer Guide

About This Document

About This Document

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

Related Versions
The following table lists the product versions related to this document. Product Name M2000 Version V200R008C01

Intended Audience
The intended audiences of this document are:
l

Network administrator

Update History 01(2008-03-20)


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 and interconnecting parameters of the Northbound MML command transparent transmission interface. 2 Interconnecting Northbound MML Command Transparent Transmission Interface
Issue 01 (2008-03-20) Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd 1

About This Document

M2000 Northbound MML Command Interface Developer Guide

This describes the interconnecting Northbound MML command transparent transmission interface, which consists of creating a user, binding an NE and an MML command, and querying an authorized MML command. 3 Transparent Transmission of the Northbound MML Command This describes the transparent transmission of the Northbound MML command, which consists of connecting the MML command transparent transmission, maintaining the MML command transparent transmission, and disconnecting the MML command transparent transmission.

Conventions
1. Symbol Conventions The following symbols may be found in this document. They are defined as follows Symbol Description Indicates a hazard with a high level of risk that, if not avoided, will result in death or serious injury. Indicates a hazard with a medium or low level of risk which, 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 your time. Provides additional information to emphasize or supplement important points of the main text.

DANGER

WARNING

CAUTION
TIP

NOTE

2. General Conventions Convention Times New Roman Boldface Italic Courier New 3. Command Conventions Convention Boldface
2

Description Normal paragraphs are in Times New Roman. Names of files,directories,folders,and users are in boldface. For example,log in as user root . Book titles are in italics. Terminal display is in Courier New.

Description The keywords of a command line are in boldface.


Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

About This Document

Convention Italic [] {x | y | ...} [ x | y | ... ] { x | y | ... } * [ x | y | ... ] *

Description Command arguments are in italic. Items (keywords or arguments) in square brackets [ ] are optional. Alternative items are grouped in braces and separated by vertical bars.One is selected. Optional alternative items are grouped in square brackets and separated by vertical bars.One or none is selected. Alternative items are grouped in braces and separated by vertical bars.A minimum of one or a maximum of all can be selected. Alternative items are grouped in braces and separated by vertical bars.A minimum of zero or a maximum of all can be selected.

4. GUI Conventions Convention Boldface > Description Buttons,menus,parameters,tabs,window,and dialog titles are in boldface. For example,click OK. Multi-level menus are in boldface and separated by the ">" signs. For example,choose File > Create > Folder .

5. Keyboard Operation Convention Key Key1+Key2 Key1,Key2 Description Press the key.For example,press Enter and press Tab. Press the keys concurrently.For example,pressing Ctrl+Alt+A means the three keys should be pressed concurrently. Press the keys in turn.For example,pressing Alt,A means the two keys should be pressed in turn.

6. Mouse Operation Action Click Double-click Drag Description Select and release the primary mouse button without moving the pointer. Press the primary mouse button twice continuously and quickly without moving the pointer. Press and hold the primary mouse button and move the pointer to a certain position.
Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd 3

Issue 01 (2008-03-20)

About This Document

M2000 Northbound MML Command Interface Developer Guide

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

1 Introduction to Northbound MML Command Transparent Transmission Interface

Command Transparent Transmission Interface


About This Chapter
This describes the definition of the Northbound interface, and the implementation and interconnecting parameters of the Northbound MML command transparent transmission interface. 1.1 Definition of Northbound Interface The Northbound interface is an interface between the Element Management System (EMS) and the Network Management System (NMS). 1.2 Northbound MML Command Transparent Transmission Interface The M2000 provides the MML command transparent transmission interface for the NMS. On this interface, the NMS connects to and manages NEs that are managed by the M2000 server.

Introduction to Northbound MML

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

1-1

1 Introduction to Northbound MML Command Transparent Transmission Interface

M2000 Northbound MML Command Interface Developer Guide

1.1 Definition of Northbound Interface


The Northbound interface is an interface between the Element Management System (EMS) and the Network Management System (NMS). On the Northbound interface, the NMS obtains the information about the NEs managed by the EMS and delivers operation commands. The NE information includes the alarm, configuration, and performance 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, and performance data to the NMS through the Northbound interface.

1.2 Northbound MML Command Transparent Transmission Interface


The M2000 provides the MML command transparent transmission interface for the NMS. On this interface, the NMS connects to and manages NEs that are managed by the M2000 server. 1.2.1 Implementation of the MML Command Transparent Transmission Interface This describes the process for implementation and the transparent transmission process of an NMS command. 1.2.2 Interconnection Parameters of the MML Command Transparent Transmission Interface When the Northbound MML command transparent interface is provided, the NMS needs to use a user account assigned by the M2000.

1.2.1 Implementation of the MML Command Transparent Transmission Interface


This describes the process for implementation and the transparent transmission process of an NMS command.

1-2

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

1 Introduction to Northbound MML Command Transparent Transmission Interface

Implementation
Table 1-1 describes the process for implementation. Table 1-1 Process for implementation Brief Using the user account of the M2000, the NMS establishes Telnet connection with the M2000. The M2000 authenticates the received information about the user account. Description -

If the authentication is successful, the login success message is displayed. If the authentication fails, the NMS disconnects the NE.

Users can query the list of all the authorized NEs and select an NE to operate. The M2000 transparently transmits an MML command sent by users to the NE.

For the direct running of scripts, the default operation object is the M2000. 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 operate one NE at a time.

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

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

1-3

1 Introduction to Northbound MML Command Transparent Transmission Interface

M2000 Northbound MML Command Interface Developer Guide

Transparent Transmission Process


Figure 1-2 Transparent transmission process of an NMS command

No. 1 2 3 4 5 6 7 8 9 10 11 12 13
1-4

Operation The NMS establishes Telnet connection with the M2000. The NMS sends a user name and a password to the M2000 for authentication. The authentication result is displayed. If the authentication is successful, the NMS sends an NE list command. The operable NE list information is displayed. The NMS registers an NE to be operated. The M2000 queries whether the NE is connected. The connection result is displayed. If the connection fails, the NMS disconnects the M2000. If the connection is successful, the NMS sends an MML command. The MML command is transparently transmitted to the NE. The result of the operation is displayed. The operation result is displayed to the NMS.
Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

1 Introduction to Northbound MML Command Transparent Transmission Interface

1.2.2 Interconnection Parameters of the MML Command Transparent Transmission Interface


When the Northbound MML command transparent interface is provided, the NMS needs to use a user account assigned by the M2000. The user account assigned by the M2000 is as follows:
l l

User name: MMLUser Password: M2000nbi

The user account is used to log in to the M2000 and to connect to the NEs managed by the M2000.
NOTE

For details, refer to 2 Interconnecting Northbound MML Command Transparent Transmission Interface.

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

1-5

M2000 Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MML Command Transparent Transmission Interface

Command Transparent Transmission Interface


About This Chapter
This describes the interconnecting Northbound MML command transparent transmission interface, which consists of creating a user, binding an NE and an MML command, and querying an authorized MML command. 2.1 Creating a User This describes the procedure for creating a user on the M2000 client. 2.2 Binding an NE This describes the procedure for binding an NE, which consists of binding an NE when creating a user and binding a new NE. 2.3 Querying an Authorized MML Command This describes the procedure for querying an authorized MML command on the M2000 client.

Interconnecting Northbound MML

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

2-1

2 Interconnecting Northbound MML Command Transparent Transmission Interface

M2000 Northbound MML Command Interface Developer Guide

2.1 Creating a User


This 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 2-1. Figure 2-1 Security Management

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

2-2

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MML Command Transparent Transmission Interface

Figure 2-2 User

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

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

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

2-3

2 Interconnecting Northbound MML Command Transparent Transmission Interface

M2000 Northbound MML Command Interface Developer Guide

For other information, use the default system settings. ----End

2.2 Binding an NE
This describes the procedure for binding an NE, which consists of binding an NE when creating a user and binding a new NE. 2.2.1 Binding an NE when Creating a User This describes the procedure for binding an NE when creating a user on the M2000 client. 2.2.2 Binding a New NE This describes the procedure for binding an new NE on the M2000 client.

2.2.1 Binding an NE when Creating a User


This describes the procedure for binding an NE when creating a user on the M2000 client.

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

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

2-4

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MML Command Transparent Transmission Interface

Figure 2-5 User

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

Step 4 In the New User dialog box, select NE tab. Step 5 Select an NE Type to be bound from the drop-down list, as shown in Figure 2-7.
Issue 01 (2008-03-20) Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd 2-5

2 Interconnecting Northbound MML Command Transparent Transmission Interface

M2000 Northbound MML Command Interface Developer Guide

All the NEs of the type are shown on the left and the MML command group that the NE belongs to is shown on the right. You can bind the NE and the command group. Figure 2-7 Binding an NE

Step 6 Click OK. ----End

2.2.2 Binding a New NE


This describes the procedure for binding an new NE on the M2000 client.

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

2-6

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MML Command Transparent Transmission Interface

Figure 2-8 Security Management

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

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

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

2-7

2 Interconnecting Northbound MML Command Transparent Transmission Interface

M2000 Northbound MML Command Interface Developer Guide

Figure 2-10 Bound NE list

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

Step 5 Select MMLUser to bind the NE and the command group. ----End
2-8 Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MML Command Transparent Transmission Interface

Example Postrequisite

2.3 Querying an Authorized MML Command


This 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 2-12. Figure 2-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 2-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.

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

2-9

2 Interconnecting Northbound MML Command Transparent Transmission Interface

M2000 Northbound MML Command Interface Developer Guide

Figure 2-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

2-10

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

3 Transparent Transmission of the Northbound MML Command

3
Context

Transparent Transmission of the Northbound MML Command

About This Chapter


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

Strictly conform to the format of MML commands when using the MML commands. The symbols : and ; are mandatory for the MML commands. 3.1 Connecting the MML Command Transparent Transmission This describes the connecting the MML command transparent transmission, which consists of login, listing operable NEs, and registering an NE. 3.2 Maintaining the MML Command Transparent Transmission This describes the procedure for maintaining the MML command transparent transmission, which consists of MML command transparent transmission, sending handshake messages, and sending disconnection messages when disconnecting. 3.3 Disconnecting the MML Command Transparent Transmission This describes the procedure for disconnecting the MML command transparent transmission, which consists of deregistering an NE and logout.

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

3-1

3 Transparent Transmission of the Northbound MML Command

M2000 Northbound MML Command Interface Developer Guide

3.1 Connecting the MML Command Transparent Transmission


This describes the connecting the MML command transparent transmission, which consists of login, listing operable NEs, and registering an NE. 3.1.1 Login When you log in to the M2000 and connect the M2000, you need send the LGI:OP="MMLUser", PWD="M2000nbi"; command. 3.1.2 Listing Operable NEs This describes the procedure for listing operable NEs. 3.1.3 Registering an NE When the user selects an NE from an NE list to maintain, the NMS sends a registration command to the M2000.

3.1.1 Login
When you log in to the M2000 and connect the M2000, you need send the LGI:OP="MMLUser", PWD="M2000nbi"; command.

Procedure
Step 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. The user name and the password for login are assigned to the NMS by the M2000. The default objects operated by the user are NEs in the M2000. The format of the command is as follows: LGI:OP="MMLUser", PWD="M2000nbi"; If the login is successful, the M2000 displays the following packets:
+++ NMS SERVER 2006-03-02 11:57:11 O&M #2304 %%LGI:OP="MMLUser", PWD="M2000nbi";%% RETCODE = 0 Success Success --END

If the login fails, the M2000 displays the following packets:


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

3-2

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide


NOTE

3 Transparent Transmission of the Northbound MML Command

l l

If RETCODE is successful, the displayed value is 0; if RETCODE fails, an error code is displayed. Error Message indicates the detailed error message.

----End

3.1.2 Listing Operable NEs


This describes the procedure for listing operable NEs.

Procedure
Step 1 Use the telnet command to connect to the port 31114 of the M2000 server. Step 2 The NMS sends the LST NE command to list all the NEs that can be operated by the current user. 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:25 O&M #2304 %%LST NE:;%% RETCODE = 0 Success LST NE Info ----------------------------NE Type RNC NodeB MGW --NE Name IP address

RNC_czh 10.161.198.208 NodeB_czh. 10.161.214.209 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:25 O&M #2304 %%LST NE:;%% RETCODE = 1 Error Message Error Message --END
NOTE

l l l

If RETCODE is successful, the displayed value is 0; if RETCODE fails, an error code is displayed. Error Message indicates the detailed error message. To type the parameter for Info, refer to the parameter that is different during the registration of the NMS.

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

3-3

3 Transparent Transmission of the Northbound MML Command

M2000 Northbound MML Command Interface Developer Guide

CAUTION
The LST NE command is optional. If the NMS needs to maintain the IP of an NE, the NMS can directly send the registration command. ----End

3.1.3 Registering an NE
When the user selects an NE from an NE list to maintain, the NMS sends a registration command to the M2000.

Procedure
Step 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 3.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 of an 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:11 O&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:25 O&M #2304 %% REG NE:IP="10.161.198.243";%% RETCODE = 1 Error Message Error Message --END
NOTE

l l l

If RETCODE is successful, the displayed value is 0; if RETCODE fails, an error code is displayed. Error Message indicates the detailed error message.

Registering an NE Through NE Name The format of the command is as follows: REG NE:NAME="NodeB_czh";

3-4

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

3 Transparent Transmission of the Northbound MML Command

Based on the parameters in the REG NE command, the M2000 obtains an NE name and establishes 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:11 O&M #2304 %% REG NE: NAME ="NodeB_czh";%% RETCODE = 0 Success Success --END

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


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

l l

If RETCODE is successful, the displayed value is 0; if RETCODE fails, an error code is displayed. Error Message indicates the detailed error message.

CAUTION
l

If the user knows the IP address of the NE or the name of the NE, the LST NE command need not be used. You can register the NE based on the IP address or the NE name. The NMS can maintain only one NE at a time. The NMS, however, can send the REG command to switch to a different NE. After the NMS sends the REG command, the M2000 automatically disconnects the previous NE that is maintained.

----End

3.2 Maintaining the MML Command Transparent Transmission


This describes the procedure for maintaining the MML command transparent transmission, which consists of MML command transparent transmission, sending handshake messages, and sending disconnection messages when disconnecting. 3.2.1 MML Command Transparent Transmission This describes the procedure for MML command transparent transmission. 3.2.2 Sending Handshake Messages To ensure smooth connection, the NMS sends a handshake message to MML command transparent transmission interface every 300 seconds. 3.2.3 Sending Disconnection Messages when Disconnecting
Issue 01 (2008-03-20) Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd 3-5

3 Transparent Transmission of the Northbound MML Command

M2000 Northbound MML Command Interface Developer Guide

When an NE disconnects the M2000, the M2000 sends an NE disconnection message to the NMS.

3.2.1 MML Command Transparent Transmission


This describes the procedure for MML command transparent transmission.

Prerequisite
Only 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. Step 2 The NMS sends a command to an NE. After receiving a command, the M2000 immediately forwards it to a specific NE.
NOTE

l l

If the MML command is authorized, the Success can be displayed. If the MML command is not authorized, the authentication fails.

----End

3.2.2 Sending Handshake Messages


To ensure smooth connection, the NMS sends a handshake message to MML command transparent transmission interface every 300 seconds.

Procedure
Step 1 Use the telnet command to connect to the port 31114 of the M2000 server. Step 2 Run the following command. SHK HAND:; The packet displayed by the NE is as follows:
+++ NMS SERVER O&M #0 %%SHK HAND:;%% RETCODE = 0 Success --END 2006-03-02 15:18:59 DST

----End

3.2.3 Sending Disconnection Messages when Disconnecting


When an NE disconnects the M2000, the M2000 sends an NE disconnection message to the NMS.
3-6 Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide

3 Transparent Transmission of the Northbound MML Command

Procedure
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:11 SYNC #2304 NE Disconnect Information -------------------IP="10.161.198.243"; --END

----End

3.3 Disconnecting the MML Command Transparent Transmission


This describes the procedure for disconnecting the MML command transparent transmission, which consists of deregistering an NE and logout. 3.3.1 Deregistering an NE When the NMS does not maintain an NE any longer, the NMS can send the logout command to the M2000. 3.3.2 Logout When you log out of the M2000 and disconnect the M2000, you need send the LGO:OP="MMLUser"; command.

3.3.1 Deregistering an NE
When the NMS does not maintain an NE any longer, the NMS can send the logout command to the M2000.

Procedure
Step 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 3.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:11 O&M #2304 %% UNREG NE:IP="10.161.198.243";%% RETCODE = 0 Success Success --END

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


Issue 01 (2008-03-20) Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd 3-7

3 Transparent Transmission of the Northbound MML Command

M2000 Northbound MML Command Interface Developer Guide

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

l l l

If RETCODE is successful, the displayed value is 0; if RETCODE fails, an error code is displayed. Error Message indicates the detailed error message.

Deregistering an NE Through NE Name The 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:11 O&M #2304 %% UNREG NE:NAME ="NodeB_czh";%% RETCODE = 0 Success Success --END

If the logout command is run unsuccessfully, the packet displayed by the M2000 is as follows:
+++ NMS SERVER 2006-03-02 12:09:25 O&M #2304 %% UNREG NE:NAME ="NodeB_czh";%% RETCODE = 1 Error Message Error Message --END
NOTE

l l

If RETCODE is successful, the displayed value is 0; if RETCODE fails, an error code is displayed. Error Message indicates the detailed error message.

----End

3.3.2 Logout
When you log out of the M2000 and disconnect the M2000, you need send the LGO:OP="MMLUser"; command.

Procedure
Step 1 Use the telnet command to connect to the port 31114 of the M2000 server. Step 2 Run the following command. LGO:OP="MMLUser"; If the logout is successful, the packet displayed by the M2000 is as follows:
+++ NMS SERVER O&M #2304 %%LGO:OP="MMLUser";%% RETCODE = 0 Success Success --END 2006-03-02 11:57:11

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


+++ O&M NMS SERVER #2304 2006-03-02 11:57:11

3-8

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

M2000 Northbound MML Command Interface Developer Guide


%%LGO:OP="MMLUser";%% RETCODE = 1 Error Message Error Message --END
NOTE

3 Transparent Transmission of the Northbound MML Command

l l

If RETCODE is successful, the displayed value is 0; if RETCODE fails, an error code is displayed. Error Message indicates the detailed error message.

----End

Issue 01 (2008-03-20)

Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd

3-9

M2000 Northbound MML Command Interface Developer Guide

Index

Index
B
binding an NE, 2-4 when creating a NE, 2-6 when creating a user, 2-4 sending handshake messages, 3-6

P
parameter password, 1-5 user name, 1-5

C
creating a user, 2-2

T
telnet, 1-2, 3-2, 3-3, 3-4

E
EMS, 1-2

I
interface MML command transparent transmission interface implementation, 1-2 process, 1-2 Northbound interface, 1-2

L
login, 3-2 logout, 3-8

M
M2000, 1-2, 1-2, 1-2 MML command transparent transmission, 3-6

N
NMS, 1-2, 1-2, 1-2

O
operation deregistering an NE, 3-7 listing operable NEs, 3-3 querying an authorized MML command, 2-9 registering an NE, 3-4 sending disconnection messages when disconnecting, 3-6
Issue 01 (2008-03-20) Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd i-1

You might also like