39
M2000 V200R008C01 Northbound MML Command Interface Developer Guide Issue 01 Date 2008-03-20 Part Number 00407977 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd

M2000 Northbound MML Command Interface Developer Guide

Embed Size (px)

DESCRIPTION

M2000 Northbound MML Command Interface Developer Guide

Citation preview

Page 1: M2000 Northbound MML Command Interface Developer Guide

M2000

V200R008C01

Northbound MML Command InterfaceDeveloper Guide

Issue 01

Date 2008-03-20

Part Number 00407977

Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd

Page 2: M2000 Northbound MML Command Interface Developer Guide

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. 2008. 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

Page 3: M2000 Northbound MML Command Interface Developer Guide

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 Northbound MML Command Transparent Transmission Interface................................................................1-2

1.2.1 Implementation of the MML Command Transparent Transmission Interface......................................1-21.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-22.2 Binding an NE.................................................................................................................................................2-4

2.2.1 Binding an NE when Creating a User....................................................................................................2-42.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-13.1 Connecting the MML Command Transparent Transmission..........................................................................3-2

3.1.1 Login......................................................................................................................................................3-23.1.2 Listing Operable NEs.............................................................................................................................3-33.1.3 Registering an NE..................................................................................................................................3-4

3.2 Maintaining the MML Command Transparent Transmission.........................................................................3-53.2.1 MML Command Transparent Transmission..........................................................................................3-63.2.2 Sending Handshake Messages...............................................................................................................3-63.2.3 Sending Disconnection Messages when Disconnecting........................................................................3-6

3.3 Disconnecting the MML Command Transparent Transmission.....................................................................3-73.3.1 Deregistering an NE...............................................................................................................................3-73.3.2 Logout....................................................................................................................................................3-8

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

M2000Northbound MML Command Interface Developer Guide Contents

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

i

Page 4: M2000 Northbound MML Command Interface Developer Guide
Page 5: M2000 Northbound MML Command Interface Developer Guide

Figures

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

M2000Northbound MML Command Interface Developer Guide Figures

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

iii

Page 6: M2000 Northbound MML Command Interface Developer Guide
Page 7: M2000 Northbound MML Command Interface Developer Guide

Tables

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

M2000Northbound MML Command Interface Developer Guide Tables

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

v

Page 8: M2000 Northbound MML Command Interface Developer Guide
Page 9: M2000 Northbound MML Command Interface Developer Guide

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 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 andinterconnecting parameters of the Northbound MML command transparent transmissioninterface.

2 Interconnecting Northbound MML Command Transparent Transmission Interface

M2000Northbound MML Command Interface Developer Guide About This Document

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

1

Page 10: M2000 Northbound MML Command Interface Developer Guide

This describes the interconnecting Northbound MML command transparent transmissioninterface, which consists of creating a user, binding an NE and an MML command, and queryingan authorized MML command.

3 Transparent Transmission of the Northbound MML Command

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.

Conventions1. Symbol Conventions

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

Symbol Description

DANGERIndicates a hazard with a high level of risk that, if not avoided,will result in death or serious injury.

WARNINGIndicates a hazard with a medium or low level of risk which, ifnot avoided, could result in minor or moderate injury.

CAUTIONIndicates a potentially hazardous situation that, if not avoided,could cause equipment damage, data loss, and performancedegradation, or unexpected results.

TIP Indicates a tip that may help you solve a problem or save yourtime.

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

2. General Conventions

Convention Description

Times New Roman Normal paragraphs are in Times New Roman.

Boldface Names of files,directories,folders,and users are in boldface. Forexample,log in as user root .

Italic Book titles are in italics.

Courier New Terminal display is in Courier New.

3. Command Conventions

Convention Description

Boldface The keywords of a command line are in boldface.

About This DocumentM2000

Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 11: M2000 Northbound MML Command Interface Developer Guide

Convention Description

Italic Command arguments are in italic.

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

{x | y | ...} Alternative items are grouped in braces and separated by verticalbars.One is selected.

[ x | y | ... ] Optional alternative items are grouped in square brackets andseparated by vertical bars.One or none is selected.

{ x | y | ... } * Alternative items are grouped in braces and separated by verticalbars.A minimum of one or a maximum of all can be selected.

[ x | y | ... ] * Alternative items are grouped in braces and separated by verticalbars.A minimum of zero or a maximum of all can be selected.

4. GUI Conventions

Convention Description

Boldface Buttons,menus,parameters,tabs,window,and dialog titles are inboldface. 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 Description

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

Key1+Key2 Press the keys concurrently.For example,pressing Ctrl+Alt+Ameans the three keys should be pressed concurrently.

