Om Oc221 E01 1 Ran Ems MML Command Reference 207 PDF

NetNumen U31 R18
Unified Element Management System

MML Command Reference
Version: 12.10.040
ZTE CORPORATION
NO. 55, Hi-tech Road South, ShenZhen, P.R.China
Postcode: 518057
Tel: +86-755-26771900
Fax: +86-755-26770801
URL: http://ensupport.zte.com.cn
E-mail: support@zte.com.cn
LEGAL INFORMATION
Copyright 2011 ZTE CORPORATION.
The contents of this document are protected by copyright laws and international treaties. Any reproduction or
distribution of this document or any portion of this document, in any form by any means, without the prior written
consent of ZTE CORPORATION is prohibited. Additionally, the contents of this document are protected by
contractual confidentiality obligations.
All company, brand and product names are trade or service marks, or registered trade or service marks, of ZTE
CORPORATION or of their respective owners.
This document is provided as is, and all express, implied, or statutory warranties, representations or conditions
are disclaimed, including without limitation any implied warranty of merchantability, fitness for a particular purpose,
title or non-infringement. ZTE CORPORATION and its licensors shall not be liable for damages resulting from the
use of or reliance on the information contained herein.
ZTE CORPORATION or its licensors may have current or pending intellectual property rights or applications
covering the subject matter of this document. Except as expressly provided in any written license between ZTE
CORPORATION and its licensee, the user of this document shall not acquire any license to the subject matter
herein.
ZTE CORPORATION reserves the right to upgrade or make technical change to this product without further notice.
Users may visit ZTE technical support website http://ensupport.zte.com.cn to inquire related information.
The ultimate right to interpret this product resides in ZTE CORPORATION.
Revision History
Revision No. Revision Date Revision Reason
R1.2 2011-1208 The following sections are modified: 1.2 Paramter Data Types,
2.2 ADD INDEX, 2.3 ADD MEASTASK, 2.4 ADD PERIODIC
TASK, 2.5 ADD QOSTASK, 2.6 ADD TIMING TASK, 4.1
CHECK NMDBUSER, 4.2 CHECK NMFTPUSER, 5.6 DEL
TASK, 6.5 EXPORTCMDLOG, 8.1 HELP, 9.1 QUERY
BYCOMMONTEMPLATE, 9.3 QUERY PMDATA, 10.2
RUNBATCH, 11.7 SET MEASTASK, 11.12 SET PERIODIC
TASK, 11.13 SET QOSTASK, 11.15 SET TIMING TASK,
11.16 SET USER, and 11.24 SHOW ALL TASK.
R1.1 2011-1026 Appendix A, Error Messages is added.
R1.0 2011-0830 First Edition
Serial Number: SJ-20110823134613-004
Publishing Date: 2011-12-08(R1.2)

Contents
About This Manual ......................................................................................... I
Chapter 1 Overview .................................................................................... 1-1
1.1 MML Command Composition .............................................................................. 1-1
1.2 Parameter Data Types........................................................................................ 1-2
Chapter 2 A ................................................................................................. 2-1

2.1 ADD DEPARTMENT .......................................................................................... 2-1
2.2 ADD INDEX ....................................................................................................... 2-2
2.3 ADD MEASTASK ............................................................................................... 2-7
2.4 ADD PERIODIC TASK...................................................................................... 2-10
2.5 ADD QOSTASK ............................................................................................... 2-12
2.6 ADD TIMING TASK .......................................................................................... 2-18
2.7 ADD USER ...................................................................................................... 2-22
2.8 ALARM CLEAR................................................................................................ 2-24
2.9 ALARM RAISE................................................................................................. 2-25
2.10 ALARM SYNC................................................................................................ 2-30
Chapter 3 B ................................................................................................. 3-1

3.1 BACKUP AND DELETE ALARM DATA................................................................ 3-1
3.2 BACKUP AND DELETE LOG DATA .................................................................... 3-1
3.3 BACKUP BASICDB ............................................................................................ 3-2
3.4 BACKUP FILE ................................................................................................... 3-3
3.5 BACKUP WHOLE DB STRUCTURE ................................................................... 3-3
Chapter 4 C ................................................................................................. 4-1

4.1 CHECK NMDBUSER ......................................................................................... 4-1
4.2 CHECK NMFTPUSER........................................................................................ 4-2
Chapter 5 D ................................................................................................. 5-1

5.1 DEL DEPARTMENT ........................................................................................... 5-1
5.2 DEL INDEX........................................................................................................ 5-2
5.3 DEL MEASTASK................................................................................................ 5-3
5.4 DEL QOSTASK .................................................................................................. 5-4
5.5 DEL SESSION ................................................................................................... 5-5
5.6 DEL TASK ......................................................................................................... 5-5
5.7 DEL USER ........................................................................................................ 5-6
I
Chapter 6 E.................................................................................................. 6-1
6.1 EXEC DIRECTORY MONITOR ........................................................................... 6-1
6.2 EXPORT COMMAND LOG ................................................................................. 6-2
6.3 EXPORT SECURITY LOG.................................................................................. 6-4
6.4 EXPORT SYSTEM LOG ..................................................................................... 6-6
6.5 EXPORTCMDLOG ............................................................................................. 6-9
Chapter 7 G ................................................................................................. 7-1

7.1 GETCBCREPORTS ........................................................................................... 7-1
7.2 GET COUNTER ................................................................................................. 7-2
7.3 GET INDEXLIST ................................................................................................ 7-4
7.4 GET LTEFDDNAFCMFILE.................................................................................. 7-7
7.5 GET MEASOBJ ................................................................................................. 7-8
7.6 GET MEASOBJTYPE......................................................................................... 7-9
7.7 GET MEASTASKLIST .......................................................................................7-11
7.8 GET MEASTYPE ............................................................................................. 7-13
7.9 GET NAFCMFILE ............................................................................................ 7-14
7.10 GETNAFOPTIMIZE ........................................................................................ 7-14
7.11 GETNAFOPTIMIZEV4 .................................................................................... 7-15
7.12 GET NAFPMFILEINTEGRALITY ..................................................................... 7-16
7.13 GET NELOC .................................................................................................. 7-17
7.14 GET QOSTASKLIST....................................................................................... 7-18
7.15 GET TYPELIST.............................................................................................. 7-20
Chapter 8 H ................................................................................................. 8-1

8.1 HELP ................................................................................................................ 8-1
Chapter 9 Q ................................................................................................. 9-1

9.1 QUERY BYCOMMONTEMPLATE ....................................................................... 9-1
9.2 QUERY BYTASK ............................................................................................... 9-3
9.3 QUERY PMDATA ............................................................................................... 9-5
Chapter 10 R ............................................................................................. 10-1

10.1 RUNBATCH ................................................................................................... 10-1
10.2 RETRIEVE NAFPMDATA................................................................................ 10-7
Chapter 11 S.............................................................................................. 11-1

11.1 SET ................................................................................................................11-2
11.2 SET AMO........................................................................................................11-5
11.3 SET CURRENT USER INFORMATION.............................................................11-5
11.4 SET DANEROURSCMD MODE .......................................................................11-7
II
11.5 SET DEPARTMENT ........................................................................................11-8
11.6 SET INDEX .....................................................................................................11-9
11.7 SET MEASTASK ........................................................................................... 11-13
11.8 SET MEASTASKSTATUS............................................................................... 11-15
11.9 SET NMDBUSER .......................................................................................... 11-16
11.10 SET NMFTPUSER....................................................................................... 11-17
11.11 SET PASSWORD ........................................................................................ 11-18
11.12 SET PERIODIC TASK.................................................................................. 11-19
11.13 SET QOSTASK ........................................................................................... 11-21
11.14 SET QOSTASKSTATUS............................................................................... 11-26
11.15 SET TIMING TASK ...................................................................................... 11-27
11.16 SET USER .................................................................................................. 11-31
11.17 SET USER RIGHT....................................................................................... 11-33
11.18 SET USER STATE....................................................................................... 11-34
11.19 SET USER VIEW LOG RANGE.................................................................... 11-35
11.20 SHOW ALARM DETAIL................................................................................ 11-36
11.21 SHOW ALL ROLES ..................................................................................... 11-37
11.22 SHOW ALL ROLE SETS.............................................................................. 11-38
11.23 SHOW ALL SESSIONS ............................................................................... 11-39
11.24 SHOW ALL TASK ........................................................................................ 11-40
11.25 SHOW ALL USERS ..................................................................................... 11-42
11.26 SHOW AMO................................................................................................ 11-43
11.27 SHOW COMMAND LOG.............................................................................. 11-43
11.28 SHOW CPU RATIO ..................................................................................... 11-47
11.29 SHOW CURRENT ALARM........................................................................... 11-47
11.30 SHOW DB RATIO ........................................................................................ 11-51
11.31 SHOW DEPARTMENT................................................................................. 11-52
11.32 SHOW DIRECTORY MONITOR TASK NAME ............................................... 11-53
11.33 SHOW HD USAGE ...................................................................................... 11-54
11.34 SHOW HISTORY ALARM ............................................................................ 11-55
11.35 SHOW INDEX ............................................................................................. 11-60
11.36 SHOW MEASTASK ..................................................................................... 11-60
11.37 SHOW NETWORK DATA ............................................................................. 11-63
11.38 SHOW NETWORK PORT ............................................................................ 11-64
11.39 SHOW NMDBUSER .................................................................................... 11-65
11.40 SHOW NMFTPUSER................................................................................... 11-65
11.41 SHOW QOSTASK ....................................................................................... 11-66
III
11.42 SHOW RAM USAGE ................................................................................... 11-70
11.43 SHOW ROLE .............................................................................................. 11-70
11.44 SHOW ROLE SET ....................................................................................... 11-71
11.45 SHOW SECURITY LOG............................................................................... 11-72
11.46 SHOW SYSTEM LOG.................................................................................. 11-75
11.47 SHOW USER .............................................................................................. 11-76
11.48 SYNCH MEASTASK .................................................................................... 11-78
Appendix A Error Messages..................................................................... A-1

Glossary .......................................................................................................... I
IV
About This Manual
The NetNumenTM U31 R18 Unified Element Management System (NetNumen U31 or
EMS) is a special network element management system that manages network elements
in radio access systems. By using NetNumen U31, users can configure and maintain
individual network elements, and manage radio access networks in a unified manner.
NetNumen U31 provides the following management functions:
l Configuration management
l Fault management
l Performance management
l Topology management
l Security management
As an object-oriented system designed on the J2EE platform, NetNumen U31 provides
unified standard interfaces to external devices.
Purpose
This manual explains all Man-Machine Language (MML) commands available in the EMS,
including command function, syntax, input parameters, output parameters, remarks, and
examples.
Intended Audience
l Maintenance engineers
l Debugging engineers
I
II
Chapter 1
Overview
Table of Contents
MML Command Composition .....................................................................................1-1
Parameter Data Types ...............................................................................................1-2
1.1 MML Command Composition

A Man-Machine Language (MML) command consists the command name (mnemonic),
one or more required and optional parameters, and command terminator (semicolon), as
illustrated in the following figure.
The following describes each part of an MML command.

l Command Name
Command name, also called mnemonic, is a required part of each command. It is
generally a short description of the function that will be performed. For example, SH
OW USE identifies a function for showing the basic information of a user.
l Command Parameters
Most commands have one or more parameters next to the command name, preceding
with a colon. A command may have required parameters and optional parameters.
No restrictions exist on the sequence of required parameters and optional parameters
in a command.
Required Parameters
If a command has required parameters, users must specify these parameters
before running the command.
Optional Parameters
Optional parameters are used depending on the actual requirements. If users do
not specify optional parameters, the system uses the default parameter values
when running the commands.
l Command Terminator
A semicolon is used as the default terminator of an MML command.
1-1
SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

NetNumen U31 R18 MML Command Reference
1.2 Parameter Data Types

The following describes different parameter data types supported by MML commands.
Data Type Description
Numeric Integer Integer parameters and integer parameter arguments are supported:
l An integer parameter has an integer value without any separator.
l An integer parameter argument contains several integers separated
by "&", "&&", "-", "&-", or "&&-".
Float Float parameters and float parameter arguments are supported:

l A float parameter has a floating point value without any separator.
l A float parameter argument contains several floating point numbers
separated by "&".
Boolean A Boolean parameter has two values, usually denoted "T" (TRUE) or
"F" (FALSE).
Identifier An identifier parameter has a value starting with a letter.

Identifier parameters and identifier parameter arguments are supported:
l An identifier parameter has a value consisting of only letters and
numbers.
l An identifier parameter argument contains several identifiers
separated by "&".
Enumeration Enumeration parameters and enumeration parameter arguments are

supported:
l A parameter of enumeration type has a set of named values
(members) separated by ,. It can be assigned any value in the set.
l An enumeration parameter argument contains enumerated data
separated by "&".
Date A date parameter has a value in the format of "YYYY-MM-DD"

(year-month-day).
Time Two types of time parameters can be used depending on time precision.
l A time parameter on second level has a value in the format of
"HH-MI-SS" (hour-minute-second).
l A time parameter on minute level has a value in the format of
"HH-MI" (hour-minute).
Temperature A temperature parameter has a decimal floating point value with a suffix
of "".
Percentage A percentage parameter has a decimal floating point value with a suffix
of "%".
1-2

Chapter 1 Overview
Data Type Description
String String parameters and string parameter arguments are supported:

l A string parameter consists of a sequence of characters, which are
enclosed in a pair of quotation marks. In man-machine language,
literal characters are regarded as a string.
l A string parameter argument contains several strings separated
by "&".
Complex A complex parameter has a value containing different types of data. It

can be considered as a special parameter.
1-3

This page intentionally left blank.
1-4

Chapter 2
A
Table of Contents
ADD DEPARTMENT ..................................................................................................2-1
ADD INDEX ...............................................................................................................2-2
ADD MEASTASK .......................................................................................................2-7
ADD PERIODIC TASK .............................................................................................2-10
ADD QOSTASK .......................................................................................................2-12
ADD TIMING TASK ..................................................................................................2-18
ADD USER ..............................................................................................................2-22
ALARM CLEAR........................................................................................................2-24
ALARM RAISE .........................................................................................................2-25
ALARM SYNC..........................................................................................................2-30
2.1 ADD DEPARTMENT

Function
This command is used to create a department.
Syntax
ADD DEPARTMENT: NAME= < NAME> [ , DESCRIPTION= < DESCRIPTION> ] [ , SUP
ERDEPART= < SUPERDEPART> ] ;
Input Parameters
Parameter Description
NAME (Required) Specifies a name for the department to be created.

Data type: String
Value range: 1-50 characters
Default value: none
Instance count: 1-1
DESCRIPTION (Optional) Adds a description for the department to be created.

Data type: String
Default value: none
Instance count: 1-1
2-1

SUPERDEPARTMENT (Optional) Assigns an upper-level department to the department to be

created.
Data type: String
Default value: None
Instance count: 1-1
Output Parameter
RESULT Returns the creation result.

Data type: String
Instance count: 1-1
Example
To create a department with the name Routine Maintenance and upper-level department
Maintenance, type the following command:
ADD DEPARTMENT:NAME=Routine Maintenance,DESCRIPTION=Departme
nt responsible for routine maintenance;SUPERDEPART=Maintenanc
e;
2.2 ADD INDEX

Function
This command is used to create a performance index.
Syntax
ADD INDEX: INDEXNAME= < INDEXNAME> , VALUETYPE= < VALUETYPE> , MEAS
OBJTYPEID= < MEASOBJTYPEID> , FORMULA= < FORMULA> , INDEXTYPE= < INDE
XTYPE> [ , DIRECTION= < DIRECTION> ] [ , SETCRITICAL= < SETCRITICAL> ] [ , AL
ARMCRITICAL= < ALARMCRITICAL> ] [ , ALARMCRITICALDELTA= < ALARMCRITICA
LDELTA> ] [ , SETMAJOR= < SETMAJOR> ] [ , ALARMMAJOR= < ALARMMAJOR> ] [ ,
ALARMMAJORDELTA= < ALARMMAJORDELTA> ] [ , SETMINOR= < SETMINOR> ] [ ,
ALARMMINOR= < ALARMMINOR> ] [ , ALARMMINORDELTA= < ALARMMINORDELTA>
] [ , SETWARN= < SETWARN> ] [ , ALARMWARN= < ALARMWARN> ] [ , ALARMWAR
NDELTA= < ALARMWARNDELTA> ] [ , EXCEPTIONVALUE= < EXCEPTIONVALUE> ] [ ,
INDEXDESC= < INDEXDESC> ] ;
2-2

Chapter 2 A
Input Parameters
INDEXNAME (Required) Specifies a name for the index to be created.

Data type: String
Default value: none
Instance count: 1-1
VALUETYPE (Required) Specifies a data type for the index to be created.

Data type: Enumeration
Default value: None
Instance count: 1-1
MEASOBJTYPEID (Required) Specifies the type ID of the measured object for the index to
be created.
Data type: String
Default value: None
Instance count: 1-1
FORMULA (Required) Sets the formula of the new index.

Data type: String
Default value: none
Instance count: 1-1
INDEXTYPE (Required) Specifies the type of the new index.

Default value: None
Instance count: 1-1
DIRECTION (Optional) Sets the direction attribute of threshold crossing alarms for the
new index.
Default value: UP
Instance count: 1-1
SETCRITICAL (Optional) Enables the setting of threshold and delta for critical threshold
crossing alarms.
Default value: Y
Instance count: 1-1
2-3

ALARMCRITICAL (Optional) Sets the threshold of the new index for reporting a critical
threshold crossing alarm when the index value is higher or lower than
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: 0.0
Instance count: 1-1
ALARMCRITICALDEL (Optional) Sets a hysteresis value for the threshold to avoid frequent
TA switching between generation and removal of critical alarm. A threshold
with a delta actually provides two thresholds: an upper threshold and a
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: 0.0
Instance count: 1-1
SETMAJOR (Optional) Enables the setting of threshold and delta for major threshold
crossing alarms.
Default value: Y
Instance count: 1-1
ALARMMAJOR (Optional) Sets the threshold of the new index for reporting a major
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: 0.0
Instance count: 1-1
ALARMMAJORDELTA (Optional) Sets a hysteresis value for the threshold to avoid frequent
switching between generation and removal of major alarm. A threshold
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: 0.0
Instance count: 1-1
SETMINOR (Optional) Enables the setting of threshold and delta for minor threshold
crossing alarms.
Default value: Y
Instance count: 1-1
2-4

Chapter 2 A
ALARMMINOR (Optional) Sets the threshold of the new index for reporting a minor
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: 0.0
Instance count: 1-1
ALARMMINORDELTA (Optional) Sets a hysteresis value for the threshold to avoid frequent
switching between generation and removal of minor alarm. A threshold
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: 0.0
Instance count: 1-1
SETWARN (Optional) Enables the setting of threshold and delta for threshold crossing
warnings.
Default value: Y
Instance count: 1-1
ALARMWARN (Optional) Sets the threshold of the new index for reporting a threshold
crossing warning when the index value is higher or lower than the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: 0.0
Instance count: 1-1
ALARMWARNDELTA (Optional) Sets a hysteresis value for the threshold to avoid frequent
switching between generation and removal of threshold crossing warning.
A threshold with a delta actually provides two thresholds: an upper
threshold and a lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: 0.0
Instance count: 1-1
EXCEPTIONVALUE (Optional) Sets the exception value of the new index, that is, the calculation
result when the denominator of the index formula is zero.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: 0.0
Instance count: 1-1
2-5

INDEXDESC (Optional) Adds a description of the new index.

Data type: String
Default value: none
Instance count: 1-1
Output Parameter

Data type: String
Instance count: 1-1
Enumeration Description
Parameter Member Description
VALUETYPE INTEGER Integer
FLOAT Float pointing
PERCENT Percentage
BOOLEAN Boolean
STATISTIC Statistic
INDEXTYPE PI Performance index
KPI Key performance index
SPI Statistical performance index
DIRECTION UP Upward: An alarm occurs when the index value

is higher than the preset threshold.
DOWN Downward: An alarm occurs when the index

value is lower than the preset threshold.
SETCRITICAL Y Yes
N No
SETMAJOR Y Yes
N No
SETMINOR Y Yes
N No
SETWARN Y Yes
N No
2-6

Chapter 2 A
Example
To create an index whose name is Call Drop Rate, type the following command:
ADD INDEX:INDEXNAME="Call Drop Rate",VALUETYPE=PERCENT,MEASOBJTYP
E=8,FORMULA="(C301050164+C301050165)/(C301050203+C301050204)",IND
EXTYPE=KPI,DIRECTION=UP,SETCRITICAL=Y,ALARMCRITICAL=0.05,ALARMCRI
TICALDELTA=0.002,SETMAJOR=Y,ALARMMAJOR=0.04,ALARMMAJORDELTA=0.00
2,SETMINOR=Y,ALARMMINOR=0.03,ALARMMINORDELTA=0.002,SETWARN=Y,ALAR
MWARN=0.02,ALARMWARNDELTA=0.002,EXCEPTIONVALUE=0.0,INDEXDESC="Ca
ll Drop Rate";
2.3 ADD MEASTASK

Function
This command is used to create a measurement task for collecting performance data.
Syntax
ADD MEASTASK: MEASTYPEID= < MEASTYPEID> , LOCTYPE= < LOCTYPE> , NELO
C= < NELOC> , NETYPEID= < NETYPEID> [ , TASKNAME= < TASKNAME> ] [ , PERFO
RMANCEOBJECT= < PERFORMANCEOBJECT> ] [ , STARTDATE= < STARTDATE> ] [ ,
ENDDATE= < ENDDATE> ] [ , STATUS= < STATUS> ] [ , GRAN= < GRAN> ] [ , DATEMA
SK= < DATEMASK> ] [ , TIMEMASK= < TIMEMASK> ] ;
Input Parameters
MEASTYPEID (Required) Specifies the type of the measured object to be involved in

the new measurement task. Wildcard characters can be used to specify
the measured object type ID.
Data type: String
Default value: None
Instance count: 1-1
LOCTYPE (Required) Selects the NE location type for specifying the location of NE(s)
to be involved in the new measurement task.
Default value: COMMON
Instance count: 1-1
2-7

NELOC (Required) Specifies the location of NE(s) to be involved in the new

measurement task.
Data type: String
Default value: None
Instance count: 1-1
NETYPEID (Required) Specifies the type of NE(s) to be involved in the new

measurement task.
Data type: String
Default value: None
Instance count: 1-1
TASKNAME (Required) Specifies a name for the new measurement task.

Data type: String
Default value: none
Instance count: 1-1
PERFORMANCEOBJE (Required) Specifies the performance object(s) to be measured.

CT Data type: String
Default value: none
Instance count: 1-1
STARTDATE (Optional) Sets a start time for the new measurement task.
Data type: Date
Default value: None
Instance count: 1-1
ENDDATE (Optional) Sets an end time for the new measurement task.
Data type: Date
Default value: None
Instance count: 1-1
STATUS (Optional) Specifies the initial status of the new measurement task.
Default value: ACTIVE
Instance count: 1-1
GRAN (Required) Specifies a data collection granularity for the new measurement
task.
Data type: Integer
Value range: 0-100000
Instance count: 1-1
2-8

Chapter 2 A
DATEMASK (Optional) Sets a running date of the new measurement task.

Data type: String
Default value: 1111111111111111111111111111111
Instance count: 1-1
TIMEMASK (Optional) Sets a running period of the new measurement task during a
day. The actual start time of the measurement task depends on the data
collection granularity. For example, if the start time is set to 12:05 and
the data collection granularity is 15 minutes, the actual start time of the
measurement task will be 12:15.
Data type: String
Default value: 00:00:00-24:00:00
Instance count: 1-1
Output Parameter

Data type: String
Instance count: 1-1
LOCTYPE COMMON Common location
GROUP Group location
STATUS ACTIVE Activated
SUSPENSIVE Suspended
Remarks
l This command only supports creating measurement tasks on the wildcard level of NE.
Therefore, the information of NEs must be specified in the command.
l The start time and end time must be integral multiples of the granularity.
Example
To create a measurement task according to the following information:
l Task Name: test
l Measurement Type: cn.wcn.cs.50088
l Performance Object: 42049
l Measurement Period: from "2010-04-25 09:50:55" to "2010-04-27 09:50:55"
2-9

l Task Status: activated

l Collection Granularity: 5 minutes
l Running Time: the task runs all day and on every day in a month.
Type the command as follows:
ADD MEASTASK: MEASTYPEID= "cn.wcn.cs.50088", LOCTYPE= "COMMON",
NELOC= "cn.wcn:OMMOID=SIM UAMO-CNBIG-501:elementid=5011000$cn.
wcn:OMMOID=SIMUAMO-CNBIG-501:elementid =5011001$cn.wcn:OMMOID=S
IMUAMO-CNBIG-500:elementid=5001000$cn.wcn:OMMOID =SIMUAMO-CNBI
G-500:elementid=5001001", NETYPEID= "cn.wcn.cs.mscs", TASKNAME=
"test", PERFORMANCEOBJJECT= "42049", STARTDATE= "2010-04-25
09:50:55", ENDDATE= "2010-04-27 09:50:55", STATUS= ACTIVE, GRAN=
5, DATEMASK= "1111111111111111111111111111111", TIIMEMASK= "00:0
0:00,24:00:00";
2.4 ADD PERIODIC TASK

Function
This command is used to create a periodic task for running MML command(s) periodically.
Syntax
ADD PERIODIC TASK: POLICYNAME= < POLICYNAME> , POLICYSTATUS= < POLIC
YSTATUS> , STARTTIME= < STARTTIME> , INTERVALTIME= [ < DAY> ] [ - < HOUR> ] [ -
< MINUTE> ] [ - < SECOND> ] , MMLSTR= < MMLSTR> [ , ENDTIME= < ENDTIME> ] ;
Input Parameters
POLICYNAME (Required) Specifies a name for the periodic task to be created.

Data type: String
Default value: None
Instance count: 1-1
POLICYSATUS (Required) Specifies the initial status of the new periodic task.
Default value: Suspend
Instance count: 1-1
STARTTIME (Required) Sets the start time of the new periodic task.
Data type: Date
Default value: None
Instance count: 1-1
2-10

Chapter 2 A
DAY (Optional) Sets the day of the start time.

Data type: Integer
Value range: 1-366
Default value: 1
Instance count: 1-1
HOUR (Optional) Sets the hour of the start time.

Value type: Integer
Value range: 0-23
Default value: 0
Instance count: 1-1
MINUTE (Optional) Sets the minute of the start time.

Value type: Integer
Value range: 0-59
Default value: 0
Instance count: 1-1
SECOND (Optional) Sets the second of the start time.

Value type: Integer
Value range: 0-59
Default value: 0
Instance count: 1-1
INTERVALTIME (Required) Sets a running cycle for the new periodic task.
Data type: Complex
Value range: 0-1000
Default value: none
Instance count: 1-1
MMLSTR (Required) Specifies MML command(s) to be run.

Data type: String
Default value: none
Instance count: 1-1
ENDTIME (Optional) Sets an end time for the new periodic task.
Data type: Date
Default value: None
Instance count: 1-1
Output Parameter

Data type: String
Instance count: 1-1
2-11

POLICYSTATUS Active Activated
Suspend Suspended
Example
To create a periodic task whose name is test, type the following command:
ADD PERIODIC TASK:POLICYNAME="test",POLICYSTATUS=ACTIVE,STARTTIME
="2009-12-16 15:25:17",INTERVALTIME="1"-"0"-"8"-"0",MMLSTR="set";
2.5 ADD QOSTASK

