n2000 ums isstar(v200r013c05_02)

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

1/472

iManager N2000 UMS Element Management System

V200R013C05

iSStar

Issue 02

Date 2010-10-10

HUAWEI TECHNOLOGIES CO., LTD.

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

2/472

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

3/472

Copyright Huawei Technologies Co., Ltd. 2010. All rights reserved.

No part of this document may be reproduced or transmitted in any form or by any means without prior written

consent of Huawei Technologies Co., Ltd.

Trademarks and Permissions

and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.

All other trademarks and trade names mentioned in this document are the property of their respective holders.

Notice

The purchased products, services and features are stipulated by the contract made between Huawei and the

customer. All or part of the products, services and features described in this document may not be within the

purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information,and recommendations in this document are provided "AS IS" without warranties, guarantees or representations

of any kind, either express or implied.

The information in this document is subject to change without notice. Every effort has been made in the

preparation of this document to ensure accuracy of the contents, but all statements, information, and

recommendations in this document do not constitute the warranty of any kind, express or implied.

Huawei Technologies Co., Ltd.

Address: Huawei Industrial Base

Bantian, Longgang

Shenzhen 518129

People's Republic of China

Website: http://www.huawei.com

Email: [email protected]

Issue 02 (2010-10-10) Huawei Proprietary and Confidential

Copyright Huawei Technologies Co., Ltd.

i
http://www.huawei.com/http://www.huawei.com/

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

4/472

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

5/472

About This Document

Purpose

Being an enhanced tool component of the N2000 UMS, Integration Script Star (iSStar) is a

powerful platform for script enhancement maintenance. This describes the functions and

application scenarios of iSStar. It also describes how to develop and use scripts through iSStar.

Related Versions

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

Product Name Version

N2000 UMS V200R013C05

Intended Audience

The intended audiences of this document are:

l System engineers

l Network management engineers

Update History

02 (2010-10-10)

This is the second commercial release. The copyright declaration is updated.

01(2010-08-30)

This is the first commercial issue.


iSStar About This Document



iii

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

6/472

Organization

1 iSStar Overview

Being an enhanced tool component of the N2000 UMS, integrated Script Star (iSStar) is apowerful script secondary development platform. iSStar provides an easy-to-learn

programmable script language - High level Script Language (HSL), powerful High-level

Foundation Classes (HFC), and an integrated development environment for editing, debugging,

and executing the HSL scripts. You can create an HSL script for the repetitive and effort-

consuming daily maintenance. In this way, daily maintenance can be performed automatically

through iSStar tool. This reduces workload and improves work efficiency.

2 iSStar Management

This chapter describes iSStar file system, log information, process service information, and

rights required for iSStar operations.

3 iSStar Operation

This chapter describes the operation procedure of iSStar and how to use iSStar to develop,

manage, or use scripts.

4 HSL Language Reference

The High Level Script Language (HSL) is a simple but powerful script language provided by

the iSStar. HSL reference contains the HSL syntax, data types and methods supported by HSL.

5 HFC Library Reference

The iSStar provides various library functions, such as Type Conversion Function, Time

Function, Input and Output Function, Network Operation Function, Directory and File OperationFunction and so on. These functions are called HSL Foundation Class (HFC) functions. HFC

functions help you to compile simple scripts and facilitate debugging and maintenance.

6 iSStar Interface Description

This topic provides the reference information of the iSStar GUI.

Conventions

Symbol 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 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, which if not

avoided,could result in equipment damage, data loss,

performance degradation, or unexpected results.

About This Document


iSStar

iv Huawei Proprietary and Confidential


Issue 02 (2010-10-10)

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

7/472

Symbol Description

Indicates a tip that may help you solve a problem or save

time.

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 in

boldface. For example, log in as user root.

Italic Book titles are in italics.

Courier New Examples of information displayed on the screen are in

Courier 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 by

vertical bars. One item is selected.

[ x | y | ... ] Optional items are grouped in brackets and separated by

vertical bars. One item is selected or no item is selected.

{ x | y | ... }* Optional items are grouped in braces and separated by

vertical bars. A minimum of one item or a maximum of all

items can be selected.

[ x | y | ... ]* Optional items are grouped in brackets and separated by

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


iSStar About This Document



v

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

8/472


Boldface Buttons, menus, parameters, tabs, window, and dialog titles

are in boldface. For example, click OK.

> Multi-level menus are in boldfaceand 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 Enterand press Tab.

Key 1+Key 2 Press the keys concurrently. For example, pressing Ctrl+Alt

+Ameans the three keys should be pressed concurrently.

Key 1, Key 2 Press the keys in turn. For example, pressing Alt, Ameans

the 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 moving

the pointer.

Double-click Press the primary mouse button twice continuously and

quickly without moving the pointer.

Drag Press and hold the primary mouse button and move the

pointer to a certain position.

About This Document


iSStar

vi Huawei Proprietary and Confidential


Issue 02 (2010-10-10)

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

9/472

Contents

About This Document...................................................................................................................iii

1 iSStar Overview..........................................................................................................................1-1

1.1 Product Features of iSStar...............................................................................................................................1-3