Key1,Key2 Press the keys in turn.For example,pressing Alt,A means the twokeys should be pressed in turn.

6. Mouse Operation

Action Description

Click Select and release the primary mouse button without moving thepointer.

Double-click Press the primary mouse button twice continuously and quicklywithout moving the pointer.

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

M2000Northbound MML Command Interface Developer Guide About This Document

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

3

Page 12: M2000 Northbound MML Command Interface Developer Guide

About This DocumentM2000

Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 13: M2000 Northbound MML Command Interface Developer Guide

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 Northbound 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.

M2000Northbound MML Command Interface Developer Guide

1 Introduction to Northbound MML Command TransparentTransmission Interface

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

1-1

Page 14: M2000 Northbound MML Command Interface Developer Guide

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,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 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.

1.2.1 Implementation of the MML Command Transparent Transmission InterfaceThis describes the process for implementation and the transparent transmission process of anNMS command.

1.2.2 Interconnection Parameters of the MML Command Transparent Transmission InterfaceWhen the Northbound MML command transparent interface is provided, the NMS needs to usea user account assigned by the M2000.

1.2.1 Implementation of the MML Command TransparentTransmission Interface

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

1 Introduction to Northbound MML Command TransparentTransmission Interface

M2000Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 15: M2000 Northbound MML Command Interface Developer Guide

ImplementationTable 1-1 describes the process for implementation.

Table 1-1 Process for implementation

Brief Description

Using the user account of the M2000,the NMS establishes Telnet connectionwith the M2000.

-

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.

M2000Northbound MML Command Interface Developer Guide

1 Introduction to Northbound MML Command TransparentTransmission Interface

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

1-3

Page 16: M2000 Northbound MML Command Interface Developer Guide

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 a user name and a password to the 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 NMS disconnects the M2000.

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

11 The MML command is transparently transmitted to the NE.

12 The result of the operation is displayed.

13 The operation result is displayed to the NMS.

1 Introduction to Northbound MML Command TransparentTransmission Interface

M2000Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 17: M2000 Northbound MML Command Interface Developer Guide

1.2.2 Interconnection Parameters of the MML CommandTransparent Transmission Interface

When the Northbound MML command transparent interface is provided, the NMS needs to usea user account assigned by the M2000.

The user account assigned by the M2000 is as follows:l User name: MMLUser

l Password: M2000nbi

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

NOTE

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

M2000Northbound MML Command Interface Developer Guide

1 Introduction to Northbound MML Command TransparentTransmission Interface

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

1-5

Page 18: M2000 Northbound MML Command Interface Developer Guide
Page 19: M2000 Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MMLCommand Transparent Transmission Interface

About This Chapter

This describes the interconnecting Northbound MML command transparent transmissioninterface, which consists of creating a user, binding an NE and an MML command, and queryingan authorized MML command.

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

2.2 Binding an NEThis describes the procedure for binding an NE, which consists of binding an NE when creatinga user and binding a new NE.

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

M2000Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MML Command TransparentTransmission Interface

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

2-1

Page 20: M2000 Northbound MML Command Interface Developer Guide

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 2-1.

Figure 2-1 Security Management

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

2 Interconnecting Northbound MML Command TransparentTransmission Interface

M2000Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 21: M2000 Northbound MML Command Interface Developer Guide

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.

M2000Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MML Command TransparentTransmission Interface

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

2-3

Page 22: M2000 Northbound MML Command Interface Developer Guide

For other information, use the default system settings.

----End

2.2 Binding an NEThis describes the procedure for binding an NE, which consists of binding an NE when creatinga user and binding a new NE.

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

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

2.2.1 Binding an NE when Creating a UserThis 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 Interconnecting Northbound MML Command TransparentTransmission Interface

M2000Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 23: M2000 Northbound MML Command Interface Developer Guide

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.

M2000Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MML Command TransparentTransmission Interface

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

2-5

Page 24: 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 belongsto 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 NEThis 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 Interconnecting Northbound MML Command TransparentTransmission Interface

M2000Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 25: M2000 Northbound MML Command Interface Developer Guide

Figure 2-8 Security Management

Step 2 Select MMLUser under the User node to view the detailed user information, as shown in Figure2-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.

M2000Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MML Command TransparentTransmission Interface

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

2-7

Page 26: 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 Interconnecting Northbound MML Command TransparentTransmission Interface

M2000Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 27: M2000 Northbound MML Command Interface Developer Guide

Example

Postrequisite

2.3 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 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.

M2000Northbound MML Command Interface Developer Guide

2 Interconnecting Northbound MML Command TransparentTransmission Interface

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

2-9

Page 28: 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 Interconnecting Northbound MML Command TransparentTransmission Interface