Function
This command is used to create a QoS task (threshold task) for monitoring performance
indexes.
Syntax
ADD QOSTASK: MEASOBJTYPEID= < MEASOBJTYPEID> , MEASOBJMOI= < NELOC>
[ - < MEASOBJLIST> ] , THRESHOLD= < INDEXID> [ - < DIRECTION> ] [ - < SETCRITICAL>
] [ - < ALARMCRITICAL> ] [ - < ALARMCRITICALDELTA> ] [ - < SETMAJOR> ] [ - < ALAR
MMAJOR> ] [ - < ALARMMAJORDELTA> ] [ - < SETMINOR> ] [ - < ALARMMINOR> ] [ - <
ALARMMINORDELTA> ] [ - < SETWARN> ] [ - < ALARMWARN> ] [ - < ALARMWARNDELTA>
] [ - < SUGGESTION> ] , TASKNAME= < TASKNAME> [ , CONDITION= < CONDITION> ]
, STARTDATE= < STARTDATE> , ENDDATE= < ENDDATE> [ , STATUS= < STATUS> ] [
, GRAN= < GRAN> ] [ , DATEMASK= < DATEMASK> ] [ , TIMEMASK= < TIMEMASK> ] ,
NETYPEID= < NETYPEID> ;
Input Parameters
MEASOBJTYPEID (Required) Specifies the type of the measured object to be involved in the
new QoS task.
Data type: String
Default value: None
Instance count: 1-1
MEASOBJMOI (Required) Specifies the Managed Object Instance (MOI) of the measured
object. Wildcard characters can be used to specify the MOI.
Data type: Complex
Default value: None
Instance count: 1-1000000
2-12

Chapter 2 A
NELOC (Required) Specifies the location of NE(s) to be involved in the new QoS
task.
Data type: String
Default value: None
Instance count: 1-1
MEASOBJLIST (Required) Specifies the list of measured objects to be involved in the

new QoS task. Wildcard characters can be used to specify the measure
object list. If a parent measured object node is selected, all its child
nodes are selected by default.
Data type: String
Default value: None
Instance count: 1-1
THRESHOLD (Required) Sets alarm thresholds for the new QoS task.
Data type: Complex
Default value: 0
INDEXID (Required) Specifies the index(es) to be involved in the new QoS task.
Data type: String
Default value: None
Instance count: 1-1
DIRECTION (Required) Sets the direction attribute of threshold crossing alarms for
the specified index.
Default value: None
Instance count: 1-1
SETCRITICAL (Required) Enables the setting of threshold and delta for critical threshold
crossing alarm.
Default value: Y
Instance count: 1
ALARMCRITICAL (Optional) Sets the threshold of the specified index for reporting a critical
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: 0.0
Instance count: 1-1
2-13

ALARMCRITICALDELTA (Optional) Sets a hysteresis value for the threshold to avoid frequent
switching between generation and removal of critical alarm. A threshold
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: 0.0
Instance count: 1-1
SETMAJOR (Required) Enables the setting of threshold and delta for major threshold
crossing alarm.
Default value: Y
Instance count: 1
ALARMMAJOR (Optional) Sets the threshold of the specified index for reporting a major
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: 0.0
Instance count: 1-1
ALARMMAJORDELTA (Optional) Sets a hysteresis value for the threshold to avoid frequent
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: 0.0
Instance count: 1
SETMINOR (Required) Enables the setting of threshold and delta for minor threshold
crossing alarm.
Default value: Y
Instance count: 1
ALARMMINOR (Optional) Sets the threshold of the specified index for reporting a minor
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: 0.0
Instance count: 1-1
2-14

Chapter 2 A
ALARMMINORDELTA (Optional) Sets a hysteresis value for the threshold to avoid frequent
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: 0.0
Instance count: 1
SETWARN (Required) Enables the setting of threshold and delta for threshold
crossing warning.
Default value: Y
Instance count: 1
ALARMWARN (Optional) Sets the threshold of the specified index for reporting a
threshold crossing warning when the index value is higher or lower than
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: 0.0
Instance count: 1
ALARMWARNDELTA (Optional) Sets a hysteresis value for the threshold to avoid frequent
Data type: Float
Value range: 0 to 999999999.999
Default value: 0.0
Instance count: 1-1
SUGGESTION (Optional) Adds a handling suggestion for threshold crossing alarms.

Data type: String
Default value: None
Instance count: 1
TASKNAME (Required) Specifies a name for the new QoS task.

Data type: String
Default value: none
Instance count: 1
2-15

CONDITION (Optional) Specifies the active condition index of the new QoS task.
Data type: Integer
Default value: None
Instance count: 1-1
STARTDATE (Required) Sets a start time of the new QoS task.

Data type: Date
Default value: None
Instance count: 1-1
ENDDATE (Required) Sets an end time of the new QoS task.

Data type: Date
Default value: None
Instance count: 1-1
STATUS (Optional) Sets the initial status of the new QoS task.
Default value: ACTIVE
Instance count: 1-1
GRAN (Required) Sets a data collection granularity for the new QoS task.
Data type: String
Default value: 15 (minutes)
Instance count: 1-1
DATEMASK (Optional) Sets the running date of the new QoS task.
Data type: String
Default value: 1111111111111111111111111111111
Instance count: 1-1
TIMEMASK (Optional) Sets the running period of the new QoS task.
Data type: String
Value range: 0-216
Default value: 00:00:00-24:00:00
Instance count: 1-1
NETYPEID (Required) Specifies the NE type concerned in the new QoS task.
Data type: String
Default value: None
Instance count: 1-1
2-16

Chapter 2 A
Output Parameter

Value type: String
Instance count: 1-1


ALL Upward and downward: An alarm occurs

when the index value is larger than the upper
threshold or smaller than the lower threshold.
SETCRITICAL Y Yes
N No
SETMAJOR Y Yes
N No
SETMINOR Y Yes
N No
SETWARN Y Yes
N No
Remarks
l This command only supports creating QoS tasks on the wildcard level of Measured
Object (MO). Therefore, the information of NEs and MOs must be specified in the
command.
l The start time and end time must be integral multiples of the granularity.
l The unit of alarm thresholds does not vary with the specified index type.
Example
To create a QoS task according to the following information:
l Task Name: UltranCell Qos01

l Measure Object Type: 401UtranCell(TD)
2-17

l Measure Object List: It contains all measured objects of RncFunction1867 of the NE

100, Subnetwork 100, Server100001.
l Alarm Threshold: The indexes 36061-Call Completion Ratio, PS and 36062-Call
Completion Ratio, CS with the default settings of thresholds are used.
l Activating Condition: 33000
l Measurement Period: From "2008-01-01 00:00:00" to "2008-01-22 00:00:00".
l Task Status: Active
l Collection Granularity: 15 minutes
l Running Time: The QoS task runs all day and on every day in a month.
ADD QOSTASK: MEASOBJJTYPEID=401, MEASOBJJMOI="100001$fqokmcs4-1
$100001$1 00$100"-"1867", THRESHOLD=36061&36062, TASKNAME="Ultra
nCell Qos01", CONDITIION=33000, STARTDATE="2008-01-01 00:00:00",
ENDDATE="2008-01-22 00:00:00", STATUS=Active, GRAN=15,
NETYPEID="cn.wcn.cs.mscs";
2.6 ADD TIMING TASK

Function
This command is used to create a timing task, which can be run only once, once a day,
once a week, or once a month.
Syntax
ADD TIMING TASK: POLICYNAME= < POLICYNAME> , POLICYSTATUS= < POLICYS
TATUS> [ , ONLYONCE= < ONLYONCE> ] , MMLSTR= < MMLSTR> ;
Input Parameters
POLICYNAME (Required) Specifies a name for the new timing task.

Data type: String
Default value: none
Instance count: 1-1
POLICYSTATUS (Required) Specifies the initial status of the new timing task.
Instance count: 1-1
2-18

Chapter 2 A
ONLYONCE Sets the running time of the new task. When this parameter is set, the new
timing task will be run only once when the preset time is up.
Data type: Date
Default value: None
Instance count: 1-1
ONCEDAY Sets the running day of the new task. When this parameter is set, the new
timing task will be run at the preset time once a day.
Data type: Date
Default value: None
Instance count: 1-1
WEEK Sets the running day of the new task. This parameter specifies the day of
a week.
Default value: Sunday
Instance count: 1-1
SHORTTIME1 Sets the task-running time.

Data type: Date
Default value: None
Instance count: 1-1
ONCEWEEK Sets the running day of the new task. When this parameter is set, the new
timing task will be run at the preset time once a week.
Data type: Date
Default value: None
Instance count: 1-1
DAY1 Sets the running day of the new task. This parameter specifies the day
of a month.
Default value: none
Instance count: 1-1

Data type: Date
Default value: None
Instance count: 1-1
ONCEMONTH Sets the running time of the new task. When this parameter is set, the new
timing task will be run once a month.
Value type: Complex
Default value: None
Instance count: 1-1
2-19

MONTH Sets the running time of the new task. This parameter specifies the
month(s) of a year.
Default value: none
Instance count: 1-1
of a month.
Default value: none
Instance count: 1-1
SHORTTIME3 Sets the running time.

Data type: Date
Default value: none
Instance count: 1-1
MMLSTR (Required) Specifies MML command(s) to be run.

Data type: String
Default value: none
Instance count: 1-1
Output Parameter

Data type: String
Instance count: 1-1
WEEK Sunday Sunday
Monday Monday
Tuesday Tuesday
Wednesday Wednesday
Thursday Thursday
Friday Friday
Saturday Saturday
2-20

Chapter 2 A
DAY1/DAY2 1-32 1-31: the first day to the 31st day of a month
32: the last day of a month
MONTH 1 January
2 February
3 March
4 April
5 May
6 June
7 July
8 August
9 September
10 October
11 November
12 December
Remarks
Only one or none of the parameters ONLYONCE, ONCEDAY, ONCEWEEK and ONCE
MONTH can be set to specify the running time of the timing task.
l ONLYONECE: it is required to specify the date in the format of yyyy-mm-dd
hour:minute:second, for example, 2008-10-17 15:27:36.
l ONCEDAY: it is required to specify the date in the format of hour:minute:second, for
example, 04:00:00.
l ONCEWEEK: it is required to select a day in the week (Sunday, Monday, Tuesday,
Wednesday, Thursday, Friday, or Saturday) , and set the time in the day, for example,
Monday-05:00:00.
l ONCEMONTH: it is required to select a day in the month (1 through 32), and set the
time in the day, for example, 25-06:00:00. The day 32 indicates the last day of a
month, which varies with different months.
Example
To create a timing task whose name is test, type the following command:
ADD TIMING TASK:POLICYNAME="test",POLICYSTATUS=Active,ONLYONCE="2
008-10-13 16:07:22",MMLSTR="set";
2-21

2.7 ADD USER

Function
This command is used to create a user.
Syntax
ADD USER: NAME= < NAME> [ , PASSWORD= < PASSWORD> ] [ , FULLNAME= < FUL
LNAME> ] [ , DESCRIPTION= < DESCRIPTION> ] [ , PHONENUMBER= < PHONENUMB
ER> ] [ , EMAILADDRESS= < EMAILADDRESS> ] [ , DEPARTMENT= < DEPARTMENT> ]
[ , USERVALIDDAYS= < USERVALIDDAYS> ] [ , PASSWORDVALIDDAYS= < PASSWOR
DVALIDDAYS> ] [ , DISABLE= < DISABLE> ] [ , USERSTOPACCDAYS= < USERSTOPAC
CDAYS> ] [ , ROLEARRAY= < ROLEARRAY> ] [ , ROLESETARRAY= < ROLESETARRAY>
] [ , CONFIRMPASSWORD= < CONFIRMPASSWORD> ] ;
Input Parameters
NAME (Required) Specifies a name of the user to be created

Value type: String
Instance count: 1-1
PASSWORD (Optional) Sets the password of the new user.

Value type: String
Instance count: 1-1
CONFIRMPASSWORD (Optional) Confirms the password of the new user.

Data type: String
Instance count: 1-1
FULLNAME (Optional) Adds the full name of the new user.

Value type: String
Instance count: 1-1
DESCRIPTION (Optional) Adds a description of the new user.

Value type: String
Instance count: 1-1
PHONENUMBER (Optional) Specifies the phone number of the new user.

Data type: String
Instance count: 1-1
2-22

Chapter 2 A
EMAILADDRESS (Optional) Specifies the Email address of the new user.

Data type: String
Instance count: 1-1
DEPARTMENT (Optional) Specifies the department to which the new user belongs.
Data type: String
Instance count: 1-1
USERVALIDDAYS (Optional) Sets the validity period of the new user account. If the parameter
value is set to zero, the new user account will never expire.
Data type: Integer
Value range: 0-500 days
Default value: 0
Instance count: 1-1
PASSWORDVALIDDA (Optional) Sets the longest reservation period of the new user accounts
YS password. If the parameter value is set to zero, the user password will
never expire.
Data type: Integer
Default value: 0
Instance count: 1-1
PASSWORDKEEPDAY (Optional) Sets the shortest reservation period of the new user accounts
S password.
Data type: Integer
Default value: 0
Instance count: 1-1
DISABLE (Optional) Sets the initial status of the new user account, enabled or
disabled.
Data type: Boolean
Value range: True, and False
Default value: False
Instance count: 1-1
USERSTOPACCDAYS (Optional) Sets the account suspended duration (days).

Data type: Integer
Value range: 0-500
Default value: 0
Instance count: 1-1
2-23

ROLEARRAY (Optional) Assigns role(s) to the new user.

Value type: String
ROLESETARRAY (Optional) Assigns role set(s) to the new user.

Value type: String
LOGROLEARRAY (Optional) Sets the role(s) so that the new user can view the logs of existing
users who are assigned with the same role(s).
Data type: String
LOGROLESETARRAY (Optional) Sets the role set(s) so that the new user can view the logs of
existing users who are assigned with the same role set(s).
Data type: String
Output Parameter

Value type: String
Instance count: 1-1
Example
To create a user with the name of user 1, type the following command:
ADD USER:NAME="user 1",PASSWORD="0",CONFIRMPASSWORD="0",FULLNAME
="1",DESCRIPTION="1",PHONENUMBER="12345678901",EMAILADDRESS="some
body@unknown.com",DEPARTMENT="1",USERVALIDDAYS=0,PASSWORDVALIDDAY
S=0,DISABLE=False,USERSTOPACCDAYS=0,ROLEARRAY="1",ROLESETARRAY="1
",LOGROLEARRAY="1",LOGROLESETARRAY="1";
2.8 ALARM CLEAR

Function
This command is used to clear an active alarm.
2-24

Chapter 2 A
Syntax
ALARM CLEAR: ID= < ID> ;
Input Parameter
ID (Required) Specifies the ID of the active alarm to be cleared.

Data type: Integer
Output Parameter
INFO Returns the information of cleared alarm.

Data type: Complex
RESULT Returns the clearing result.

Data type: String
Instance count: 1-1
Remarks
The alarm ID required in this command can be obtained by the SHOW CURRENT ALARM
command. After running the SHOW CURRENT ALARM command, the system shows the
IDs of all active alarms in the result.
Example
To clear an active alarm whose ID is 1169630078865, type the following command:
ALARM CLEAR: ID= 1169630078865;
2.9 ALARM RAISE

Function
This command is used to raise an active alarm or historical alarm by sending an alarm
reporting message or alarm clearing message when necessary.
Syntax
ALARM RAISE: [ , SEVERITY= < SEVERITY> ] [ , POSITION= < POSITION> ] [ , ALARM
CODE= < ALARMCODE> ] [ , SYSTEMTYPE< SYSTEMTYPE> ] [ , ALARMKEY< ALARMKEY>
] [ , MESSAGETYPE= < MESSAGETYPE> ] [ , SUBPOSITION1= < SUBPOSITION1> ] [ ,
SUBNAME1= < SUBNAME1> ] [ , POSITION2= < POSITION2> ] [ , SUBPOSITION2= <
SUBPOSITION2> ] [ , LINK= < LINK> ] [ , REASON< REASON> ] [ , SPECIFICPROBLEM=
< SPECIFICPROBLEM> ] [ , DATAPRODUCT= < DATAPRODUCT> ] [ , DISPRODUCT= <
2-25

DISPRODUCT> ] [ , ADDITIONALTEXT= < ADDITIONALTEXT> ] [ , CUSTOMATTRS1=

< CUSTOMATTRS1> ] [ , CUSTOMATTRS2= < CUSTOMATTRS2> ] [ , CUSTOMATTRS3<
CUSTOMATTRS3> ] [ , CUSTOMATTRS4= < CUSTOMATTRS4> ] [ , CUSTOMATTRS5= <
CUSTOMATTRS9> ] [ , CUSTOMATTRS10= < CUSTOMATTRS10> ] [ , PATHID= < PATHI
D> ] [ , PATHNAME= < PATHNAME> ] ;
Input Parameters
SEVERITY (Required) Specifies the severity level of the alarm to be raised.

Default value: None
Instance count: 1-1
POSITION (Required) Specifies the occurrence position of the alarm to be raised.

Data type: String
Default value: None
Instance count: 1-1
ALARMCODE (Required) Specifies the alarm code of the alarm to be raised.

Data type: Integer
Value range: 0-9223372036854775807
Default value: None
Instance count: 1-1
SYSTEMTYPE (Required) Specifies the system type of the alarm to be raised.

Data type: Integer
Default value: None
Instance count: 1-1
ALARMKEY (Required) Specifies the primary key of the alarm to be raised.

Data type: String
Default value: None
Instance count: 1-1
MESSAGETYPE (Required) Specifies a message type to determine whether an active or

historical alarm shall be raised. If this parameter is set to ALARM_RAISE,
an active alarm will be raised after an alarm raising message is sent. If this
parameter is set to ALARM_CLEAR, a historical alarm will be raised after
an alarm clearing message is sent.
Default value: None
Instance count: 1-1
2-26

Chapter 2 A
SUBPOSITION1 (Optional) Specifies the ID of the related element in the primary position.
Data type: String
Default value: None
Instance count: 1-1
SUBNAME1 (Optional) Specifies the name of the related element in the primary position.
Data type: String
Default value: None
Instance count: 1-1
POSITION2 (Optional) Specifies the ID of the related element in the subordinate

position.
Data type: String
Default value: None
Instance count: 1-1
SUBPOSITION2 (Optional) Specifies the name of the related element in the subordinate
position.
Data type: String
Default value: None
Instance count: 1-1
LINK (Optional) Specifies the link related to the alarm to be raised.

Data type: String
Default value: None
Instance count: 1-1
REASON (Optional) Specifies the reason code.

Data type: Integer
Value range: 0-9223372036854775807
Default value: None
Instance count: 1-1
SPECIFICPROBLEM (Optional) Specifies the reason for raising an alarm.

Data type: String
Default value: None
Instance count: 1-1
2-27

DATAPRODUCT (Optional) Specifies the product information related to the alarm to be

raised.
Data type: String
Default value: None
Instance count: 1-1
DISPRODUCT (Optional) Specifies the description of the products related to the alarm,
which will be displayed as an attribute of the alarm. For example,
DISPRODUCT=All wireless products.
Data type: String
Default value: none
Instance count: 1-1
ADDITIONALTEXT (Optional) Specifies the additional information about the products.

Data type: String
Default value: None
Instance count: 1-1
CUSTOMATTRS1 (Optional) Specifies an attribute for the alarm to be raised. Ten attributes
can be set for an alarm.
CUSTOMATTRS2
Data type: String
CUSTOMATTRS3
CUSTOMATTRS4 Default value: none
CUSTOMATTRS5 Instance count: 1-1
CUSTOMATTRS6
CUSTOMATTRS7
CUSTOMATTRS8
CUSTOMATTRS9
CUSTOMATTRS10
PATHID (Optional) Specifies the ID of the path related to the alarm to be raised.
Data type: String
Default value: None
Instance count: 1-1
PATHNAME (Optional) Specifies the name of the path related to the alarm to be raised.
Data type: String
Default value: None
Instance count: 1-1
2-28

Chapter 2 A
Output Parameters
INFO Shows the alarm raising information.

Data type: Complex
Instance count: 255
RESULT Returns the alarm rasing result.

Data type: String
Instance count: 1
SEVERITY SEVERITY_CRITICAL Critical
SEVERITY_MAJOR Major
SEVERITY_MINOR Minor
SEVERITY_WARNING Warning
MESSAGETYPE ALARM_RAISE Alarm raising message
ALARM_CLEAR Alarm clearing message
Remarks
l This command can be used to raise an active alarm or historical alarm, depending on
the value of MESSAGETYPE.
l POSITION specifies the position of the alarm in the format of resource OID, for
example, "wcdma:OMMOID=gkq5vm1x-2@sbn=100@me=100". OID information
can be obtained from the topology table.
l POSITION2 must have a valid value that indicates an existing network element. Or
else, the system will fail to add this field as an attribute of the raised alarm.
l LINK must have a valid value that indicates an existing link. Or else, the system will
fail to add this field as an attribute of the raised alarm.
l DATAPRODUCT can have a value containing the information of multiple types of
products, for example, "Gsm&Umts&Td&Lte". Different product types are separated
by &. This field corresponds to PRODUCTID in the PRODUCT table.
l If the alarm to be raised is a special alarm with predefined alarm code, the system
will determine its severity according to the alarm code. If the alarm to be raised is
a common alarm without predefined alarm code, the alarm severity is determined by
the value of SEVERITY.
l ALARMKEY is the primary key of the alarm to be raised, which must be unique in the
system. If ALARMKEY in the command has the same value as an existing alarm, the
system will fail to raise an alarm.
2-29

Example
To raise an active alarm, type the following command:
ALARM RAISE:ALARMTYPE=COMMUNICATIONS_ALARM,SEVERITY=SEVERITY_MAJO
R,POSITION="CommonTopoObject=112",ALARMCODE=1000,SYSTEMTYPE=6,ALA
RMKEY="30",MESSAGETYPE=ALARM_RAISE,REASON=5,SPECIFICPROBLEM="Wron
g password entered consecutively",DATAPRODUCT="Gsm&Umts&Td&Lte",D
ISPRODUCT="All wireless products";
2.10 ALARM SYNC

Function
This command is used to synchronize alarms from one or more NEs to the EMS.
Syntax
ALARM SYNC: POSITION= < POSITION;
Input Parameter
POSITION (Required) Specifies the positions of NEs whose alarms need to be

synchronized to the EMS.
Data type: String
Default value: None
Output Parameters
INFO Shows the alarm synchronization information.

Value type: Complex
RESULT Returns the alarm synchronization result.

Value type: String
Instance count: 1-1
Remarks
l The NE position specified by POSITION is the OID information of the corresponding
resource. For example, POSITION="wcdma:OMMOID=gkq5vm1x-2@sbn=100@me
=100". OID information can be obtained from the topology map.
l This command can be run to synchronize alarms from at most 100 NEs to the EMS
at a time.
2-30

Chapter 2 A
Example
To synchronize the alarms of two NEs (1000, and 1001), type the following command:
ALARM SYNC:POSITION="IpNode=1000"&"IpNode=1001";
2-31

2-32

Chapter 3
B
Table of Contents
BACKUP AND DELETE ALARM DATA ......................................................................3-1
BACKUP AND DELETE LOG DATA ...........................................................................3-1
BACKUP BASICDB....................................................................................................3-2
BACKUP FILE............................................................................................................3-3
BACKUP WHOLE DB STRUCTURE ..........................................................................3-3
3.1 BACKUP AND DELETE ALARM DATA

Function
This command is used to back up and delete alarm data in the EMS.
Syntax
BACKUP AND DELETE ALARM DATA;
Input Parameter
None
Output Parameter
EXECRESULT Returns the backup and deletion result.

Data type: String
Example
To back up and then delete the alarm data in the EMS, type the following command:
BACKUP AND DELETE ALARM DATA;
3.2 BACKUP AND DELETE LOG DATA

Function
This command is used to back up and delete log data (operation log, system log, and
security log) in the EMS.
3-1

Syntax
BACKUP AND DELETE LOG DATA;
Input Parameter
None
Output Parameter
EXECRESULT Returns the backup and deletion result.

Data type: String
Example
To back up and then delete the log data in the EMS, type the following command:
BACKUP AND DELETE LOG DATA;
3.3 BACKUP BASICDB

Function
This command is used to back up the basic data in the database of the EMS.
Syntax
BACKUP BASICDB;
Input Parameter
None
Output Parameter
EXECRESULT Returns the backup result.

Data type: String
Example
To back up the basic data of the database of the EMS, type the following command:
BACKUP BASICDB;
3-2

Chapter 3 B
3.4 BACKUP FILE

Function
This command is used to back up version files, configuration files, and runtime files in the
EMS.
Syntax
BACKUP FILE;
Input Parameter
None
Output Parameter

Data type: String
Example
To back up the version files, configuration files, and runtime files in the EMS, type the
following command:
BACKUP FILE;
3.5 BACKUP WHOLE DB STRUCTURE

Function
This command is used to back up the whole database of the EMS, including the structure
of all objects in the database.
Syntax
BACKUP WHOLE DB STRUCTURE;
Input Parameter
None
3-3

Output Parameter

Data type: String
Remarks
If the database structure breaks down, an offline recovery tool in the \ums-server\util
s\usf-backup directory can be used, on the condition that the EMS service is disabled,
to restore the whole database structure from the backup file.
Example
To back up the whole database of the EMS, type the following command:
BACKUP WHOLE DB STRUCTURE;
3-4

Chapter 4
C
Table of Contents
CHECK NMDBUSER .................................................................................................4-1
CHECK NMFTPUSER................................................................................................4-2
4.1 CHECK NMDBUSER

Function
This command is used to check the connection of a user to the database.
Syntax
CHECK NMDBUSER: USER= < USER> , PASSWORD= < PASSWORD> ;
Input Parameters
USER (Required) Specifies the database user to be checked.

Data type: String
Default value: none
Instance count: 1-1
PASSWORD (Required) Specifies the user password.

Data type: String
Default value: None
Instance count: 1-1
Output Parameter
RESULT Returns the check result.

Data type: String
Example
To check the connection of the user uep4x to the database, type the following command:
CHECK NMDBUSER:USER="uep4x",PASSWORD="U_tywg_2010";
4-1

4.2 CHECK NMFTPUSER

Function
This command is used to check the FTP connection of a user.
Syntax
CHECK NMFTPUSER: USER= < USER> , PASSWORD= < PASSWORD> ;
Input Parameters
USER (Required) Specifies the name of the FTP user.

Data type: String
Default value: none
Instance count: 1-1
PASSWORD (Required) Specifies the user password.

Data type: String
Default value: None
Instance count: 1-1
Output Parameter
RESULT Returns the check result.

Data type: String
Example
To check the FTP connection of the user uepcommon, type the following command:
CHECK NMFTPUSER:USER="uepcommon",PASSWORD="U_tywg_2010_ftp";
4-2

Chapter 5
D
Table of Contents
DEL DEPARTMENT ...................................................................................................5-1
DEL INDEX ................................................................................................................5-2
DEL MEASTASK ........................................................................................................5-3
DEL QOSTASK ..........................................................................................................5-4
DEL SESSION ...........................................................................................................5-5
DEL TASK..................................................................................................................5-5
DEL USER .................................................................................................................5-6
5.1 DEL DEPARTMENT