1.2 Basic Concepts of iSStar.................................................................................................................................1-31.3 iSStar Application Scenarios...........................................................................................................................1-5

1.4 iSStar Software Structure................................................................................................................................1-7

1.5 Basic Functions of iSStar................................................................................................................................1-8

1.6 iSStar Script Sample........................................................................................................................................1-8

1.7 iSStar Technical Specifications.....................................................................................................................1-12

2 iSStar Management....................................................................................................................2-1

2.1 iSStar File System...........................................................................................................................................2-2

2.2 iSStar Log Data...............................................................................................................................................2-3

2.3 iSStar Process and Service..............................................................................................................................2-32.4 iSStar User Authority Setting..........................................................................................................................2-6

3 iSStar Operation.........................................................................................................................3-1

3.1 iSStar Operation Procedure.............................................................................................................................3-2

3.2 Developing Scripts..........................................................................................................................................3-4

3.2.1 Creating a Script File..............................................................................................................................3-4

3.2.2 Debugging a Script File..........................................................................................................................3-7

3.2.3 Creating a Script Project......................................................................................................................3-11

3.2.4 Debugging a Script Project..................................................................................................................3-13

3.2.5 Creating a Script Application...............................................................................................................3-153.3 Using Scripts.................................................................................................................................................3-17

3.3.1 Types and Status of Script Tasks.........................................................................................................3-18

3.3.2 Running a Script File............................................................................................................................3-21

3.3.3 Running a Script Project......................................................................................................................3-23

3.3.4 Running a Script Application...............................................................................................................3-24

3.3.5 Viewing the Result of a Script.............................................................................................................3-26

3.3.6 Monitoring the Process of Running a Script........................................................................................3-27

3.3.6.1 Viewing the Script Task States.........................................................................................................3-28

3.3.6.2 Viewing Output Files of a Script Task..............................................................................................3-29

3.3.6.3 Pausing and Resuming a Script Task................................................................................................3-30


iSStar Contents



vii

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

10/472

3.3.6.4 Stopping a Script Task......................................................................................................................3-30

3.3.6.5 Deleting a Script Task.......................................................................................................................3-31

3.4 Managing Scripts...........................................................................................................................................3-31

3.4.1 Viewing the Script Application Information........................................................................................3-32

3.4.2 Downloading a Script Application to the Local Terminal...................................................................3-33

3.4.3 Issuing a Script Application to the Server............................................................................................3-34

3.4.4 Deleting a Script Application...............................................................................................................3-35

3.4.5 Managing Script Application Bookmarks............................................................................................3-36

4 HSL Language Reference..........................................................................................................4-1

4.1 Introduction to the HSL Language..................................................................................................................4-2

4.2 HSL Language Syntax....................................................................................................................................4-2

4.2.1 Identifiers...............................................................................................................................................4-3

4.2.2 Keywords...............................................................................................................................................4-3

4.2.3 Statements..............................................................................................................................................4-4

4.2.4 Operators................................................................................................................................................4-5

4.2.5 String Format..........................................................................................................................................4-6

4.2.6 Comments...............................................................................................................................................4-7

4.2.7 Condition Statements.............................................................................................................................4-8

4.2.8 Loop Statements.....................................................................................................................................4-8

4.2.9 Function Definitions.............................................................................................................................4-10

4.3 Data Types and Methods in the HSL............................................................................................................4-11

4.3.1 Number.................................................................................................................................................4-12

4.3.2 Sequence...............................................................................................................................................4-134.3.3 String....................................................................................................................................................4-13

4.3.4 List........................................................................................................................................................4-19

4.3.5 Tuple.....................................................................................................................................................4-19

4.3.6 Dictionary.............................................................................................................................................4-20

4.3.7 File........................................................................................................................................................4-22

4.4 HSL Built-In Functions.................................................................................................................................4-26

4.4.1 Built-In Functions List.........................................................................................................................4-27

4.4.2 Example of the Data Operation Function.............................................................................................4-30

4.4.3 Example of the Type Conversion Function..........................................................................................4-31

4.4.4 Example of Other Functions................................................................................................................4-32

5 HFC Library Reference..............................................................................................................5-1

5.1 NE Operation Function...................................................................................................................................5-3

5.1.1 Overview of NE Operation Function.....................................................................................................5-4

5.1.2 Function: ConnectNE.............................................................................................................................5-7

5.1.3 Function: GetNELst...............................................................................................................................5-8

5.1.4 Function: GetNELstByType..................................................................................................................5-9

5.1.5 Function: GetNEName.........................................................................................................................5-10

5.1.6 Function: GetNEFDN..........................................................................................................................5-11

5.1.7 Function: GetNEIP...............................................................................................................................5-12

Contents


iSStar

viii Huawei Proprietary and Confidential


Issue 02 (2010-10-10)

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

11/472

5.1.8 Function: GetNEVer............................................................................................................................5-13

5.1.9 Function: GetNEType..........................................................................................................................5-14

5.1.10 Function: GetNETypeIDByName......................................................................................................5-15

5.1.11 Function: GetNETypeNameByID......................................................................................................5-16

5.1.12 Function: GetNEStatus.......................................................................................................................5-17

5.1.13 Function: SendMML..........................................................................................................................5-18