M2000Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 29: M2000 Northbound MML Command Interface Developer Guide

3 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.

3.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.

3.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.

3.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.

M2000Northbound MML Command Interface Developer Guide

3 Transparent Transmission of the Northbound MMLCommand

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

3-1

Page 30: M2000 Northbound MML Command Interface Developer Guide

3.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.

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

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

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

3.1.1 LoginWhen you log in to the M2000 and connect the M2000, you need send theLGI: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 defaultobjects 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:11O&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:11O&M #2304%%LGI:OP="MMLUser", PWD="M2000nbi";%%RETCODE = 1 Error MessageError Message--- END

3 Transparent Transmission of the Northbound MMLCommand

M2000Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 31: M2000 Northbound MML Command Interface Developer Guide

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.

----End

3.1.2 Listing Operable NEsThis 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 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.

M2000Northbound MML Command Interface Developer Guide

3 Transparent Transmission of the Northbound MMLCommand

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

3-3

Page 32: M2000 Northbound MML Command Interface Developer Guide

CAUTIONThe LST NE command is optional. If the NMS needs to maintain the IP of an NE, the NMS candirectly send the registration command.

----End

3.1.3 Registering an NEWhen the user selects an NE from an NE list to maintain, the NMS sends a registration commandto 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 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 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 Registering an NE Through NE NameThe format of the command is as follows:REG NE:NAME="NodeB_czh";

3 Transparent Transmission of the Northbound MMLCommand

M2000Northbound MML Command Interface Developer Guide

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

Issue 01 (2008-03-20)

Page 33: M2000 Northbound MML Command Interface Developer Guide

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:+++ NMS SERVER 2006-03-02 12:09:25O&M #2304%% REG NE: NAME ="NodeB_czh";%%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.

CAUTIONl 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.l 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, theM2000 automatically disconnects the previous NE that is maintained.

----End

3.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.

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

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

3.2.3 Sending Disconnection Messages when Disconnecting

M2000Northbound MML Command Interface Developer Guide

3 Transparent Transmission of the Northbound MMLCommand

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

3-5

Page 34: M2000 Northbound MML Command Interface Developer Guide

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

3.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.

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 If the MML command is authorized, the Success can be displayed.

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

----End

3.2.2 Sending Handshake MessagesTo ensure smooth connection, the NMS sends a handshake message to MML commandtransparent 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 2006-03-02 15:18:59 DSTO&M #0%%SHK HAND:;%%RETCODE = 0 Success

--- END

----End

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

3 Transparent Transmission of the Northbound MMLCommand

M2000Northbound MML Command Interface Developer Guide

3-6 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

Page 35: M2000 Northbound MML Command Interface Developer Guide

ProcedureThe 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

3.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.

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

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

3.3.1 Deregistering an NEWhen the NMS does not maintain an NE any longer, the NMS can send the logout command tothe 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: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:

M2000Northbound MML Command Interface Developer Guide

3 Transparent Transmission of the Northbound MMLCommand

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

3-7

Page 36: M2000 Northbound MML Command Interface Developer Guide

+++ 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 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 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:+++ NMS SERVER 2006-03-02 12:09:25O&M #2304%% UNREG NE:NAME ="NodeB_czh";%%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.

----End

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

ProcedureStep 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 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

3 Transparent Transmission of the Northbound MMLCommand

M2000Northbound MML Command Interface Developer Guide

3-8 Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd

Issue 01 (2008-03-20)

Page 37: M2000 Northbound MML Command Interface Developer Guide

%%LGO:OP="MMLUser";%%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.

----End

M2000Northbound MML Command Interface Developer Guide

3 Transparent Transmission of the Northbound MMLCommand

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

3-9

Page 38: M2000 Northbound MML Command Interface Developer Guide
Page 39: M2000 Northbound MML Command Interface Developer Guide

Index

Bbinding an NE, 2-4

when creating a NE, 2-6when creating a user, 2-4

Ccreating a user, 2-2

EEMS, 1-2

Iinterface

MML command transparent transmission interfaceimplementation, 1-2process, 1-2

Northbound interface, 1-2

Llogin, 3-2logout, 3-8

MM2000, 1-2, 1-2, 1-2MML command transparent transmission, 3-6

NNMS, 1-2, 1-2, 1-2

Ooperation

deregistering an NE, 3-7listing operable NEs, 3-3querying an authorized MML command, 2-9registering an NE, 3-4sending disconnection messages whendisconnecting, 3-6

sending handshake messages, 3-6

Pparameter

password, 1-5user name, 1-5

Ttelnet, 1-2, 3-2, 3-3, 3-4

M2000Northbound MML Command Interface Developer Guide Index

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

i-1