Function
This command is used to delete a department.
Syntax
DEL DEPARTMENT: NAME= < NAME> ;
Input Parameter
NAME (Required) Types the name of the department you want to delete.
Data type: String
Instance count: 1
Output Parameter
RESULT Returns the deletion result.

Value type: String
Instance count: 1-1
Example
To delete the department whose name is 1, type the following command:
DEL DEPARTMENT: NAME="1";
5-1

5.2 DEL INDEX

Function
This command is used to delete a user-defined performance index.
Syntax
DEL INDEX: INDEXID= < INDEXID> ;
Input Parameter
INDEXID (Required) Types the ID of the performance index you want to delete.
Data type: String
Instance count: 1-1
Output Parameters
DETAIL Returns the details of the deleted index.

Data type: Complex
Instance count: 1-1
INDEXID Shows the ID of the deleted index.

Data type: String
Instance count: 1-1
INDEXNAME Shows the name of the deleted index.

Data type: String
Instance count: 1-1

Data type: String
Instance count: 1-1
Remark
l The deletion of an index will not be allowed if the index is used in a QoS task, query
template or the performance index topology.
l You can not delete any default index provided by the system.
Example
To delete a user-defined index with the ID 33000, type the following command:
DEL INDEX:INDEXID=33000;
5-2

Chapter 5 D
5.3 DEL MEASTASK

Function
This command is used to delete measurement task(s).
Syntax
DEL MEASTASK: TASKID= < BEGINID> [ - < ENDID> ] ;
Input Parameters
TASKID (Required) Types the ID of the measurement task or the ID range of the
measurement tasks that you want to delete.
Value type: Complex
Value range: None
BEGINID (Required) Sets the start ID of the measurement tasks that you want to
delete.
Data type: Integer
Value range: None
Instance count: 1
ENDID (Optional) Sets the end ID of the measurement tasks that you want to
delete.
Data type: Integer
Value range: None
Instance count: 1
Output Parameter

Data type: String
Instance count: 1-1
Remarks
At most 100 measurement tasks can be deleted by this command at a time.
Examples
l To delete the measurement task with the ID 125, type the following command:
DEL MEASTASK:TASKID=125;
l To delete the measurement tasks with the IDs ranging from 100 to 120, from 150 to
155, and the ID 200 and 210, type the command as follows:
5-3

DEL MEASTASK:TASKID=100-120&150-155&200&210;
5.4 DEL QOSTASK

Function
This command is used to delete one or more QoS tasks.
Syntax
DEL QOSTASK: TASKID= < BEGINID> [ - < ENDID> ] ;
Input Parameter
TASKID (Required) Types the ID of the QoS task or the ID range of the QoS tasks
that you want to delete.
Data type: Complex
Value range: None
BEGINID (Required) Sets the start ID of the QoS tasks that you want to delete.
Data type: Integer
Value range: None
Instance count: 1-1
ENDID (Optional) Sets the end ID of the QoS tasks that you want to delete.
Data type: Integer
Value range: None
Instance count: 1-1
Output Parameter

Value type: String
Instance count: 1-1
Remarks
At most 100 QoS tasks can be deleted by this command at a time.
Examples
l To delete the QoS task with the ID 125, type the following commands:
DEL QOSTASK:TASKID=125;
5-4

Chapter 5 D
l To delete the QoS tasks with the IDs ranging from 100 to 120, from 150 to 155, and
the ID 200 and 210, type the command as follows:
DEL QOSTASK:TASKID=100-120&150-155&200&210;
5.5 DEL SESSION

Function
This command is used to delete a session.
Syntax
DEL SESSION: SESSIONID= < SESSIONID> ;
Input Parameter
SESSIONID (Required) Types the ID of the session that you want to delete.
Data type: Integer
Default value: None
Instance count: 1-1
Output Parameter

Value type: String
Instance count: 1-1
Example
To delete the session with the ID 0, type the following command:
DEL SESSION:SESSIONID=0;
5.6 DEL TASK

Function
This command is used to delete a task.
Syntax
DEL TASK: POLICYNAME= < POLICYNAME> ;
5-5

Input Parameter
POLICYNAME (Required) Types the name of the task that you want to delete.
Data type: String
Default value: None
Instance count: 1-1
Output Parameter

Data type: String
Instance count: 1-1
Example
To create a task with the name task a, type the following command:
DEL POLICY: POLICYNAME="task a";
5.7 DEL USER

Function
This command is used to delete a user.
Syntax
DEL USER: NAME= < NAME> ;
Input Parameter
NAME (Required) Types the name of the user that you want to delete.
Data type: String
Default value: None
Instance count: 1
Output Parameter

Data type: String
Instance count: 1-1
5-6

Chapter 5 D
Example
To delete a user with the name user 1, type the following command:
DEL USER:NAME="user 1";
5-7

5-8

Chapter 6
E
Table of Contents
EXEC DIRECTORY MONITOR ..................................................................................6-1
EXPORT COMMAND LOG ........................................................................................6-2
EXPORT SECURITY LOG .........................................................................................6-4
EXPORT SYSTEM LOG ............................................................................................6-6
EXPORTCMDLOG.....................................................................................................6-9
6.1 EXEC DIRECTORY MONITOR

Function
This command is used to run a directory monitoring task.
Syntax
EXEC DIRECTORY MONITOR: TASKNAME= < TASKNAME> ;
Input Parameter
TASKNAME (Required) Types the name of the directory monitoring task that you want
to run.
Data type: String
Default value: None
Instance count: 1-1
Output Parameter
RESULT Returns the running result of the directory monitoring task.

Data type: String
Instance count: 1-1
Example
To run a directory monitoring task with the name 0, type the following command:
EXEC DIRECTORY MONITOR:TASKNAME=0;
6-1

6.2 EXPORT COMMAND LOG

Function
This command is used to export operation logs.
Syntax
EXPORT COMMAND LOG: FILEPATH= < FILEPATH> [ , USERNAME= < USERNAME>
] [ , IP= < IP> ] [ , LOGSTARTDATE_FROM= < LOGSTARTDATE_FROM> ] [ , LOGSTAR
TDATE_TO= < LOGSTARTDATE_TO> ] [ , CMDCODE= < CMDCODE> ] [ , CONMODE=
< CONMODE> ] [ , ISSUCCESS= < ISSUCCESS> ] [ , LOGRANK= < LOGRANK> ] [ , FILE
TYPE= < FILETYPE> ] [ , COUNT= < COUNT> ] ;
Input Parameter
USERNAME (Optional) Types the name of the user who performs the operation.
Data type: String
Default value: None
IP (Optional) Sets the IP address of the host.

Value type: String
Default value: None
LOGSTART- (Optional) Sets the operation start time range (from).

DATE_FROM Data type: Date
Default value: None
Instance count: 1-1
LOGSTARTDATE_TO (Optional) Sets the operation start time range (to).

Data type: Date
Default value: None
Instance count: 1-1
CMDCODE (Optional) Sets the command code.

Data type: String
Default value: None
CONMODE (Optional) Sets the connection mode.

Default value: None
Instance count: 1-4
6-2

Chapter 6 E
ISSUCCESS (Optional) Sets the operation result.

Default value: None
Instance count: 1-3
LOGRANK (Optional) Sets the log rank.

Default value: None
Instance count: 1-4
FILEPATH (Required) Sets the log file path.

Data type: String
Default value: None
Instance count: 1-1
FILETYPE (Optional) Sets the log file path.

Default value: 4
Instance count: 1-1
COUNT (Optional) Sets the number of records you want to export from the
operation log.
Data type: Integer
Default value: 10000
Instance count: 1-1
Output Parameter
FILES Returns the name of the file where the log records are exported.
Data type: String
CONMODE GUI Graphical user interface
TELNET TELNET
SSH Secure shell
NDA North access
ERT Embedded remote terminal
6-3

ISSUCCESS 0 Succeeded
1 Failed
2 Not finished
LOGRANK 1 Very important
2 Important
3 Notice
4 Normal
FILETYPE EXCEL XLS file
TXT TXT file
HTM HTM file
PDF PDF file
CSV CSV file
XML XML file
Example
EXPORT COMMAND LOG:
USERNAME="a",IP="10.75.64.44",LOGSTARTDATE_FROM="2009-12-23
16:22:31",LOGSTARTDATE_TO="2009-12-24
16:22:31",CMDCODE="1012",CONMODE="GUI",ISSUCCESS="0",LOGRANK="1",FILEPATH="/f
Note:
l By default, this command exports 10000 log records if you do not set the value of
COUNT.
l The exporting operation must be done on the server. Therefore, the FILEPATH must
be set with a path that you have the written authority on the server.
6.3 EXPORT SECURITY LOG

Function
This command is used to export security logs.
Syntax
EXPORT SECURITY LOG: FILEPATH= < FILEPATH> [ , USERNAME= < USERNAME>
] [ , IP= < IP> ] [ , LOGSTARTDATE_FROM= < LOGSTARTDATE_FROM> ] [ ,
6-4

Chapter 6 E
LOGSTARTDATE_TO< LOGSTARTDATE_TO> ] [ , CONMODE= < CONMODE> ] [ ,

FILETYPE= < FILETYPE> ] [ , COUNT= < COUNT> ] ;
Input Parameters
USERNAME (Optional) Types the name of the user who performs the operation.
Data type: String
Default value: None
IP (Optional) Sets the host IP address.

Data type: String
Default value: None
LOGSTARTDATE_FR (Optional) Sets the operation start time range (from).

OM Data type: Date
Default value: None
Instance count: 1-1

Data type: Date
Default value: None
Instance count: 1-1
CONMODE (Optional) Sets the connection mode.

Default value: None
Instance count: 1-4

Data type: String
Default value: None
Instance count: 1-1

Default value: 4
Instance count: 1-1
operation log.
Data type: Integer
Instance count: 1-1
6-5

Output Parameter
Data type: String
CONMODE GUI Graphical user interface
TELNET TELNET
SSH Secure shell
NDA North access
TXT TXT file
HTM HTM file
PDF PDF file
CSV CSV file
XML XML file
Remarks
l The system runs this command to export 10000 log records by default if no value is
set to COUNT.
be set with a path on the server that you have been granted with the written permission.
Example
EXPORT SECURITY LOG: USERNAME= "a", IP= "10.75.64.44",
LOGSTARTDATE_FROM= "2009-12-24 16:40:36", LOGSTARTDATE_TO=
"2009-12-25 16:40:37", CONMODE = "TELNET", FILEPATH= "/filePath",
FILETYPE= CSV, COUNT= 10000;
6.4 EXPORT SYSTEM LOG

Function
This command is used to export security logs.
6-6

Chapter 6 E
Syntax
EXPORT SYSTEM LOG: FILEPATH= < FILEPATH> [ , IP= < IP> ] [ ,
LOGSTARTDATE_FROM< LOGSTARTDATE_FROM> ] [ , LOGSTARTDATE_TO<
LOGSTARTDATE_TO> ] [ , LOGRANK= < LOGRANK> ] [ , LOGSOURCE= <
LOGSOURCE> ] [ , TASKNAME= < TASKNAME> ] [ , FILETYPE= < FILETYPE> ] [ ,
COUNT= < COUNT> ] ;
Input Parameter
IP (Optional) Sets the host IP address.

Data type: String
Default value: None
LOGRANK (Optional) Sets the log rank.

Default value: None
Instance count: 1-6
LOGSTARTDATE_FR (Optional) Sets the operation start time range (from).

OM Data type: Date
Default value: None
Instance count: 1-1

Data type: Date
Default value: None
Instance count: 1-1
LOGSOURCE (Optional) Sets the log source.

Data type: String
Default value: None
TASKNAME (Optional) Sets the task name.

Data type: String
Default value: None

Data type: String
Default value: None
Instance count: 1-1
6-7


Default value: 4
Instance count: 1-1
operation log.
Data type: Integer
Instance count: 1-1
Output Parameter
Data type: String
LOGRANK 1-EMERGENCY Emergency
2-ALERT Alert
3-ERROR Error
4-WARNING Warning
5-NOTIFICATION Notification
6-INFORMATION Information
TXT TXT file
HTM HTM file
PDF PDF file
CSV CSV file
XML XML file
Remarks
l The system runs this command to export 10000 log records by default if no value is
set to COUNT.
be set with a path on the server that you have been granted with the written permission.
6-8

Chapter 6 E
Example
EXPORT SYSTEM LOG: IP="10.75.64.44", LOGRANK="6",
LOGSTARTDATE_TO="2009-12-24 16:41:13", ENDTIME="2009-12-25
16:41:13", LOGSOURCE="logmodule", TASKNAME="aa"&"bb",
FILEPATH="/filePath", FILETYPE=CSV, COUNT=10000;
6.5 EXPORTCMDLOG
Function
This command is used to export operation logs from an Access Managed Object (AMO),
that is, an NE agent.
Syntax
EXPORTCMDLOG: [ AMONAME= < AMONAME> ] [ , STARTTIME= < STARTTIME> ] [ ,
ENDTIME= < ENDTIME> ] [ , FTPADDRESS= < FTPADDRESS> ] ;
Input Parameters
AMONAME (Optional) Specifies the name of the AMO.

Data type: String
Default value: None
STARTTIME (Optional) Sets the start time of the period for exporting the operation logs
during this period.
Data type: Date
Default value: None
Instance count: 1-1
ENDTIME (Optional) Sets the end time of the period for exporting the operation logs
during this period.
Data type: Date
Default value: None
Instance count: 1-1
FTPADDRESS (Optional) Specifies the FTP address.

Data type: String
Default value: None
Instance count: 1-1
6-9

Output Parameter
RESULT Returns the export result of operation logs.

Data type: String
Instance count: 1-1
Example
To export the operation logs from an AMO (10.61.97.10), type the following command:
EXPORTCMDLOG:AMONAME="10.61.97.10",STARTTIME="2010-04-16 11:35:56
",ENDTIME="2010-04-17 11:35:56",FTPADDRESS="ftp://username:passwo
rd@10.61.97.242:21111";
6-10

Chapter 7
G
Table of Contents
GETCBCREPORTS ...................................................................................................7-1
GET COUNTER .........................................................................................................7-2
GET INDEXLIST ........................................................................................................7-4
GET LTEFDDNAFCMFILE .........................................................................................7-7
GET MEASOBJ..........................................................................................................7-8
GET MEASOBJTYPE ................................................................................................7-9
GET MEASTASKLIST ..............................................................................................7-11
GET MEASTYPE .....................................................................................................7-13
GET NAFCMFILE ....................................................................................................7-14
GETNAFOPTIMIZE..................................................................................................7-14
GETNAFOPTIMIZEV4 .............................................................................................7-15
GET NAFPMFILEINTEGRALITY..............................................................................7-16
GET NELOC ............................................................................................................7-17
GET QOSTASKLIST ................................................................................................7-18
GET TYPELIST........................................................................................................7-20
7.1 GETCBCREPORTS
Function
This command is used to generate a Cell Broadcast Center (CBC) report.
Syntax
GETCBCREPORTS: AMONAME= < AMONAME> , TYPE= < TYPE> , FILETYPE= < FILE
TYPE> [ , RESERVED= < RESERVED> ] ;
Input Parameters
AMONAME (Required) Specifies the name of the Access Managed Object (AMO) from
which the CBC report needs to be exported.
Data type: String
Default value: None
Instance count: 1-1
7-1

TYPE (Required) Specifies the status of short messages to be exported.

Data type: String
Default value: None
Instance count: 1-1
FILETYPE (Required) Specifies the file format of the exported report.

Data type: String
Default value: none
Instance count: 1-1
RESERVED (Optional) Reserved field

Data type: String
Default value: None
Instance count: 1-1
Output Parameters
RESULT Returns the export result.

Data type: String
DETAIL Shows the export information.

Data type: String
Example
To export short messages to a CBC report, type the following command:
GETCBCREPORTS:AMONAME="0",TYPE="0",FILETYPE="0",RESERVED="0";
7.2 GET COUNTER

Function
This command is used to get the list of counters of a specific measured object type or
measurement type.
Syntax
GET COUNTER: [ NETYPENAME= < NETYPENAME >] ;
7-2

Chapter 7 G
Input Parameters
NETYPENAME (Required) Specifies the NE type for listing all counters of this NE type.
Data type: String
Default value: None
Instance count: 1-1
MEASOBJTYPEID Specifies the measured object type for listing all counters of this MO type.
Data type: String
Default value: None
Instance count: 1-1
MEASTYPEID Specifies the measurement type for listing all counters of this measurement
type.
Data type: String
Default value: None
Instance count: 1-1
Output Parameters
DETAIL Returns the counter list, including count ID, counter name, measurement
type ID, measurement type name, measured object type ID, and measured
object type name.
Data type: Complex
COUNTERID Returns the counter ID.

Data type: String
Instance count: 1
COUNTERNAME Returns the counters name.

Data type: String
Instance count: 1-1
MEASTYPEID Returns the measurement type ID.

Data type: String
Instance count: 1-1
MEASTYPENAME Returns the name of the measurement type.

Data type: String
Instance count: 1-1
7-3

MEASOBJTYPEID Returns the ID of the measured object.

Data type: String
Instance count: 1-1
MEASOBJTYPENAME Returns the name of the measured object.

Data type: String
Instance count: 1-1
Remarks
l The parameters MEASOBJTYPEID and MEASTYPEID are mutually exclusive. That
means you can only set one of the two parameters in the command.
Examples
l To get the list of all counters of the NE CG, with the CG load as its measurement
type (object id = cn.wcn.cs.50550), type the following command:
GET COUNTER: NETYPENAME= cg, MEASOBJTYPEID= cn.wcn.cs.50500;
l To get the list of counters subject to the current RNC type (MEASOBJTYPEID=8),
type the command as follows:
GET COUNTER: NETYPENAME= cg, MEASOBJTYPEID = 8;
l To get the list of counters subject to the current PVC cell type
(MEASOBJTYPEID=32010), type the command as follows:
GET COUNTER: NETYPENAME= cg, MEASTYPEID=32010;
7.3 GET INDEXLIST

Function
This command is used to get the list of performance indexes.
Syntax
GET INDEXLIST: [ NETYPENAME= < NETYPENAME> ] [ , MEASOBJTYPEID= < MEAS
OBJTYPEID> ] [ , ISSYS= < ISSYS> ] [ , ISKPI= < ISKPI> ] [ , VALUETYPE= < VALUETYPE>
];
7-4

Chapter 7 G
Input Parameters
NETYPENAME (Required) Specifies the type of NE whose performance index list is

needed.
Data type: String
Default value: None
Instance count: 1-1
MEASOBJTYPEID (Optional) Specifies the type of measured object whose performance

index list is needed.
Data type: String
Default value: None
Instance count: 1-1
ISSYS (Optional) Selects the attribute of indexes you want to view: user-defined
indexes or default indexes provided by the system.
Default value: None
Instance count: 1
ISKPI (Optional) Selects the type of indexes you want to view: Key Performance
Index (KPI), Performance Index (PI), or Statistical Performance Index (SPI).
Default value: None
Instance count: 1-1
VALUETYPE (Optional) Selects the value type of indexes you want to view: integer,
float, percent, boolean (true/false), or statistic (1/0).
Default value: None
Instance count: 1-1
Output Parameter
DETAIL Shows the list of performance indexes, including index ID, index name, NE
type, measured object type ID, measured object type name, and index
attributes.
Data type: Complex
INDEXID Shows the index ID.

Data type: String
Instance count: 1
7-5

INDEXNAME Shows the index name.

Data type: String
Instance count: 1-1
NETYPE Shows the NE type.

Data type: String
Instance count: 1
MEASOBJTYPEID Shows the ID of measured object type.

Data type: String
Instance count: 1-1
MEASOBJTYPENAME Shows the name of measured object type.

Data type: String
Instance count: 1-1
ISSYS Shows the attribute of the index.

Instance count: 1-1
ISKPI Shows the index type.

Instance count: 1-1
VALUETYPE Shows the value type of the index.

Instance count: 1-1
ISSYS USER User-defined index
SYS Predefined index in the system
ISKPI KPI Key performance index
PI Performance index
SPI Statistical performance index
FLOAT Floating point
PERCENT Percentage
BOOLEAN Boolean (True/False)
STATISTIC Statistic (1/0)
7-6

Chapter 7 G
Examples
l To get the list of performance indexes subject to RNC NE type (NETYPEID= CG),
GET INDEXLIST: NETYPENAME="CG";
l To get the list of performance indexes subject to RNC type (MEASOBJTYPEID= 8),
GET INDEXLIST: NETYPENAME="CG", MEASOBJTYPEID=8;
l To get the list of all current KPIs, type the command as follows:
GET INDEXLIST: NETYPENAME="CG", ISKPI=TRUE;
l To get the list of performance indexes whose value type is percent, type the command
as follows:
GET INDEXLIST: NETYPENAME="CG", VALUETYPE=PERCENT;
7.4 GET LTEFDDNAFCMFILE

Function
This command is used to get the configuration information of all managed LTE FDD
elements from corresponding Operation & Maintenance Modules (OMMs).
Syntax
GET LTEFDDNAFCMFILE: TYPE= < TYPE> , TIMEOUT= < TIMEOUT> [ , OMM= < OM
M> ] ;
Input Parameters
TYPE (Required) Specifies the type of LTE network elements.

Data type: String
Default value: All
Instance count: 1-1
TIMEOUT (Required) Specifies the timeout.

Data type: Integer
Default value: None
Instance count: 1-1
7-7

OMM (Optional) Specifies the OMM.

Data type: String
Default value: All
Instance count: 1-1
Output Parameters
RESULT Returns the result of the command.

Data type: String
DETAIL Returns the configuration information of the specified elements.

Data type: String
Example
To get the configuration information of all LTE FDD network elements, type the following
command:
GET LTEFDDNAFCMFILE:TYPE="ALL",TIMEOUT=0,OMM="ALL";
7.5 GET MEASOBJ

Function
This command is used to get the list of measured objects.
Syntax
GET MEASOBJ: NELOC= < NELOC> , MEASOBJTYPEID= < MEASOBJTYPEID> ;
Input Parameters
NELOC (Required) Specifies the location of the NE whose measure objects are
needed.
Data type: String
Default value: None
Instance count: 1-1
7-8

Chapter 7 G
MEASOBJTYPEID Specifies the type of the measured objects you want to view.
Data type: String
Default value: None
Instance count: 1-1
MEASTYPEID Specifies the measurement type of the measured objects you want to view.
Data type: String
Default value: None
Instance count: 1-1
Output Parameter
RESULT Returns the measured objects list as required.

Value type: String
Remarks
The parameters MEASOBJTYPEID and MEASTYPEID are mutually exclusive. That
means you can only set one of the two parameters in the command.
Examples
l To get the list of measured objects of the RNC type (measure object type ID=8) of an
RNC managed element (NE location=100001), type the command as follows:
GET MEASOBJ:NELOC="100001",MEASOBJTYPEID=8;
l To get the list of measured objects of the RNC traffic statistics type (measurement type
ID=30116) of an RNC managed element (NE location=100001), type the command
as follows:
GET MEASOBJ:NELOC="100001",MEASTYPEID=30116;
7.6 GET MEASOBJTYPE

Function
This command is used to get the list of measurement object types of a specific NE type.
Syntax
GET MEASOBJTYPE: [ NETYPENAME= < NETYPENAME >] ;
7-9

Input Parameter
NETYPENAME (Optional) Specifies the type of the NE whose measured object types are
needed.
Data type: String
Default value: None
Instance count: 1-1
Output Parameter
DETAIL Returns the list of required measured object types, including the ID, name
of the measured object type, and the ID and name of the NE type.
Data type: Complex
MEASOBJTYPEID The ID of the measured objects.

Data type: String
Instance count: 1-1
MEASOBJTYPENAME The name of the measured objects.

Data type: String
Instance count: 1-1
NETYPEID The ID of the NE type.

Data type: String
Instance count: 1
NETYPENAME The name of the NE type.

Data type: String
Instance count: 1-1
Examples
l To get the list of measured object types subject to the RNC NE type
(NETYPEID=rncMeasureElement), type the following command:
GET MEASOBJTYPE:NETYPENAME="rncManagedElement";
l To get the list of measurement object types subject to all NE types, type the following
command:
GET MEASOBJTYPE;
7-10

Chapter 7 G
7.7 GET MEASTASKLIST