5.1.14 Function: GetMMLReport.................................................................................................................5-19

5.1.15 Function: GetAllMMLReport............................................................................................................5-22

5.1.16 Function: ClearMMLBuffer...............................................................................................................5-24

5.1.17 Function: SetMMLBufferSize............................................................................................................5-25

5.1.18 Example of NE Operation Function...................................................................................................5-26

5.2 CSV Parse Functions.....................................................................................................................................5-29

5.2.1 Overview of CSV Parse Functions.......................................................................................................5-29

5.2.2 Function: ReadCSVFile.......................................................................................................................5-29

5.2.3 Function: WriteCSVFile......................................................................................................................5-30

5.3 XML Parse Functions....................................................................................................................................5-31

5.3.1 Overview of XML Parse Functions.....................................................................................................5-32

5.3.2 Function: OpenXML............................................................................................................................5-33

5.3.3 Function: WriteBackXML...................................................................................................................5-34

5.3.4 Function: NewElement.........................................................................................................................5-35

5.3.5 Function: GetSubElement....................................................................................................................5-36

5.3.6 Function: GetSubElements...................................................................................................................5-37

5.3.7 Function: GetAttribute.........................................................................................................................5-385.3.8 Function: AddSubElement...................................................................................................................5-39

5.3.9 Function: SetElementContent..............................................................................................................5-40

5.3.10 Function: GetElementContent............................................................................................................5-41

5.3.11 Function: SetAttribute........................................................................................................................5-42

5.3.12 Function: RemoveAttribute................................................................................................................5-43

5.3.13 Function: RemoveSubElement...........................................................................................................5-43

5.3.14 Function: GetElementName...............................................................................................................5-44

5.3.15 Function: GetAttributes......................................................................................................................5-45

5.3.16 Example of XML Parse Function.......................................................................................................5-46

5.4 MML Message Parse Functions....................................................................................................................5-47

5.4.1 Overview of MML Message Parse Function.......................................................................................5-49

5.4.2 MML Message Format.........................................................................................................................5-52

5.4.3 Function: ParseMMLRpt......................................................................................................................5-56

5.4.4 Function: GetSourceName...................................................................................................................5-58

5.4.5 Function: GetReportDate.....................................................................................................................5-59

5.4.6 Function: GetReportTime....................................................................................................................5-60

5.4.7 Function: GetTimeAdjustFlag..............................................................................................................5-61

5.4.8 Function: GetServiceFlag.....................................................................................................................5-62

5.4.9 Function: GetReportIdx........................................................................................................................5-64


iSStar Contents



ix

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

12/472

5.4.10 Function: GetMMLCmd....................................................................................................................5-65

5.4.11 Function: GetResultCode...................................................................................................................5-66

5.4.12 Function: GetResultCause..................................................................................................................5-68

5.4.13 Function: GetObjNum........................................................................................................................5-69

5.4.14 Function: GetObjTitle........................................................................................................................5-70

5.4.15 Function: GetRecordNum..................................................................................................................5-71

5.4.16 Function: GetTips...............................................................................................................................5-72

5.4.17 Function: GetAttrValueByName........................................................................................................5-73

5.4.18 Function: GetAttrValueByIdx............................................................................................................5-75

5.4.19 Function: GetAttrNameList................................................................................................................5-76

5.4.20 Function: GetAttrNum.......................................................................................................................5-77

5.4.21 Function: GetColumnByName...........................................................................................................5-78

5.4.22 Function: GetColumnByIndex...........................................................................................................5-80

5.4.23 Function: GetRowByIndex................................................................................................................5-82

5.4.24 Function: GetDataFrmMMLRpt........................................................................................................5-83

5.4.25 Function: GetUTCTimeOffSet...........................................................................................................5-86

5.4.26 Function: DestroyMMLParser...........................................................................................................5-87

5.4.27 Examples of MML Message Parse Functions....................................................................................5-88

5.5 Alarm Message Parsing Function.................................................................................................................5-90

5.5.1 Overview of Alarm Message Parsing Function...................................................................................5-93

5.5.2 Alarm Message Format........................................................................................................................5-97

5.5.3 Function: ParseAlmRpt......................................................................................................................5-100

5.5.4 Function: GetAlmSource....................................................................................................................5-1025.5.5 Function: GetAlmRptDate.................................................................................................................5-103

5.5.6 Function: GetAlmRptTime................................................................................................................5-104

5.5.7 Function: GetAlmRptNum.................................................................................................................5-106

5.5.8 Function: GetAlmServiceTag............................................................................................................5-107

5.5.9 Function: GetAlmTimeAdjustFlag....................................................................................................5-108

5.5.10 Function: GetAlmServiceFlag..........................................................................................................5-109

5.5.11 Function: GetAlmRptIdx..................................................................................................................5-110

5.5.12 Function: GetAlmMMLCmd...........................................................................................................5-111

5.5.13 Function: GetAlmResultCode..........................................................................................................5-113

5.5.14 Function: GetAlmResultCause.........................................................................................................5-114

5.5.15 Function: GetAlmTips......................................................................................................................5-115

5.5.16 Function: GetAlmFlowNumber.......................................................................................................5-116

5.5.17 Function: GetAlmType....................................................................................................................5-117

5.5.18 Function: GetAlmLevel....................................................................................................................5-118

5.5.19 Function: GetAlmNEType...............................................................................................................5-120

5.5.20 Function: GetAlmID........................................................................................................................5-121

5.5.21 Function: GetAlmSort......................................................................................................................5-123

5.5.22 Function: GetAlmSyncSerialNo......................................................................................................5-124

5.5.23 Function: GetAlmName...................................................................................................................5-125

Contents


iSStar

x Huawei Proprietary and Confidential


Issue 02 (2010-10-10)

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

13/472

5.5.24 Function: GetAlmRaiseTime...........................................................................................................5-127

5.5.25 Function: GetAlmLocationInfo........................................................................................................5-128

5.5.26 Function: GetAlmAttrValueByName..............................................................................................5-130

5.5.27 Function: GetAlmAttrValueByIdx...................................................................................................5-131

5.5.28 Function: GetAlmNumByLevel.......................................................................................................5-133

5.5.29 Function: GetAlmNumByTimeDur.................................................................................................5-134

5.5.30 Function: GetAlmRptUTCTimeOffSet............................................................................................5-136

5.5.31 Examples of Alarm Message Parsing Function...............................................................................5-137

5.6 Database Operation Function......................................................................................................................5-139

5.6.1 Overview of Database Operation Functions......................................................................................5-141

5.6.2 Function: OpenDB.............................................................................................................................5-144

5.6.3 Function: CreateCond........................................................................................................................5-145

5.6.4 Function: QueryFmRcds....................................................................................................................5-146

5.6.5 Function: NextFmRcds......................................................................................................................5-153

5.6.6 Function: QueryPmRcds....................................................................................................................5-159

5.6.7 Function: NextPmRcds......................................................................................................................5-163

5.6.8 Function: QueryCmRcds....................................................................................................................5-165

5.6.9 Function: NextCmRcds......................................................................................................................5-165

5.6.10 Function: GetCmCom......................................................................................................................5-166

5.6.11 Function: GetChildMoc....................................................................................................................5-168

5.6.12 Function: GetIntegrityReportCond..................................................................................................5-169

5.6.13 Function: GetFunctionSubSetList....................................................................................................5-170

5.6.14 Function: QueryIntegrityResult........................................................................................................5-1715.6.15 Function: GetOneNEInteLst............................................................................................................5-172

5.6.16 Function: GetOneFssInte..................................................................................................................5-173

5.6.17 Function: GetOneIntegrity...............................................................................................................5-174

5.6.18 Function: GetPmCond......................................................................................................................5-175

5.6.19 Function: GetFmCond......................................................................................................................5-178

5.6.20 Function: QueryRecord....................................................................................................................5-183

5.6.21 Function: RecordCount....................................................................................................................5-184

5.6.22 Function: NextRecord......................................................................................................................5-185

5.6.23 Function: GetMocAttrNameList......................................................................................................5-189

5.6.24 Function: GetMocList......................................................................................................................5-190

5.6.25 Function: GetNeObjInfo..................................................................................................................5-191

5.6.26 Function: GetCounterInfo................................................................................................................5-192

5.6.27 Function: GetFuncSetList................................................................................................................5-193

5.6.28 Function: GetFuncSubSetList..........................................................................................................5-194

5.6.29 Function: GetMoiAttrValueList.......................................................................................................5-195

5.6.30 Function: GetMoiListByFilter..........................................................................................................5-196

5.6.31 Function: GetPmNeType..................................................................................................................5-198

5.6.32 Function: GetNeInfo........................................................................................................................5-199

5.6.33 Function: CloseDB...........................................................................................................................5-200


iSStar Contents



xi

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

14/472

5.7 Alarm Operation Function..........................................................................................................................5-201

5.7.1 Overview of Alarm Operation Function............................................................................................5-201

5.7.2 Function: SendAlarm.........................................................................................................................5-201

5.8 OM Operation Function..............................................................................................................................5-202

5.8.1 Overview of OM Operation Function................................................................................................5-203

5.8.2 Function: GetOMCVersion................................................................................................................5-204

5.8.3 Function: LOG_OP............................................................................................................................5-204

5.8.4 Function: GetAllSubareaInformation.................................................................................................5-205

5.8.5 Function: GetFdnListByHostname....................................................................................................5-206

5.8.6 Function: GetHostNameByNeFdn.....................................................................................................5-207

5.9 Type Conversion Functions........................................................................................................................5-208

5.9.1 Overview of the Type Conversion Functions....................................................................................5-208

5.9.2 Function: String2Int...........................................................................................................................5-209

5.9.3 Function: String2Float........................................................................................................................5-210

5.9.4 Function: String2Long.......................................................................................................................5-211

5.9.5 Function: Sequence2Tuple.................................................................................................................5-211

5.9.6 Function: Sequence2List....................................................................................................................5-212

5.9.7 Function: ToString.............................................................................................................................5-213

5.10 Time Functions..........................................................................................................................................5-214

5.10.1 Overview of the Time Functions......................................................................................................5-215

5.10.2 Time Format.....................................................................................................................................5-216

5.10.3 Time Tuple.......................................................................................................................................5-217