Function
This command is used to get the information list of all measurement tasks in a specific NE.
Syntax
GET MEASTASKLIST: [ NELOC= < NELOC> ] [ ;
Input Parameter
NELOC (Required) Specifies the location of the NE for viewing the information
of all measurement tasks in the NE. Wildcard characters can be used
to specify the NE location.
Data type: String
Default value: None
Output Parameter
DETAIL Returns the list of required measurement tasks, including task ID, task
name, node ID, creator, creation time, modification time, task status, NE
type ID, granularity, begin date, end date, running date and running time.
Data type: Complex
TASKID Shows the ID of each task.

Data type: Integer
Instance count: 1-1
TASKNAME Shows the name of each task.

Data type: String
Instance count: 1-1
NODEID Shows the ID of the server where each task is created.

Value type: String
Instance count: 1-1
CREATOR Shows the creator of each task.

Data type: String
Instance count: 1-1
CREATETIME Shows the time when each task was created.

Data type: String
Instance count: 1-1
7-11

MODIFYTIME Shows the time when each task has been modified.
Data type: String
Instance count: 1-1
STATUS Shows the status of each task.

Instance count: 1-1
NETYPEID Shows the type of the NE involved in each task.

Data type: String
Instance count: 1-1
GRAN Shows the data collection granularity of each task.

Data type: String
Instance count: 1-1
BEGINDATE Shows the start time of each task.

Data type: String
Instance count: 1-1
ENDDATE Shows the end time of each task.

Data type: String
Instance count: 1-1
DATEMASK Shows the running date of each task.

Data type: String
Instance count: 1-1
TIMEMASK Shows the running time period of each task.

Data type: String
Instance count: 1-1
Remarks
The GET NELOC command can be used to obtain the NE location, which is required in
the GET MEASTASKLIST command for querying measurement tasks in the NE.
Example
To query all measurement tasks of the node with subnetwork ID 100 and NE ID 101 under
Server 100001, type the following command:
GET MEASTASKLIST:NELOC="100001$100$101";
7-12

Chapter 7 G
7.8 GET MEASTYPE

Function
This command is used to get the list of measurement types of a specific measurement
object type.
Syntax
GET MEASTYPE: NETYPENAME= < NETYPENAME> [ , MEASOBJTYPEID= MEASOBJ
TYPEID] ;
Input Parameters
NETYPEID (Required) Specifies the type of NE whose measurement types are needed.
Data type: String
Default value: None
Instance count: 1-1
MEASOBJTYPEID (Optional) Specifies the ID of measured object type to which the

measurement types relate.
Data type: String
Default value: None
Instance count: 1-1
Output Parameter
DETAIL Returns the list of required measurement types, including the ID and name
of measurement type, and the ID and name of the measured object type.
Data type: Complex
Examples
l To get the measurement type list subject to the MscServer output ticket type
(measured object id = cn.wcn.cs.50501) of the NE CG, type the following
commands:
GET MEASTYPE:NETYPENAME=cg,MEASOBJTYPEID=cn.wcn.cs.50501;
l To get the list of measurement types subject to all measurement object types of current
application, type the command as follows:
GET MEASTYPE:NETYPENAME=cg;
7-13

7.9 GET NAFCMFILE

Function
This command is used to collect radio data and equipment data from the EMS through
northbound interfaces.
Syntax
GET NAFCMFILE: TYPE= < TYPE> , TIMEOUT= < TIMEOUT> ;
Input Parameters
TYPE (Required) Specifies the types of data to be collected, such as radio data,
equipment data, or all data.
Data type: String
Default value: All
Instance count: 1-1
TIMEOUT (Required) Specifies the collection timeout.

Data type: Integer
Default value: 10
Instance count: 1-1
Output Parameters
RESULT Returns the result of the command.

Data type: String
EXCEPTION Shows the exception occurring during the execution of the command.
Data type: String
Example
GET NAFCMFILE:TYPE="All",TIMEOUT=10;
7.10 GETNAFOPTIMIZE
Function
This command is used to export radio parameters from lower-level GSM Operation and
Maintenance Center (V3) managed by the EMS. The exported radio parameters can be
collected by an upper-level network management system through northbound interfaces
for network optimization.
7-14

Chapter 7 G
Syntax
GETNAFOPTIMIZE: TYPE= < TYPE> [ , ATTRIB= < ATTRIB> ] ;
Input Parameters
TYPE (Required) Specifies the type of parameters to be exported.

Data type: String
Default value: None
Instance count: 1-1
ATTRIB (Optional) Specifies the attribute of parameters to be exported.

Data type: String
Default value: None
Instance count: 1-1
Output Parameters
RESULT Returns the execution result of the command.

Data type: String
Instance count: 1-1
DETAIL Shows the details of exported parameters.

Data type: String
Instance count: 1-1
Example
To get the radio parameters from the managed GSM OMCs (V3), type the following
command:
GETNAFOPTIMIZE:TYPE="1",ATTRIB="1";
7.11 GETNAFOPTIMIZEV4
Function
This command is used to export radio parameters from lower-level GSM Operation and
Maintenance Center (V4) managed by the EMS. The exported radio parameters can be
collected by an upper-level network management system through northbound interfaces
for network optimization.
Syntax
GETNAFOPTIMIZEV4: type= < type> [ , attrib= < attrib> ] ;
7-15

Input Parameters
TYPE (Required) Specifies the type of parameters to be exported.

Data type: String
Default value: None
Instance count: 1-1
ATTRIB (Optional) Specifies the attribute of parameters to be exported.

Data type: String
Default value: None
Instance count: 1-1
Output Parameters

Data type: String
Instance count: 1-1
DETAIL Shows the details of exported parameters.

Data type: String
Instance count: 1-1
Example
To get the radio parameters from the managed GSM OMCs (V4), type the following
command:
GETNAFOPTIMIZEV4:TYPE="1",ATTRIB="1";
7.12 GET NAFPMFILEINTEGRALITY

Function
This command is used to check the integrity of NAF performance data file.
Syntax
GET NAFPMFILEINTEGRALITY: APPTYPE= < APPTYPE> , HOUR= < HOUR> ;
7-16

Chapter 7 G
Input Parameters
APPTYPE (Required) Specifies the application type.

Data type: String
Default value: td
HOUR (Required) Specifies the time period (unit: hour) in which the
performance data in the NAF PM file shall be checked. If HOUR=12,
the system will check the integrity of performance data in the NAF
performance data file in the latest 12 hours.
Data type: Integer
Value range: 0-48 hours
Default value: None
Output Parameter

Data type: String
Example
To
GET NAFPMFILEINTEGRALITY:APPTYPE="td",HOUR=12;
7.13 GET NELOC

Function
This command is used to get the location of NEs of an NE type.
Syntax
GET NELOC: [ NETYPENAME= < NETYPENAME >] ;
Input Parameter
NETYPENAME (Optional) Specifies the type of NEs whose location is needed.

Data type: String
Default value: None
Instance count: 1
7-17

Output Parameter
DETAIL Returns the list of required NE location, including the topology ID of NE,
NE name, NE type ID, and NE type name.
Value type: Complex
NETOPODI Shows the OID of the NEs root node.

Value type: String
Instance count: 1-1
NENAME Shows the NE name.

Value type: String
Instance count: 1-1
NETYPEID Shows the ID of the NE type.

Value type: String
Instance count: 1-1
NETYPENAME Shows the name of the NE type.

Value type: String
Instance count: 1-1
Remarks
The character "\" must be added in front of "$" in a batch command file.
Examples
l To get the location list of all NEs, type the following command:
GET NELOC;
l To get the location list of all NEs subject to a certain NE type (NETYPENAME= CG),
type the following command:
GET NELOC:NETYPENAME="CG";
7.14 GET QOSTASKLIST

Function
This command is used to get the information list of all QoS tasks in a specific NE.
Syntax
GET QOSTASKLIST: [ NELOC= < NELOC> ] [ ;
7-18

Chapter 7 G
Input Parameter
NELOC (Required) Specifies the location of the NE for querying all QoS tasks in
the NE. Wildcard characters can be used to specify the NE location.
Data type: String
Default value: None
Output Parameter
DETAIL Returns the list of required QoS tasks, including task ID, task name,
node ID, creator, creation time, modification time, task status, NE type,
granularity, begin date, end date, running date and running time.
Data type: Complex
TASKID Shows the ID of each task.

Data type: Integer
Instance count: 1-1
TASKNAME Shows the name of each task.

Data type: String
Instance count: 1-1
NODEID Shows the ID of the server where each task is created.

Value type: String
Instance count: 1-1
CREATOR Shows the creator of each task.

Data type: String
Instance count: 1-1
CREATETIME Shows the time when each task was created.

Data type: String
Instance count: 1-1
MODIFYTIME Shows the time when each task has been modified.
Data type: String
Instance count: 1-1
STATUS Shows the status of each task.

Value range: ACTIVE, SUSPENSIVE, and FINISH
Instance count: 1-1
7-19

NETYPEID Shows the type of the NE involved in each task.

Data type: String
Instance count: 1-1
GRAN Shows the data collection granularity of each task.

Data type: String
Instance count: 1-1
BEGINDATE Shows the start time of each task.

Data type: String
Instance count: 1-1
ENDDATE Shows the end time of each task.

Data type: String
Instance count: 1-1
DATEMASK Shows the running date of each task.

Data type: String
Instance count: 1-1
TIMEMASK Shows the running time period of each task.

Data type: String
Instance count: 1-1
Remarks
The GET NELOC command can be used to obtain the NE location, which is required in
the GET QOSTASKLIST command for querying QoS tasks in the NE.
Example
To get the list of QoS tasks on server (ID=100001)/subnetwork (ID=100)/NE (ID=101)
and server 100001/subnetwork (ID=300)/NE (ID=300), type the following command:
GET QOSTASKLIST:NELOC="100001$100$101"&"100001$300$300";
7.15 GET TYPELIST

Function
This command is used to get the type parameter list of a specific measured object or
measurement type, including task type, QoS monitoring type, performance data query
mode, and data collection mode.
Syntax
GET TYPELIST: NETYPENAME= < NETYPENAME> , MEASOBJTYPEID= < MEASOBJT
YPEID> ;
7-20

Chapter 7 G
Input Parameters
NETYPENAME (Required) Types the ID of the NE type.

Data type: String
Default value: None
Instance count: 1-1
MEASOBJTYPEID Specifies the ID of the measured object type.

Value type: String
Default value: None
Instance count: 1-1
MEASTYPEID Specifies the ID of the measurement type.

Data type: String
Default value: None
Instance count: 1-1
Output Parameters
DETAIL Shows the details of the type parameters.

Value type: String
Instance count: 1-1
TASKBY Shows the task type, including the number, ID, and name of task types.
Data type: Complex
TASKBYNO Shows the number of the task type.

Data type: String
Instance count: 1-1
TASKBYID Shows the ID of the task type.

Data type: String
Instance count: 1-1
TASKBYNAME Shows the name of the task type.

Data type: String
Instance count: 1-1
MONITOR Shows the QoS monitoring type, including the number, ID, and name of
QoS monitoring types.
Data type: Complex
7-21

MONITORNO Shows the number of the monitoring type.

Data type: String
Instance count: 1-1
MINITORID Shows the ID of the monitoring type.

Data type: String
Instance count: 1-1
MONITORNAME Shows the name of the monitoring type.

Data type: String
Instance count: 1-1
QUERYBY Shows the data query mode, including the number, ID, and name of data
query modes.
Data type: Complex
QUERYBY Shows the number of the query mode.

Data type: String
Instance count: 1-1
QUERYBYNO Shows the ID of the query mode.

Data type: String
Instance count: 1-1
QUERYBYID Shows the name of the query mode.

Data type: String
Instance count: 1-1
GROUPBY Shows the data grouping mode, including the No., ID, and the name of
data grouping modes.
Data type: Complex
GROUPBYNO Shows the number of the grouping mode.

Data type: String
Instance count: 1-1
GROUPBYID Shows the ID of the grouping mode.

Data type: String
Instance count: 1-1
GROUPBYNAME Shows the name of the grouping mode.

Data type: String
Instance count: 1-1
Remarks
The parameters MEASOBJTYPEID and MEASTYPEID are mutually exclusive. That
means you can only set one of these two parameters in the command.
7-22

Chapter 7 G
Examples
l To obtain the list of type parameters corresponding to the object type "108-RNC Type"
of a WCDMA RNC NE, type the command as follows:
GET TYPELIST:NETYPENAME="rncManagedElement",MEASOBJTYPEID=108;
l To obtain the list of type parameters corresponding to the measurement type "35004-Iu
Connection Statistics" of a TDSCDMA RNC NE, type the command as follows:
GET TYPELIST:NETYPENAME="TRncManagedElement",MEASTYPEID=35004;
7-23

7-24

Chapter 8
H
Table of Contents
HELP .........................................................................................................................8-1
8.1 HELP
Function
This command is used to get the help information of a command.
Syntax
HELP : [ CMD= < CMD> ] [ , GROUPNO= < GROUPNO> ] [ , PARANAME= < PARANAME>
];
Input Parameter
CMD (Optional) Types the name of the command you want to know.
Data type: String
Default value: None
Instance count: 1-1
GROUPNO (Optional) Types the group number.

Data type: Integer
Default value: None
Instance count: 1-1
PARANAME (Optional) Types the parameter name.

Data type: String
Default value: None
Instance count: 1-1
8-1

Output Parameters
CMD Shows the command you want to know.

Data type: Complex
DETAILINFO Shows the help information of the command.

Value type: String
Example
To get the help information of the command SET, type the following command:
HELP:CMD=SET;
8-2

Chapter 9
Q
Table of Contents
QUERY BYCOMMONTEMPLATE ..............................................................................9-1
QUERY BYTASK........................................................................................................9-3
QUERY PMDATA .......................................................................................................9-5
9.1 QUERY BYCOMMONTEMPLATE

Function
This command is used to query performance data by common template, and save the
result to a file in the PMQUERY folder under the FTP directory on the server. The files
containing queried results are grouped by login users.
Syntax
QUERY BYCOMMONTEMPLATE: COMMONTEMPLATEID= < COMMONTEMPLATEID
> [ , STARTDATE= < STARTDATE> ] [ , ENDDATE= < ENDDATE> ] [ , SEGMENT= <
SEGMENT> ] [ , FILETYPE= < FILETYPE> ] ;
Input Parameters
COMMONTEM- (Required) Specifies the ID of the common template you want to use for
PLATEID performance data query.
Data type: String
Value range: 0 to 1728
Instance count: 1-1
STARTDATE (Optional) Sets the start date of the period during which the performance
data is required.
Data type: Date
Instance count: 1-1
ENDDATE (Optional) Sets the end date of the period during which the performance
data is required.
Data type: Date
Instance count: 1-1
9-1

FILETYPE (Optional) Sets the file type for the query result.
Default value: CSV
Instance count: 1-1
SEGMENT (Optional) Sets the filter period.

Data type: String
Value range: 0 to 1728
Instance count: 1-1
Output Parameter
FILEPATH Shows the save path of the result file.

Data type: String
Instance count: 1-1
FILETYPE XLS XLS file
HTM HTML file
CSV CSV file
PDF PDF file
XML XML file
Remarks
l This command queries the performance data during the latest day by default.
l The query results, grouped by login user name, are saved in files of specified format
under the FTP\PMQUERY directory on the server.
Examples
l To query performance data according to the common template (ID: 102), which
specifies the following items:
Counter: all counters of the objects and measurement types in the template
Query Period: from 08/01/2011 00:00:00 to 08/31/2011 00:00:00
Filter Period: 08:00:00, 11:00:00; 13:00:00, 16:00:00

9-2

Chapter 9 Q
QUERY BYCOMMONTEMPLATE:COMMONTEMPLATEID="102",STARTDATE="2011-
8-1 00:00:00",ENDDATE="2011-8-31 00:00:00",SEGMENT="08:00:00,1
1:00:00;13:00:00,16:00:00",FILETYPE=HTM;
9.2 QUERY BYTASK

Function
This command is used to query performance data by measurement task, and save the
result to a file in the PMQUERY folder under the FTP directory on the server. The files
containing queried results are grouped by login users.
Syntax
QUERY BYTASK: TASKID= < TASKID> [ , MEASOBJLIST= < MEASOBJLIST> ] [ , COU
NTER= < COUNTER> ] [ , STARTDATE= < STARTDATE> ] [ , ENDDATE= < ENDDATE> ]
[ , FILETYPE= < FILETYPE> ] ;
Input Parameters
TASKID (Required) Specifies the ID of the measurement task you want to use for
performance data query.
Data type: Integer
Instance count: 1-1
COUNTER (Optional) Specifies the counter(s) you want to query.

Data type: Integer
data is required.
Data type: Date
Instance count: 1-1
data is required.
Data type: Date
Instance count: 1-1
Default value: CSV
Instance count: 1-1
9-3

Output Parameter
FILEPATH Shows the save path of the result file.

Data type: String
Instance count: 1-1
HTM HTML file
CSV CSV file
PDF PDF file
XML XML file
Remarks
l The query results, grouped by login user name, are saved in files of specified format
under the FTP\PMQUERY directory on the server.
l This command queries the performance data during the latest day by default.
l The measured objects specified in the measurement task are used by default when
no parameter is specified in this command.
l All counters of the measurement type specified in the measurement task are used by
default when no counter is set in this command.
Examples
l To query performance data according to the default measurement task (ID: 106),
which specifies the following items:
Counter: all counters of the objects and measurement types in the task
QUERY BYTASK:STARTDATE="2008-1-1 00:00:00",ENDDATE="2008-1-31
00:00:00",TASKID=106,FILETYPE=CSV;
l To query performance data according to the default measurement task (ID: 106),
which specifies the following items:
Measured Object: RNC RRM object (ID=100)-cell (ID=9301) and RNC RRM
object (ID=100)-cell (ID=9302)
Counter: Cell AM RLC Packets Sent (ID=301370565) and Cell AM RLC Packets
Received (ID=301370568)
9-4

Chapter 9 Q

QUERY BYTASK:STARTDATE="2008-1-1 00:00:00",ENDDATE="2008-1-31
00:00:00",TASKID=106,MEASOBJLIST="100-9301,100-9302",COUNTER
="301370565"&"301370568",FILETYPE=CSV;
9.3 QUERY PMDATA

Function
This command is used to query performance data by customized conditions, and save the
query result to a file in the PMQUERY folder in the FTP directory on the server. The query
result files are grouped by login user.
Syntax
QUERY PMDATA: MEASOBJTYPEID= < MEASOBJTYPEID> , QUERYITEMLIST= < QU
ERYITEMTYPE> - < QUERYITEMID> [ - < FILTEROPERATOR> ] [ - < FILTERVALUE> ] [
, FILTERTYPE= < FILTERTYPE> ] [ , TOPNBYTYPE= < TOPNBYTYPE> ] [ , QUERYB
YTYPE= < QUERYBYTYPE> ] [ , MEASOBJMOI= < NELOC> [ - < MEASOBJLIST> ] ] [ ,
GROUPBYTYPE= < GROUPBYTYPE> ] [ , STARTDATE= < STARTDATE> ] [ , ENDDATE=
< ENDDATE> ] [ , SEGMENT= < SEGMENT> ] [ , QUERYGRAN= < QUERYGRAN> ] [ ,
FILETYPE= < FILETYPE> ] ;
Input Parameters
MEASOBJTYPEID (Required) Specifies the type ID of measured objects you want to query.
Data type: String
Default value: None
Instance count: 1-1
QUERYITEMLIST (Required) Specifies the item you want to query, including the item type,
item ID, filter operator, and filter value.
Data type: Complex
Default value: None
QUERYITEMTYPE (Required) Specifies the type of the item.

Default value: COUNTER
Instance count: 1-1
9-5

QUERYITEMID (Required) Specifies the ID of the item.

Data type: String
Default value: None
Instance count: 1-1
FILTEROPERATOR (Optional) Specifies the filter operator.

Default value: None
Instance count: 1-1
FILTERVALUE (Optional) Specifies the value for filtering.

Data type: Float
Default value: None
Instance count: 1-1
FILTERTYPE (Optional) Sets the filtering type for performance data query.
Default value: AND
Instance count: 1-1
TOPNBYTYPE (Optional) Sets the Top N sorting mode of the query result.
Default value: NONE
Instance count: 1-1
QUERYBYTYPE (Optional) Specifies the query type.

Data type: String
Default value: None
Instance count: 1-1
MEASOBJMOI (Required) Specifies the MOI of the measured objects you want to query,
including the NE location and measured object list.
Data type: Complex
Default value: None
NELOC (Required) Specifies the NE location.

Data type: String
Default value: None
Instance count: 1-1
9-6

Chapter 9 Q
MEASOBJLIST (Optional) Specifies the measured object list. Wildcard characters can be
used to specify the measured object list. If a parent node is selected, all its
child nodes are selected by default.
Data type: String
Default value: None
Instance count: 1-1
GROUPBYTYPE (Optional) Specifies the grouping type of the query result.

Default value: None
Instance count: 1
data is required.
Data type: Date
Default value: None
Instance count: 1
data is required.
Data type: Date
Default value: None
Instance count: 1
SEGMENT (Optional) Sets the time period for filtering the performance data.
Data type: String
Default value: None
Instance count: 1
QUERYGRAN (Optional) Sets the query granularity.

Default value: None
Instance count: 1-1
Default value: CSV
Instance count: 1-1
LOCGROUPLAYER (Optional) Specifies the location group layer.

Data type: String
Default value: None
Instance count: 1-1
9-7

LOCFILTERLEVEL (Optional) Specifies the location filter level.

Default value: None
Instance count: 1-1
Output Parameter
FILEPATH Shows the path of the saved result file.

Data type: String
QUERYITEMTYPE INDEX Index
COUNTER Counter
FILTEROPERATOR GREAT Greater than
GREAT AND EQUAL Greater than or equal to
LESS Less than
LESS AND EQUAL Less than or equal to
EQUAL Equal to
NOT EQUAL Not equal to
TOP MAX Maximum
TOP MIN Minimum
TRUE Equal to true
FALSE Equal to false
BUSY HOUR MAX Maximum in busy hour
BUSY HOUR MIN Minimum in busy hour
FILTERTYPE AND Logical AND
OR Logical OR
TOPN Top N
BUSYHOUR Busy hour
TOPNBYTYPE NONE Top by none
TIME Top by time
OBJECT Top by object
9-8

Chapter 9 Q
GROUPBYTYPE GROUPTYPE_NONE Group by none
GROUPTYPE_MO- Group by MO layer

LAYER
GROUPTYPE_NE Group by NE
GROUPTYPE_NEALL Group by all NEs
GROUPTYPE_MO Group by specific MO
QUERYGRAN 5MIN 5 minutes
15MIN 15 minutes
HOURSUM Hourly summary
DAYSUM Daily summary
WEEKSUM Weekly summary
MONTHSUM Monthly summary
ALLHOURSUM User-defined all time summary
ALLDAYSUM User-defined all date summary
TIMESECTSUM 24hour group
HTM HTML file
CSV CSV file
PDF PDF file
XML XML file
LOCFILTERLEVEL FILTERTYPE_ALL All NEs
FILTERTYPE_NE- NE group
GROUP
FILTERTYPE_NE NE
FILTER- MO group
TYPE_MOGROUP
FILTERTYPE_MO MO
Remarks
l The query results, grouped by login user name, are saved as files in the specified file
format in the FTP\PMQUERY directory on the server.
l If no optional parameters are set, this command will be run to query the performance
data during the day by default.
l The query result is grouped by original collection object by default.
9-9

l The system queries performance data from all NEs by default according to this
command.
l The query result will not be grouped if TOPN is set as the filter type.
Example
To query the performance data according to the following conditions:
l Measured Object Type: CELL (ID=10)
l Measured Object MOI: server (ID=100001)/ subnetwork (ID=100)/ NE (ID=100), RNC
RRM object (ID=100)-serving cell (ID=9301) and RNC RRM object (ID=100)-serving
cell (ID=9302)
l Query Items: Radio Access Success Rate (KPI ID=30008), Number of Completed
RAB Release (counter ID=301240940), and all counters of the measurement type
Cell UE Quantity Statistics (ID=30138)
l Query Period: from 03/06/2008 00:00:00 to 03/07/2008 00:00:00
l Query Granularity: summarize the performance data by hour
l Filter Segment: "08:00:00-11:00:00 and 13:00:00-16:00:00
l Query Type: query performance data by NE
l Group Type: group the query result by NE
l File Type: save the query result in a CSV file
QUERY PMDATA:MEASOBJTYPEID=10,MEASOBJMOI="100001$100$100"-"100
",QUERYITEMLIST="INDEX"-"30008"--&"COUNTER"-"301240940"--&"MEAS
TYPE"-"30138"--,STARTDATE="2008-3-6 00:00:00",ENDDATE="2008-3-7
00:00:00",QUERYGRAN=HOURSUM,QUERYBYTYPE=BYNE,GROUPBYTYPE=NE,SEGME
NT="08:00:00,11:00:00;13:00:00,16:00:00",FILETYPE=CSV;
9-10

Chapter 10
R
Table of Contents
RUNBATCH .............................................................................................................10-1
RETRIEVE NAFPMDATA .........................................................................................10-7
10.1 RUNBATCH
Function
This command is used to run a batch script.
Syntax
RUNBATCH: FILENAME= < FILENAME> [ , ARGS= < ARGS> ] [ , OUTFILENAME= <
OUTFILENAME> ] , SHOWRESULT= < SHOWRESULT> ;
Input Parameters
FILENAME (Required) Specifies the name of the batch script file (*.txt) you want to run.
Data type: String
Default value: None
ARGS (Optional) Sets the arguments.

Data type: String
Default value: None
OUTFILENAME (Optional) Specifies the name of the output file.

Data type: String
Default value: None
Instance count: 1
10-1

SHOWRESULT (Optional) Sets whether to show the running result on the Upload Message
tab in the client window of the EMS.
Data type: Boolean
Default value: False
Instance count: 1
Output Parameter
Result Shows the running result of the batch script.

Value type: String
Instance count: 1-1
Example
To run a batch script whose name is batch file 1, type the following command:
RUNBATCH:FILENAME="batch file 1",ARGS="1"&"1",OUTFILENAME="1"&"1
",SHOWRESULT=False;
Remarks
Follow the precautions below when using this command:
l Be sure to save the batch script file to be run under the path ...\ums-server\wo
rks\global\runtime\ppus\uca.ppu\uca-mml.pmu\mmlbatchfiles on the
server in advance.
l The FILENAME is the batch script file to be run (corresponding to the "FILENAME="
MML sentence). The format of the file name must be *.txt.
l Enter multiple instances (parameters) for "ARGS=" on the MML sentence. They
correspond to argus[0], argus[1]... in the script according to the input sequence.
l The default name format of the output result file is: <input file name> + "_output" +
<time stamp> + ".txt". The saving path of the result file is displayed in the command
executing result.
The following gives an introduction to the syntax of batch scripts.
l Execute MML Commands
Execute an MML sentence in the format of exec("mml sentence", isReport,
isWrite).
isReport: it is an optional parameter of boolean type, indicating whether to show
the execution result of this MML command and report it to the message page.
isWrite: it is an optional parameter of boolean type, indicating whether to write
the execution result of this MML command to a result file.
For example: to search for a cell, enter exec("get cell;") in the batch script file.
l Global Variables
10-2

Chapter 10 R
The input values of the ARGUS parameter are global variables. Multiple values can
be set for the parameter. When the system calls the batch script, it receives the input
values in the sequence of argus[0], argus[1]....
For example: two values are set for the parameter, corresponding to ARGS=a&b on
the MML sentence. Then the batch script can use the variables argus[0] and argus[1],
whose values are a and b respectively.
l Local Variables
You can define local variables in the batch script. The qualifier is def.
For example, def a=0.
Note:
The prefix "$" is required when a variable (global variable or local variable) is used as
the parameter value in an MML sentence. In other cases, the prefix is unnecessary.
For example:
exec("get cell : rncid = ${argus[0]};")
l If...Else Condition
The batch script supports if..else condition.
For example:
if(argus[0]. equals("1")) { exec("get rnccell: rncid =
${argus[1]};",true,true) } else { exec("get rnccell: rncid =
${argus[2]};",true,true) }
In this sentence, argus[0], argus[1] and argus[2] are three values of the parameter
"ARGS".
l For Loop
The batch script supports for loop.
For example:
for(cellno in argus[1]..argus[2]) { exec("set cell: rncid=${a
rgus[0]}, cellno=$cellno, userlabel=${argus[3]};") }
In this sentence, argus[0], argus[1], argus[2] and argus[3] are four values of the
parameter "ARGS".
l While Loop
The batch script supports while loop.
For example:
def x=1; while(x<argus[0]) { exec ("get cell: rncid=$x;") }
10-3

In this sentence, argus[0] is the value of the parameter "ARGS".

l Transaction Processing
The batch script supports the transaction processing mode. It is required to complete
the following settings in the batch script first:
1. Add Transaction (STARTTRANS)
Be sure to add the start transaction sentence before the commands for enabling
the transaction processing mode, for example, exec("STARTTRANS").
2. Commit Transaction (COMMITTRANS)
Be sure to add the commit transaction sentence at the end of the commands
for executing the commands in the transaction processing mode, for example,
exec("COMMITTRANS").
3. Cancel Transaction (CANCELTRANS)
When the script already runs to process the transaction, one can add the cancel
transaction sentence after the specified command to cancel the transaction
processing mode, for example, exec("CANCELTRANS").
For example, to set the transaction processing mode for a part of commands in the
script, you can modify the script file as follows:
def x=1; exec("STARTTRANS") for(cellno in argus[1]..argus[2])
{ exec("set cell: rncid=${argus[0]}, cellno=$cellno, userlabe
l=${argus[3]};") } exec("COMMITTRANS")
In this script, argus[0], argus[1], argus[2] and argus[3] are four values of the parameter
"ARGS".
l Show the Processing Result
To show the execution result of MML commands in a batch script on the message
page of the MML terminal view, set the SHOWRESULT parameter to TRUE in the
corresponding MML command, or add one of the following sentences in the batch
script file:
exec("getcmdlog;",true)
exec("getcmdlog;",true,false)
l Record the Processing Result
To save the execution result of the MML commands in a batch script, add one of the
following sentences in the batch script file:
exec("getcmdlog;",false,true)
exec("getcmdlog;",true,true)
l Obtain the Execution Result of MML Commands
Any of the commands ADD, GET, BATCHGET, SET, BATCHSET, ACTION, DEL,
and SHOW can be used to get the execution result. A string array is returned (for
example, results[]) after you run exec(). The element with the ID 0 in the array
10-4

Chapter 10 R
(result[0] for example) indicates whether the command is successfully executed.

The value 1 of this element indicates that the system has successfully executed
this command; while the value 0 indicates that the system failed to execute this
command. The other elements (results[1], results[2], ...) are the name/value pairs
of the returned parameters.
When the returned parameters are simple parameters, each parameter occupies
one element in the array. Multiple instances are separated by ",". The format is
as follows:
ParamName=ParamValue1,ParamValue2,ParamValue3
When the returned parameters are complex parameters, multiple virtual
parameters occupy multiple elements in the array. Multiple instances of a virtual
parameter are separated by ",". The format is as follows:
ComplexParamName:VirtualParamName1=Value1,Value2,Value3
The following introduces the methods to get the execution result and parameter value.
getResult(String[] results): add this sentence in the script to get the
execution result. The system returns the result of the integer type. "1" indicates
successful execution; while "0" indicates execution failure.
getParam(String[] results, String paramName): add this sentence
in the script to get the value of a parameter. The system returns the value in the
format of string array.
The following gives an example of how to obtain the execution result. Suppose that
the output parameters of the get test command include:
A (real parameter, string type)
B (real parameter, integer type)
C (complex parameter, including virtual parameter C1 and C2)
C1 (virtual parameter, belongs to C), C2 (virtual parameter, belongs to C)
Then use the following commands to get the desired result:
def results = exec("get test"): gets the total returned result. "results"
is displayed as a string array.
def isSuccess = getResult(results): gets the execution result of the
command. "inSuccess" is a parameter of int data type. "1" indicates successful
execution; while "0" indicates execution failure.
def a = getParam(results, "A"): gets the value of the parameter A. "a"
is a string array, in which each element is an instance. If it only contains one
instance, only a[0] can be obtained. Using "a.size()" can get the instance number
of the parameter.
def b = getParam(results, "B"): gets the value of the parameter B. "a"
is a string array, in which each element is an instance. If it only contains one
instance, only b[0] can be obtained. Using "b.size()" can get the instance number
10-5

of the parameter. To convert the element values of "b" into values of int data type,
use "toInt(b[0])".
def c = getParam(results, "C"): gets the values of all virtual
parameters of the parameter C. "c" is a string array, whose elements include "C1
= Value1, Value2", and "C2 = Value3, Value4, Value5".
def c1 = getParam(c, "C1"): gets the value of the parameter C1. "c1" is
a string array.
def c2 = getParam(c, "C2"): gets the value of the parameter C2. "c2" is
a string array.
l Print Log
debug(String): print the logs of the DEBUG level in the log file.
info(String): print the logs of the INFO level in the log file.
warn(String): print the logs of the WARN level in the log file.
error(String): print the logs of the ERROR level in the log file.
output(String): print the logs to the output file of batch commands.
l Convert the Data Type of Variables
Use toInt(String) in the script to convert a string to an integer value.
Use toFloat(String) in the script to convert a string to a float value.
l Set Timeout Time
Add setTimeout(int) at the first row of the script to set the timeout time of the
script. The script will end if it has not been completed when the set time is up.
The default time for the timeout of a script is one hour.
l Comment
The script supports the same format of comments used in Java.

Single-line comment: starts at a "//".
Multiline comment: included between "/*" and "*/".
l Script Keywords
In batch scripts, it is required to add the escape character "\" before the characters in
MML sentences, which are the same as the keywords defined for the scripts, such as
" and $. For example,
exec("ADD MEASTASK:MEASTYPEID=30105,MEASOBJMOI=\"100001\$1000
\$1000\",STATUS=ACTIVE, GRAN=15MIN,DATEMASK=\"1111111111111111
111111111111111\", TIMEMASK=\"00:00:00,24:00:00\";");
10-6

Chapter 10 R
10.2 RETRIEVE NAFPMDATA

Function
This command is used to retrieve performance data through northbound interfaces.
Syntax
RETRIEVE NAFPMDATA: JOBID= < JOBID> , STARTTIME= < STARTTIME> , ENDTIM
E= < ENDTIME> [ , MOINSTANCELIST= < MOINSTANCELIST> ] ;
Input Parameters
JOBID (Required) Specifies the ID of the performance data collection task to be

run.
Data type: String
Default value: None
STARTTIME (Required) Sets the start time of the period during which the performance
data is required.
Data type: Date
Default value: None
ENDTIME (Required) Sets the end time of the period during which the performance
data is required.
Data type: Date
Default value: None
MOINSTANCELIST (Optional) Specifies the NE list.

Data type: String
Default value: None
Output Parameter
Result Shows the retrieving result

Value type: String
Instance count: 1-1
Remarks
l Multiple data retrieving task IDs can be specified in JOBID, which are separated by
;. The wildcard level of all tasks specified in this parameter must be All. Or none
of the tasks specified in this parameter has the wildcard level of All.
10-7

l MOINSTANCELIST is only valid when all tasks specified by JOBID have the wildcard
level of All. It indicates the NEs whose performance data needs to be retrieved. This
parameter must be set to null when the wildcard level of tasks specified by JOBID is
not All. One or more NEs at the RncFunction level can be specified in MOINSTAN
CELIST, which are separated by ;.
Example
To retrieve performance data through northbound interfaces, type the following command:
RETRIEVE NAFPMDATA:JOBID="101",STARTTIME="2010-11-18 14:00:01",EN
DTIME="2010-11-18 15:00:01",MOINSTANCELIST="DC=www.zte.com.cn,Sub
Network=ZTE_UTRAN_SYSTEM,SubNetwork=trns1234,ManagedElement=RNCME
1234,RncFunction=1234";
10-8

Chapter 11
S
Table of Contents
SET..........................................................................................................................11-2
SET AMO.................................................................................................................11-5
SET CURRENT USER INFORMATION....................................................................11-5
SET DANEROURSCMD MODE ...............................................................................11-7
SET DEPARTMENT .................................................................................................11-8
SET INDEX ..............................................................................................................11-9
SET MEASTASK .................................................................................................... 11-13
SET MEASTASKSTATUS....................................................................................... 11-15
SET NMDBUSER................................................................................................... 11-16
SET NMFTPUSER ................................................................................................. 11-17
SET PASSWORD................................................................................................... 11-18
SET PERIODIC TASK ............................................................................................ 11-19
SET QOSTASK ...................................................................................................... 11-21
SET QOSTASKSTATUS......................................................................................... 11-26
SET TIMING TASK................................................................................................. 11-27
SET USER ............................................................................................................. 11-31
SET USER RIGHT ................................................................................................. 11-33
SET USER STATE ................................................................................................. 11-34
SET USER VIEW LOG RANGE ............................................................................. 11-35
SHOW ALARM DETAIL.......................................................................................... 11-36
SHOW ALL ROLES................................................................................................ 11-37
SHOW ALL ROLE SETS........................................................................................ 11-38
SHOW ALL SESSIONS.......................................................................................... 11-39
SHOW ALL TASK................................................................................................... 11-40
SHOW ALL USERS ............................................................................................... 11-42
SHOW AMO........................................................................................................... 11-43
SHOW COMMAND LOG........................................................................................ 11-43
SHOW CPU RATIO................................................................................................ 11-47
SHOW CURRENT ALARM..................................................................................... 11-47
SHOW DB RATIO .................................................................................................. 11-51
SHOW DEPARTMENT........................................................................................... 11-52
SHOW DIRECTORY MONITOR TASK NAME........................................................ 11-53
SHOW HD USAGE ................................................................................................ 11-54
SHOW HISTORY ALARM ...................................................................................... 11-55
SHOW INDEX ........................................................................................................ 11-60
SHOW MEASTASK................................................................................................ 11-60
SHOW NETWORK DATA ....................................................................................... 11-63
11-1

SHOW NETWORK PORT ...................................................................................... 11-64

SHOW NMDBUSER............................................................................................... 11-65
SHOW NMFTPUSER ............................................................................................. 11-65
SHOW QOSTASK .................................................................................................. 11-66
SHOW RAM USAGE.............................................................................................. 11-70
SHOW ROLE ......................................................................................................... 11-70
SHOW ROLE SET ................................................................................................. 11-71
SHOW SECURITY LOG......................................................................................... 11-72
SHOW SYSTEM LOG ............................................................................................ 11-75
SHOW USER ......................................................................................................... 11-76
SYNCH MEASTASK .............................................................................................. 11-78
11.1 SET
Function
This command is used to set environment variables.
Syntax
SET: [ REQUESTTIMEOUT= < REQUESTTIMEOUT> ] [ , SESSIONTIMEOUT= < SESSION
TIMEOUT> ] [ , CONNECTTIMEOUT= < CONNECTTIMEOUT> ] [ , FORMAT= < FORMAT>
] [ , WAITRESTIMEOUT= < WAITRESTIMEOUT> ] [ , NEID= < NEID> ] ;
Input Parameters
REQUESTTIMEOUT (Optional) Sets the request timeout limit (unit: 10s).

Data type: Integer
Value range: 1-360
Default value: None
Instance count: 1
SESSIONTIMEOUT (Optional) Sets the session timeout limit (unit: 10s).

Data type: Integer
Default value: None
Instance count: 1
CONNECTTIMEOUT (Optional) Sets the connection timeout limit (unit: 10s).

Data type: Integer
Value range: 12-720
Default value: None
Instance count: 1
11-2

Chapter 11 S
FORMAT (Optional) Sets the output format.

Default value: None
Instance count: 1-1
WAITRESTIMEOUT (Optional) Sets the resource waiting timeout limit (unit: 10s).
Data type: Integer
Value range: 1-60
Default value: None
Instance count: 1
TELNETBYPAGE (Optional) Enables telnet by page or not.

Default value: None
Instance count: 1-1
NEID (Optional) Specifies the ID of the NE you want to set.

Data type: Integer
Value range: 0-255
Default value: None
Instance count: 1
Output Parameters
REQUESTTIMEOUT Shows the request timeout (unit: 10 seconds).

Value type: Integer
Instance count: 1-1
SESSIONTIMEOUT Shows the session timeout (unit: 10 seconds).

Value type: Integer
Instance count: 1-1
CONNECTTIMEOUT Shows the connection timeout (unit: 10 seconds).

Data type: Integer
Instance count: 1-1
FORMAT Shows the output format.

Instance count: 1-1
WAITRESTIMEOUT Shows the resource waiting timeout (unit: 10 seconds).

Data type: Integer
Instance count: 1-1
TELNETBYPAGE Shows the status of telnet by page.

Instance count: 1-1
11-3

NEID Shows the NE ID.

Data type: Integer
Instance count: 1
RUNTIME Shows the running time.

Data type: Integer
Instance count: 1-1
ERRCODE Shows the error code.

Data type: Integer
Instance count: 1-1
ERRMSG Shows the result information.

Data type: String
Instance count: 1-1
ERRTEXT Shows the result details.

Data type: String
Instance count: 1-1
SYSTIME Shows the system time of the server.

Data type: Date
Instance count: 1-1
FORMAT TBL TBL
ETBL ETBL
UNI UNI
MML MML
HI1 HI1
OP OP
NDFMML NDF MML
FILE FILE
TELNETBYPAGE true Enable
false Disable
Example
To set some environment variables, type the following command:
SET: REQUESTTIMEOUT=1,SESSIONTIMEOUT=30,CONNECTTIMEOUT=12,FORMAT
=MML,WAITRESTIMEOUT=1,NEID=0,TELNETBYPAGE=TRUE;
11-4

Chapter 11 S
11.2 SET AMO

Function
This command is used to connect to an Access Managed Object (AMO) for performing
operations on NEs connected to the EMS via the AMO.
Syntax
SET AMO: [ NAME= < NAME> ] [ , MOI= < MOI> ] ;
Input Parameter
NAME Specifies the name of the AMO you want to connect.

Data type: String
Default value: None
Instance count: 1
MOI Specifies the MOI of the OMM you want to connect.

Data type: String
Default value: None
Instance count: 1
Output Parameter
None
Remarks
The parameters NAME and MOI are mutually exclusive. That means you can only set one
of these two parameters in the command.
Example
To connect the AMO with the name of 1, or with the MOI 1, type the following command:
SET AMO : NAME="1"; Or SET AMO : MOI="1";
11.3 SET CURRENT USER INFORMATION

Function
This command is used to set the information of the current login user.
11-5

Syntax
SET CURRENT USER INFORMATION: [ EMAILADDRESS= < EMAILADDRESS> ] [ , PH
ONENUMBER= < PHONENUMBER> ] [ , OLDPASSWORD= < OLDPASSWORD> ] [ , NEW
PASSWORD= < NEWPASSWORD> ] [ , CONFIRMPASSWORD= < CONFIRMPASSWORD>
];
Input Parameters
EMAILADDRESS (Optional) Sets the E-mail address of the current user.

Data type: String
Default value: None
Instance count: 1-1
PHONENUMBER (Optional) Sets the phone number of the current user.

Data type: String
Default value: None
Instance count: 1-1
OLDPASSWORD (Optional) Types the old password of the current user.

Data type: String
Default value: None
Instance count: 1-1
NEWPASSWORD (Optional) Sets the new password for the current user.
Data type: String
Default value: None
Instance count: 1-1
CONFIRMPASSWORD (Optional) Confirms the new password of the current user.

Data type: String
Default value: None
Instance count: 1-1
Output Parameter
RESULT Shows the setting result.

Value type: String
Instance count: 1-1
11-6

Chapter 11 S
Example
To set the E-mail address, phone number and password of the current login user, type the
following command:
SET CURRENT USER INFORMATION:EMAILADDRESS="somebody@unknown.com
",PHONENUMBER="12345678901",OLDPASSWORD="1",NEWPASSWORD="0",CONFI
RMPASSWORD="0";
11.4 SET DANEROURSCMD MODE

Function
This command is used to set whether a confirmation is required before a command that
may impact the system is executed.
Syntax
SET DANEROURSCMD MODE: [ EXECUTEMODE= < EXECUTEMODE> ] ;
Input Parameter
EXECUTEMODE (Optional) Specifies the execution mode of commands that may impact the
system operation: execute directly, or confirmation required.
Default value: None
Instance count: 1-1
Output Parameter
EXECUTEMODE Shows the execution mode of command that may impact the system.
Instance count: 1-1
EXECUTEMODE CONFIRM Confirmation is required.
EXECUTE Confirmation is not required.
Example
To disable the confirmation before a command that may impact the system is run, type the
following command:
SET DANEROURSCMD MODE:EXECUTEMODE=EXECUTE;
11-7

11.5 SET DEPARTMENT

Function
This command is used to modify the information of a department.
Format
SET DEPARTMENT: NAME= < NAME> [ , DESCRIPTION= < DESCRIPTION> ] [ , SUPE
RDEPART= < SUPERDEPART> ] [ , NEWNAME= < NEWNAME> ] ;
Input Parameters
NAME (Required) Specifies the name of the department you want to modify.
Data type: String
Default value: None
Instance count: 1-1
DESCRIPTION (Optional) Modifies the description of the department.

Data type: String
Default value: None
Instance count: 1
SUPERDEPART (Optional) Changes the superior department of the department.

Data type: String
Default value: None
Instance count: 1
NEWNAME (Optional) Modifies the name of the department.

Value type: String
Default value: None
Instance count: 1-1
Output Parameter
RESULT Shows the modification result.

Data type: String
Instance count: 1-1
11-8

Chapter 11 S
Remarks
For the root department, you can only modify its name. For common departments, you
can only modify its description and superior department.
Example
To modify a common department with the name of 1, type the following command:
SET DEPARTMENT: NAME="1",DESCRIPTION="1",SUPERDEPART="2";
11.6 SET INDEX

Function
This command is used to modify the settings of a user-defined performance index.
Syntax
SET INDEX: INDEXID= < INDEXID> [ , INDEXNAME= < INDEXNAME> ] [ , INDEXDESC=
< INDEXDESC> ] [ , FORMULA= < FORMULA> ] [ , INDEXTYPE= < INDEXTYPE> ] [ ,
DIRECTION= < DIRECTION> ] [ , SETCRITICAL= < SETCRITICAL> ] [ , ALARMCRITIC
AL= < ALARMCRITICAL> ] [ , ALARMCRITICALDELTA= < ALARMCRITICALDELTA> ] [ ,
SETMAJOR= < SETMAJOR> ] [ , ALARMMAJOR= < ALARMMAJOR> ] [ , ALARMMAJO
RDELTA= < ALARMMAJORDELTA> ] [ , SETMINOR= < SETMINOR> ] [ , ALARMMINOR=
< ALARMMINOR> ] [ , ALARMMINORDELTA= < ALARMMINORDELTA> ] [ , SETWARN=
< SETWARN> ] [ , ALARMWARN= < ALARMWARN> ] [ , ALARMWARNDELTA= < ALAR
MWARNDELTA> ] [ , EXCEPTIONVALUE= < EXCEPTIONVALUE> ] ;
Input Parameters
INDEXID (Required) Specifies the ID of the performance index you want to modify.
Data type: String
Default value: None
Instance count: 1-1
INDEXNAME (Optional) Specifies the name of the performance index you want to modify.
Data type: String
Default value: None
Instance count: 1-1
11-9

INDEXDESC (Optional) Changes the description of the performance index.

Data type: String
Default value: None
Instance count: 1
FORMULA (Optional) Modifies the formula of the performance index.

Data type: String
Default value: None
Instance count: 1
DIRECTION (Optional) Changes the direction attribute of threshold crossing alarms

related to the performance index.
Default value: None
Instance count: 1-1
SETCRITICAL (Optional) Enables or disables the setting of threshold and delta for critical
threshold crossing alarm.
Default value: None
Instance count: 1
ALARMCRITICAL (Optional) Modifies the threshold of the performance index for reporting a
critical threshold crossing alarm when the index value is higher or lower
than the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: None
Instance count: 1
ALARMCRITICALDEL (Optional) Modifies the hysteresis value of the threshold to avoid frequent
TA raising and clearing of a critical alarm. A threshold with a delta actually
provides two thresholds: an upper threshold and a lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: None
Instance count: 1-1
SETMAJOR (Optional) Enables or disables the setting of threshold and delta for major
Default value: None
Instance count: 1-1
11-10

Chapter 11 S
ALARMMAJOR (Optional) Modifies the threshold of the performance index for reporting
a major threshold crossing alarm when the index value is higher or lower
than the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: None
Instance count: 1
ALARMMAJORDELTA (Optional) Modifies the hysteresis value for the threshold to avoid frequent
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: None
Instance count: 1-1
SETMINOR (Optional) Enables or disables the setting of threshold and delta for minor
Instance count: 1-1
ALARMMINOR (Optional) Modifies the threshold of the performance index for reporting
a minor threshold crossing alarm when the index value is higher or lower
than the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: None
Instance count: 1
ALARMMINORDELTA (Optional) Modifies the hysteresis value for the threshold to avoid frequent
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: None
Instance count: 1-1
SETWARN (Optional) Enables or disables the setting of threshold and delta for
threshold crossing warning.
Default value: None
Instance count: 1-1
11-11

ALARMWARN (Optional) Modifies the threshold of the performance index for reporting a
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: None
Instance count: 1
ALARMWARNDELTA (Optional) Modifies the hysteresis value for the threshold to avoid frequent
Data type: Float
Value range: 0 to 999999999.999
Default value: None
Instance count: 1-1
EXCEPTIONVALUE (Optional) Modifies the exception value of the performance index, that is,
the calculation result when the denominator of the index formula is zero.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: None
Instance count: 1-1
Output Parameter
RESULT Shows the modification result of the performance index.

Data type: String
Instance count: 1-1



SETCRITICAL Y Yes
N No
11-12

Chapter 11 S
SETMAJOR Y Yes
N No
SETMINOR Y Yes
N No
SETWARN Y Yes
N No
Remarks
Only user-defined performance indexes can be modified.
Example
To modify a user-defined performance index whose ID is 33008, type the following
command:
SET INDEX:INDEXID=33008,SETCRITICAL=Y,ALARMCRITICAL=0.06,ALARMCRI
TICALDELTA=0.01,EXCEPTIONVALUE=1;
11.7 SET MEASTASK

Function
This command is used to modify the information of a suspended measurement task.
Syntax
SET MEASTASK: TASKID= < TASKID> [ , NELOC= < NELOC> ] [ , TASKNAME= < TASK
NAME> ] [ , ENDDATE= < ENDDATE> ] [ , DATEMASK= < DATEMASK> ] [ , TIMEMASK=
< TIMEMASK> ] ;
Input Parameters
TASKID (Required) Specifies the ID of the measurement task you want to modify.
Data type: Integer
Default value: None
Instance count: 1-1
NELOC (Optional) Modifies the NEs involved in the measurement task.

Data type: String
Default value: None
Instance count: 1-1
11-13

TASKNAME (Optional) Modifies the name of the measurement task.

Data type: String
Default value: none
Instance count: 1-1
ENDDATE (Optional) Resets the end time of the measurement task.

Data type: Date
Default value: None
Instance count: 1-1
DATEMASK (Optional) Resets the running date of the measurement task.

Data type: String
Default value: none
Instance count: 1-1
TIMEMASK (Optional) Resets the running period of the measurement task during a day.
Data type: String
Default value: None
Instance count: 1-1
Output Parameter
RESULT Shows the modification result of the measurement task.

Data type: String
Instance count: 1-1
Remarks
l Only suspended measurement tasks can be modified.
l Use 7 or 31 1s and 0s to specify the running date (DATEMASK). For example,
DATEMASK=0110000 indicates the system runs the measurement task every
Monday and Tuesday in each week.
Examples
l To modify the following information of the measurement task with ID 118:
The end time of the task is 2008-03-22 00:00:00.

The task runs from 09:00:00 to 12:00:00 and from 14:00:00 to 18:00:00 every
Monday and Tuesday.
11-14

Chapter 11 S
SET MEASTASK:TASKID=118,ENDDATE="2008-03-22 00:00:00",DATEMASK

="0110000", TIMEMASK="09:00:00,12:00:00;14:00:00,18:00:00";
11.8 SET MEASTASKSTATUS

Function
This command is used to change the status of measurement task(s).
Syntax
SET MEASTASKSTATUS: TASKID= < BEGINID >-< ENDID >, STATUS= < STATUS >;
Input Parameters
TASKID (Required) Specifies the ID of the measurement task or the ID range of

multiple measurement tasks whose status needs to be changed.
Data type: Complex
Default value: None
BEGINID (Required) Specifies the begin ID of the range when you want to change
the status of multiple measurement tasks at a time.
Data type: Integer
Default value: None
Instance count: 1-1
ENDID (Optional) Specifies the end ID of the range when you want to change the
status of multiple measurement tasks at a time.
Data type: Integer
Default value: None
Instance count: 1-1
STATUS (Required) Changes the status of the measurement task(s).

Default value: None
Instance count: 1-1
Output Parameters
RESULT Shows the modification result of the measurement task(s).

Data type: String
Instance count: 1-1
11-15

Example
To activate the measurement task whose ID is 125, type the following command:
SET MEASTASKSTATUS:TASKID=125,STATUS=ACTIVE;
11.9 SET NMDBUSER

Function
This command is used to modify the password of a database user.
Syntax
SET NMDBUSER: [ USER= < USER> ] [ , OLDPASSWORD= < OLDPASSWORD> ] [ ,
NEWPASSWORD= < NEWPASSWORD> ] [ , CONFIRM= < CONFIRM> ] ;
Input Parameters
USER (Required) Specifies the database user whose password needs to be

modified.
Data type: String
Default value: None
Instance count: 1-1
OLDPASSWORD (Required) Specifies the old password of the database user.

Data type: String
Default value: None
Instance count: 1-1
NEWPASSWORD (Required) Specifies the new password of the database user.

Data type: String
Default value: None
Instance count: 1-1
11-16

Chapter 11 S
CONFIRM (Required) Confirms the new password of the database user.

Data type: String
Default value: None
Instance count: 1-1
Output Parameter
Result Returns the modification result of the user password.

Data type: String
Instance count: 1-1
Example
To modify the password of the database user uep4x, type the following command:
SET NMDBUSER:USER="uep4x",OLDPASSWORD="U_tywg_2008",NEWPASSWORD
="Qq1",CONFIRM="Qq1";
11.10 SET NMFTPUSER

Function
This command is used to modify the password of an FTP user.
Syntax
SET NMFTPUSER: [ USER= < USER> ] [ , NEWPASSWORD= < NEWPASSWORD> ] ;
Input Parameters
USER (Required) Specifies the FTP user whose password needs to be modified.
Data type: String
Default value: None
Instance count: 1-1
OLDPASSWORD (Required) Specifies the old password of the FTP user.

Data type: String
Default value: None
Instance count: 1-1
11-17

NEWPASSWORD (Required) Specifies the new password of the FTP user.

Data type: String
Default value: None
Instance count: 1-1
CONFIRM (Required) Confirms the new password of the FTP user.

Data type: String
Default value: None
Instance count: 1-1
Output Parameter
Result Returns the modification result of the user password.

Data type: String
Instance count: 1-1
Example
To modify the password of the FTP user uepcommon, type the following command:
SET NMFTPUSER:USER="uepcommon",OLDPASSWORD="U_tywg_2008_ftp",NEWP
ASSWORD="Qq1",CONFIRM="Qq1";
11.11 SET PASSWORD

Function
This command is used to modify the password of a user.
Syntax
SET PASSWORD: NAME= < NAME> , OLDPASSWORD= < OLDPASSWORD> , PASSW
ORD= < PASSWORD> , CONFIRMPASSWORD= < CONFIRMPASSWORD> ;
Input Parameters
NAME (Required) Specifies the name of the user whose password you want to
modify.
Data type: String
Default value: None
Instance count: 1-1
11-18

Chapter 11 S
OLDPASSWORD (Required) Types the old password of the user.

Data type: String
Default value: None
Instance count: 1-1
NEWPASSWORD (Required) Sets the new password for the user.

Data type: String
Default value: None
Instance count: 1-1
CONFIRMPASSWORD (Required) Confirms the new password of the user.

Data type: String
Default value: None
Instance count: 1-1
Output Parameter
RESULT Shows the modification result of the password.

Value type: String
Instance count: 1-1
Remarks
l This command cannot be run on the Graphical User Interface (GUI) of the element
management system. It can only be used on a terminal connected to the EMS server
through TELNET.
l This command can only be used to change the password of a child user of the current
user.
Example
SET PASSWORD: NAME= "USER", OLDPASSWORD= "oldpassword", PASSWORD= "n
ewpassword", CONFIRMPASSWORD= "newpassword";
11.12 SET PERIODIC TASK

Function
This command is used to modify the settings of a periodic task.
11-19

Syntax
SET PERIODIC TASK: POLICYNAME= < POLICYNAME> [ , POLICYSTATUS= < POLIC
YSTATUS> ] [ , STARTTIME= < STARTTIME> ] [ , INTERVALTIME= [ < DAY> ] [ - < HOUR>
] [ - < MINUTE> ] [ - < SECOND> ] ] [ , MMLSTR= < MMLSTR> ] [ , ENDTIME= < ENDTIME>
];
Input Parameters
POLICYNAME (Required) Specifies the name of the periodic task you want to modify.
Data type: String
Default value: None
Instance count: 1-1
POLICYSATUS (Optional) Changes the status of the periodic task.

Instance count: 1-1
STARTTIME (Optional) Resets the start time of the periodic task. The format of the
start time is yyyy-mm-dd hour:minute:second, for example, 2010-08-17
09:00:00.
Data type: Date
Default value: None
Instance count: 1
INTERVALTIME (Optional) Resets the running cycle of the periodic task. The format of
interval is day-hour-minute-second, for example, 1-0-0-0, which
indicates that the system runs the periodic task once a day.
Data type: Complex
Instance count: 1-1
MMLSTR (Optional) Modifies the MML command(s) in the periodic task.

Data type: String
Default value: None
Instance count: 1-1
ENDTIME (Optional) Resets the end time of the periodic task. The format of the
start time is yyyy-mm-dd hour:minute:second, for example, 2010-08-17
10:00:00.
Data type: Date
Default value: None
Instance count: 1
11-20

Chapter 11 S
Output Parameter
RESULT Shows the modification result of the periodic task.

Data type: String
Instance count: 1-1
POLICYSATUS Active Activated
Suspend Suspended
Example
To change the status of a periodic task whose name is test a to Suspend, type the
following command:
SET PERIODIC TASK:POLICYNAME="test a",POLICYSTATUS=Suspend;
11.13 SET QOSTASK

Function
This command is used to modify the settings of a suspended QoS task, also called
threshold task.
Syntax
QOSTASK: TASKID= < TASKID> [ , TASKNAME= < TASKNAME> ] [ , THRESHOLD= <
INDEXID> [ - < DIRECTION> ] [ - < SETCRITICAL> ] [ - < ALARMCRITICAL> ] [ - < ALARMC
RITICALDELTA> ] [ - < SETMAJOR> ] [ - < ALARMMAJOR> ] [ - < ALARMMAJORDELTA> ] [
- < SETMINOR> ] [ - < ALARMMINOR> ] [ - < ALARMMINORDELTA> ] [ - < SETWARN> ] [ - <
ALARMWARN> ] [ - < ALARMWARNDELTA> ] [ - < SUGGESTION> ] ] [ , SETCONDITION=
< SETCONDITION> ] [ , CONDITION= < CONDITION> ] [ , STARTDATE= < STARTDATE>
] [ , ENDDATE= < ENDDATE> ] [ , DATEMASK= < DATEMASK> ] [ , TIMEMASK= < TIM
EMASK> ] ;
Input Parameters
TASKID (Required) Specifies the ID of the QoS task you want to modify.
Data type: Integer
Default value: None
Instance count: 1-1
11-21

TASKNAME (Optional) Specifies the name of the task you want to modify.
Data type: String
Default value: None
Instance count: 1
THRESHOLD (Optional) Resets the alarm threshold for the QoS task.
Data type: Complex
Default value: None
INDEXID (Required) Resets the index IDs involved in the QoS task.
Data type: String
Default value: None
DIRECTION (Required) Resets the direction attribute of threshold crossing alarms for
the specified index.
Default value: None
Instance count: 1-1
SETCRITICAL (Required) Enables or disables the setting of threshold and delta for critical
Default value: None
Instance count: 1
ALARMCRITICAL (Optional) Resets the threshold of the specified index for reporting a critical
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: None
Instance count: 1
ALARMCRITICALDEL (Optional) Resets the hysteresis value for the threshold to avoid frequent
TA switching between generation and removal of critical alarm. A threshold
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: None
Instance count: 1-1
11-22

Chapter 11 S
SETMAJOR (Required) Enables or disables the setting of threshold and delta for major
Default value: None
Instance count: 1-1
ALARMMAJOR (Optional) Resets the threshold of the specified index for reporting a major
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: None
Instance count: 1
ALARMMAJORDELTA (Optional) Resets the hysteresis value for the threshold to avoid frequent
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: None
Instance count: 1-1
SETMINOR (Required) Enables or disables the setting of threshold and delta for minor
Default value: None
Instance count: 1-1
ALARMMINOR (Optional) Resets the threshold of the specified index for reporting a minor
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: None
Instance count: 1
ALARMMINORDELTA (Optional) Resets the hysteresis value for the threshold to avoid frequent
lower threshold.
Data type: Float
Value range: 0 to 999999999.999
Default value: None
Instance count: 1-1
11-23

SETWARN (Required) Enables or disables the setting of threshold and delta for
threshold crossing warning.
Default value: None
Instance count: 1-1
ALARMWARN (Optional) Resets the threshold of the specified index for reporting a
the threshold.
Data type: Float
Value range: -999999999.999 to 999999999.999
Default value: None
Instance count: 1-1
ALARMWARNDELTA (Optional) Resets the hysteresis value for the threshold to avoid frequent
Data type: Float
Value range: 0 to 999999999.999
Default value: None
Instance count: 1-1
SUGGESTION (Optional) Modifies the handling suggestion of threshold crossing alarms.

Data type: String
Default value: None
Instance count: 1-1
SETCONDITION (Optional) Sets whether to use the active condition.

Default value: None
Instance count: 1-1
CONDITION (Optional) Modifies the active condition index of the QoS task.
Data type: Integer
Default value: None
Instance count: 1-1
STARTDATE (Required) Resets the start time of the QoS task.

Data type: Date
Default value: None
Instance count: 1-1
ENDDATE (Required) Resets the end time of the QoS task.

Value type: Date
Default value: None
Instance count: 1-1
11-24

Chapter 11 S
DATEMASK (Optional) Resets the running date of the QoS task.

Data type: String
Default value: None
Instance count: 1-1
TIMEMASK (Optional) Resets the running period of the QoS task.

Data type: String
Default value: None
Instance count: 1
Output Parameter
RESULT Shows the modification result of the QoS task.

Data type: String
Instance count: 1-1



SETCRITICAL Y Yes
N No
SETMAJOR Y Yes
N No
SETMINOR Y Yes
N No
SETWARN Y Yes
N No
Example
To modify the following information of the QoS task with the ID 118:
11-25

l Change the end time of the task to 2008-03-22 00:00:00.

l Change the running date and time to: from 09:00:00 to 12:00:00 and from 14:00:00
to 18:00:00 every Monday and Tuesday.
l Change the measured object list, including NodeB configuration object 1 of the RNC
radio resource managed object 200;
l The alarm thresholds are based on the index 30225-Iub uplink bandwidth utilization.
No index is used as the triggering condition.
SET QOSTASK:TASKID=118,ENDDATE="2008-03-22 00:00:00",DATEMASK="0
110000", TIMEMASK="09:00:00,12:00:00;14:00:00,18:00:00",THRESHOL
D=30225;
11.14 SET QOSTASKSTATUS

Function
This command is used to change the status of QoS task(s).
Syntax
SET QOSTASKSTATUS: TASKID= < BEGINID >-< ENDID >, STATUS= < STATUS >;
Input Parameters
TASKID (Required) Specifies the ID of the QoS task or ID range of multiple QoS
tasks whose status need to be changed.
Value type: Complex
Default value: None
BEGINID (Required) Specifies the begin ID of the range when you want to change
the status of multiple QoS tasks at a time.
Value type: Integer
Default value: None
Instance count: 1-1
ENDID (Optional) Specifies the end ID of the range when you want to change the
status of multiple QoS tasks at a time.
Value type: Integer
Default value: None
Instance count: 1-1
11-26

Chapter 11 S
STATUS (Required) Changes the status of the QoS task(s).

Default value: None
Instance count: 1-1
Output Parameters
RESULT Shows the modification result of the QoS task(s).

Data type: String
Instance count: 1-1
Examples
l To activate the QoS task with the ID 125, type the following command:
SET QOSTASKSTATUS:TASKID=125,STATUS=ACTIVE;
l To activate the QoS tasks with the IDs range from 100 to 120, and from 150 to 155,
type the following command:
SET QOSTASKSTATUS:TASKID=100-120&150-155,STATUS=ACTIVE;
l To suspend the QoS tasks with the IDs ranging from 100 to 120, and the QoS tasks
with the ID 145 and 148, type the following command:
SET QOSTASKSTATUS:TASKID=100-120&145&148,STATUS=SUSPENSIVE;
11.15 SET TIMING TASK

Function
This task is used to modify the settings of a timing task.
Syntax
SET TIMING TASK: POLICYNAME= < POLICYNAME> [ , POLICYSTATUS= < POLICYS
TATUS> ] [ , ONLYONCE= < ONLYONCE> ] [ , MMLSTR= < MMLSTR> ] ;
11-27

Input Parameters
POLICYNAME (Required) Specifies the name of the new timing task.

Data type: String
Default value: None
Instance count: 1
POLICYSTATUS (Optional) Specifies the initial status of the new timing task.
Value range: Active, Suspend
Instance count: 1-1
ONLYONCE Sets the running time of the new task. When this parameter is set, the new
timing task will be run only once when the preset time is up.
Data type: Date
Default value: None
Instance count: 1-1
ONCEDAY Sets the running day of the new task. When this parameter is set, the new
timing task will be run at the preset time once a day.
Data type: Date
Default value: None
Instance count: 1-1
WEEK Sets the running day of the new task. This parameter specifies the day of
a week.
Default value: Sunday
Instance count: 1-1

Data type: Date
Default value: None
Instance count: 1-1
ONCEWEEK Sets the running day of the new task. When this parameter is set, the new
timing task will be run at the preset time once a week.
Data type: Date
Default value: None
Instance count: 1-1
of a month.
Instance count: 1-1
11-28

Chapter 11 S

Data type: Date
Default value: None
Instance count: 1-1
ONCEMONTH Sets the running time of the new task. When this parameter is set, the new
timing task will be run once a month.
Value type: Complex
Default value: None
Instance count: 1-1
MONTH Sets the running time of the new task. This parameter specifies the
month(s) of a year.
Instance count: 1-1
of a month.
Default value: None
Instance count: 1-1

Data type: Date
Default value: None
Instance count: 1-1
MMLSTR (Required) Specifies the MML command(s) for the new timing task.
Data type: String
Default value: None
Instance count: 1
Output Parameter
RESULT Returns the modification result of the timing task.

Data type: String
Instance count: 1-1
11-29

WEEK Sunday Sunday
Monday Monday
Tuesday Tuesday
Wednesday Wednesday
Thursday Thursday
Friday Friday
Saturday Saturday
DAY1/DAY2 1-32 1-31: the first day to the 31st day of a month
32: the last day of a month
MONTH 1 January
2 February
3 March
4 April
5 May
6 June
7 July
8 August
9 September
10 October
11 November
12 December
Remarks
Only one or none of the parameters ONLYONCE, ONCEDAY, ONCEWEEK and ONCE
MONTH can be set to specify the running time of the timing task.
l ONLYONECE: it is required to specify the date in the format of yyyy-mm-dd

hour:minute:second, for example, 2008-10-17 15:27:36.
l ONCEDAY: it is required to specify the date in the format of hour:minute:second, for
example, 04:00:00.
l ONCEWEEK: it is required to select a day in the week (Sunday, Monday, Tuesday,
Wednesday, Thursday, Friday, or Saturday) , and set the time in the day, for example,
Monday-05:00:00.
l ONCEMONTH: it is required to select a day in the month (1 through 32), and set the
time in the day, for example, 25-06:00:00. The day 32 indicates the last day of a
month, which varies with different months.
11-30

Chapter 11 S
Example
To modify the timing task whose name is test a, type the following command:
SET TIMING TASK:POLICYNAME="test a",POLICYSTATUS=Active,ONLYONCE
="2008-10-17 15:27:36";
11.16 SET USER

Function
This command is used to modify the information of a user.
Syntax
SET USER: NAME= < NAME> [ , FULLNAME= < FULLNAME> ] [ , DESCRIPTION= <
DESCRIPTION> ] [ , PHONENUMBER= < PHONENUMBER> ] [ , EMAILADDRESS= <
EMAILADDRESS> ] [ , DEPARTMENT= < DEPARTMENT> ] [ , USERVALIDDAYS= < USE
RVALIDDAYS> ] [ , PASSWORDVALIDDAYS= < PASSWORDVALIDDAYS> ] [ , PASSWO
RDKEEPDAYS= < PASSWORDKEEPDAYS> ] [ , USERSTOPACCDAYS= < USERSTOPAC
CDAYS> ] ;
Input Parameters
NAME (Required) Specifies the name of the user you want to modify.
Data type: String
Default value: None
Instance count: 1-1
FULLNAME (Optional) Modifies the full name of the user.

Value type: String
Default value: None
Instance count: 1-1
DESCRIPTION (Optional) Modifies the description of the user.

Value type: String
Default value: None
Instance count: 1-1
PHONENUMBER (Optional) Modifies the phone number of the user.

Data type: String
Default value: None
Instance count: 1-1
11-31

EMAILADDRESS (Optional) Modifies the Email address of the user.

Data type: String
Default value: None
Instance count: 1-1
DEPARTMENT (Optional) Changes the department to which the user belongs.

Data type: String
Default value: None
Instance count: 1-1
USERVALIDDAYS (Optional) Resets the validity period of the user account. The account never
expires if the number of days that the account is valid (USERVALIDDAYS)
is set to 0.
Data type: Integer
Default value: None
Instance count: 1-1
PASSWORDVALIDDA (Optional) Resets the longest reservation period of the password. The
YS password never expires if the parameter value is set to 0.
Value type: Integer
Default value: None
Instance count: 1-1
PASSWORDKEEPDAY (Optional) Resets the shortest reservation period of the password.

S Data type: Integer
Default value: None
Instance count: 1
USERSTOPACCDAYS (Optional) Sets the account suspended duration (days).

Data type: Integer
Default value: None
Instance count: 1
Output Parameter
RESULT Shows the modification result of the user information.

Data type: String
Instance count: 1-1
11-32

Chapter 11 S
Example
To modify the information of the user user 1, type the following command:
SET USER:NAME="1",FULLNAME="1",DESCRIPTION="1",PHONENUMBER="1",E
MAILADDRESS="1",DEPARTMENT="1",USERVALIDDAYS=0,PASSWORDVALIDDAYS
=0,USERSTOPACCDAYS=0;
11.17 SET USER RIGHT

Function
This command is used to grant specific operation permissions to a user.
Syntax
SET USER RIGHT : NAME= < NAME> [ , ROLEARRAY= < ROLEARRAY> ] [ , ROLESET
ARRAY= < ROLESETARRAY> ] ;
Input Parameters
NAME (Required) Specifies the name of the user to which you want to assign
the role or role set.
Data type: String
Default value: None
Instance count: 1-1
ROLEARRAY (Optional) Specifies the role that you want to assign to the user.
Data type: String
Default value: None
ROLESETARRAY (Optional) Specifies the role set that you want to assign to the user.
Data type: String
Default value: None
Output Parameter
RESULT Shows the setting result of the user.

Data type: String
Instance count: 1-1
11-33

Example
To set the right of a user, type the following command:
SET USER RIGHT:NAME="1",ROLEARRAY="0",ROLESETARRAY="0";
11.18 SET USER STATE

Function
This command is used to set the state of a user.
Syntax
SET USER STATE : NAME= < NAME> , DISABLE= < DISABLE> ;
Input Parameters
NAME (Required) Specifies the name of the user you want to set.
Data type: String
Default value: None
Instance count: 1
DISABLE (Required) Sets the state of the user to disabled.

Data type: Boolean
Value range: TRUE, and FALSE
Default value: None
Instance count: 1-1
Output Parameter
RESULT Shows the setting result of the user.

Data type: String
Instance count: 1-1
Example
To enable the user with the name of 1, type the following command:
SET USER STATE:NAME="1",DIISABLE=false;
11-34

Chapter 11 S
11.19 SET USER VIEW LOG RANGE

Function
This command is used to grant the permission of viewing logs to a user by specifying
role(s) or/and role set(s).
Syntax
SET USER VIEW LOG RANGE: NAME= < NAME> [ , LOGROLEARRAY= < LOGROLEA
RRAY> ] [ , LOGROLESETARRAY= < LOGROLESETARRAY> ] ;
Input Parameters
NAME (Required) Specifies the name of the user.

Data type: String
Default value: None
Instance count: 1-1
LOGROLEARRAY (Optional) Specifies the role(s), and the logs of the users assigned with
the role(s) can be viewed.
Data type: String
Default value: None
LOGROLESETARRAY (Optional) Specifies the role set(s), and the logs of the users assigned
with the role set(s) can be viewed.
Data type: String
Default value: None
Output Parameter
RESULT Shows the setting result.

Data type: String
Instance count: 1-1
Example
To set the range of role and role set for viewing logs of users assigned with the role and
role set, type the following command:
11-35

SET USER VIEW LOG RANGE:NAME="1",LOGROLEARRAY="0",LOGROLESETARRAY

="0";
11.20 SHOW ALARM DETAIL

Function
This command is used to show the details of an active alarm.
Syntax
SHOW ALARM DETAIL: ID= < ID> ;
Input Parameter
ID (Required) Specifies the ID of the alarm you want to view.

Data type: Integer
Value range: 0-9223372036854775807
Default value: None
Instance count: 1
Output Parameters
INFO Shows the details of the alarm.

Data type: Complex
Instance count: 1-1
SYSTEMTYPE Shows the system type.

Data type: String
Instance count: 1-1
AID Shows the original alarm ID.

Data type: String
Instance count: 1-1
ID Shows the serial number of the alarm.

Data type: Integer
Instance count: 1-1
POSITION Shows the occurrence position of the alarm.

Data type: String
Instance count: 1-1
ALARMTYPE Shows the alarm type.

Data type: String
Instance count: 1-1
11-36

Chapter 11 S
ALARMCODE Shows the alarm code.

Data type: Integer
Instance count: 1-1
CODEINFORMATION Shows the code description of the alarm.

Data type: String
Instance count: 1-1
ALARMRAISETIME Shows the occurrence time of the alarm.

Data type: String
Instance count: 1-1
SEVERITY Shows the severity level of the alarm.

Data type: String
Instance count: 1-1
ADDITIONALINFO Shows the additional information of the alarm.

Data type: String
Instance count: 1-1
ACKSTATE Shows the acknowledgement state of the alarm.

Data type: String
Instance count: 1-1
Remarks
l This command is used to show the details of only one active alarm.
l The SHOW CURRENTALARM command can be used to get the ID of an active alarm
from the returned information.
Example
To show the details of the alarm with the ID 1169630078865, type the following command:
SHOW ALARM DETAIL:ID=1169630078865;
11.21 SHOW ALL ROLES

Function
This command is used to query the information of all roles.
Syntax
SHOW ALL ROLES;
Input Parameter
None
11-37

Output Parameters
NAME Shows the name of each role.

Data type: String
Instance count: 1-1
DESCRIPTION Shows the description of each role.

Data type: String
Instance count: 1-1
LOCKED Shows the locking status of each role.

Data type: Boolean
Instance count: 1-1
Remarks
At most 1000 roles can be displayed in the query result.
Example
To show the information of all roles in the EMS, type the following command:
SHOW ALL ROLES;
11.22 SHOW ALL ROLE SETS

Function
This command is used to query the information of all role sets.
Syntax
SHOW ALL ROLE SETS;
Input Parameter
None
Output Parameters
NAME Shows the name of each role set.

Data type: String
Instance count: 1-1
DESCRIPTION Shows the description of each role set.

Data type: String
Instance count: 1-1
11-38

Chapter 11 S
LOCKED Shows the locking status of each role set.

Data type: Boolean
Instance count: 1-1
Remarks
At most 1000 role sets can be displayed in the query result.
Example
To show the information of all role sets in the EMS, type the following command:
SHOW ALL ROLE SETS;
11.23 SHOW ALL SESSIONS

Function
This command is used to show the information of all sessions on the server.
Syntax
SHOW ALL SESSIONS;
Input Parameter
None
Output Parameters
SESSIONID Shows the ID of each session.

Data type: Integer
Instance count: 1-1
USERNAME Shows the name of the user involved in each session.

Data type: String
Instance count: 1-1
CLIENTIP Shows the IP address of the client involved in each session.

Data type: String
Instance count: 1-1
CONNECTTYPE Shows the connection type.

Data type: String
Instance count: 1-1
11-39

LOGINTIME Shows the login time of the user.

Data type: String
Instance count: 1-1
IDLEUSETIME Shows the idle time period in the unit of minute.

Data type: String
Instance count: 1-1
Remarks
Only the information of at most 1000 sessions can be displayed in the query result.
Example
To show the information of all sessions on the server, type the following command:
SHOW ALL SESSIONS;
11.24 SHOW ALL TASK

Function
This command is used to query the information of all periodic tasks in the EMS.
Syntax
SHOW ALL TASK: [ POLICYNAME= < POLICYNAME> ] [ , POLICYSTATUS= < POLICY
STATUS> ] [ , MMLSTR= < MMLSTR> ] ;
Input Parameters
POLICYNAME (Optional) Specifies the name of the periodic task you want to query.
Wildcard characters (* and ?) can be used to specify several period tasks
to be queried.
Data type: String
Default value: None
Instance count: 1-1
POLICYSTATUS (Optional) Selects to query active or suspended periodic tasks.

Value range: Suspend, and Active
Default value: None
Instance count: 1-1
11-40

Chapter 11 S
MMLSTR (Optional) Specifies the commands involved in the periodic tasks to be

queried.
Data type: String
Default value: None
Instance count: 1-1
Output Parameters
POLICYNAME Shows the name of each queried task.

Data type: String
Instance count: 1-1
POLICYINFO Shows the execution period of each queried task.

Data type: String
Instance count: 1-1
TASKSTATUS Shows the status of each queried task.

Data type: String
Instance count: 1-1
INFO Shows the information of all queried periodic tasks.

Data type: Complex
TASKDESC Shows the additional information of each queried task.

Data type: String
Instance count: 1-1
LASTEXE Shows the last execution time of each queried task.

Data type: String
Instance count: 1-1
POLICYTYPE Shows the policy type of each queried task.

Data type: String
Instance count: 1-1
DETAILS Shows the detailed information of each queried task.

Data type: String
Instance count: 1-1
Remarks
Only one of the two parameters (POLICYNAME and POLICYSTATUS) can be set at a time
in this command. All periodic tasks in the EMS will be queried if neither of them is set.
11-41

Example
To view the information of the periodic task with the name of aaa, type the following
command:
SHOW ALL TASK:POLICYNAME=aaa;
11.25 SHOW ALL USERS

Function
This command is used to query the information of all users.
Syntax
SHOW ALL USERS;
Input Parameter
None
Output Parameters
NAME Shows the name of each user.

Data type: String
Instance count: 1-1
DESCRIPTION Shows the additional information of each user.

Data type: String
Instance count: 1-1
DISABLE Shows whether a user is disabled.

Data type: Boolean
Instance count: 1-1
Remarks
Only the information of at most 1000 users can be displayed in the query result.
Example
To show the information of all users of the EMS, type the following command:
SHOW ALL USERS;
11-42

Chapter 11 S
11.26 SHOW AMO

Function
This command is used to show the names of Access Managed Objects (AMOs) that are
connected to the EMS server and have been started.
Syntax
SHOW AMO;
Input Parameter
None
Output Parameter
AMONAME Shows the names of all started AMOs connected to the server.
Data type: String
Example
To show all the started AMOs connected to the EMS server, type the following command:
SHOW AMO;
11.27 SHOW COMMAND LOG

Function
This command is used to query operation logs in the EMS.
Syntax
SHOW COMMAND LOG: [ USERNAME= < USERNAME> ] [ , IP= < IP> ] [ , LOGSTARTD
ATE_FROM= < LOGSTARTDATE_FROM> ] [ , LOGSTARTDATE_TO= < LOGSTARTDATE
_TO> ] [ , CMDCODE= < CMDCODE> ] [ , CONMODE= < CONMODE> ] [ , ISSUCCESS=
< ISSUCCESS> ] [ , LOGRANK= < LOGRANK> ] ;
11-43

Input Parameters
USERNAME (Optional) Specifies the name of the user for querying the operation logs
related to this user.
Data type: String
Default value: None
IP (Optional) Specifies the IP address of the client for querying the operation
logs related to this client.
Data type: String
Default value: None
LOGSTARTDATE_FR (Optional) Sets the start time of a period for querying the operation logs
OM during this period.
Data type: Date
Default value: None
Instance count: 1-1
LOGSTARTDATE_TO (Optional) Sets the end time of a period for querying the operation logs
during this period.
Data type: Date
Default value: None
Instance count: 1
CMDCODE (Optional) Specifies the command code for querying related operation logs.
Data type: String
Default value: None
CONMODE (Optional) Specifies the connection mode of the client.

Default value: None
Instance count: 1-4
ISSUCCESS (Optional) Selects to query the operation logs related to successful, failed,
or unfinished operations.
Default value: None
Instance count: 1-3
LOGRANK (Optional) Specifies the rank of the operation logs you want to query.
Default value: None
Instance count: 1-4
11-44

Chapter 11 S
Output Parameters
LOGRANK Shows the log rank.

Instance count: 1-1
USERNAME Shows the user name

Data type: String
Instance count: 1-1
CMDCODE Shows the command.

Data type: String
Instance count: 1-1
OPSET Shows the operation.

Data type: String
Instance count: 1-1
ISSUCCEED Shows the operation result.

Instance count: 1-1
FAILREASON Shows the reason for failure.

Data type: String
Instance count: 1-1
CLIENTIP Shows the host address.

Data type: String
Instance count: 1-1
CONMODE Shows the connection mode.

Instance count: 1-1
STARTTIME Shows the operation start time.

Data type: String
Instance count: 1-1
OPRES Shows the operated object.

Data type: String
Instance count: 1-1
RESOURCEIP Shows the NE address.

Data type: String
Instance count: 1-1
LOG Shows the log.

Data type: Complex
11-45

CONMODE (input GUI Graphical user interface

parameter)
TELNET TELNET
NDA NDA
SSH Secure shell
ISSUCCESS 0 Success
1 Failure
2 Unfinished
LOGRANK 1 Very important
2 Important
3 Notice
4 Normal
CONMODE (output GUI Graphical user interface

parameter)
TELNET TELNET
NDF NDF
CORBA CORBA
SSH Secure shell
SNMP SNMP
TL1 TL1
MTOSI MTOSI
EMS EMS
Remarks
Only the first 500 logs can be displayed in the query result.
Example
To show the command logs of the user a on the server 10.75.64.44, type the following
command:
SHOW COMMAND LOG:USERNAME="a",IP="10.75.64.44",LOGSTARTDATE_FROM

="2009-12-23 16:22:31",LOGSTARTDATE_TO="2009-12-24 16:22:31",CMDC
ODE="1012",CONMODE="GUI",ISSUCCESS="0",LOGRANK="1";
11-46

Chapter 11 S
11.28 SHOW CPU RATIO

Function
This command is used to show the CPU usage of the server.
Syntax
SHOW CPU RATIO: IP= < IP> ;
Input Parameter
IP (Optional) Specifies the IP address of the server.

Data type: Address
Default value: None
Instance count: 1-1
Output Parameter
CPURATION Shows the CPU usage in percentage.

Data type: String
Instance count: 1-1
Example
To show the CPU usage of the server 10.75.72.153, type the following command:
SHOW CPU RATIO:IP=10.75.72.153;
11.29 SHOW CURRENT ALARM

Function
This command is used to query active alarms in the EMS.
Syntax
SHOW CURRENT ALARM: [ ALARMTYPE= < ALARMTYPE> ] [ , SEVERITY= < SEVERI
TY> ] [ , ALARMRAISEBEGINTIME= < ALARMRAISEBEGINTIME> ] [ , ALARMRAISEEN
DTIME= < ALARMRAISEENDTIME> ] [ , POSITION= < POSITION> ] [ , PROBABLECAUS
ECODE= < PROBABLECAUSECODECODE> ] [ , ACKSTATE= < ACKSTATE> ] [ , ACKBE
GINTIME= < ACKBEGINTIME> ] [ , ACKENDTIME= < ACKENDTIME> ] [ , ISVISIBLE= <
ISVISIBLE> ] [ , SYSTEMTYPE= < SYSTEMTYPE> ] ;
11-47

Input Parameters
ALARMTYPE (Optional) Specifies the type of current alarms that you want to query.
Default value: None
SEVERITY (Optional) Specifies the severity of current alarms that you want to query.
Default value: None
Instance count: 1-1
ALARMRAISEBEGINT (Optional) Sets the start time of a period for querying the current alarms
IME occurring in this period. The begin time must be set if the end time is set.
Data type: Date
Default value: None
Instance count: 1
ALARMRAISEENDTIM (Optional) Sets the end time of a period for querying the current alarms
E occurring in this period.
Data type: Date
Default value: None
Instance count: 1-1
POSITION (Optional) Specifies the occurrence position of the current alarms you want
to query. Use the symbol "," to separate the fields while typing the string
of a specific position, which may include the information of subnetwork,
office, and module.
Data type: String
Default value: None
ALARMCODE (Optional) Specifies each alarm code for querying corresponding current
alarms.
Data type: Integer
Value range: 0-9223372036854775807
Default value: None
ACKSTATE (Optional) Selects to query unacknowledged current alarms only,

acknowledged current alarms only, or all current alarms.
Default value: None
Instance count: 1-1
11-48

Chapter 11 S
ACKBEGINTIME (Optional) Sets the start time of the period for querying the acknowledged
or unacknowledged current alarms that have been acknowledged or
unacknowledged during this period.
Data type: Date
Default value: None
Instance count: 1-1
ACKENDTIME (Optional) Sets the end time of the period for querying the acknowledged
Data type: Date
Default value: None
Instance count: 1-1
ISVISIBLE (Optional) Specifies the visibility of the current alarms you want to query.
Data type: Boolean
Value range: TRUE, and FALSE
Default value: TRUE
Instance count: 1-1
SYSTEMTYPE (Optional) Specifies the type of the system where the current alarms you
want to query were raised.
Data type: Integer
Default value: None
Instance count: 1-1
Output Parameters
INFO Shows the information of all active alarms.

Data type: Complex

Data type: String
Instance count: 1-1
AID Shows the original ID of each alarm.

Data type: String
Instance count: 1-1
ID Shows the serial number of each alarm.

Data type: Integer
Instance count: 1-1
11-49

ALARMTYPE Shows the type of each alarm.

Data type: String
Instance count: 1-1
ALARMCODE Shows the alarm code of each alarm

Data type: Integer
Instance count: 1-1
CODEINFORMATION Shows the code description of each alarm.

Data type: String
Instance count: 1-1
SEVERITY Shows the severity level of each alarm.

Data type: String
Instance count: 1-1
POSITION Shows the occurrence position of each alarm.

Data type: String
Instance count: 1-1
ALARMRAISETIME Shows the occurrence time of each alarm.

Data type: String
Instance count: 1-1
ADDITIONALINFO Shows the additional information of each alarm.

Data type: String
Instance count: 1-1
ACKSTATE Shows the acknowledgement state of each alarm.

Data type: String
Instance count: 1-1
ALARMTYPE COMMUNICATION_ALARM Communication alarm
PROCESSING_ERROR_ALARM Processing error alarm
QUALITY_OF_SERVICE_ALARM Quality of service alarm
EQUIPMENT_ALARM Equipment alarm
ENVIRONMENTAL_ALARM Environmental alarm
OMC_ALARM OMC alarm
INTEGRITY_VIOLATION Integrity violation
OPERATIONAL_VIOLATION Operational violation
PHYSICAL_VIOLATION Physical violation
SECURITY_VIOLATION Security violation
11-50

Chapter 11 S
TIME_DOMAIN_VIOLATION Time domain violation
ACKSTATE ALL Unacknowledged and acknowledged
UNACKNOWLEDGE Unacknowledged
ACKNOWLEDGE Acknowledged
Remarks
l At most 500 active alarms can be displayed in the query result.
l CLEARED active alarms can be queried only when the query mode supports the
query of cleared alarms.
l The system type (SYSTEMTYPE) must be set if alarm codes are set as query
conditions. If the system type is not set, ALARMCODE is invalid.
l SYSTEMTYPE must have a value larger than zero.
Example
To show all active major alarms of OMC type during the period from 2009-12-16 10:31:34
to 2009-12-19 10:31:34, type the following command:
SHOW CURRENT ALARM:ALARMTYPE=OMC_ALARM,SEVERITY=SEVERITY_MAJO

R,ALARMRAISEBEGINTIME="2009-12-16 10:31:34",ALARMRAISEENDTIME="20
09-12-19 10:31:34",POSITION="IpNode=1008",PROBABLECAUSECODE="1011
",ACKSTATE=UNACKNOWLEDGE,ISVISIBLE=TRUE,SYSTEMTYPE=6;
11.30 SHOW DB RATIO

Function
This command is used to show the usage of the Oracle database.
Syntax
SHOW DB RATIO;
11-51

Input Parameter
DBINFO (Optional) Specifies the information of the database instance you want
to view.
Data type: Complex
Default value: None
Instance count: 1
IP (Required) Specifies the IP address of the database server.

Data type: Address
Default value: None
Instance count: 1-1
SID (Required) Specifies the SID of the database.

Value type: String
Default value: None
Instance count: 1
Output Parameter
SPACE Shows the usage information of the database.

Value type: String
Example
To show the usage of the database, type the following command:
SHOW DB RATIO;
11.31 SHOW DEPARTMENT

Function
This command is used to show the information of a department.
Syntax
SHOW DEPARTMENT: NAME= < NAME> ;
11-52

Chapter 11 S
Input Parameter
NAME (Required) Specifies the name of the department you want to view.
Data type: String
Default value: None
Instance count: 1-1
Output Parameter
NAME Shows the department name.

Data type: String
Instance count: 1-1
DESCRIPTION Shows the additional information of the department.

Data type: String
Instance count: 1-1
SUPERDEPART Shows the superior department of the department.

Data type: String
Instance count: 1-1
Example
To show the information of the department whose name is department 1, type the
following command:
SHOW DEPARTMENT:NAME="1";
11.32 SHOW DIRECTORY MONITOR TASK NAME

Function
This command is used to show the names of directory monitoring tasks defined in the EMS.
Syntax
SHOW DIRECTORY MONITOR TASK NAME;
Input Parameter
None
11-53

Output Parameter
DIRECTORYTASKNA Shows the names of all directory monitoring tasks in the system,
ME Data type: Complex
TASKNAME Returns the director-monitoring task names.

Value type: String
Instance count: 1-1
Example
To show the names of all directory monitoring tasks in the system, type the following
command:
SHOW DIRECTORY MONITOR TASK NAME;
11.33 SHOW HD USAGE

Function
This command is used to show the hard disk usage on the server.
Syntax
SHOW HD USAGE: [ : IP= IP, ] [ DISK= DISK] ;
Input Parameters

Data type: Address
Default value: None
Instance count: 1-1
DISK (Optional) Specifies the disk descriptor.

Data type: String
Default value: None
Instance count: 1-1
11-54

Chapter 11 S
Output Parameter
HDINFO Shows the information of the hard disk, including

l DISK: the disk descriptor
l DISSIZE: the size of the disk
l USEDSIZE: the size of the used disk
l UNUSED: the size of the free disk space
l PER: the disk usage shown in percentage
l HANG: the mount point
Data type: Complex
Remark
The format of disk descriptor in a Solaris operating system is /dev/sda1; while the format
in a Windows operating system is c:/.
Example
To show the usage information of the hard disk in the server, type the following command:
SHOW HD USAGE;
11.34 SHOW HISTORY ALARM

Function
This command is used to query historical alarms.
Syntax
SHOW HISTORY ALARM: [ ALARMTYPE= < ALARMTYPE> ] [ , SEVERITY= < SEVERI
TY> ] [ , ALARMRAISEBEGINTIME= < ALARMRAISEBEGINTIME> ] [ , ALARMRAISEEN
DTIME= < ALARMRAISEENDTIME> ] [ , CLEARBEGINTIME= < CLEARBEGINTIME> ] [ ,
CLEARENDTIME= < CLEARENDTIME> ] [ , POSITION= < POSITION> ] [ , PROBABLEC
AUSECODE= < PROBABLECAUSECODE> ] [ , ACKSTATE= < ACKSTATE> ] [ , ACKBEG
INTIME= < ACKBEGINTIME> ] [ , ACKENDTIME= < ACKENDTIME> ] [ , SYSTEMTYPE=
< SYSTEMTYPE> ] ;
Input Parameters
ALARMTYPE (Optional) Specifies the type of historical alarms that you want to query.
Default value: None
11-55

SEVERITY (Optional) Specifies the severity of historical alarms that you want to query.
Default value: None
Instance count: 1-1
ALARMRAISEBEGINT (Optional) Sets the start time of a period for querying the historical alarms
IME occurring in this period. The begin time must be set if the end time is set.
Data type: Date
Default value: None
Instance count: 1
ALARMRAISEENDTIM (Optional) Sets the end time of a period for querying the historical alarms
E occurring in this period.
Data type: Date
Default value: None
Instance count: 1-1
CLEARBEGINTIME (Optional) Sets the start time of a period for querying the historical alarms
that have been cleared in this period.
Value type: Date
Default value: None
Instance count: 1-1
CLEARENDTIME (Optional) Sets the end time of a period for querying the historical alarms
that have been cleared in this period.
Value type: Date
Default value: None
Instance count: 1-1
POSITION (Optional) Specifies the occurrence position of the history alarms you want
to query. Use the symbol "," to separate the fields while typing the string
of a specific position, which may include the information of subnetwork,
office, and module.
Data type: String
Default value: None
ALARMCODE (Optional) Specifies the cause code for querying corresponding historical
alarms. Be sure to set the system type if you want to use the cause code
as a query condition. If you do not set the system type, this parameter is
invalid.
Data type: Integer
Value range: 0-9223372036854775807
Default value: None
11-56

Chapter 11 S
ACKSTATE (Optional) Selects to query unacknowledged historical alarms only,

acknowledged historical alarms only, or all historical alarms.
Default value: None
Instance count: 1-1
ACKBEGINTIME (Optional) Sets the start time of the period for querying the acknowledged
or unacknowledged historical alarms that have been acknowledged or
Data type: Date
Default value: None
Instance count: 1-1
ACKENDTIME (Optional) Sets the end time of the period for querying the acknowledged
Data type: Date
Default value: None
Instance count: 1-1
SYSTEMTYPE (Optional) Specifies the type of the system where the history alarms you
want to query were raised. Be sure that the value of this parameter is
greater than zero.
Data type: Integer
Default value: None
Instance count: 1-1
Output Parameters
INFO Shows the details of the queried historical alarms.

Data type: Complex
DATERANGE Shows the time period during which the historical alarms have been
removed.
Data type: Complex
Instance count: 1

Data type: String
Instance count: 1-1
AID Shows the original ID of each alarm.

Data type: String
Instance count: 1-1
11-57

ID Shows the serial number of each alarm.

Data type: Integer
Instance count: 1-1
ALARMTYPE Shows the type of each alarm.

Data type: String
Instance count: 1-1
ALARMCODE Shows the alarm code of each alarm

Data type: Integer
Instance count: 1-1
CODEINFORMATION Shows the code description of each alarm.

Data type: String
Instance count: 1-1
SEVERITY Shows the severity level of each alarm.

Data type: String
Instance count: 1-1
POSITION Shows the occurrence position of each alarm.

Data type: String
Instance count: 1-1
ALARMRAISETIME Shows the occurrence time of each alarm.

Data type: String
Instance count: 1-1
CLEARTIME Shows the clearing time of each alarm.

Data type: String
Instance count: 1-1
ADDITIONALINFO Shows the additional information of each alarm.

Data type: String
Instance count: 1-1
BEGINDATE Shows the start time of the query period.

Data type: String
Instance count: 1-1
ENDDATE Shows the end time of the query period.

Data type: String
Instance count: 1-1
11-58

Chapter 11 S
ALARMTYPE COMMUNICATION_ALARM Communication alarm
PROCESSING_ERROR_ALARM Processing error alarm
QUALITY_OF_SERVICE_ALARM Quality of service alarm
EQUIPMENT_ALARM Equipment alarm
ENVIRONMENTAL_ALARM Environmental alarm
OMC_ALARM OMC alarm
INTEGRITY_VIOLATION Integrity violation
OPERATIONAL_VIOLATION Operational violation
PHYSICAL_VIOLATION Physical violation
SECURITY_VIOLATION Security violation
TIME_DOMAIN_VIOLATION Time domain violation
ACKSTATE ALL Unacknowledged and acknowledged
UNACKNOWLEDGE Unacknowledged
ACKNOWLEDGE Acknowledged
Remarks
l At most 500 historical alarms can be displayed in the query result.
l The system type (SYSTEMTYPE) must be set if alarm codes are set as query
conditions. If the system type is not set, ALARMCODE is invalid.
l SYSTEMTYPE must have a value larger than zero.
Example
To show specific historical alarms, type the following command:
SHOW HISTORY ALARM:ALARMTYPE="OMC_ALARM",SEVERITY=SEVERITY_CRITIC

AL,ALARMRAISEBEGINTIME="2009-12-14 16:13:23",ALARMRAISEENDTIME="2
009-12-21 16:13:23",CLEARBEGINTIME="2009-12-14 16:13:23",CLEAREND
TIME="2009-12-21 16:13:23",POSITION="IpNode=1003",PROBABLECAUSECO
DE="1011",ACKSTATE=ACKNOWLEDGE,SYSTEMTYPE=6;
11-59

11.35 SHOW INDEX

Function
This command is used to show the information of a performance index.
Syntax
SHOW INDEX: INDEXID= INDEXID;
Input Parameter
INDEXID (Required) Specifies the ID of the performance task you want to view.
Data type: String
Default value: None
Instance count: 1-1
Output Parameter
DETAIL Shows the details of the performance index, including the index ID, index
name, index description, NE type, measured object type, formula code,
formula name, index attribute (system index or not), value type, exception
value, index type, direction, settings of critical, major, minor, and warning
alarms, and Remarks.
Data type: Complex
Instance count: 1-1
Example
To view the details of the performance index whose ID is 30000, type the following
command:
SHOW INDEX:INDEXID=30000;
11.36 SHOW MEASTASK

Function
This command is used to show the information of a measurement task.
Syntax
SHOW MEASTASK: TASKID= < TASKID >;
11-60

Chapter 11 S
Input Parameter
TASKID (Required) Specifies the ID of the measurement task you want to view.
Data type: Integer
Default value: None
Instance count: 1-1
Output Parameter
DETAIL Shows the details of the measurement task.

Data type: Complex
Instance count: 1-1
TASKID Shows the ID of the task.

Data type: Integer
Instance count: 1-1
TASKNAME Shows the name of the task.

Data type: String
Instance count: 1-1
NODEID Shows the ID of the server where the task is created.

Value type: String
Instance count: 1-1
CREATOR Shows the creator of the task.

Data type: String
Instance count: 1-1
CREATETIME Shows the time when the task was created.

Data type: String
Instance count: 1-1
MODIFYTIME Shows the time when the task has been modified.
Data type: String
Instance count: 1-1
STATUS Shows the status of the task.

Instance count: 1-1
GRAN Shows the data collection granularity of the task.

Data type: String
Instance count: 1-1
BEGINDATE Shows the start time of the task.

Data type: String
Instance count: 1-1
11-61

ENDDATE Shows the end time of the task.

Data type: String
Instance count: 1-1
DATEMASK Shows the running date of the task.

Data type: String
Instance count: 1-1
TIMEMASK Shows the running time period of the task.

Data type: String
Instance count: 1-1
MEASOBJTYPE Shows the type of measured objects involved in the task.

Data type: String
Instance count: 1-1
MEASTYPE Shows the measurement type of the task.

Data type: String
Instance count: 1-1
NETYPE Shows the type of the NE involved in the task.

Data type: String
Instance count: 1-1
LOCTYPE Shows the location type of the task.

Instance count: 1-1
NELOC Shows the NE location of the task.

Data type: String
Instance count: 1-1
TASKTYPE Shows the task type.

Instance count: 1-1
MEASOBJLIST Shows the list of measured objects involved in the task.

Data type: String
Instance count: 1-1
LOCTYPE COMMON Common location
GROUP Group location
11-62

Chapter 11 S
TASKTYPE 0 Normal task
3 All-PO task
Example
To show the details of a measurement task with ID 125, type the following command:
SHOW MEASTASK:TASKID=125;
11.37 SHOW NETWORK DATA

Function
This command is used to show the information of data packets sent and received by a
network adapter.
Syntax
SHOW NETWORK DATA: [ PERIOD= < PERIOD> ] [ , TIMES= < TIMES> ] IP= < IP> ;
Input Parameters
PERIOD (Optional) Specifies the sampling period (unit: second) for viewing the
data packets.
Data type: Integer
Value range: 2-60
Default value: None
Instance count: 1-1
TIMES (Optional) Specifies the number of sampling times.

Data type: Integer
Value range: 1-10
Default value: None
Instance count: 1

Data type: Address
Default value: None
Instance count: 1-1
11-63

Output Parameter
NETWORKINFO Shows the information of data packets, including the sent error packets,
received error packets, sent data packets, received data packets, and
the name of the network adapter.
Data type: Complex
Remarks
The first sampling cycle is PERIOD*2 because the period of sending this command is 2
seconds.
Example
To show the network information of the server 10.75.72.153, type the following command:
SHOW NETWORK DATA:PERIOD=2,TIMES=1,IP=10.75.72.153;
11.38 SHOW NETWORK PORT

Function
This command is used to show the information of the port used by the EMS.
Syntax
SHOW NETWORK PORT: IP= < IP> ;
Input Parameter
IP (Optional) Specifies the IP address of the EMS server.

Data type: Address
Default value: None
Instance count: 1-1
Output Parameter
PORTINFO Shows the information of the network port, including the port number, port
description, port state, the process occupying the port, and the description
of the process.
Data type: Complex
11-64

Chapter 11 S
Example
To show the network port information of a server (10.75.72.153), type the following
command:
SHOW NETWORK PORT:IP=10.75.72.153;
11.39 SHOW NMDBUSER

Function
This command is used to show the list of database users.
Syntax
SHOW NMDBUSER;
Input Parameter
None
Output Parameter
USERNAME Shows the information of database users.

Data type: String
Example
To show all users of the database, type the following command:
SHOW NMDBUSER;
11.40 SHOW NMFTPUSER

Function
This command is used to show the list of FTP users.
Syntax
SHOW NMFTPUSER;
Input Parameter
None
11-65

Output Parameter
USERNAME Shows the information of FTP users.

Data type: String
Example
To show all FTP users, type the following command:
SHOW NMFTPUSER;
11.41 SHOW QOSTASK

Function
This command is used to show the details of a QoS task.
Format
SHOW QOSTASK: TASKID= <TASKID>;
Input Parameter
TASKID (Required) Specifies the ID of the QoS task you want to view.
Data type: Integer
Instance count: 1-1
Output Parameters
DETAIL Shows the details of the QoS task.

Data type: Complex
Instance count: 1-1
TASKID Shows the task ID.

Data type: Integer
Instance count: 1-1
TASKNAME Shows the task name.

Data type: String
Instance count: 1-1
NODEID Shows the ID of the node where the QoS task was created.
Data type: String
Instance count: 1-1
11-66

Chapter 11 S
CREATOR Shows the task creator.

Data type: String
Instance count: 1-1
CREATTIME Shows when the task was created.

Data type: String
Instance count: 1-1
MODIFYTIME Shows when the task has been modified.

Data type: String
Instance count: 1-1
STATUS Shows the task status.

Instance count: 1-1
GRAN Shows the data collection granularity specified in the task.

Data type: Integer
Instance count: 1-1
BEGINDATE Shows the start date of the task.

Data type: String
Instance count: 1-1
ENDDATE Shows the end date of the task.

Data type: String
Instance count: 1-1
DATEMASK Shows the running date of the task.

Data type: String
Instance count: 1-1
TIMEMASK Shows the running period of the task.

Data type: String
Instance count: 1-1
MEASOBJTYPE Shows the type of measured objects involved in the task.

Data type: String
Instance count: 1-1
NETYPE Shows the type of NEs involved in the task.

Data type: String
Instance count: 1-1
TASKTYPE Shows the task type.

Data type: String
Instance count: 1-1
MONITORTYPE Shows the monitoring mode.

Data type: String
Instance count: 1-1
11-67

NELOC Shows the location of NEs.

Data type: String
Instance count: 1-1
CONDITION Shows the conditions of the task.

Data type: String
Instance count: 1-1
THRESHOLD Shows the thresholds set in the QoS task.

Value type: Complex
INDEXID Shows the IDs of indexes involved in the task.

Data type: String
Instance count: 1-1
INDEXNAME Shows the names of indexes involved in the task.

Data type: String
Instance count: 1-1
DIRECTION Shows the direction of thresholds.

Instance count: 1-1
VALUETYPE Shows the value type of indexes.

Instance count: 1-1
ALARMCRITICAL Shows the thresholds for raising critical alarms.

Data type: String
Instance count: 1-1
ALARMCRITI- Shows the hysteresis value of thresholds for raising critical alarms.
CALDELTA Data type: String
Instance count: 1-1
ALARMMAJOR Shows the thresholds for raising major alarms.

Data type: String
Instance count: 1-1
ALARMMAJORDELTA Shows the hysteresis value of thresholds for raising major alarms.
Data type: String
Instance count: 1-1
ALARMMINOR Shows the thresholds for raising minor alarms.

Data type: String
Instance count: 1-1
11-68

Chapter 11 S
ALARMMINORDELTA Shows the hysteresis value of thresholds for raising minor alarms.
Data type: String
Instance count: 1-1
ALARMWARN Shows the thresholds for raising warning alarms.

Data type: String
Instance count: 1-1
ALARMWARNDELTA Shows the hysteresis value of thresholds for raising warning alarms.
Data type: String
Instance count: 1-1
SUGGESTION Shows the handling suggestion of threshold crossing alarms.

Data type: String
Instance count: 1-1
FINISH Finished



FLOAT Floating point
PERCENT Percentage
BOOLEAN Boolean
STATISTIC Statistic
Example
To view the details of a QoS task with the ID 125, type the following command:
SHOW QOSTASK:TASKID=125;
11-69

11.42 SHOW RAM USAGE

Function
This command is used to show the RAM utilization of the server.
Syntax
SHOW RAM USAGE: IP= < IP> ;
Input Parameter

Data type: Address
Default value: None
Instance count: 1-1
Output Parameter
MEM Shows the utilization information of the RAM, including the size of the
available memory, the physical memory of the system, the size of the swap
space, and the size of the used space.
Data type: Complex
Instance count: 1-1
Example
To show the RAM utilization of the server 10.75.72.153, type the following command:
SHOW RAM USAGE:IP=10.75.72.153;
11.43 SHOW ROLE

Function
This command is used to show the details of a specific role.
Syntax
SHOW ROLE: NAME= < NAME> ;
11-70

Chapter 11 S
Input Parameter
NAME (Required) Specifies the name of the role you want to view.
Data type: String
Default value: None
Instance count: 1-1
Output Parameters
NAME Shows the role name.

Data type: String
Instance count: 1-1
DESCRIPTION Shows the description of the role.

Data type: String
Instance count: 1-1
LOCKED Shows whether the role is locked.

Data type: Boolean
Instance count: 1-1
Example
To show a role (NAME= 1), type the following command:
SHOW ROLE : NAME= "1";
11.44 SHOW ROLE SET

Function
This command is used to show the details of a specific role set.
Syntax
SHOW ROLE SET: NAME= < NAME> ;
Input Parameter
NAME (Required) Specifies the name of the role set you want to view.
Data type: String
Default value: None
Instance count: 1-1
11-71

Output Parameters
NAME Shows the role set name.

Data type: String
Instance count: 1-1
DESCRIPTION Shows the description of the role set.

Data type: String
Instance count: 1-1
LOCKED Shows whether the role set is locked.

Data type: Boolean
Instance count: 1-1
Example
To show a role set (NAME= 1), type the following command:
SHOW ROLE SET: NAME= "1";
11.45 SHOW SECURITY LOG

Function
This command is used to show the information of security logs.
Syntax
SHOW SECURITY LOG: [ USERNAME= < USERNAME> ] [ , IP= < IP> ] [ , LOGSTART
DATE_FROM= < LOGSTARTDATE_FROM> ] [ , LOGSTARTDATE_TO= < LOGSTARTDA
TE_TO> ] [ , CONMODE= < CONMODE> ] ;
Input Parameters
USERNAME (Optional) Specifies the name of the user for viewing the security logs
related to the user.
Data type: String
Default value: None
11-72

Chapter 11 S
IP (Optional) Specifies the IP address of the client for viewing the information
of security logs related to the client.
Value type: String
Default value: None
LOGSTARTDATE_FR (Optional) Sets the start time of the period for viewing the information of
OM security logs during this period.
Data type: Date
Default value: None
Instance count: 1-1
LOGSTARTDATE_TO (Optional) Sets the end time of the period for viewing the information of
security logs during this period.
Data type: Date
Default value: None
Instance count: 1-1
CONMODE (Optional) Specifies the connection mode for querying corresponding

security logs.
Default value: None
Instance count: 1-4
Output Parameters
USERNAME Shows the user name in each security log.

Data type: String
Instance count: 1-1
CLIENTIP Shows the IP address of the client involved in each security log.
Data type: String
Instance count: 1-1
OPERATE Shows the name of each security log.

Data type: String
Instance count: 1-1
LOGTIME Shows the operation time recorded in each security log.

Data type: String
Instance count: 1-1
CONMODE Shows the connection mode of the corresponding client.

Instance count: 1-1
11-73

DESCRIPTION Shows the additional information of each security log.

Data type: String
Instance count: 1-1
LOG Shows the information of the first 500 security logs in the query result.
Data type: Complex
CONMODE (input GUI Graphical user interface

parameter)
TELNET TELNET
NDA NDA
SSH Secure shell
CONMODE (output GUI Graphical user interface

parameter)
TELNET TELNET
NDF NDF
CORBA CORBA
SSH Secure shell
SNMP SNMP
TL1 TL1
MTOSI MTOSI
EMS EMS
Remarks
Only the first 500 logs can be displayed in the query result.
Example
To view the information of security logs during the period from 2009-12-24 16:40:36 to
2009-12-25 16:40:37 on the host 10.75.64.44, type the following command:
SHOW SECURITY LOG:USERNAME="a",IP="10.75.64.44",LOGSTARTDATE_FROM
="2009-12-24 16:40:36",LOGSTARTDATE_TO="2009-12-25 16:40:37",CON
MODE="TELNET";
11-74

Chapter 11 S
11.46 SHOW SYSTEM LOG

Function
This command is used to show the information of system logs.
Syntax
SHOW SYSTEM LOG: [ IP= < IP> ] [ , LOGSTARTDATE_FROM= < LOGSTARTDATE_FR
OM> ] [ , LOGSTARTDATE_TO= < LOGSTARTDATE_TO> ] [ , LOGRANK= < LOGRANK>
] [ , LOGSOURCE= < LOGSOURCE> ] [ , TASKNAME= < TASKNAME> ] ;
Input Parameters
IP (Optional) Specifies the IP address of the host for viewing the information
of system logs on the host.
Data type: String
Default value: None
LOGRANK (Optional) Specifies the rank of system logs you want to view.
Default value: None
Instance count: 1-6
LOGSTARTDATE_FR (Optional) Sets the start time of the period for viewing the information of
OM system logs during this period.
Data type: Date
Instance count: 1-1
LOGSTARTDATE_TO (Optional) Sets the end time of the period for viewing the information of
system logs during this period.
Data type: Date
Default value: None
Instance count: 1-1
LOGSOURCE (Optional) Specifies the source of the system logs you want to view.
Data type: String
Default value: None
TASKNAME (Optional) Specifies the name of the system logs you want to view.
Data type: String
Default value: None
11-75

Output Parameter
LOG Shows the information of the first 500 system logs in the query result,
including the log rank, log name, log source, host name, start time, end
time, and description.
Data type: Complex
LOGRANK 1 Emergency
2 Alert
3 Error
4 Warning
5 Notification
6 Information
Example
To view the information of system logs (rank 6) during the period from 2009-12-24 16:41:13
to 2009-12-25 16:41:13 on the host 10.75.64.44, type the following command:
SHOW SYSTEM LOG:IP="10.75.64.44",LOGSTARTDATE_FROM="2009-12-24
16:41:13",LOGSTARTDATE_TO="2009-12-25 16:41:13",LOGRANK="6",LOGSO
URCE="logmodule";
11.47 SHOW USER

Function
This command is used to show the information of a user.
Syntax
SHOW USER : NAME= < NAME> ;
11-76

Chapter 11 S
Input Parameter
NAME (Required) Specifies the name of the user you want to view.
Data type: String
Default value: None
Instance count: 1
Output Parameters
NAME Shows the user name.

Data type: String
Instance count: 1-1
CREATOR Shows the creator of the user.

Data type: String
Instance count: 1-1
FULLNAME Shows the full name of the user.

Value type: String
Instance count: 1-1
DESCRIPTION Shows the additional information of the user.

Value type: String
Instance count: 1-1
PHONENUMBER (Optional) Modifies the phone number of the user.

Data type: String
Instance count: 1-1
EMAILADDRESS Shows the Email address of the user.

Data type: String
Instance count: 1-1
DEPARTMENT Shows the department to which the user belongs.

Data type: String
Instance count: 1-1
USERVALIDDAYS Shows the validity period of the user account.

Data type: Integer
Instance count: 1-1
PASSWORDVALIDDA Shows the longest reservation period of the password.

YS Value type: Integer
Instance count: 1-1
11-77

PASSWORDKEEPDAY Shows the shortest reservation period of the password.

S Data type: Integer
Instance count: 1-1
DISABLE Shows whether the reservation period of the password is disabled.

Data type: Boolean
Instance count: 1-1
ROLEARRAY Shows the roles assigned to the user.

Data type: String
Instance count: 1-1
ROLESETARRAY Shows the role sets assigned to the user.

Data type: String
Instance count: 1-1
ISINBLACKLIST Shows whether the user is in the black list.

Data type: Boolean
Instance count: 1-1
INBLANKLISTREASO Shows why the user is put in the black list.

N Data type: String
Instance count: 1-1
USERSTOPACCDAYS Shows the account suspended duration (days).

Data type: Integer
Instance count: 1-1
LOGROLEARRAY Shows whether the user is assigned with a role that is allowed to view logs.
Data type: String
Instance count: 1-1
LOGROLESETARRAY Shows whether the user is assigned with a role set that is allowed to view
logs.
Data type: String
Instance count: 1-1
Example
To view the information of the user whose name is user 1, type the following command:
SHOW USER:NAME="user 1";
11.48 SYNCH MEASTASK

Function
This command is used to synchronize a measurement task from the EMS to the
corresponding NEs.
11-78

Chapter 11 S
Syntax
SYNCH MEASTASK: [ TASKID= < TASKID> ] ;
Input Parameter
TASKID (Required) Specifies the ID of the measurement task you want to

synchronize to the corresponding NE(s).
Data type: Integer
Default value: None
Instance count: 1-1
Output Parameter
RESULT Shows the synchronization result.

Data type: Complex
Instance count: 1-1
Example
To synchronize the measurement task with the ID of 100 to the corresponding NE(s), type
the following command:
SYNCH MEASTASK:TASKID=100;
11-79

11-80

Appendix A
Error Messages
This Appendix lists all possible error messages. If an error message is unclear, please
contact the administrator or ZTE.
Mod-
Error Code Level Lable
ule
FM 0x00001400 INFO Other error
FM 0x00001401 INFO Alarm service not found
FM 0x00001402 INFO Format of parameter is invalid
FM 0x00001403 INFO Fail to get alarm service interface of platform
FM 0x00001404 INFO Begin time later than end time
FM 0x00001405 INFO Necessary parameter is null
FM 0x00001406 INFO Execute F message error
FM 0x00001407 INFO The parameter is invalid
FM 0x00001408 INFO (Hint Message)
(Date must between 1753-01-01 00:00:00

FM 0x00001410 INFO
and 9999-12-31 23:59:59)
MML 0x00001900 INFO Command execute failed
MML 0x00001901 INFO Can not get Net Element No
MML 0x00001902 INFO Missing parameter
MML 0x00001903 INFO Illegal parameter
MML 0x00001904 INFO Invalid parameter
MML 0x00001905 INFO Measure task does not exist
MML 0x00001906 INFO PM object class does not exist
MML 0x00001907 INFO PM type does not exist
MML 0x00001908 INFO PM ID does not exist
MML 0x00001A00 INFO Command execute successful
MML 0x00001A01 INFO Command execute failed
MML 0x00001A02 INFO Command aborted
Error occurred when getting data from

MML 0x00001A03 INFO
database
A-1

Mod-
ule
Incorrect SQL statement for checking input

MML 0x00001A05 INFO
parameters
Incorrect SQL statement for checking input

MML 0x00001A06 INFO
parameters
MML 0x00001A07 INFO Incorrect SQL statement for operation
MML 0x00001A0B INFO Error occurred when reading the MML script
MML 0x00001A0C INFO Incorrect command No
Error occurred when connecting to the

MML 0x00001A0E INFO
database
MML 0x00001A0F INFO Command has no result
MML 0x00001A10 INFO Script define parameter error
MML 0x00001A11 INFO Timeout in fronted
Error occurred when preparing the package

MML 0x00001A12 INFO
to be sent.
MML 0x00001A13 INFO IP address is repeated
MML 0x00001A14 INFO The record(s) has already existed
MML 0x00001A18 INFO MA initialize failed
MML 0x00001A19 INFO Get input para info failed
MML 0x00001A1A INFO Get result failed
MML 0x00001A1B INFO Execute sql failed
MML 0x00001A1C INFO Output parameter name does not exist
MML 0x00001A1D INFO Output parameter sql return fields error
MML 0x00001A1E INFO Error code is invalid
MML 0x00001A1F INFO Get App Operation Log Failed
MML 0x00002100 INFO The required parameter is not input
Single choose, same group, one parameter

MML 0x00002104 INFO
permission only
Multi choose, same group, at least one

MML 0x00002105 INFO
parameter
MML 0x00002108 INFO Group parameter, input all or not
MML 0x0000210c INFO Data type error
MML 0x00002110 INFO Void parameter can't input
MML 0x00002114 INFO No support data type transfer
A-2

Appendix A Error Messages
Mod-
ule
MML 0x00002118 INFO Value check error
The void parameter must be in the complex

MML 0x0000211c INFO
para
MML 0x00002120 INFO Can input only one parameter value or none
MML 0x00002200 INFO MML parse error
MML 0x00002204 INFO MML version is disagree
MML 0x00002208 INFO Unknown error
MML 0x0000220c INFO Can't not create session
MML 0x00002210 INFO Time manager error
MML 0x00002214 INFO Has no transaction, so can't commit
MML 0x00002218 INFO Has no transaction,so can't rollback
MML 0x0000221c INFO Can't get service
MML 0x00002220 INFO Can't get the mml app
MML 0x00002224 INFO Database error
MML 0x00002228 INFO Datasource error
MML 0x0000222c INFO No support database
MML 0x00002230 INFO Send JMS failed
MML 0x00002234 INFO Please login first
MML 0x00002238 INFO Managed element does not exist
Check ICmdRequest.getResultCode()
equals ICmdResponse.SUCCESS,if equals
MML 0x0000223c INFO
then do normal, if not equals then do
exception
The command() is cancelled,maybe not

MML 0x00002240 INFO
finished
Because of request timeout, the command()

is cancelled, maybe not finished.if command
has request timeout time, please modify
MML 0x00002241 INFO
request timeout time of command; if request
timeout time is default request timeout time,
please use command:set to modify it
System parameter NEID can't input in

MML 0x00002244 INFO normal command,please use SET BUREAR
command
A-3

Mod-
ule
The file does not exist, the file path

is:\ums-server\works\global\runti
MML 0x00002248 INFO
me\ppus\uca.ppu\uca-mml.pmu\mml
batchfiles\
MML 0x00002252 INFO Can't read the batch file, file type must be txt
MML 0x00002256 INFO OMM does not exist or has been stopped
MML 0x00002257 INFO Mutex MML is running
MML 0x00002260 INFO Cancel running
MML 0x00002261 INFO Amo has not authentication
MML 0x00002262 INFO Connect error
MML 0x00002300 INFO XML file load failed
MML 0x00002304 INFO Element node does not exist
MML 0x00002308 INFO Loading parameter type error
MML 0x0000230c INFO Loading parameter value error
MML 0x00002310 INFO Loading virtual parameter error
MML 0x00002314 INFO Loading enum node failed
MML 0x00002318 INFO Loading error node failed
MML 0x0000231c INFO Loading attribute node failed
MML 0x00002320 INFO Loading element value failed
MML 0x00002324 INFO Command does not exist
MML 0x00002328 INFO Error code does not exist
MML 0x0000232c INFO Enum does not exist
MML 0x00002330 INFO Command has been forbidden
Parameter of this command does not exist,

MML 0x00002334 INFO
the parameter name or number is
MML 0x00002338 INFO Enum item does not exist
MML 0x0000233c INFO Enum value does not exist
MML 0x00002340 INFO Enum macro does not exist
MML 0x00002344 INFO System parameter access forbidden
MML 0x00002348 INFO i18n file error
MML 0x0000234c INFO omm does not exist
MML 0x0000234e INFO Command does not exist
MML 0x0000234f INFO Run batch has been interrupted
A-4

Mod-
ule
MML 0x00002350 INFO Get file from FTP exceptional
MML 0x00002351 INFO Disk space lack, unzip file error
Command forbidden execute by this

MML 0x00002352 INFO
connection type
MML 0x00002353 INFO Already been root, can't exit anymore
OMM has not been started or does not

MML 0x00002354 INFO
support the MML
MML 0x00002355 INFO Ehcache directory isn't exist
The CmdInfo version does not exist in the

MML 0x00002356 INFO
local
MML 0x00002357 INFO Can't exist any command file
MML 0x00002358 INFO Can't get this version's cache
MML 0x00002359 INFO Data files are copying now
MML 0x00002360 INFO Initialize ehcache is wrong
Get enumerate information from ehcache

MML 0x00002361 INFO
is wrong
MML 0x00002362 INFO Get error information from ehcache is wrong
Get command information from ehcache is

MML 0x00002363 INFO
wrong
MML 0x00002364 INFO Get command tree from ehcache is wrong
MML Authenticate Fail(Operating without

MML 0x00002400 INFO
authority)
MML 0x00002401 INFO MML Authenticate Exception
MML Authenticate Fail(Parameter:,Value:

MML 0x00002402 INFO
Invalid)
Not support re-login,please run "LOGOUT",

MML 0x00002403 INFO
firstly
MML information Error(Parameter:,Value:

MML 0x00002404 INFO
Invalid)
MML 0x00004BE5 INFO Config error
MML 0x00004BE6 INFO Timeout failed
MML 0x00004BE7 INFO Network failed
MML 0x00004BE8 INFO Array error
MML 0x00004BE9 INFO Parameter error
A-5

Mod-
ule
MML 0x00004BEA INFO Operation on nonexistent net element link
MML 0x00004BEB INFO Link failed
MML 0x00004BEC INFO Dynamic failed
MML 0x00004BED INFO Repetitive IP addr
MML 0x00004BEE INFO No such netype
MML 0x00004BEF INFO Session terminated
MML 0x00004C46 INFO Unknown Exception
MML 0x00004C48 INFO MacroReplace input format error
MML 0x00004C49 INFO Macro must be defined beginning of the file
MML 0x00004C4a INFO Macro can't repeat to be define
MML 0x00004C4b INFO Remote error
MML 0x00004C4c INFO The CmdInfo of this version is loading
MML 0x00004C4d INFO Command execute failure
MML 0x00004C4e INFO Command execute error
MML 0x00004C4f INFO CLIS Server is starting, please try later
MML 0x00004C50 INFO Login failed
MML 0x00004C51 INFO MOI:is invalid
MML 0x00004C52 INFO Invoke AMF service failed
The Network Element Does Not Support

MML 0x00004C53 INFO
The MML
The task name is invalid. Please ensure

MML 0x00004C55 INFO that the task name is not null and contains
no special characters
MML 0x00004C54 INFO Can't execute this command by license
MML 0x00004C56 INFO Session is out of limited
EMS command is being updated please

MML 0x00004C57 INFO
execute back later
MML 0x00004C58 INFO User name is null
MML 0x00004C59 INFO Network element agent no access
MML 0x00004C60 INFO Please logout current user
MML 0x00004C62 INFO ID does not exist
MML 0x00004C63 INFO ID already exist
MML 0x00004C64 INFO Database error
A-6

Mod-
ule
MML 0x00004C65 INFO IP address is not valid
MML 0x00004C66 INFO Port is not valid
MML 0x00004C67 INFO Value is empty
MML 0x00004C68 INFO EMS id does not exist
MML 0x00004C69 INFO EMS id already exist
MML 0x00004C70 INFO OMM does not start up
MML 0x00004C71 INFO Fail to detele MML time task
Lower session as long unused, have

MML 0x00004C72 INFO been destroyed, please switching network
element create new session
MML 0x00004C74 INFO Route element id() is a net element
MML 0x00004C73 INFO Route element id() is updating model
Null enum cannot be used with other enum

MML 0x00004C75 INFO
value at the same time
MML 0x00004C76 INFO Fail to build OMM transparent parameter
MML 0x00004C77 INFO Fail to parse OMM transparent parameter
The key of OMM transparent parameter is

MML 0x00004C78 INFO
null
MML 0x00004C79 INFO Route attribute object cannot be empty
MML 0x00004C80 INFO Client type is not configured
PM 0x32F02001 INFO Failed to deal the command code
PM 0x32F02002 INFO Failed to get measure object type
PM 0x32F02003 INFO Failed to get measure type
PM 0x32F02004 INFO Failed to get NE type by type id
PM 0x32F02005 INFO Failed to get measure object type by type id
PM 0x32F02006 INFO Failed to get counter
PM 0x32F02007 INFO Failed to execute F message
PM 0x32F02008 INFO Failed to get command code for F message
PM 0x32F02009 INFO Failed to get App type
PM 0x32F0200A INFO Index ID is wrong
PM 0x32F0200B INFO Failed to get index
PM 0x32F0200C INFO End ID should be greater than start ID
PM 0x32F0200D INFO Inputted ID repeated
A-7

Mod-
ule
PM 0x32F0200E INFO Failed to get logging in user
PM 0x32F0200F INFO Granularity is invalid
PM 0x32F02010 INFO NE location is invalid
PM 0x32F02011 INFO Failed to get measurement task's Ne type
PM 0x32F02012 INFO Error measure type ID
PM 0x32F02013 INFO Invalid measure object list
PM 0x32F02014 INFO Active condition index must be Boolean type
PM 0x32F02015 INFO Failed to get CM object by NE object
PM 0x32F02016 INFO Invalid PM object in measure object list
PM 0x32F02017 INFO Failed to get task information by task ID.
PM 0x32F02018 INFO Only the suspensive status can be modified
Begin time can't be modified when task was

PM 0x32F02019 INFO
began
Begin time should be later than the current

PM 0x32F0201A INFO
time
PM 0x32F0201B INFO Begin time must be earlier than end time
Invalid date format, the right format should

PM 0x32F0201C INFO
be YYYY-MM-DD HH24:MI:SS
Time is not an integral multiple of the time

PM 0x32F0201D INFO
granularity
Time difference between begin and end

PM 0x32F0201E INFO time should be an integral multiple of the
time granularity
Invalid time mask format,the right format

PM 0x32F0201F INFO
should be HH24:MI:SS,HH24:MI:SS
Time mask is not an integral multiple of the

PM 0x32F02020 INFO
time granularity
End time mask should be later than begin

PM 0x32F02021 INFO
time mask and less than 24 hours
PM 0x32F02022 INFO NE location repeated
Time mask must not more than 12 time

PM 0x32F02023 INFO
periods
PM 0x32F02024 INFO Time mask can not be repeated period
PM 0x32F02025 INFO Invalid date mask format
A-8

Mod-
ule
The day in date mask is not between begin

PM 0x32F02026 INFO
time and end time
At least one valid collection time should be

set! A valid time indicates that between the
begin and end time, at least one collection
PM 0x32F02027 INFO time remains after the AND/OR operation of
the time mask and date make is performed
and the collection time is an integral multiple
of the collection granularity
PM 0x32F02028 INFO Repeated KPI index ID in threshold
PM 0x32F02029 INFO Invalid KPI index ID in threshold
PM 0x32F0202A INFO Threshold value or delta must be Integer.
Threshold value or delta can't greater than

PM 0x32F0202B INFO
four decimal fractions
The order of alarm value is wrong.

PM 0x32F0202C INFO When the direction is upward,
critical>major>minor>warning
The order of alarm value is wrong.

PM 0x32F0202D INFO When the direction is downward,
critical<major<minor<warning
PM 0x32F0202E INFO APP type of the task was changed
PM 0x32F0202F INFO NE type should be the same
PM 0x32F02030 INFO Should input correct measure objects
Input task type value is invalid. Please

PM 0x32F02031 INFO
consult the vailid value list
Cannot modify tasks created by the superior

PM 0x32F02032 INFO
server on current server
Task name length is greater than 100

PM 0x32F02033 INFO characters according to "%Ne Type%-%Ne
Name%" auto named rule
PM 0x32F02034 INFO Failed to get Server service
PM 0x32F02035 INFO Failed to get Extention implement
PM 0x32F02036 INFO Failed to get PM query data config
Invalid segment format,the right format

PM 0x32F02037 INFO
should be YYYY-MM-DD HH24:MI:SS
A-9

Mod-
ule
Segment is not an integral multiple of the

PM 0x32F02038 INFO
ROMP granularity
Segment end time should be later than

PM 0x32F02039 INFO
begin time and less than 24 hours
Exceeded the max segment number be set

PM 0x32F0203A INFO
in current system
PM 0x32F0203B INFO Segment can not be repeated
PM 0x32F0203C INFO Failed to get query by type
PM 0x32F0203D INFO Failed to get group by type
Exceeded the max query measure object

PM 0x32F0203E INFO
number
PM 0x32F0203F INFO Exceeded the max query item number
Invalid index item in current measure object

PM 0x32F02040 INFO
type
Invalid counter item in current measure

PM 0x32F02041 INFO
object type
Invalid measure type in current measure

PM 0x32F02042 INFO
object type
PM 0x32F02043 INFO Please input the right filter operator
PM 0x32F02044 INFO Please input the right filter value
PM 0x32F02045 INFO Failed to get csp-pm-mml par
PM 0x32F02046 INFO Failed to create data file
The counter not belong to task's measure

PM 0x32F02047 INFO
type
Must input the measure objects when task

PM 0x32F02048 INFO
created by NE
Two approaching grade delta'plus should

be less than two alarm value'minus.
PM 0x32F02049 INFO
For example,(critical delta+major
delta)<=(critical-major)
Threshold exceed the valid scope. Integer:

PM 0x32F0204A INFO
[-999999999, 999999999]
Threshold value exceed the valid scope.

PM 0x32F0204B INFO
Float: [-999999999.999, 999999999.999]
A-10

Mod-
ule
Threshold value exceed the valid scope.

PM 0x32F0204C INFO
Percent: [0, 1]
Delta exceed the valid scope. Integer: [0,

PM 0x32F0204D INFO
999999999]
Delta exceed the valid scope. Float: [0,

PM 0x32F0204E INFO
999999999.999]
Delta exceed the valid scope. Percent: [0,

PM 0x32F0204F INFO
1]
PM 0x32F02050 INFO Please set one grade alarm at least
PM 0x32F02051 INFO Measure object repeated
The KPI can not be boolean value type in

PM 0x32F02052 INFO
threshold
PM 0x32F02053 INFO Index name can not be null
Index value type is integer, so the value

PM 0x32F02054 INFO
must be integer
Index value can not greater than four

PM 0x32F02055 INFO
decimal fractions
Index value type is percent, so the valid

PM 0x32F02056 INFO
scope is [0,1]
PM 0x32F02057 INFO Error in index formula
PM 0x32F02058 INFO Can not operate system or readonly index
Index information not changed, do not need

PM 0x32F02059 INFO
update
No record is operated, this record you have

PM 0x32F0205A INFO selected may have be deleted or modified
by others
This index is used by QoS task, so it can't

PM 0x32F0205B INFO
be modified from KPI to PI
Name should be unique with the same Ne

PM 0x32F0205C INFO Type and Object type, select another name
please
Please input the active condition index

PM 0x32F0205D INFO
correctly
PM 0x32F0205E INFO Index type of SPI could not be changed
Index type of KPI and PI could not be

PM 0x32F0205F INFO
changed to SPI
A-11

Mod-
ule
PM 0x32F02060 INFO Only the value type of SPI could be Statistic
Input monitor type value is invalid. Please

PM 0x32F02061 INFO
consult the valid value list
Input query by type value is invalid. Please

PM 0x32F02062 INFO
Input group by type value is invalid. Please

PM 0x32F02063 INFO
System not support object type to weekly

PM 0x32F02064 INFO
summary or monthly summary
For "Hourly Time Segment Column

PM 0x32F02065 INFO Summary", you can only select one Index
or Counter
Only index with Boolean data type can set

PM 0x32F02066 INFO
Boolean filter operator
Top Max/Min N Filter can only set one filter

PM 0x32F02067 INFO
item
The filter value of Top Max/Min N Filter must

PM 0x32F02068 INFO
be Integer greater than 0
Only "Top Max/Min N Filter" can set Top

PM 0x32F02069 INFO
Max/Min operator
For object type, system limit you can only

PM 0x32F0206A INFO
query or summarize 24 hours data
For "User-defined All Time Summary",

PM 0x32F0206B INFO system limit you can only summarize 72
hours data
For "Hourly Time Segment Column

PM 0x32F0206C INFO Summary", system limit you can only query
or summarize 1 months data
System limit you can only query or

PM 0x32F0206D INFO
summarize 3 months data
ROLE 0x00001700 INFO Exception occurred
ROLE 0x00001701 INFO No record
ROLE 0x00001702 INFO User does not exist
ROLE 0x00001703 INFO Role does not exist
ROLE 0x00001704 INFO Role set does not exist
ROLE 0x00001705 INFO Department does not exist
A-12

Mod-
ule
Department can not belong to itself or it's

ROLE 0x00001706 INFO
junior department
Only can modify Administrator's full name ,

telephone, Email address and description
ROLE 0x00001708 INFO No Permission
ROLE 0x00001709 INFO Can not delete admin
Can not disable admin or modify admin's

ROLE 0x0000170A INFO
right
No permission to change current user's

ROLE 0x0000170C INFO
password
No permission to modify or delete current

ROLE 0x0000170D INFO
user
No permission to set current user's role or

ROLE 0x0000170E INFO
role set
ROLE 0x0000170F INFO Can not delete root department
Can not delete this department,there are

sub-departments or users in this department
ROLE 0x00001721 INFO Root department can modify name only
Normal department can modify super

department and description only
No permission to modify or delete this

department
ROLE 0x00001724 INFO Only admin can delete session
ROLE 0x00001725 INFO Can not delete session yourself
ROLE 0x00001726 INFO Email format is incorrect
ROLE 0x00001727 INFO Session does not exist
ROLE 0x00001728 INFO Phone number format is incorrect
Cannot use this command to change

current user password
ROLE 0x0000172A INFO The old password is error
The confirm password is different from new

ROLE 0x0000172B INFO
password
ROLE 0x0000172C INFO User name has existed
Confirm Password differs from new

ROLE 0x0000172D INFO
password, please re-enter
A-13

Mod-
ule
ROLE 0x0000172E INFO Super Department does not exist
A-14

Glossary
AMO
- Access Managed Object
EMS
- Network Element Management System
J2EE
- JAVA 2 platform Enterprise Edition
MML
- Man Machine Language
OMM
- Operation & Maintenance Module

Om Oc221 E01 1 Ran Ems MML Command Reference 207 PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Om Oc221 E01 1 Ran Ems MML Command Reference 207 PDF

Uploaded by

Copyright:

Available Formats

NetNumen U31 R18

Unified Element Management System

Revision No. Revision Date Revision Reason

R1.1 2011-1026 Appendix A, Error Messages is added.

R1.0 2011-0830 First Edition

Serial Number: SJ-20110823134613-004

Publishing Date: 2011-12-08(R1.2)

Chapter 2 A ................................................................................................. 2-1

Chapter 3 B ................................................................................................. 3-1

Chapter 4 C ................................................................................................. 4-1

Chapter 5 D ................................................................................................. 5-1

Chapter 7 G ................................................................................................. 7-1

Chapter 8 H ................................................................................................. 8-1

Chapter 9 Q ................................................................................................. 9-1

Chapter 10 R ............................................................................................. 10-1

Chapter 11 S.............................................................................................. 11-1

Appendix A Error Messages..................................................................... A-1

1.1 MML Command Composition

The following describes each part of an MML command.

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

1.2 Parameter Data Types

Data Type Description

Float Float parameters and float parameter arguments are supported:

Identifier An identifier parameter has a value starting with a letter.

Enumeration Enumeration parameters and enumeration parameter arguments are

Date A date parameter has a value in the format of "YYYY-MM-DD"

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

Data Type Description

String String parameters and string parameter arguments are supported:

Complex A complex parameter has a value containing different types of data. It

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

This page intentionally left blank.

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

2.1 ADD DEPARTMENT

NAME (Required) Specifies a name for the department to be created.

DESCRIPTION (Optional) Adds a description for the department to be created.

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

SUPERDEPARTMENT (Optional) Assigns an upper-level department to the department to be

RESULT Returns the creation result.

2.2 ADD INDEX

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

INDEXNAME (Required) Specifies a name for the index to be created.

VALUETYPE (Required) Specifies a data type for the index to be created.

FORMULA (Required) Sets the formula of the new index.

INDEXTYPE (Required) Specifies the type of the new index.

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

INDEXDESC (Optional) Adds a description of the new index.

RESULT Returns the creation result.

Parameter Member Description

VALUETYPE INTEGER Integer

FLOAT Float pointing

INDEXTYPE PI Performance index

KPI Key performance index

SPI Statistical performance index

DIRECTION UP Upward: An alarm occurs when the index value

DOWN Downward: An alarm occurs when the index

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

2.3 ADD MEASTASK

MEASTYPEID (Required) Specifies the type of the measured object to be involved in

SJ-20110823134613-004|2011-12-08(R1.2) ZTE Proprietary and Confidential

NELOC (Required) Specifies the location of NE(s) to be involved in the new