5.10.4 Function: GMTime...........................................................................................................................5-2185.10.5 Function: LocalTime........................................................................................................................5-218

5.10.6 Function: MkTime............................................................................................................................5-219

5.10.7 Function: Sleep.................................................................................................................................5-220

5.10.8 Function: StrfTime...........................................................................................................................5-221

5.10.9 Function: StrpTime..........................................................................................................................5-222

5.10.10 Function: Time...............................................................................................................................5-223

5.10.11 Function: CTime............................................................................................................................5-224

5.10.12 Function: AscTime.........................................................................................................................5-224

5.11 Input and Output Functions.......................................................................................................................5-225

5.11.1 Overview of Input and Output Functions.........................................................................................5-226

5.11.2 Function: UserInput..........................................................................................................................5-227

5.11.3 Function: UserOutput.......................................................................................................................5-228

5.11.4 Function: SetOutMode.....................................................................................................................5-229

5.11.5 Function: SetOutFlag.......................................................................................................................5-229

5.11.6 Function: SetOutFileName...............................................................................................................5-231

5.11.7 Function: Print..................................................................................................................................5-231

5.11.8 Function: GetOutputPath..................................................................................................................5-232

5.11.9 Function: NotifyProgress.................................................................................................................5-233

5.12 GetError Function.....................................................................................................................................5-234

Contents


iSStar

xii Huawei Proprietary and Confidential


Issue 02 (2010-10-10)

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

15/472

5.12.1 Overview of GetError Function.......................................................................................................5-234

5.12.2 Function: GetLastError....................................................................................................................5-235

5.12.3 Function: GetErrorMsg....................................................................................................................5-235

5.13 Network Operation Function.....................................................................................................................5-237

5.13.1 Overview of Network Operation Function.......................................................................................5-238

5.13.2 Function: SetPassive........................................................................................................................5-239

5.13.3 Function: LoginFTP.........................................................................................................................5-240

5.13.4 Function: Upload..............................................................................................................................5-240

5.13.5 Function: Download.........................................................................................................................5-241

5.13.6 Function: GetFTPStatus...................................................................................................................5-242

5.13.7 Function: LogoutFTP.......................................................................................................................5-243

5.13.8 Function: OpenTelnet.......................................................................................................................5-243

5.13.9 Function: ExecuteCmd.....................................................................................................................5-245

5.13.10 Function: IsConnected....................................................................................................................5-247

5.13.11 Function: CloseTelnet....................................................................................................................5-248

5.13.12 Examples of Network Operation Function.....................................................................................5-250

5.14 Report Operation Function........................................................................................................................5-252

5.14.1 Overview of Report Operation Function..........................................................................................5-253

5.14.2 Report Management Function..........................................................................................................5-254

5.14.2.1 Function: LoadReport...................................................................................................................5-255

5.14.2.2 Function: NewReport....................................................................................................................5-255

5.14.2.3 Function: SaveReportAs...............................................................................................................5-256

5.14.2.4 Function: StoreReport...................................................................................................................5-2575.14.3 Report Design Function...................................................................................................................5-258

5.14.3.1 Function: AddRange.....................................................................................................................5-259

5.14.3.2 Function: AddSheet.......................................................................................................................5-261

5.14.3.3 Function: AddTable.......................................................................................................................5-262

5.14.3.4 Function: GetRowCount...............................................................................................................5-263

5.14.3.5 Function: GetRowData..................................................................................................................5-264

5.14.3.6 Function: InsertRow......................................................................................................................5-265

5.14.3.7 Function: RemoveRow..................................................................................................................5-266

5.14.3.8 Function: Selector.........................................................................................................................5-267

5.14.3.9 Function: SetCellValue.................................................................................................................5-269

5.14.3.10 Function: SetRangeValue............................................................................................................5-270

5.14.3.11 Function: SetTableValueEx........................................................................................................5-271

5.14.3.12 Function: SetTableValue.............................................................................................................5-273

5.14.3.13 Function: UpdateRow.................................................................................................................5-274

5.14.4 Report Display Function..................................................................................................................5-275

5.14.4.1 Function: ReportStyle...................................................................................................................5-276

5.14.4.2 Function: SetCellAlign..................................................................................................................5-277

5.14.4.3 Function: SetCellBGColor............................................................................................................5-279

5.14.4.4 Function: SetCellFont...................................................................................................................5-280


iSStar Contents



xiii

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

16/472

5.14.4.5 Function: SetColumnWidth...........................................................................................................5-281

5.14.4.6 Function: SetRangeAlign..............................................................................................................5-282

5.14.4.7 Function: SetRangeBGColor.........................................................................................................5-283

5.14.4.8 Function: SetRangeFont................................................................................................................5-284

5.14.4.9 Function: SetTableBGColor..........................................................................................................5-285

5.14.4.10 Function: SetTableFont...............................................................................................................5-286

5.14.4.11 Function: SetTableTitleFont.......................................................................................................5-287

5.14.5 Parameters for Operating Report......................................................................................................5-289

5.14.5.1 Parameter: Color...........................................................................................................................5-289

5.14.5.2 Parameter: FontType.....................................................................................................................5-291

5.14.5.3 Parameter: Type............................................................................................................................5-292

5.14.6 Examples of Report Operation Function..........................................................................................5-292

5.15 Directory and File Operation Function.....................................................................................................5-295

5.15.1 Overview of Directory and File Operation Function.......................................................................5-296

5.15.2 Function: Open.................................................................................................................................5-296

5.15.3 Function: read...................................................................................................................................5-298

5.15.4 Function: write.................................................................................................................................5-299

5.15.5 Function: close.................................................................................................................................5-299

5.15.6 Function: FindFiles..........................................................................................................................5-300

5.15.7 Function: MkDir...............................................................................................................................5-301

5.15.8 Function: RmDir..............................................................................................................................5-302

5.15.9 Function: GetCwd............................................................................................................................5-302

5.15.10 Function: Remove..........................................................................................................................5-3035.15.11 Function: Rename..........................................................................................................................5-304

5.15.12 Function: ListDir............................................................................................................................5-304

5.15.13 Function: MakeDirs........................................................................................................................5-305

5.15.14 Function: RemoveDirs...................................................................................................................5-306

5.15.15 Examples of Directory Operation Function...................................................................................5-306

5.16 GUI Interactive Library Function.............................................................................................................5-307

5.16.1 Overview of GUI Interactive Library Function...............................................................................5-308

5.16.2 Introduction to GUI Interactive Library Controls............................................................................5-309

5.16.3 Function: CreateForm......................................................................................................................5-312

5.16.4 Function: Label................................................................................................................................5-313

5.16.5 Function: Edit...................................................................................................................................5-314

5.16.6 Function: CheckBox.........................................................................................................................5-315

5.16.7 Function: RadioBoxGroup...............................................................................................................5-316

5.16.8 Function: Enter.................................................................................................................................5-317

5.16.9 Function: Space................................................................................................................................5-318

5.16.10 Function: ShowForm......................................................................................................................5-319

5.16.11 Function: GetValue........................................................................................................................5-320

5.16.12 Function: DeleteForm....................................................................................................................5-321

5.16.13 Function: TextArea........................................................................................................................5-322

Contents


iSStar

xiv Huawei Proprietary and Confidential


Issue 02 (2010-10-10)

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

17/472

5.16.14 Examples of GUI Interactive Library Function.............................................................................5-323

5.17 Task Management Function......................................................................................................................5-324

5.17.1 Overview of Task Management Function........................................................................................5-324

5.17.2 Function: CreateTask.......................................................................................................................5-325

5.17.3 Function: Wait..................................................................................................................................5-326

5.17.4 Function: GetRegisterKey................................................................................................................5-326

5.17.5 Function: Exit...................................................................................................................................5-327

5.18 Assertion Function....................................................................................................................................5-328

5.18.1 Overview of Assertion Function......................................................................................................5-328

5.18.2 Function: Assert...............................................................................................................................5-329

5.18.3 Function: Assert_ON........................................................................................................................5-329

5.18.4 Function: Assert_OFF......................................................................................................................5-330

5.19 Function: ModifyProjParam......................................................................................................................5-330

5.20 Mail Sending Function..............................................................................................................................5-331

5.20.1 Overview of Mail Sending Functions..............................................................................................5-331

5.20.2 Function: CreateLoginInfo...............................................................................................................5-332

5.20.3 Function: CreateMailInfo.................................................................................................................5-334

5.20.4 Function: SendMail..........................................................................................................................5-335

5.21 Function: SendSMSMessage.....................................................................................................................5-337

6 iSStar Interface Description.....................................................................................................6-1

6.1 Interface Description: iSStar Main Window...................................................................................................6-3

6.2 Interface Description: Application Management Window.............................................................................6-6

6.3 Interface Description: Script Running Window..............................................................................................6-8

6.4 Interface Description: Script Debugging Window........................................................................................6-10

6.5 Interface Description: Task Management Window.......................................................................................6-13

6.6 Parameter Description: Project Attribute......................................................................................................6-15

6.7 Parameter Description: Configuring Virtual NEs.........................................................................................6-17

6.8 Parameter Description: Script Pack Setting..................................................................................................6-19

6.9 Parameter Description: Script Timing Task of the iSStar.............................................................................6-21


iSStar Contents



xv

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

18/472

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

19/472

Figures

Figure 1-1iSStar system deployment..................................................................................................................1-7

Figure 3-1Progress for developing scripts...........................................................................................................3-2

Figure 3-2Script Application Operation Flow Chart...........................................................................................3-3

Figure 3-3State transition of a running task......................................................................................................3-18

Figure 3-4State transition of a debugging task..................................................................................................3-19

Figure 3-5State transition of a scheduled task...................................................................................................3-20

Figure 5-1Procedure for using NE operation functions......................................................................................5-6

Figure 5-2Workflow of MML message parse functions...................................................................................5-52

Figure 5-3MML message format 1...................................................................................................................5-53

Figure 5-4MML message format 2...................................................................................................................5-53

Figure 5-5Elements in the report.......................................................................................................................5-90

Figure 5-6Workflow of alarm message parsing functions................................................................................5-96

Figure 5-7Alarm Message Format....................................................................................................................5-97

Figure 5-8Procedure for using database operation functions..........................................................................5-144Figure 5-9Procedure for modifying a report...................................................................................................5-257

Figure 5-10Optional colors.............................................................................................................................5-289

Figure 6-1iSStar Main Window........................................................................................................................6-3

Figure 6-2Application Managementwindow...................................................................................................6-6

Figure 6-3iSStar Execute Window....................................................................................................................6-8

Figure 6-4iSStar Execute Window....................................................................................................................6-9

Figure 6-5iSStar Debug Window....................................................................................................................6-11

Figure 6-6iSStar Debug Window....................................................................................................................6-11

Figure 6-7iSStar Task Manage Window........................................................................................................6-14


iSStar Figures



xvii

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

20/472

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

21/472

Tables

Table 1-1Basic concepts involved in iSStar........................................................................................................1-3

Table 1-2List of self-defined functions of CPU load query script....................................................................1-11

Table 1-3iSStar running environment specifications........................................................................................ 1-13

Table 1-4Performance specifications of iSStar.................................................................................................1-13

Table 2-1Directory structure of iSStar................................................................................................................2-2

Table 2-2iSStar User Right List..........................................................................................................................2-6

Table 3-1State transition of a running task........................................................................................................3-19

Table 3-2State transition of a debugging task...................................................................................................3-19

Table 3-3States of a scheduled task...................................................................................................................3-20

Table 4-1Keywords.............................................................................................................................................4-4

Table 4-2MML statements..................................................................................................................................4-5

Table 4-3Basic operators.....................................................................................................................................4-5

Table 4-4String format........................................................................................................................................4-7

Table 4-5Formats for writing a comment............................................................................................................4-7Table 4-6Classification......................................................................................................................................4-12

Table 4-7Numeric operations............................................................................................................................4-12

Table 4-8String object methods.........................................................................................................................4-13

Table 4-9Special Character............................................................................................................................... 4-17

Table 4-10Rule of escape characters.................................................................................................................4-18

Table 4-11List object methods..........................................................................................................................4-19

Table 4-12Operations on dictionary objects......................................................................................................4-20

Table 4-13Methods about dictionary objects.................................................................................................... 4-21

Table 4-14Open function description................................................................................................................4-23

Table 4-15File object methods..........................................................................................................................4-23

Table 5-1List of NE operation functions.............................................................................................................5-4

Table 5-2List of the CSV parse functions.........................................................................................................5-29

Table 5-3List of the XML parse functions........................................................................................................5-32

Table 5-4MML message parse functions.......................................................................................................... 5-49

Table 5-5Description of MML message format................................................................................................5-54

Table 5-6Alarm message parsing function list..................................................................................................5-93

Table 5-7Description of the Alarm Message Format........................................................................................5-98

Table 5-8Database operation function list.......................................................................................................5-141

Table 5-9Description of items inFmcond.......................................................................................................5-148


iSStar Tables



xix

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

22/472

Table 5-10Attributes of alarm data records.....................................................................................................5-153

Table 5-11Description of items ofPmcond.....................................................................................................5-160

Table 5-12Description of conditions for querying performance data.............................................................5-176

Table 5-13Description of conditions for querying alarm data.........................................................................5-178

Table 5-14Items in the list of alarm records....................................................................................................5-186

Table 5-15Items in the list of alarm records....................................................................................................5-187

Table 5-16Alarm function list.........................................................................................................................5-201

Table 5-17OM function list.............................................................................................................................5-203

Table 5-18List of type conversion functions...................................................................................................5-208

Table 5-19List of time functions.....................................................................................................................5-215

Table 5-20List of input and output functions..................................................................................................5-226

Table 5-21List of GetError functions..............................................................................................................5-235

Table 5-22Description of error information....................................................................................................5-236

Table 5-23Description of error level ..............................................................................................................5-236

Table 5-24List of Network operation functions..............................................................................................5-238

Table 5-25Report operation function list.........................................................................................................5-253

Table 5-26Example of Using Conditional Expressions..................................................................................5-268

Table 5-27Meanings of optional colors...........................................................................................................5-289

Table 5-28Description of optional font values................................................................................................5-291

Table 5-29Type Description............................................................................................................................5-292

Table 5-30List of directory operation functions..............................................................................................5-296

Table 5-31List of GUI interactive library functions........................................................................................5-308

Table 5-32GUI interactive library controls.....................................................................................................5-309Table 5-33Layout of the controls....................................................................................................................5-310

Table 5-34Return values..................................................................................................................................5-320

Table 5-35List of task management functions................................................................................................5-324

Table 5-36List of assertion functions..............................................................................................................5-328

Table 5-37List of mail sending functions........................................................................................................5-331

Table 6-1Description of iSStar Main Window..................................................................................................6-3

Table 6-2Description of the Application Managementwindow.......................................................................6-7

Table 6-3Description of iSStar Execute Window.............................................................................................6-9

Table 6-4Description of iSStar Debug Window..............................................................................................6-12

Table 6-5Output area.........................................................................................................................................6-12

Table 6-6Description of iSStar Task Manage Window.................................................................................6-14

Table 6-7Shortcut buttons.................................................................................................................................6-15

Table 6-8Basic Parameters................................................................................................................................6-16

Table 6-9Preset parameters...............................................................................................................................6-17

Table 6-10Basic Parameters..............................................................................................................................6-19

Table 6-11Preset parameters.............................................................................................................................6-20

Tables


iSStar

xx Huawei Proprietary and Confidential


Issue 02 (2010-10-10)

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

23/472

1iSStar OverviewAbout This Chapter

Being an enhanced tool component of the N2000 UMS, integrated Script Star (iSStar) is a

powerful script secondary development platform. iSStar provides an easy-to-learn

programmable script language - High level Script Language (HSL), powerful High-level

Foundation Classes (HFC), and an integrated development environment for editing, debugging,

and executing the HSL scripts. You can create an HSL script for the repetitive and effort-

consuming daily maintenance. In this way, daily maintenance can be performed automatically

through iSStar tool. This reduces workload and improves work efficiency.

1.1 Product Features of iSStar

iSStar has all the features that a secondary development platform should have. After you

understand these features, you will have a basic working knowledge of iSStar.

1.2 Basic Concepts of iSStar

iSStar has unique concepts to help you better understand iSStar. The basic concepts of iSStar

involve script, script development platform, script application platform, user, and script project.

1.3 iSStar Application Scenarios

iSStar is a secondary development platform for users to extend the operation and maintenance

of the service functions. Users can perform secondary development in iSStar secondary platform

as required. This secondary platform is used where there is need for bulk operations or routine

and automatic executions. iSStar is complementary to the N2000 UMS system.

1.4 iSStar Software Structure

iSStar is a subsystem of the N2000 UMS. It compliments the architecture design of the N2000

UMS, and is classified into client system and server system. With regards to function modules,

iSStar software system is composed of GUI subsystem, executor (descriptor) subsystem, HFC

subsystem, ScriptServer subsystem, and service subsystem.

1.5 Basic Functions of iSStar

iSStar provides the HSL, an integrated development environment for editing, debugging, and

running HSL scripts, and functions of managing script applications and script tasks.

1.6 iSStar Script Sample

This section describes an example of querying the CPU load. This sample is provided by iSStar.

By studying this sample, you gain a preliminary understanding of the structure and frameworkof script files and their applications in the business.


iSStar 1 iSStar Overview



1-1

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

24/472

1.7 iSStar Technical Specifications

The iSStar technical specifications are operational environment specifications and performance

specifications. The running environment specifications include hardware configuration and

software configuration. The performance specifications include number of local tasks

simultaneously started, number of timed tasks simultaneously started, and size of the script files.

These technical specifications must be met when you use iSStar.

1 iSStar Overview


iSStar

1-2 Huawei Proprietary and Confidential


Issue 02 (2010-10-10)

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

25/472

1.1 Product Features of iSStar

iSStar has all the features that a secondary development platform should have. After you

understand these features, you will have a basic working knowledge of iSStar.

As a powerful secondary development platform, iSStar has the following features:

l iSStar provides powerful script program development capability and can flexibly customize

personalized service.

iSStar provides an easy-to-learn programmable script language - HSL. The HSL can be

used to write multiple kinds of programs because its syntax is based on Python. In addition,

the HSL has its own data types and functions and has good control over the MML scripts

through compiling. Thus iSStar can help you customize personalized services as required

for fast service deployment.

l

iSStar provides abundant extendable service functions.iSStar provides abundant extendable HSL Foundation Class (HFC). The HFC encapsulates

many complex and similar service implementations into functions. To compile a script

program in iSStar, you only have to invoke these functions. You can flexibly extend HFC

as required.

l iSStar provides a comprehensive program debugging mechanism.

You can set breakpoints and one-step debugging for the script programs. You can debug

the program to check whether it operates properly and can quickly locate problems with

the program.

l You can compile MML scripts in batches through iSStar.

By compiling the MML script program, you can conveniently deliver batch MMLcommands and can perform batch operations on multiple NEs.

l Script tasks can be automatically executed.

The script programs support manual immediate execution and timing automatic execution.

Tasks that need to be executed in certain time point or periodically executed can be set as

timing tasks. The script automatically executes these tasks.

l iSStar provides an user-friendly interface.

You can follow the wizard to edit, compile, and execute scripts. The result of the script

execution is displayed in the monitoring window in real time.

1.2 Basic Concepts of iSStariSStar has unique concepts to help you better understand iSStar. The basic concepts of iSStar

involve script, script development platform, script application platform, user, and script project.

Table 1-1describes the basic concepts involved in iSStar.

Table 1-1Basic concepts involved in iSStar

BasicConcepts

Description

Script Programs written in the HSL are used to provide specific service functions.


iSStar 1 iSStar Overview



1-3

8/13/2019 N2000 UMS iSStar(V200R013C05_02)

26/472

BasicConcepts

Description

Script file Indicates the text file written by users in the HSL, saved with .hsl as the

extension name. The script is used to implement a specific service function.

Script

development

platform

Indicates the platform for developing service function scripts. The

development platform provides the functions of managing projects and

editing, debugging, and running scripts.

Script

application

platform

Indicates the platform for applying service function scripts. This platform

provides the functi

n2000 ums isstar(v200r013c05_02)

Documents