03.developer Guide (Performance)

iManager U2000 Unified Network Management
System
V200R015C50
XML NBI Developer Guide

(Performance)
Issue 02
Date 2015-08-15
HUAWEI TECHNOLOGIES CO., LTD.

Copyright © Huawei Technologies Co., Ltd. 2015. All rights reserved.
No part of this document may be reproduced or transmitted in any form or by any means without prior written
consent of Huawei Technologies Co., Ltd.
Trademarks and Permissions
and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective holders.
Notice
The purchased products, services and features are stipulated by the contract made between Huawei and the
customer. All or part of the products, services and features described in this document may not be within the
purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information,
and recommendations in this document are provided "AS IS" without warranties, guarantees or representations
of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but all statements, information, and
recommendations in this document do not constitute a warranty of any kind, express or implied.
Huawei Technologies Co., Ltd.

Address: Huawei Industrial Base
Bantian, Longgang
Shenzhen 518129
People's Republic of China
Website: http://www.huawei.com
Email: support@huawei.com
Issue 02 (2015-08-15) Huawei Proprietary and Confidential i

Copyright © Huawei Technologies Co., Ltd.
iManager U2000 Unified Network Management System
XML NBI Developer Guide (Performance) About This Document
About This Document
Related Versions
The following table lists the product versions related to this document.
Product Name Version
iManager U2000 V200R015C50
Intended Audience
Focusing on the performance management of the XML NBI (northbound interface), this
document describes the secondary development of the NBI from the aspects as follows: basic
information, interface function, interface model, object attributes, notification format and sample
message.
This document provides the reference information about the performance management of the
XML NBI.
This document is intended for:
l Application Developer
l Data Configuration Engineer
Symbol Conventions
The symbols that may be found in this document are defined as follows.
Symbol Description
Indicates an imminently hazardous situation

which, if not avoided, will result in death or
serious injury.
Indicates a potentially hazardous situation

which, if not avoided, could result in death or
serious injury.
Issue 02 (2015-08-15) Huawei Proprietary and Confidential ii

Symbol Description

which, if not avoided, may result in minor or
moderate injury.

which, if not avoided, could result in
equipment damage, data loss, performance
deterioration, or unanticipated results.
NOTICE is used to address practices not
related to personal injury.
Calls attention to important information, best

practices and tips.
NOTE is used to address information not
related to personal injury, equipment damage,
and environment deterioration.
Command Conventions
The command conventions that may be found in this document are defined as follows.
Convention Description
Boldface The keywords of a command line are in boldface.
Italic Command arguments are in italics.
[] Items (keywords or arguments) in brackets [ ] are optional.
{ x | y | ... } Optional items are grouped in braces and separated by

vertical bars. One item is selected.
[ x | y | ... ] Optional items are grouped in brackets and separated by

vertical bars. One item is selected or no item is selected.
{ x | y | ... }* Optional items are grouped in braces and separated by

vertical bars. A minimum of one item or a maximum of all
items can be selected.
[ x | y | ... ]* Optional items are grouped in brackets and separated by

vertical bars. Several items or no item can be selected.
GUI Conventions
The GUI conventions that may be found in this document are defined as follows.
Issue 02 (2015-08-15) Huawei Proprietary and Confidential 3

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

are in boldface. For example, click OK.
> Multi-level menus are in boldface and separated by the ">"

signs. For example, choose File > Create > Folder.
Change History
Updates between document issues are cumulative. Therefore, the latest document issue contains
all updates made in previous issues.
Changes in Issue 02 (2015-08-15) Based on Product Version V200R015C50

second release.
Changes in Issue 01 (2015-05-25) Based on Product Version V200R015C50

Initial release.

XML NBI Developer Guide (Performance) Contents
Contents
About This Document.....................................................................................................................ii

1 Overview.........................................................................................................................................1
1.1 Introduction....................................................................................................................................................................2
1.2 Introduction to Performance Function..................................................................................... .......................................2
2 Message Exchange Pattern...........................................................................................................3

2.1 SRR...................................................................................................................... ...........................................................4
2.2 SIT...................................................................................................................... ............................................................4
2.3 SIT-ITERATOR........................................................................................................................... ..................................5
2.4 AFB................................................................................................................................................................................7
3 Interface Model..............................................................................................................................9
3.1 PerformanceManagementRetrieval............................................................................................................... ...............10
3.1.1 getAllCurrentPerformanceMonitoringData...............................................................................................................10
3.1.2 getHistoryPerformanceMonitoringData.................................................................................... ................................11
3.1.3 getAllPerformanceMonitoringPoints............................................................................................ .............................12
3.1.4 getPfmInstanceByResource.......................................................................................................................................12
3.2 PerformanceManagementControl............................................................................................. ....................................13
3.2.1 createPerformanceMonitoringData............................................................................................................... .............13
3.2.2 deletePerformanceMonitoringData............................................................................................................................14
3.2.3 disablePerformanceMonitoringData....................................................................................... ...................................15
3.2.4 enablePerformanceMonitoringData...........................................................................................................................16
3.3 ThresholdCrossingAlertControl............................................................................................ .......................................17
3.3.1 setTcaTpParameter...................................................................................................... ..............................................17
3.3.2 getTcaTpParameter....................................................................................................................................................18
4 Object Attributes.........................................................................................................................20
4.1 PerformanceManagementRetrieval........................................................................................... ...................................21
4.1.1 PerformanceMonitoringObjectSelectType........................................................................................ ........................21
4.1.2 PerformanceMonitoringObjectSelectListType..........................................................................................................23
4.1.3 PerformanceMonitoringParameterNameListType....................................................................................................23
4.1.4 PerformanceMonitoringMeasurementType...............................................................................................................23
4.1.5 PerformanceMonitoringMeasurementListType........................................................................................................24
4.1.6 PerformanceMonitoringDataType.......................................................................................... ...................................24

4.1.7 PerformanceMonitoringDataListType...................................................................................... .................................25

4.1.8 GetAllCurrentPerformanceMonitoringDataRequest.................................................................................................25
4.1.9 MultiplePerformanceMonitoringDataObjectsResponseType....................................................................................25
4.1.10 GetHistoryPerformanceMonitoringDataRequest....................................................................................................26
4.1.11 PerformanceMonitoringThresholdType..................................................................................................................27
4.1.12 ThresholdCrossingAlertType............................................................................................ ......................................27
4.1.13 ThresholdCrossingAlertListType.......................................................................................... ..................................29
4.1.14 GetPfmInstanceByResourceRequest.......................................................................................................................30
4.1.15 GetPfmInstanceByResourceResponse...................................................................................... ...............................30
4.1.16 PerformanceMonitoringInstanceListType...............................................................................................................31
4.1.17 PerformanceMonitoringInstanceType..................................................................................... ................................31
4.1.18 PmMonitorConditioningType............................................................................................. ....................................32
4.1.19 GetAllPerformanceMonitoringPointsRequest.........................................................................................................33
4.1.20 ActivityStatusEnumType................................................................................................ .........................................33
4.1.21 InstanceEnumType...................................................................................................... ............................................34
4.1.22 MultiplePerformanceMonitoringPointObjectsResponseType.................................................................................34
4.1.23 PerformanceMonitoringPointListType.................................................................................... ................................35
4.1.24 PerformanceMonitoringPointType............................................................................................... ...........................35
4.2 PerformanceManagementControl.................................................................................................................................35
4.2.1 CreatePerformanceMonitoringDataRequest..............................................................................................................36
4.2.2 CreatePerformanceMonitoringDataResponse...........................................................................................................36
4.2.3 PerformanceCreateInstanceType.......................................................................................... .....................................36
4.2.4 PerformanceCreateResourceType.......................................................................................... ...................................38
4.2.5 PerformanceTemplateType........................................................................................................................................38
4.2.6 DeletePerformanceMonitoringDataRequest..............................................................................................................38
4.2.7 DeletePerformanceMonitoringDataResponse...........................................................................................................39
4.2.8 DisablePerformanceMonitoringDataRequest............................................................................................................39
4.2.9 DisablePerformanceMonitoringDataResponse.........................................................................................................39
4.2.10 EnablePerformanceMonitoringDataRequest...........................................................................................................40
4.2.11 EnablePerformanceMonitoringDataResponse.........................................................................................................40
4.3 ThresholdCrossingAlertControl............................................................................................ .......................................41
4.3.1 SetTcaTpParameterRequest............................................................................................... ........................................41
4.3.2 SetTcaTpParameterResponse....................................................................................................................................41
4.3.3 GetTcaTpParameterRequest............................................................................................... .......................................42
4.3.4 ThresholdCrossingAlertParametersType...................................................................................................................42
4.3.5 GetTcaTpParameterResponse...................................................................................................................................43
4.3.6 PerformanceMonitoringThresholdValueListType....................................................................................................43
4.3.7 PerformanceMonitoringThresholdValueType.......................................................................................................... .43
5 Notification Format and Sample..............................................................................................45

5.1 Performance Threshold-Crossing Event............................................................................................................... ........46
6 Sample Message...........................................................................................................................48

6.1 TCA...................................................................................................................... ........................................................49
7 Object Naming Rules..................................................................................................................52

7.1 AID................................................................................................................. ..............................................................54
7.2 CC.................................................................................................................................................................................54
7.3 CTP........................................................................................................................... ....................................................55
7.4 EH.................................................................................................................................................................................56
7.5 EPG...................................................................................................................... .........................................................57
7.6 EQ....................................................................................................................... ..........................................................58
7.7 EXPLICITPATH..........................................................................................................................................................59
7.8 FDFR.......................................................................................................... ..................................................................60
7.9 FTP...............................................................................................................................................................................62
7.10 ISIS.............................................................................................................................................................................63
7.11 MAINTENANCEASSOCIATION............................................................................................................................63
7.12 MAINTENANCEDOMAIN....................................................................................................... ...............................64
7.13 MD.................................................................................................................................... ..........................................65
7.14 ME..............................................................................................................................................................................65
7.15 MEP..................................................................................................................... .......................................................66
7.16 MIP..................................................................................................................... ........................................................67
7.17 MLSN......................................................................................................................... ................................................67
7.18 OAMMEASURE........................................................................................................................................................68
7.19 OS...............................................................................................................................................................................69
7.20 PG...............................................................................................................................................................................69
7.21 PMINSTANCE...........................................................................................................................................................70
7.22 PTP..................................................................................................................... ........................................................71
7.23 RESOURCESITE............................................................................................................ ...........................................72
7.24 RMEP........................................................................................................................................................ .................73
7.25 SNC............................................................................................................................................................................73
7.26 TC...............................................................................................................................................................................75
7.27 TCPROFILE............................................................................................................... ................................................75
7.28 TL...............................................................................................................................................................................76
7.29 TMD..................................................................................................................... ......................................................77
7.30 TS................................................................................................................................................................................77
7.31 TUNNELPOLICY.................................................................................................................................................. ....78
7.32 VRRP................................................................................................................... .......................................................79
8 Description of Unimplemented and Customized Interfaces..............................................80

9 Layer Rate Description...............................................................................................................82
10 Glossary.......................................................................................................................................89
11 Acronyms and Abbreviations.................................................................................................95
Issue 02 (2015-08-15) Huawei Proprietary and Confidential vii

XML NBI Developer Guide (Performance) 1 Overview
1 Overview
About This Chapter
Unless otherwise specified, the XML NBI described in this document refers to the standardized
NBI that complies with the MTOSI 2.0 standard.
1.1 Introduction
1.2 Introduction to Performance Function

XML NBI Developer Guide (Performance) 1 Overview
1.1 Introduction
Compliant with MTOSI 2.0 standards, the XML northbound interface (NBI) have functions of
querying the current and historical performance data, and performance threshold-crossing alert
events. This document mainly describes the XML interfaces that are already realized to help
OSS developers and technical support engineers to better understand the functions of the
interfaces.
1.2 Introduction to Performance Function

Table 1-1 Performance Functions supported by the XML NBI
Function Function Description Domains Involved
Querying the current Querying the current PTN and transport domains
performance data performance by monitoring
conditions and parameter
names
Querying the historical Querying the historical Router, PTN,Access and

performance data performance by monitoring transport domains
conditions and parameter
names
Managing performance Querying, creating, enabling, Router and PTN domains

monitoring instances disabling, and deleting
monitoring instances
Reporting performance Reporting threshold-crossing Router, PTN, and transport

threshold-crossing events events domains

XML NBI Developer Guide (Performance) 2 Message Exchange Pattern
2 Message Exchange Pattern
About This Chapter
A message exchange pattern (MEP) is a template that establishes a pattern for the mapping and
exchange of messages between SOAP (short for simple object access protocol) nodes.
l SRR: synchronous request and response pattern.

l SIT: synchronous iterator pattern.
l SIT-ITERATOR: synchronous iterator pattern - iterator.
l AFB: Asynchronous file bulk.
2.1 SRR
Synchronous request response (SRR) is a message exchange pattern in which all response
information is returned at a time for each request.
2.2 SIT
Synchronous iterator pattern (SIT) is a message exchange pattern in which the response
information of a request is returned in an iterative way.
2.3 SIT-ITERATOR
Synchronous iterator pattern - iterator (SIT-ITERATOR) is a message exchange pattern similar
to SIT. When the sequence number of a request packet is greater than one, SIT is called SIT-
ITERATOR.
2.4 AFB
Asynchronous file bulk (AFB) is a message exchange pattern in which the response information
of a request is exported as files.

2.1 SRR
Synchronous request response (SRR) is a message exchange pattern in which all response
information is returned at a time for each request.
Name Type Value Remarks
security String User name:password If the user name is

admin and password
is test123, the value
of the security field is
as follows:
<security>admi
n:test123</
security>.
communicationPat- CommunicationPat- SimpleResponse N/A

tern ternType
communicationStyle CommunicationSty- RPC N/A

leType
2.2 SIT
Synchronous iterator pattern (SIT) is a message exchange pattern in which the response
information of a request is returned in an iterative way.

admin and password
as follows:
<security>admi
n:test123</
security>.
communicationPat- CommunicationPat- MultipleBatchRes- N/A

tern ternType ponse

leType

requestedBatchSize Long The value is greater This parameter

than or equal to 1. indicates the number
of resources
contained in each
information packet.
For alarm inventory
query interfaces of
the AlarmRetrieval
module, the
recommended value
of this parameter is
2000.
For alarm inventory
query interfaces of
the ResourceInven-
toryRetrieval
module, set the
recommended value
for this parameter by
referring to interface
description in the
related document.
For alarm inventory
query interfaces of
other modules, the
recommended value
1000.
batchSequenceNum- Long 1 N/A

ber
2.3 SIT-ITERATOR
Synchronous iterator pattern - iterator (SIT-ITERATOR) is a message exchange pattern similar
to SIT. When the sequence number of a request packet is greater than one, SIT is called SIT-
ITERATOR.


admin and password
as follows:
<security>admi
n:test123</
security>.
communicationPat- CommunicationPat- MultipleBatchRes- N/A

tern ternType ponse

leType
requestedBatchSize Long The value is equal to This parameter

or greater than 1. indicates the number
of resources
contained in each
information packet.
For alarm inventory
query interfaces of
the AlarmRetrieval
module, the
recommended value
2000.
For alarm inventory
query interfaces of
the ResourceInven-
toryRetrieval
module, set the
recommended value
for this parameter by
referring to interface
description in the
related document.
For alarm inventory
query interfaces of
other modules, the
recommended value
1000.
batchSequenceNum- Long The value is greater N/A

ber than 1.

iteratorReferen- String This is the returned N/A

ceURI iteratorReferen-
ceURI value of the
SIT request.
Such as
1236849276385::0.4
741201104301136::
3.
2.4 AFB
Asynchronous file bulk (AFB) is a message exchange pattern in which the response information
of a request is exported as files.
communicationPat- CommunicationPat- BulkResponse N/A

tern ternType
communicationStyle CommunicationSty- MSG N/A

leType
requestedBatchSize Long N/A N/A

fileLocationURI String ftp:// The file's location

userName:password can not be the root
@hostName.domain path of the FTP.
.com/uploadDir/ The naming rule for
fileName generated data files is
or as follows: If only
Sftp:// one file is generated,
userName:password the name is in the
@hostName.domain format of
.com/uploadDir/ filename.pfm. If
fileName more than one file is
generated, the names
are in the format of
filename_x.pfm,
where x is an integer
larger than 0. The
amount of data in
each file is
determined by the
value of the
requestedBatchSize
parameter. A
generated data file is
a text file wherein
data is separated by a
comma (,), like a .csv
file.
compressionType CompressionType- NO_COMPRESSIO N/A

Type N or GZIP
packingType PackingType ZIP or The ZIP packaging

NO_PACKING mode takes effect
only when
compressionType is
GZIP.
security String User name:password N/A

XML NBI Developer Guide (Performance) 3 Interface Model
3 Interface Model
About This Chapter
This topic describes interfaces and their functions.
3.1 PerformanceManagementRetrieval
This interface is used to query current performances, historicalperformance data, and
performance instances.
3.2 PerformanceManagementControl
This interface is used to manage performance instances.
3.3 ThresholdCrossingAlertControl
This object is used to specify the performance threshold query and setting operations.

This interface is used to query current performances, historicalperformance data, and
performance instances.
3.1.1 getAllCurrentPerformanceMonitoringData
This interface is used to query all current performancedata.
Definition
MultiplePerformanceMonitoringDataObjectsResponseType
getAllCurrentPerformanceMonitoringData (Holder<Header> mtopHeader,
getAllCurrentPerformanceMonitoringDataRequest mtopBody) throws
GetAllCurrentPerformanceMonitoringDataException
Function
Query the current performance data according to the specified monitoring condition and
parameter names.
Parameters
Parameter Description Value Remarks
mtopHeader Indicates the request Holder<Header> The SRR and SIT

header request headers are
supported.
mtopBody Indicates the request getAllCurrentPerfor- N/A

body manceMonitoring-
DataRequest
Returned Values
Returned Value Type Description Remarks
MultiplePerformanceMoni- Indicates the response N/A

toringDataObjectsResponse- information when you query
Type the current performance data.
GetAllCurrentPerformance- Indicates that an exception N/A

MonitoringDataException occurs when you query the
current performance data.
Restrictions
Concurrency interface call is not more than four.

3.1.2 getHistoryPerformanceMonitoringData
This interface is used to query historical performance data.
Definition
MultiplePerformanceMonitoringDataObjectsResponseType
getHistoryPerformanceMonitoringData (Holder<Header> mtopHeader,
getHistoryPerformanceMonitoringDataRequest mtopBody) throws
GetHistoryPerformanceMonitoringDataException
Function
Query the historical performance data according to the specified monitoring condition and
parameter names.
Parameters
mtopHeader Indicates the request Holder<Header> Supports the SIT and

header AFB request header
information.
mtopBody Indicates the request getHistoryPerfor- N/A

body manceMonitoring-
DataRequest
Returned Values
MultiplePerformanceMoni- Indicates the response For performance events that

toringDataObjectsResponse- information when you query are supported by the SIT
Type the history performance data. request header, see "XML
NBI Performance Event
List".
For returned data structures
of queries that are with the
AFB request header, see
"XML NBI Performance
Data Example".
GetHistoryPerformanceMo- Indicates that an exception N/A

nitoringDataException occurs when you query the
history performance data.
Restrictions
The query of historical RMON performance data in the 30s period is not supported.

Concurrency interface call is not more than four.
3.1.3 getAllPerformanceMonitoringPoints
This interface is used to query performance monitoring points.
Definition
MultiplePerformanceMonitoringPointObjectsResponseType
getAllPerformanceMonitoringPoints(Holder<Header> mtopHeader,
GetAllPerformanceMonitoringPointsRequest mtopBody) throws
GetAllPerformanceMonitoringPointsException
Function
Query performance monitoring points.
Parameters
mtopHeader Indicates the request Holder<Header> Supports the SRR

header request header
information.
mtopBody Indicates the request GetAllPerformance-

body MonitoringPoints-
Request
Returned Values
MultiplePerformanceMoni- Indicates the response to

toringPointObjectsRespon- performance monitoring
seType point queries.
GetAllPerformanceMonitor- Indicates that an exception

ingPointsException occurs during performance
monitoring point queries.
Restrictions
3.1.4 getPfmInstanceByResource
This interface is used to query information about performance monitoring instances.

Definition
GetPfmInstanceByResourceResponse getPfmInstanceByResource
(Holder<Header> mtopHeader, GetPfmInstanceByResourceRequest
mtopBody) throws GetPfmInstanceByResourceException
Function
Query information about performance monitoring instances based on the performance
monitoring instance index.
Parameters
mtopHeader Indicates the request Holder<Header> Supports the SRR

header request header
information.
mtopBody Indicates the request getPfmInstanceByR- N/A

body esourceRequest
Returned Values
GetPfmInstanceByResour- Indicates the response N/A

ceResponse information when you query
the performance monitoring
instances.
GetPfmInstanceByResour- Indicates that an exception N/A

ceException occurs when you query
performance monitoring
instances.
Restrictions
There is no restriction.
This interface is used to manage performance instances.
3.2.1 createPerformanceMonitoringData
This interface is used to create a performance monitoring instance.

Definition
CreatePerformanceMonitoringDataResponse createPerformanceMonitoringData
(Holder<Header> mtopHeader, CreatePerformanceMonitoringDataRequest
mtopBody) throws CreatePerformanceMonitoringDataException
Function
Create a performance monitoring instance.
Parameters
mtopHeader Indicates the request Holder<Header> The request header

header can be SRR.
mtopBody Indicates the request createPerformance- N/A

body MonitoringDataRe-
quest
Returned Values
CreatePerformanceMonitor- Indicates the response N/A

ingDataResponse information when you create
a performance monitoring
instances.
CreatePerformanceMonitor- Indicates that an exception N/A

ingDataException occurs when you create a
instance.
Restrictions
To create a performance instance, a non-admin user must be added to the operator group.
Currently, the supported interfaces are as follows: Atm (2049), Eth-Trunk (65539),
GigabitEthernet (1025) and subinterfaces, Vlanif (65544), Pos (2049), Ip-Trunk (65540) and
Rpr (65546).
3.2.2 deletePerformanceMonitoringData
This interface is used to delete a performance monitoring instance.

Definition
DeletePerformanceMonitoringDataResponse deletePerformanceMonitoringData
(Holder<Header> mtopHeader, DeletePerformanceMonitoringDataRequest
mtopBody) throws DeletePerformanceMonitoringDataException
Function
Delete a performance monitoring instance.
Parameters

header can be SRR.
mtopBody Indicates the request deletePerformance- N/A

quest
Returned Values
DeletePerformanceMonitor- Indicates the response N/A

ingDataResponse information when you delete
a performance monitoring
instance.
DeletePerformanceMonitor- Indicates that an exception N/A

ingDataException occurs when you delete a
instance.
Restrictions
3.2.3 disablePerformanceMonitoringData
This interface is used to suspend a performance monitoring instance or disable performance
monitoring.
Definition
DisablePerformanceMonitoringDataResponse
disablePerformanceMonitoringData (Holder<Header> mtopHeader,
DisablePerformanceMonitoringDataRequest mtopBody) throws
DisablePerformanceMonitoringDataException

Function
Suspend a performance monitoring instance or disable performance monitoring.
Parameters

header can be SRR.
mtopBody Indicates the request disablePerformance- N/A

quest
Returned Values
DisablePerformanceMoni- Indicates the response N/A

toringDataResponse information when you
suspend a performance
monitoring instance or
disable performance
monitoring.
DisablePerformanceMoni- Indicates that an exception N/A

toringDataException occurs when you suspend a
instance or disable
performance monitoring.
Restrictions
3.2.4 enablePerformanceMonitoringData
This interface is used to enable a performance monitoring instance or enable performance
monitoring.
Definition
EnablePerformanceMonitoringDataResponse enablePerformanceMonitoringData
(Holder<Header> mtopHeader, EnablePerformanceMonitoringDataRequest
mtopBody) throws EnablePerformanceMonitoringDataException
Function
Enable a performance instance or enable performance monitoring.

Parameters

header can be SRR.
mtopBody Indicates the request enablePerformance- N/A

quest
Returned Values
EnablePerformanceMonitor- Indicates the response N/A

ingDataResponse information when you enable
a performance a monitoring
instance or enable
EnablePerformanceMonitor- Indicates that an exception N/A

ingDataException occurs when you enable a
instance or enable
Restrictions
This object is used to specify the performance threshold query and setting operations.
3.3.1 setTcaTpParameter
This interface is used to set performance thresholds.
Definition
SetTcaTpParameterResponse setTcaTpParameter(Holder<Header> mtopHeader,
SetTcaTpParameterRequest mtopBody) throws SetTcaTpParameterException
Function
Set performance thresholds.

Parameters

header can be SRR.
mtopBody Indicates the request SetTcaTpParameter-

body Request
Returned Values
SetTcaTpParameterRes- Indicates the response to

ponse performance threshold
setting.
SetTcaTpParameterExcep- Indicates that an exception

tion occurs during performance
threshold setting.
Restrictions
3.3.2 getTcaTpParameter
This interface is used to query performance thresholds.
Definition
GetTcaTpParameterResponse getTcaTpParameter(Holder<Header> mtopHeader,
GetTcaTpParameterRequest mtopBody) throws GetTcaTpParameterException
Function
Query performance thresholds.
Parameters

header can be SRR.
mtopBody Indicates the request GetTcaTpParame-

body terRequest

Returned Values
GetTcaTpParameterRes- Indicates the response to

ponse performance threshold
queries.
GetTcaTpParameterExcep- Indicates that an exception

tion occurs during performance
threshold queries.
Restrictions

XML NBI Developer Guide (Performance) 4 Object Attributes
4 Object Attributes
About This Chapter
This topic describes object attributes of interfaces.
This interface is used to query performance data, including current performance data and
historical performance data.
This interface is used to manage performances.
This interface is used to query and set performance thresholds.

This interface is used to query performance data, including current performance data and
historical performance data.
4.1.1 PerformanceMonitoringObjectSelectType
This topic describes the data structure of the PerformanceMonitoringObjectSelectTypeobject.
The classpath information is as follows:
org.tmforum.mtop.nra.xsd.pmtgt.v1.PerformanceMonitoringObjectSelectType
Name Type Description Remarks
name NamingAttribute- Indicates the name of The value cannot be

Type the performance blank.
monitoring object. When you enter an
The NE, port (TP), IP NE, the performance
link, and L2 link are data relevant to the
supported. services that
traverses the NE is
returned.
You can enable or
disable performance
monitoring for NEs
and OTN ports. If
NEs are entered,
performance
monitoring for the
sub-objects is also
enabled to disabled.
You can clear
accumulated
performance data for
NEs and OTN ports.
If NEs are entered,
the accumulated
performance data for
the sub-objects is
also cleared.

layerRateList LayerRateListType Indicates the layer When the value is

rate list. blank, all supported
layer rates are
queried.
You must enter a
layer rate when
enabling or disabling
performance
monitoring.
You must enter a
layer rate when
clearing accumulated
performance data.
pmLocationList PerformanceMoni- Indicates the list of When the value is

toringLocationList- performance blank, all supported
Type monitoring locations are queried.
locations. This field cannot be
PML_NEAR_END_ entered during the
Rx | clearance of
PML_FAR_END_R accumulated
x| performance data.
PML_FAR_ENDTy
pex |
PML_BIDIRECTIO
NAL |
PML_CONTRA_N
EAR_END_Rx |
PML_CONTRA_F
AR_END_Rx
granularityList PerformanceMoni- Indicates the period When the value is

toringGranularity- list. blank, all supported
ListType 15min|24h|NA|30s| periods are queried.
30min Enabling or disabling
performance
monitoring only
supports 15min and
24h.
Clearing
accumulated
performance data
only supports 15min
and 24h.

4.1.2 PerformanceMonitoringObjectSelectListType
This topic describes the data structure of the PerformanceMonitoringObjectSelectListType
object. The classpath information is as follows:
org.tmforum.mtop.nra.xsd.pmtgt.v1.PerformanceMonitoringObjectSelectListType
pmObjectSelect List<Performance- Indicates the list of For details, see

MonitoringObject- monitoring objects. PerformanceMoni-
SelectType> toringObjectSelect-
Type.
4.1.3 PerformanceMonitoringParameterNameListType
This topic describes the data structure of the PerformanceMonitoringParameterNameListType
org.tmforum.mtop.nra.xsd.pm.v1.PerformanceMonitoringParameterNameListType
pmParameterName List<String> Indicates the list of N/A

performance
monitoring
parameters.
4.1.4 PerformanceMonitoringMeasurementType
This topic describes the data structure of the PerformanceMonitoringMeasurementTypeobject.
org.tmforum.mtop.nra.xsd.pmmsrt.v1.PerformanceMonitoringMeasurementType
pmParameterName String Indicates the N/A

parameter name for a
performance record.
pmLocation PerformanceMoni- Indicates the location N/A

toringLocationType where a performance
record occurs.
value Float Indicates the N/A

performance value.
measurementUnits String Indicates the unit of N/A

the performance
record.

pmIntervalStatus PerformanceMoni- Indicates the interval N/A

toringIntervalStatus- status.
Type PMIS_Valid history
performance.
PMIS_Incomplete
current performance.
4.1.5 PerformanceMonitoringMeasurementListType
This topic describes the data structure of the PerformanceMonitoringMeasurementListType
org.tmforum.mtop.nra.xsd.pmmsrt.v1.PerformanceMonitoringParameterNameListType
pmMeasurement List<Performance- Indicates the list of N/A

MonitoringMeasure- monitoring data.
mentType>
4.1.6 PerformanceMonitoringDataType
This topic describes the data structure of the PerformanceMonitoringDataTypeobject. The
classpath information is as follows:
org.tmforum.mtop.nra.xsd.pmdata.v1.PerformanceMonitoringDataType
tpName NamingAttribute- Indicates the name of N/A

Type an object.
layerRate LayerRateType Indicates the layer N/A

rate of an object.
granularity String Indicates the N/A

monitoring period.
The values are as
follows:
15min, 24h, NA, 30s,
30min
pmMeasurementList PerformanceMoni- Indicates the list of N/A

toringMeasuremen- measurement data.
tListType

retrievalTime XMLGregorianCa- Time in which the N/A

lendar system obtains the
performance data
from the NE.
4.1.7 PerformanceMonitoringDataListType
This topic describes the data structure of the PerformanceMonitoringDataListType object. The
classpath information is as
follows:org.tmforum.mtop.nra.xsd.pmdata.v1.PerformanceMonitoringDataListType
pmData List<Performance- Indicates the list of N/A

MonitoringData- performance
Type> monitoring data.
4.1.8 GetAllCurrentPerformanceMonitoringDataRequest
This topic describes the data structure of the GetAllCurrentPerformanceMonitoringDataRequest
org.tmforum.mtop.rpm.xsd.pmr.v1.GetAllCurrentPerformanceMonitoringDataRequest
pmObjectSelectList PerformanceMoni- Indicates that the For details, see

toringObjectSelect- query result is PerformanceMoni-
ListType filtered according to toringObjectSelect-
the monitoring ListType.
condition.
pmParameterList PerformanceMoni- Indicates that only If the value is blank,

toringParameterNa- the performance data it indicates that the
meListType of the parameter performance data of
types that exist in the all the parameter
list is queried. types is queried.
4.1.9 MultiplePerformanceMonitoringDataObjectsResponseType
This topic describes the data structure ofthe
MultiplePerformanceMonitoringDataObjectsResponseType object. The classpath information
is as follows:
org.tmforum.mtop.rpm.xsd.pmr.v1.MultiplePerformanceMonitoringDataObjectsResponseTyp
e

pmDataList PerformanceMoni- Indicates the list of N/A

toringDataListType returned
performance data.
4.1.10 GetHistoryPerformanceMonitoringDataRequest
This topic describes the data structure of the GetHistoryPerformanceMonitoringDataRequest
org.tmforum.mtop.rpm.xsd.pmr.v1.GetHistoryPerformanceMonitoringDataRequest
pmObjectSelectList PerformanceMoni- Indicates that the For details, see

toringObjectSelect- query result is PerformanceMoni-
ListType filtered according to toringObjectSelect-
the monitoring ListType.
condition.
pmParameterList PerformanceMoni- Indicates that only If the value is blank,

toringParameterNa- the performance data it indicates that the
meListType of the parameter performance data of
types that exist in the all the parameter
list is queried. types is queried.
startTime XMLGregorianCa- Indicates the start UTC time in the

lendar time of the interval format of YYYY-
for querying history MM-
performance data. DDThh:mm:ss.SZ.
endTime XMLGregorianCa- Indicates the end UTC time in the

lendar time of the interval format of YYYY-
for querying history MM-
performance data. DDThh:mm:ss.SZ.
mustForceUpload Boolean Indicates whether to N/A

query the historical
performance
monitoring data from
an NE.
true: Query the data
from the NE.
false: Query the data
from the NMS.

4.1.11 PerformanceMonitoringThresholdType
This topic describes the data structure of the PerformanceMonitoringThresholdTypeobject. The
org.tmforum.mtop.nra.xsd.pmth.v1.PerformanceMonitoringThresholdType
thresholdType PerformanceMoni- Indicates the The 24-hour

toringThresholdTy- threshold type. The performance data has
peType values are as follows: only the high
TWM_HIGH: high threshold.
threshold
TWM_LOW: low
threshold
trigger TriggerType Indicates the trigger If an event occurs,

flag. The values are the value is raise. If
raise and clear the event is cleared,
the value is clear.
thresholdValue Float Indicates the N/A

threshold value.
thresholdUnit String Indicates the N/A

threshold unit.
4.1.12 ThresholdCrossingAlertType
This topic describes the data structure of the ThresholdCrossingAlertTypeobject. The classpath
information is as follows: org.tmforum.mtop.nra.xsd.tca.v1.ThresholdCrossingAlertType
notificationId String Indicates the N/A

notification ID.
sourceTime XMLGregorianCa- Indicates the time at UTC time in the

lendar which a performance format of YYYY-
event occurs. MM-
DDThh:mm:ss.SZ.
objectType String Indicates the type of N/A

a performance
monitoring object.
objectName NamingAttribute- Indicates the name of N/A

Type a performance
monitoring object.

osTime XMLGregorianCa- Indicates the time at UTC time in the

lendar which the T2000 format of YYYY-
receives a MM-
performance event. DDThh:mm:ss.SZ.
isClearable boolean Indicates whether to The fixed value is

clear a performance true.
event. The values are
as follows:
true, false
perceivedSeverity PerceivedSeverity- Indicates the N/A

Type severities of
performance
threshold-crossing
events. The values
are as follows:
INDETERMINATE
CLEARED
layerRate LayerRateType Indicates the layer N/A

rate.
granularity String Indicates the period N/A

of performance
monitoring. The
values are as follows:
15min
24h
30s
30min
NA
pmParameterName String Indicates the N/A

performance
parameter name.

pmLocation PerformanceMoni- Indicates the N/A

toringLocationType performance
monitoring location.
The values are as
follows:
PML_NEAR_END_
Rx
PML_FAR_END_R
x
PML_FAR_ENDTy
pex
PML_BIDIRECTIO
NAL
PML_CONTRA_N
EAR_END_Rx
PML_CONTRA_F
AR_END_Rx
thresholdType PerformanceMoni- Indicates the N/A

toringThreshold- threshold-crossing
Type type.
thresholdValue Float Indicates the N/A

threshold-crossing
value.
thresholdUnit String Indicates the N/A

threshold-crossing
unit.
acknowledgeIndica- AcknowledgeIndica- Indicates the N/A

tion tionType acknowledgment
status. The values are
as follows:
EVENT_ACKNOW
LEDGED
EVENT_UNACKN
OWLEDGED
NA
4.1.13 ThresholdCrossingAlertListType
This object is used to specify the list of threshold-crossing alerts. The classpath information is
as follows: org.tmforum.mtop.nra.xsd.pmmsrt.v1.ThresholdCrossingAlertListType

tcaList List< Indicates the list of N/A

ThresholdCrossin- performance
gAlertType > threshold-crossing
events.
4.1.14 GetPfmInstanceByResourceRequest
This topic describes the data structure of the GetPfmInstanceByResourceRequestobject. The
org.tmforum.mtop.rpm.xsd.pmr.v1.GetPfmInstanceByResourceRequest
resourceRef NamingAttribute- Indicates the name of N/A

Type the monitored object.
layerRateList LayerRateListType Indicates the layer N/A

rate. Currently, the
name of the
monitored object
complies with the
FDN naming
convention, that is
the name can
uniquely identify the
monitored object.
Therefore, you do not
need to set the layer
rate.
4.1.15 GetPfmInstanceByResourceResponse
This topic describes the data structure ofthe GetPfmInstanceByResourceResponse object. The
org.tmforum.mtop.rpm.xsd.pmr.v1.GetPfmInstanceByResourceResponse
pmInstanceList PerformanceMoni- Indicates the list of N/A

toringInstanceList- performance
Type monitoring
instances.

4.1.16 PerformanceMonitoringInstanceListType
This topic describes the data structure ofthe PerformanceMonitoringInstanceListType object.
org.tmforum.mtop.nra.xsd.pmtgt.v1.PerformanceMonitoringInstanceListType
pmInstanceList PerformanceMoni- Indicates the list of The list contains

toringInstanceType performance multiple
monitoring performance
instances. monitoring
instances.
4.1.17 PerformanceMonitoringInstanceType
This object is used to specify the type of a performancemonitoring instance. The classpath
information is as follows:
org.tmforum.mtop.nra.xsd.pmtgt.v1.PerformanceMonitoringInstanceType
name NamingAttribute- Indicates the name of N/A

Type the performance
monitoring instance.
userLabel string For the U2000 N/A

V100R03, this
parameter is left
blank.
aliasNameList AliasNameListType For the U2000 N/A

V100R03, this
parameter is left
blank.
vendorExtensions AnyListType For the U2000 N/A

V100R03, this
parameter is left
blank.
resourceRef NamingAttribute- Indicates the name of N/A

Type resources that are
applied the
performance
monitoring instance.
pmmc PmMonitorCondi- Indicates the N/A

tioningType performance
monitoring policy.

status ActivityStatusE- Indicates the status of N/A

numType the performance
monitoring instance,
including
SUSPENDED and
ACTIVE.
4.1.18 PmMonitorConditioningType
This topic describes the data structure of the PmMonitorConditioningType object. The classpath
information is as follows: org.tmforum.mtop.nra.xsd.pmtgt.v1.PmMonitorConditioningType
granularity string Indicates the N/A

performance
monitoring
granularity. The
options are as
follows:
5min
10min
15min
30min
1h
24h
startTime dateTime Indicates the start N/A

time (UTC time) of
the performance
monitoring. The
default start time is
1979-12-30T08:00:0
0.000Z.
endTime dateTime Indicates the end N/A

time (UTC time) of
the performance
monitoring. The
default end time is
2037-12-30T08:00:0
0.000Z.

pmScheduleName string Indicates the name of N/A

the template of the
scheduled
performance
monitoring policy.
templateID string Indicates the ID of N/A

the performance
monitoring template.
templateName string Indicates the name of N/A

the performance
intanceType InstanceEnumType Indicates the type of N/A

the performance
The options are
DATA and TCA.
4.1.19 GetAllPerformanceMonitoringPointsRequest
This object is used to specify the request for querying performance monitoring points.
org.tmforum.mtop.rpm.xsd.pmr.v1.GetAllPerformanceMonitoringPointsRequest
tpOrMeName NamingAttribute- Indicates the name of

Type an object.
4.1.20 ActivityStatusEnumType
This topic describes the data structure of the ActivityStatusEnumTypeobject. The classpath
information is as follows: org.tmforum.mtop.nra.xsd.pm.v1.ActivityStatusEnumType
NOT_STARTED string Indicates that the

performance
monitoring instance
is not started.

ACTIVE string Indicates that the

performance
monitoring instance
is activated.
SUSPENDED string Indicates that the

performance
monitoring instance
is suspended.
4.1.21 InstanceEnumType
This topic describes the data structure ofthe InstanceEnumType object. The classpath
information is as follows: org.tmforum.mtop.nra.xsd.pm.v1.InstanceEnumType
DATA string Indicates that the

monitoring template
is a DATA
TCA string Indicates that the

monitoring template
is a TCA monitoring
template.
4.1.22
MultiplePerformanceMonitoringPointObjectsResponseType
This object is used to specify the response to the query of performance monitoring points. The

org.tmforum.mtop.rpm.xsd.pmr.v1.MultiplePerformanceMonitoringPointObjectsResponseTy
pe
pmpList PerformanceMoni- Indicates the list of

toringPointListType performance
monitoring points.

4.1.23 PerformanceMonitoringPointListType
This object is used to specify the list of performance monitoring points.
org.tmforum.mtop.nra.xsd.pmp.v1.PerformanceMonitoringPointListType
pmp List<Performance- Indicates the

MonitoringPoint- performance
Type> monitoring points.
4.1.24 PerformanceMonitoringPointType
This object is used to specify performance monitoring point information.
org.tmforum.mtop.nra.xsd.pmp.v1.PerformanceMonitoringPointType
name NamingAttribute- Indicates the name of ME, PTP, FTP, and

Type an object. CTP are possible.
layerRate LayerRateType Indicates the layer

rate of an object.
granularity String Indicates the The value is 15min or

monitoring period. 24h.
monitoringState X721Administrati- Indicates the If monitoring is

veStateType monitoring state. disabled, the value is
LOCKED. If
monitoring is
enabled, the value is
UNLOCKED. If
monitoring is
enabled or disabled
partially, the value is
SHUTTING_DOW
N.
This interface is used to manage performances.

4.2.1 CreatePerformanceMonitoringDataRequest
This topic describes the data structure ofthe CreatePerformanceMonitoringDataRequest object.
org.tmforum.mtop.rpm.xsd.pmc.v1.CreatePerformanceMonitoringDataRequest
pmCreateInstance PerformanceCrea- Indicates the N/A

teInstanceType information about
the instance to be
created.
4.2.2 CreatePerformanceMonitoringDataResponse
This topic describes the data structure of the CreatePerformanceMonitoringDataResponse
org.tmforum.mtop.rpm.xsd.pmc.v1.CreatePerformanceMonitoringDataResponse
N/A N/A N/A The returned result is

blank. Usually
notification of the
result is reported to
the OSS. If the result
cannot be reported to
the OSS by
notification, call the
corresponding
interface to query the
result.
4.2.3 PerformanceCreateInstanceType
This topic describes the data structure of the PerformanceCreateInstanceType object. The
org.tmforum.mtop.nra.xsd.pmtgt.v1.PerformanceCreateInstanceType
userLabel string This parameter is left N/A

blank.
aliasNameList AliasNameListType This parameter is left N/A

blank.

vendorExtensions AnyListType This parameter is left N/A

blank.
resType int Indicates the N/A

resource type. This
parameter is left
blank.
pmScheduleName string Indicates the name of N/A

the schedule policy.
This parameter is
optional.
startTime datetime Indicates the start N/A

time. This parameter
is optional.
endTime datetime Indicates the end N/A

time. This parameter
is optional.
resourceList PerformanceCrea- Indicates the list of You can create

teResource resources, such as multiple monitoring
NEs, interfaces and instances.
boards, that are
applied the
performance
monitoring
instances. The list
contains FDNs and
SLAs of the
monitored resources.
templateList PerformanceTem- Indicates the You can create

plateType template list. multiple monitoring
Templates are instances.
classified into two
types: TCA and
DATA templates.
The templates in the
list cannot be the
same type.
Therefore, the list
can contain a
maximum of two
templates: a TCA
template and a
DATA template.

4.2.4 PerformanceCreateResourceType
This topic describes the data structure ofthe PerformanceCreateResourceType object. The
org.tmforum.mtop.nra.xsd.pmtgt.v1.PerformanceCreateResourceType
resourceRefList NamingAttribute- Indicates the list of N/A

Type resources that are to
be monitored.
resourceSLAList NamingAttribute- Indicates the SLA N/A

Type list.
4.2.5 PerformanceTemplateType
This topic describes the data structure of the PerformanceTemplateType object. The classpath
information is as follows: org.tmforum.mtop.nra.xsd.pmtgt.v1.PerformanceTemplateType
id int Indicates the N/A

template ID.
name String Indicates the N/A

template name.
type InstanceEnumType Indicates the DATA or TCA

template type.
period int Indicates the N/A

monitoring period.
4.2.6 DeletePerformanceMonitoringDataRequest
This topic describes the data structure of the DeletePerformanceMonitoringDataRequest object.
org.tmforum.mtop.rpm.xsd.pmc.v1.DeletePerformanceMonitoringDataRequest
pmTpSelectList PerformanceMoni- Indicates the N/A

toringObjectSelect- information about
ListType the performance
instance to be
deleted.

4.2.7 DeletePerformanceMonitoringDataResponse
This topic describes the data structure of the DeletePerformanceMonitoringDataResponse
org.tmforum.mtop.rpm.xsd.pmc.v1.DeletePerformanceMonitoringDataResponse
failedTpSelectList PerformanceMoni- Indicates the N/A

instance that failed to
be deleted.
4.2.8 DisablePerformanceMonitoringDataRequest
This topic describes the data structureof the DisablePerformanceMonitoringDataRequest object
or the request for disabling performance monitoring for OTN ports.

org.tmforum.mtop.rpm.xsd.pmc.v1.DisablePerformanceMonitoringDataRequest

instance to be
suspended or the
information about
the object for which
performance
monitoring will be
disabled.
4.2.9 DisablePerformanceMonitoringDataResponse
This topic describes the data structure of the DisablePerformanceMonitoringDataResponse
object or the response to the disabling of performance monitoring for OTN ports.

org.tmforum.mtop.rpm.xsd.pmc.v1.DisablePerformanceMonitoringDataResponse


be suspended or the
instance information
about a performance
monitoring disabling
failure.
4.2.10 EnablePerformanceMonitoringDataRequest
This topic describes the data structure of the EnablePerformanceMonitoringDataRequest object
or the request for enabling performance monitoring for OTN ports.

org.tmforum.mtop.rpm.xsd.pmc.v1.EnablePerformanceMonitoringDataRequest

instance to be
enabled or the
information about
the object for which
performance
monitoring will be
enabled.
4.2.11 EnablePerformanceMonitoringDataResponse
This topic describes the data structure of the EnablePerformanceMonitoringDataResponse
object or the response to the enabling of performance monitoring for OTN ports.
org.tmforum.mtop.rpm.xsd.pmc.v1.EnablePerformanceMonitoringDataResponse


be enabled or the
instance information
about a performance
monitoring enabling
failure.
This interface is used to query and set performance thresholds.
4.3.1 SetTcaTpParameterRequest
This object is used to specify the request for setting OTN port performance thresholds.
org.tmforum.mtop.rpm.xsd.tcac.v1.SetTcaTpParameterRequest
tpRef NamingAttribute- Indicates the name of PTP, FTP, and CTP

Type an object. are supported.
tcaParameterList ThresholdCrossin- Indicates the

gAlertParameter- performance
sType threshold
parameters.
4.3.2 SetTcaTpParameterResponse
This object is used to specify the response to OTN port performance threshold setting.
org.tmforum.mtop.rpm.xsd.tcac.v1.SetTcaTpParameterResponse

tcaParameterList ThresholdCrossin- Indicates the

sType threshold
parameters.
4.3.3 GetTcaTpParameterRequest
This object is used to specify the request for querying performance thresholds of OTN ports.
org.tmforum.mtop.rpm.xsd.tcac.v1.GetTcaTpParameterRequest
tpElementRef NamingAttribute- Indicates the name of PTP, FTP, and CTP

Type an object. are supported.

rate.
granularity String Indicates the period 15min, 24h, and NA

of performance are supported.
monitoring.
4.3.4 ThresholdCrossingAlertParametersType
This object is used to specify performance threshold parameters. The classpath
org.tmforum.mtop.nra.xsd.tcapars.v1.ThresholdCrossingAlertParametersType

rate.
granularity String Indicates the period

of performance
monitoring.
tcaTypeValues PerformanceMoni- Indicates the list of

toringThresholdVa- performance
lueListType thresholds.

4.3.5 GetTcaTpParameterResponse
This object is used to specify the response to performance threshold queries.
org.tmforum.mtop.rpm.xsd.tcac.v1.GetTcaTpParameterResponse
tcaParameter ThresholdCrossin- Indicates the

sType threshold
parameters.
4.3.6 PerformanceMonitoringThresholdValueListType
This object is used to specify the performance threshold list. The classpath
org.tmforum.mtop.nra.xsd.pmtv.v1.PerformanceMonitoringThresholdValueListType
pmThresholdValue List<Performance- Indicates the

MonitoringThre- performance
sholdValueType> thresholds.
4.3.7 PerformanceMonitoringThresholdValueType
This object is used to specify performance thresholds. The classpath information
is as follows:
org.tmforum.mtop.nra.xsd.pmtv.v1.PerformanceMonitoringThresholdValueType
pmParameterName String Indicates the

parameter name for a
performance record.
pmLocation PerformanceMoni- Indicates the location

toringLocationType where a performance
record occurs.

thresholdType PerformanceMoni- Indicates the The value for 15-min

toringThresholdTy- performance performance data is
peType threshold type. TWM_HIGH or
TWM_LOW. The
value for 24-hour
performance data is
TWM_HIGH.
triggerFlag Boolean Indicates the trigger The value is true

flag. when thresholdType
is set to
TWM_HIGH. The
value is false when
thresholdType is set
to TWM_LOW.
value Float Indicates the

performance
thresholds.
units String Indicates the unit of

the performance
record.

XML NBI Developer Guide (Performance) 5 Notification Format and Sample
5 Notification Format and Sample
About This Chapter
This topic describes notification formats and samples.
5.1 Performance Threshold-Crossing Event

This topic provides a sample notification of performance threshold-crossing events. When
measurement values of performance indicators exceed thresholds, a notification will be reported.

5.1 Performance Threshold-Crossing Event

This topic provides a sample notification of performance threshold-crossing events. When
measurement values of performance indicators exceed thresholds, a notification will be reported.
Notification Example
Contents
header
notify topic performance
message ThresholdCr notificationI 031515524780

ossingAlertT d
ype
sourceTime 2009-03-12T05:20:19.000Z
objectType PTP
objectName type value
MD Huawei/
U2000
ME 3145739
PTP /shelf=1/
slot=3/
domain=sdh/
port=2
osTime 2009-03-12T05:20:21.000Z
isClearable true
perceivedSe INDETERMINATE
verity
layerRate LR_Section_OC48_STS48_
and_RS_STM16
granularity 15min
pmParamete PMP_BBE
rName
pmLocation PML_NEAR_END_Rx
thresholdTy thresholdTy TWM_HIG

pe pe H
trigger raise

Contents
thresholdVal 0.0
ue
thresholdUni block
t
thresholdVal 25
ue
thresholdUni block
t
acknowledge EVENT_ACKNOWL-
Indication EDGED

XML NBI Developer Guide (Performance) 6 Sample Message
6 Sample Message
About This Chapter
This topic provides sample messages of the XML NBI.
6.1 TCA
This topic provides a sample notification of performance threshold-crossing events

6.1 TCA
This topic provides a sample notification of performance threshold-crossing events
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"
xmlns:ns10="http://www.tmforum.org/mtop/fmw/xsd/cornot/v1"
xmlns:ns11="http://www.tmforum.org/mtop/nra/xsd/ps/v1"
xmlns:ns12="http://www.tmforum.org/mtop/nra/xsd/tca/v1"
xmlns:ns13="http://www.tmforum.org/mtop/nra/xsd/pmth/v1"
xmlns:ns14="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"
xmlns:ns15="http://www.tmforum.org/mtop/rtm/xsd/mc/v1"
xmlns:ns16="http://www.tmforum.org/mtop/rtm/xsd/mr/v1"
xmlns:ns17="http://www.tmforum.org/mtop/fmw/xsd/avc/v1"
xmlns:ns18="http://www.tmforum.org/mtop/fmw/xsd/sc/v1"
xmlns:ns19="http://www.tmforum.org/mtop/nrb/xsd/rscsc/v1"
xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"
xmlns:ns20="http://www.tmforum.org/mtop/fmw/xsd/oc/v1"
xmlns:ns21="http://www.tmforum.org/mtop/nra/xsd/eps/v1"
xmlns:ns22="http://www.tmforum.org/mtop/mri/xsd/rsc/v1"
xmlns:ns23="http://www.tmforum.org/mtop/mri/xsd/rsd/v1"
xmlns:ns24="http://www.tmforum.org/mtop/nrb/xsd/rscavc/v1"
xmlns:ns25="http://www.tmforum.org/mtop/nrb/xsd/rscoc/v1"
xmlns:ns26="http://www.tmforum.org/mtop/nrb/xsd/rscodel/v1"
xmlns:ns27="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"
xmlns:ns28="http://www.tmforum.org/mtop/nrb/xsd/cri/v1"
xmlns:ns29="http://www.tmforum.org/mtop/nrf/xsd/snc/v1"
xmlns:ns3="http://www.tmforum.org/mtop/fmw/xsd/notmsg/v1"
xmlns:ns30="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"
xmlns:ns31="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1"
xmlns:ns32="http://www.tmforum.org/mtop/nrf/xsd/com/v1"
xmlns:ns33="http://www.tmforum.org/mtop/mri/xsd/ancp/v1"
xmlns:ns34="http://www.tmforum.org/mtop/rp/xsd/ancp/v1"
xmlns:ns35="http://www.tmforum.org/mtop/nrf/xsd/me/v1"
xmlns:ns36="http://www.tmforum.org/mtop/nrb/xsd/lay/v1"
xmlns:ns37="http://www.tmforum.org/mtop/nrf/xsd/eq/v1"
xmlns:ns38="http://www.tmforum.org/mtop/nrf/xsd/eh/v1"
xmlns:ns39="http://www.tmforum.org/mtop/nrf/xsd/rs/v1"
xmlns:ns4="http://www.tmforum.org/mtop/fmw/xsd/cei/v1"
xmlns:ns40="http://www.tmforum.org/mtop/nrf/xsd/tl/v1"
xmlns:ns41="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1"
xmlns:ns42="http://www.tmforum.org/mtop/nrf/xsd/ctp/v1"
xmlns:ns43="http://www.tmforum.org/mtop/nrf/xsd/ftp/v1"
xmlns:ns44="http://www.tmforum.org/mtop/nrf/xsd/cc/v1"
xmlns:ns45="http://www.tmforum.org/mtop/mri/xsd/vrrpr/v1"
xmlns:ns46="http://www.tmforum.org/mtop/nrf/xsd/fdfr/v1"
xmlns:ns47="http://www.tmforum.org/mtop/nrf/xsd/tmd/v1"
xmlns:ns48="http://www.tmforum.org/mtop/nra/xsd/epg/v1"
xmlns:ns49="http://www.tmforum.org/mtop/nra/xsd/pgp/v1"
xmlns:ns5="http://www.tmforum.org/mtop/fmw/xsd/ei/v1"
xmlns:ns50="http://www.tmforum.org/mtop/nra/xsd/pg/v1"
xmlns:ns51="http://www.tmforum.org/mtop/nrf/xsd/route/v1"
xmlns:ns52="http://www.tmforum.org/mtop/nrf/xsd/tcp/v1"
xmlns:ns53="http://www.tmforum.org/mtop/fmw/xsd/fts/v1"
xmlns:ns54="http://www.tmforum.org/mtop/nra/xsd/ethoam/v1"
xmlns:ns6="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"

xmlns:ns7="http://www.tmforum.org/mtop/nra/xsd/alm/v1"
xmlns:ns8="http://www.tmforum.org/mtop/nra/xsd/prc/v1"
xmlns:ns9="http://www.tmforum.org/mtop/nra/xsd/com/v1"/>
</soap:Header>
<soap:Body>
<ns3:notify xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"
xmlns:ns10="http://www.tmforum.org/mtop/fmw/xsd/cornot/v1"
xmlns:ns11="http://www.tmforum.org/mtop/nra/xsd/ps/v1"
xmlns:ns12="http://www.tmforum.org/mtop/nra/xsd/tca/v1"
xmlns:ns13="http://www.tmforum.org/mtop/nra/xsd/pmth/v1"
xmlns:ns14="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"
xmlns:ns15="http://www.tmforum.org/mtop/rtm/xsd/mc/v1"
xmlns:ns16="http://www.tmforum.org/mtop/rtm/xsd/mr/v1"
xmlns:ns17="http://www.tmforum.org/mtop/fmw/xsd/avc/v1"
xmlns:ns18="http://www.tmforum.org/mtop/fmw/xsd/sc/v1"
xmlns:ns19="http://www.tmforum.org/mtop/nrb/xsd/rscsc/v1"
xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"
xmlns:ns20="http://www.tmforum.org/mtop/fmw/xsd/oc/v1"
xmlns:ns21="http://www.tmforum.org/mtop/nra/xsd/eps/v1"
xmlns:ns22="http://www.tmforum.org/mtop/mri/xsd/rsc/v1"
xmlns:ns23="http://www.tmforum.org/mtop/mri/xsd/rsd/v1"
xmlns:ns24="http://www.tmforum.org/mtop/nrb/xsd/rscavc/v1"
xmlns:ns25="http://www.tmforum.org/mtop/nrb/xsd/rscoc/v1"
xmlns:ns26="http://www.tmforum.org/mtop/nrb/xsd/rscodel/v1"
xmlns:ns27="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"
xmlns:ns28="http://www.tmforum.org/mtop/nrb/xsd/cri/v1"
xmlns:ns29="http://www.tmforum.org/mtop/nrf/xsd/snc/v1"
xmlns:ns3="http://www.tmforum.org/mtop/fmw/xsd/notmsg/v1"
xmlns:ns30="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"
xmlns:ns31="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1"
xmlns:ns32="http://www.tmforum.org/mtop/nrf/xsd/com/v1"
xmlns:ns33="http://www.tmforum.org/mtop/mri/xsd/ancp/v1"
xmlns:ns34="http://www.tmforum.org/mtop/rp/xsd/ancp/v1"
xmlns:ns35="http://www.tmforum.org/mtop/nrf/xsd/me/v1"
xmlns:ns36="http://www.tmforum.org/mtop/nrb/xsd/lay/v1"
xmlns:ns37="http://www.tmforum.org/mtop/nrf/xsd/eq/v1"
xmlns:ns38="http://www.tmforum.org/mtop/nrf/xsd/eh/v1"
xmlns:ns39="http://www.tmforum.org/mtop/nrf/xsd/rs/v1"
xmlns:ns4="http://www.tmforum.org/mtop/fmw/xsd/cei/v1"
xmlns:ns40="http://www.tmforum.org/mtop/nrf/xsd/tl/v1"
xmlns:ns41="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1"
xmlns:ns42="http://www.tmforum.org/mtop/nrf/xsd/ctp/v1"
xmlns:ns43="http://www.tmforum.org/mtop/nrf/xsd/ftp/v1"
xmlns:ns44="http://www.tmforum.org/mtop/nrf/xsd/cc/v1"
xmlns:ns45="http://www.tmforum.org/mtop/mri/xsd/vrrpr/v1"
xmlns:ns46="http://www.tmforum.org/mtop/nrf/xsd/fdfr/v1"
xmlns:ns47="http://www.tmforum.org/mtop/nrf/xsd/tmd/v1"
xmlns:ns48="http://www.tmforum.org/mtop/nra/xsd/epg/v1"
xmlns:ns49="http://www.tmforum.org/mtop/nra/xsd/pgp/v1"
xmlns:ns5="http://www.tmforum.org/mtop/fmw/xsd/ei/v1"
xmlns:ns50="http://www.tmforum.org/mtop/nra/xsd/pg/v1"
xmlns:ns51="http://www.tmforum.org/mtop/nrf/xsd/route/v1"
xmlns:ns52="http://www.tmforum.org/mtop/nrf/xsd/tcp/v1"
xmlns:ns53="http://www.tmforum.org/mtop/fmw/xsd/fts/v1"
xmlns:ns54="http://www.tmforum.org/mtop/nra/xsd/ethoam/v1"
xmlns:ns6="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"
xmlns:ns7="http://www.tmforum.org/mtop/nra/xsd/alm/v1"
xmlns:ns8="http://www.tmforum.org/mtop/nra/xsd/prc/v1"
xmlns:ns9="http://www.tmforum.org/mtop/nra/xsd/com/v1">
<ns3:topic>Performance</ns3:topic>

<ns3:message>
<ns12:thresholdCrossingAlert>
<ns4:notificationId>0629201231268</ns4:notificationId>
<ns4:sourceTime>2010-06-30T10:00:40.000Z</ns4:sourceTime>
<ns5:objectType>EQ</ns5:objectType>
<ns5:objectName>
<ns6:rdn>
<ns6:type>MD</ns6:type>
<ns6:value>Huawei/U2000</ns6:value>
</ns6:rdn>
<ns6:rdn>
<ns6:type>ME</ns6:type>
<ns6:value>3145764</ns6:value>
</ns6:rdn>
<ns6:rdn>
<ns6:type>EH</ns6:type>
<ns6:value>/shelf=1/slot=2</ns6:value>
</ns6:rdn>
<ns6:rdn>
<ns6:type>EQ</ns6:type>
<ns6:value>1</ns6:value>
</ns6:rdn>
</ns5:objectName>
<ns5:osTime>2010-06-30T10:00:42.000Z</ns5:osTime>
<ns12:isClearable>true</ns12:isClearable>
<ns12:perceivedSeverity>INDETERMINATE</ns12:perceivedSeverity>
<ns12:layerRate>LR_Not_Applicable</ns12:layerRate>
<ns12:granularity>15min</ns12:granularity>
<ns12:pmParameterName>CPUUSAGEMAX</ns12:pmParameterName>
<ns12:pmLocation>PML_FAR_ENDTypex</ns12:pmLocation>
<ns12:thresholdType>
<ns13:thresholdType>TWM_HIGH</ns13:thresholdType>
<ns13:trigger>raise</ns13:trigger>
<ns13:thresholdValue>0.0</ns13:thresholdValue>
<ns13:thresholdUnit>%</ns13:thresholdUnit>
</ns12:thresholdType>
<ns12:thresholdValue>9.0</ns12:thresholdValue>
<ns12:thresholdUnit>%</ns12:thresholdUnit>
<ns12:acknowledgeIndication>NA</ns12:acknowledgeIndication>
</ns12:thresholdCrossingAlert>
</ns3:message>
</ns3:notify>
</soap:Body>
</soap:Envelope>

XML NBI Developer Guide (Performance) 7 Object Naming Rules
7 Object Naming Rules
About This Chapter
This section describes the naming rules of objects of the U2000 XML interface according to the
naming rules recommended by MTOSI.
7.1 AID
7.2 CC
7.3 CTP
7.4 EH
7.5 EPG
7.6 EQ
7.7 EXPLICITPATH
7.8 FDFR
7.9 FTP
7.10 ISIS
7.11 MAINTENANCEASSOCIATION
7.12 MAINTENANCEDOMAIN
7.13 MD
7.14 ME
7.15 MEP
7.16 MIP
7.17 MLSN
7.18 OAMMEASURE
7.19 OS

7.20 PG
7.21 PMINSTANCE
7.22 PTP
7.23 RESOURCESITE
7.24 RMEP
7.25 SNC
7.26 TC
7.27 TCPROFILE
7.28 TL
7.29 TMD
7.30 TS
7.31 TUNNELPOLICY
7.32 VRRP

7.1 AID
Object Name AID
Parameter naming N/A

rules recommended
by MTOSI
Sample parameter <name>

<nam:rdn>
names of equipment <nam:type>MD</nam:type>
AIDs of the U2000 <nam:value>Huawei/U2000</nam:value>
XML interface </nam:rdn>
<nam:rdn>
<nam:type>ME</nam:type>
<nam:value>3145795 </nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>AID</nam:type>
<nam:value>/FB=4210|1||</nam:value>
</nam:rdn>
</name>

<nam:rdn>
names of NMS AIDs <nam:type>OS</nam:type>
of the U2000 XML <nam:value>Huawei/U2000</nam:value>
interface </nam:rdn>
<nam:rdn>
<nam:type>AID</nam:type>
<nam:value>SystemMonitor</nam:value>
</nam:rdn>
</name>
Remarks N/A
7.2 CC
Object Name CC
Parameter Naming
<name>
Rules <nam:rdn>
Recommended by <nam:type>MD</nam:type>
MTOSI <nam:value>CompanyName /MDName </nam:value>
</nam:rdn>
<nam:rdn>
<nam:value>MEName </nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>CC</nam:type>
<nam:value>CCName </nam:value>
</nam:rdn>
</name>

Object Name CC
Sample Parameter
<name>
Names of the U2000 <nam:rdn>
XML Interface <nam:type>MD</nam:type>
<nam:value>Huawei/U2000</nam:value>
</nam:rdn>
<nam:rdn>
<nam:value>3145728</nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>CC</nam:type>
<nam:value>PWSW=|556|12.12.12.156|456|455|557|
12.12.12.157|458|457|12</nam:value>
</nam:rdn>
</name>
Remarks CrossConnect (CC) indicates PW switches, static tunnels in the PTN

and IP domain, and cross-connections in the transport domain.
7.3 CTP
Object Name CTP
Parameter Naming <name>

<nam:rdn>
Rules <nam:type>MD</nam:type>
Recommended by <nam:value>CompanyName /MDName </nam:value>
MTOSI </nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PTP/FTP</nam:type>
<nam:value>PTPName/FTPName </nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>CTP</nam:type>
<nam:value>CTPName </nam:value>
</nam:rdn>
</name>

Object Name CTP
Sample Parameter
<name>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PTP</nam:type>
<nam:value>/shelf=1/slot=2/sub_slot=0/type=eth/
port=1/cli_name=GigabitEthernet2/0/1</nam:value>
</nam:rdn>
<nam:rdn>
<nam:value>/sub_port=234</nam:value>
</nam:rdn>
</name>
Remarks
7.4 EH
Object Name EH

Rules <nam:rdn>
Recommended by
MTOSI <nam:type>MD</nam:type>
<nam:value>CompanyName /MDName </nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EH</nam:type>
<nam:value>EHName </nam:value>
</nam:rdn>
</name>

Object Name EH
Sample Parameter <name>

XML Interface
<nam:type>MD</nam:type>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EH</nam:type> <nam:value>/shelf=1/slot=1/
sub_slot=0</nam:value>
</nam:rdn>
</name>
Remarks Currently, the U2000 XML interface supports three types of

EquipmentHolder objects: shelf, slot, and subslot. Rack and subshelf
objects are not supported.
7.5 EPG
Object Name EPG
Parameter Naming
<name>
Rules <nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EPG</nam:type>
<nam:value>EPGName </nam:value>
</nam:rdn>
</name>

Object Name EPG
Sample Parameter
<name>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EPG</nam:type>
<nam:value>/pg=1/type=1</nam:value>
</nam:rdn>
</name>
Remarks This is a sample of renaming rules of equipment protection groups in

the transport domain.
7.6 EQ
Object Name EQ

Rules <nam:rdn>
Recommended by
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EH</nam:type>
<nam:value>EHName </nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>EQ</nam:type>
<nam:value>EQName </nam:value>
</nam:rdn>
</name>

Object Name EQ

XML Interface
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EH</nam:type> <nam:value>/shelf=1/slot=1/
sub_slot=0</nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>EQ</nam:type>
</nam:rdn>
</name>
Remarks For Huawei equipment, the value of Equipment is always 1, that is,
only one board can be installed in a slot.
7.7 EXPLICITPATH
Object Name EXPLICITPATH
Parameter Naming
<name>
Rules <nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EXPLICITPATH</nam:type>
<nam:value>EXPLICITPATHName </nam:value>
</nam:rdn>
</name>

Object Name EXPLICITPATH
Sample Parameter
<name>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>EXPLICITPATH</nam:type>
<nam:value>ex_path</nam:value>
</nam:rdn>
</name>
Remarks
7.8 FDFR
Object Name FDFR
Parameter Naming
<name>
Rules <nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>FDFR</nam:type>
<nam:value>FDFRName </nam:value>
</nam:rdn>
</name>
<name>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>FD</nam:type>
</nam:rdn>
<nam:rdn>
<nam:value>FDFRName </nam:value>
</nam:rdn>
</name>

Object Name FDFR
Sample Parameter
<name>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>VSI=555|vsinam</nam:value>
</nam:rdn>
</name>
Sample Parameter
<name>
XML Interface (E2E <nam:type>MD</nam:type>
PWE3) <nam:value>Huawei/U2000</nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>PWE3TRAIL=123</nam:value>
</nam:rdn>
</name>
Sample Parameter
<name>
XML Interface (E2E <nam:type>MD</nam:type>
VPLS) <nam:value>Huawei/U2000</nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>VPLS=123</nam:value>
</nam:rdn>
</name>
Remarks

7.9 FTP
Object Name FTP

Rules <nam:rdn>
Recommended by
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>FTP</nam:type>
<nam:value>FTPName </nam:value>
</nam:rdn>
</name>

XML Interface
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>FTP</nam:type> <nam:value>/shelf=1/slot=3/
sub_slot=1/domain=ptn/type=ima/port=1</nam:value>
</nam:rdn>
</name>

Object Name FTP
Remarks For naming rules for the shelf, slot, and subslot in a FTP name, refer
to section "EquipmentHolder".
The values of domain include sdh, wdm, eth, atm, sonnet, and ptn.
Only the transport equipment has these attributes. The port names of
the equipment of other domains, such as router, do not contain the
domain field. For the IP domain, there is a cli_name field after the
port field, for example, /shelf=1/type=vlanif/port=1001/
cli_name=Vlanif1001.
7.10 ISIS
Object Name ISIS

rules recommended
by MTOSI

<nam:rdn>
names of the U2000 <nam:type>MD</nam:type>
XML interface <nam:value>Huawei/U2000</nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>ISIS</nam:type>
</nam:rdn>
</name>
Remarks The value of IS-IS is the ID of a public route process.
7.11 MAINTENANCEASSOCIATION
Object Name MAINTENANCEASSOCIATION

rules recommended
by MTOSI

Object Name MAINTENANCEASSOCIATION

<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>MAINTENANCEDOMAIN</nam:type>
<nam:value>new226</nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>MAINTENANCEASSOCIATION</nam:type>
<nam:value>test</nam:value>
</nam:rdn>
</name>
Remarks N/A
7.12 MAINTENANCEDOMAIN
Object Name MAINTENANCEDOMAIN

rules recommended
by MTOSI

<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn></name>
Remarks N/A

7.13 MD
Object Name MD

Rules <nam:rdn>
Recommended by
</nam:rdn>
</name>
Note: nam indicates the alias of the name space defined by the object
naming XSD of MTOSI. Its meaning is the same as that of nam used
in the following section.

XML Interface
</nam:rdn>
</name>
Remarks If multiple iManager U2000s need to be managed at the same time,

change the U2000 names by configuring the MD name to ensure that
each U2000 name is unique in the NMS management domain. For
details, see "XML NBI User Guide".
7.14 ME
Object Name ME

Rules <nam:rdn>
Recommended by
</nam:rdn>
<nam:rdn>
</nam:rdn>
</name>

Object Name ME

XML Interface
</nam:rdn>
<nam:rdn>
</nam:rdn>
</name>
Remarks
7.15 MEP
Object Name MEP

rules recommended
by MTOSI

<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>MEP</nam:type>
</nam:rdn>
</name>
Remarks N/A

7.16 MIP
Object Name MIP

rules recommended
by MTOSI

<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>MIP</nam:type>
</nam:rdn>
</name>
Remarks N/A
7.17 MLSN
Object Name TL

Rules <nam:rdn>
Recommended by
</nam:rdn>
<nam:rdn>
<nam:type>MLSN</nam:type>
<nam:value>MLSNName</nam:value>
</nam:rdn>
</name>

Object Name TL

XML Interface
</nam:rdn>
<nam:rdn>
</nam:rdn>
</name>
Remarks The value of MLSNName is always 1.
7.18 OAMMEASURE
Object Name OAMMEASURE

rules recommended
by MTOSI

<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>OAMMEASURE</nam:type>
<nam:value>vsi</nam:value>
</nam:rdn>
</name>
Remarks The value of OAMMEASURE is the name of OAMMEASURE.

7.19 OS
Object Name OS

Rules <nam:rdn>
Recommended by
MTOSI <nam:type>OS</nam:type>
<nam:value> OSName </nam:value>
</nam:rdn>
</name>

XML Interface
<nam:type>OS</nam:type>
<nam:value>Local NM</nam:value>
</nam:rdn>
</name>
Remarks If it is necessary to manage multiple iManager U2000 at the same

time, modify the U2000 names through the configuration file to
ensure that each U2000 OS name is unique in the NMS management
domain.
7.20 PG
Object Name PG
Parameter Naming
<name>
Rules <nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PG</nam:type>
<nam:value>PGName </nam:value>
</nam:rdn>
</name>

Object Name PG
Sample Parameter
<name>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PG</nam:type>
<nam:value>/shelf=1/pg=1/pos=17</nam:value>
</nam:rdn>
</name>
Remarks This is a sample of renaming rules of protection groups in the transport

domain.
7.21 PMINSTANCE
Object Name PMINSTANCE

rules recommended
by MTOSI

<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PMINSTANCE</nam:type>
</nam:rdn>
</name>
Remarks N/A

7.22 PTP
Object Name PTP

Rules <nam:rdn>
Recommended by
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>PTPName </nam:value>
</nam:rdn>
</name>

XML Interface
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>PTP</nam:type> <nam:value>/shelf=1/slot=3/
domain=wdm/port=1</nam:value>
</nam:rdn>
</name>

Object Name PTP
Remarks For naming rules for the shelf, slot, and subslot in a PTP name, refer
to section "EH".
The values of domain include sdh, wdm, eth, atm, sonnet, and ptn.
Only the transport equipment has these attributes. The port names of
the equipment of other domains, such as router, do not contain the
domain field. For the IP domain, there is a cli_name field after the
port field, for example, /shelf=1/slot=13/type=eth/port=0/
cli_name=Ethernet13/0/0.
7.23 RESOURCESITE
Object Name RESOURCESITE

Rules <nam:rdn>
Recommended by
</nam:rdn>
<nam:rdn>
<nam:type>RESOURCESITE</nam:type>
<nam:value>RESOURCESITEName </nam:value>
</nam:rdn>
</name>

XML Interface
</nam:rdn>
<nam:rdn>
<nam:type> RESOURCESITE</nam:type>
<nam:value> 4063235</nam:value>
</nam:rdn>
</name>
Remarks This object is added by Huawei, which represents the transport WDM
NE.

7.24 RMEP
Object Name RMEP

rules recommended
by MTOSI

<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>RMEP</nam:type>
</nam:rdn>
</name>
Remarks N/A
7.25 SNC
Object Name SNC
Parameter naming
<name>
rules recommended <nam:rdn>
by MTOSI <nam:type>MD</nam:type>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>SNC</nam:type>
<nam:value>SNCName </nam:value>
</nam:rdn>
</name>

Object Name SNC
U2000 Parameter
<name>
name example of the <nam:rdn>
XML NBI (RSVP- <nam:type>MD</nam:type>
TE Tunnel) <nam:value>Huawei/U2000</nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>TUNNEL=3||||100||||</nam:value>
</nam:rdn>
</name>
U2000 Parameter
<name>
XML NBI (Static- <nam:type>MD</nam:type>
CR E2E Tunnel) <nam:value>Huawei/U2000</nam:value>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>TUNNELTRAIL=190</nam:value>
</nam:rdn>
</name>
U2000 Parameter
<name>
XML NBI (path) <nam:type>MD</nam:type>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>2007-08-22 07:14:05 - 35183-sdh</
nam:value>
</nam:rdn>
</name>
Remarks SNC can represent dynamic RSVP-TE tunnels in the PTN NE

Explorer, dynamic RSVP-TE tunnels in router, CX, and switch NE
Explorers, static-CR E2E tunnels of hybrid MSTP NEs, and transport
domain paths.

7.26 TC
Object Name TC

rules recommended
by MTOSI

<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TS</nam:type>
<nam:value>gui_TestSuite</nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>TC</nam:type>
</nam:rdn>
</name>
Remarks The value of TC is the test case name.
7.27 TCPROFILE
Object Name TCPROFILE
Parameter Naming
<name>
Rules <nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TCPROFILE</nam:type>
<nam:value>TCPROFILEName </nam:value>
</nam:rdn>
</name>
Sample Parameter
<name>
</nam:rdn>
<nam:rdn>
<nam:type>TCPROFILE</nam:type>
<nam:value>/type=cbqosprofile/name=cbqosprofiletest</
nam:value>
</nam:rdn>
</name>
Remarks

7.28 TL
Object Name TL

Rules <nam:rdn>
Recommended by
</nam:rdn>
<nam:rdn>
<nam:type>TL</nam:type>
<nam:value>TLName </nam:value>
</nam:rdn>
</name>

XML Interface
</nam:rdn>
<nam:rdn>
<nam:type>TL</nam:type>
<nam:value>2009-05-05 23:54:32 - 3</nam:value>
</nam:rdn>
</name>
Remarks

7.29 TMD
Object Name TMD
Parameter Naming
<name>
Rules <nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TMD</nam:type>
<nam:value>TMDName </nam:value>
</nam:rdn>
</name>
Sample Parameter
<name>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TMD</nam:type>
<nam:value>20|</nam:value>
</nam:rdn>
</name>
Remarks This is a sample of renaming rules of transmission descriptors.
7.30 TS
Object Name TS

rules recommended
by MTOSI

<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TS</nam:type>
<nam:value>gui_TestSuite</nam:value>
</nam:rdn>
</name>

Object Name TS
Remarks The value of TS is the test suit name.
7.31 TUNNELPOLICY
Object Name TUNNELPOLICY
Parameter Naming
<name>
Rules <nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TUNNELPOLICY</nam:type>
<nam:value>TUNNELPOLICYName </nam:value>
</nam:rdn>
</name>
Sample Parameter
<name>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:type>TUNNELPOLICY</nam:type>
<nam:value>tnl_policy</nam:value>
</nam:rdn>
</name>
Remarks This is a sample of renaming rules of tunnel policies extended by

Huawei.

7.32 VRRP
Object Name VRRP
Parameter Naming
<name>
Rules <nam:rdn>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>PTPName </nam:value>
</nam:rdn>
<nam:rdn>
<nam:value>CTPName </nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>VRRP</nam:type>
<nam:value>VRRPName </nam:value>
</nam:rdn>
</name>
Sample Parameter
<name>
</nam:rdn>
<nam:rdn>
</nam:rdn>
<nam:rdn>
<nam:value>/shelf=1/slot=1/sub_slot=0/type=eth/
port=0/cli_name=GigabitEthernet1/0/0</nam:value>
</nam:rdn>
<nam:rdn>
<nam:value>/sub_port=2</nam:value>
</nam:rdn>
<nam:rdn>
<nam:type>VRRP</nam:type>
</nam:rdn>
</name>
Remarks

XML NBI Developer Guide (Performance) 8 Description of Unimplemented and Customized Interfaces
8 Description of Unimplemented and

Customized Interfaces
Table 8-1 List of unimplemented and customized interfaces
Module Interface Function Description
Performanc getAllPerforman- Queries the names of all This interface does not
eManagem ceMonitoring- performance monitoring implement any specific
entRetrieva PointNames points. service functions and
l returns the error message
"notImplemented".
getAllPerforman- Queries information about This interface does not

ceMonitoring- all performance implement any specific
Points monitoring points. service functions and
returns the error message
"notImplemented".
getHoldingTime Queries the holding time of This interface does not

performance records on the implement any specific
EMS. service functions and
"notImplemented".
getMePerforman- Queries performance This interface does not

ceMonitoringCap parameters supported by an implement any specific
abilities NE. service functions and
"notImplemented".
getProfileAsso- Queries information about This interface does not

ciatedTermina- ports associated with a implement any specific
tionPoints performance monitoring service functions and
profile. returns the error message
"notImplemented".

XML NBI Developer Guide (Performance) 8 Description of Unimplemented and Customized Interfaces
Module Interface Function Description
getPerformance- Queries the next-batch This interface does not

MonitoringDa- performance data. implement any specific
taIterator service functions and
"notImplemented".
getPerformance- Queries the names of the This interface does not

MonitoringPoint- next-batch performance implement any specific
NamesIterator monitoring points. service functions and
"notImplemented".
getPerformance- Queries information about This interface does not

MonitoringPoint- the next-batch implement any specific
sIterator performance monitoring service functions and
points. returns the error message
"notImplemented".
Performanc clearPerforman- Clears performance This interface does not

eManagem ceMonitoringData monitoring instances. implement any specific
entControl service functions and
returns no data.

XML NBI Developer Guide (Performance) 9 Layer Rate Description
9 Layer Rate Description
Table 9-1 List of layer rates supported by the U2000 XML NBI
ID Layer Identifier Description
1 LR_Not_Applicable The layer is not relevant
2 LR_T1_and_DS1_1_5M 1.5Mbit/s async/PDH signal
3 LR_T2_and_DS2_6M 6Mbit/s async/PDH signal
4 LR_T3_and_DS3_45M 45Mbit/s async/PDH signal
5 LR_E1_2M 2Mbit/s PDH signal
10 LR_VT1_5_and_TU11_VC11 VC11 SONET/SDH path signal
11 LR_VT2_and_TU12_VC12 VC12 SONET/SDH path signal
12 LR_VT6_and_TU2_VC2 VC2 SONET/SDH path signal
13 LR_Low_Order_TU3_VC3 VC3 SONET/SDH path signal
14 LR_STS1_and_AU3_High_Order AU3 SONET/SDH path signal

_VC3
15 LR_STS3c_and_AU4_VC4 SONET/SDH path signal
16 LR_STS12c_and_VC4_4c 12xSTS-1/4xVC4 contiguous

concatenation

concatenation


concatenation
19 LR_Section_OC1_STS1_and_RS STM-0 regenerator section

_STM0
20 LR_Section_OC3_STS3_and_RS STM-1 regenerator section

_STM1
21 LR_Section_OC12_STS12_and_ STM-4 regenerator section

RS_STM4

RS_STM16
23 LR_Section_OC192_STS192_and STM-64 regenerator section

_RS_STM64
25 LR_Line_OC3_STS3_and_MS_S STM-1 multiplex section

TM1
26 LR_Line_OC12_STS12_and_MS STM-4 multiplex section

_STM4

_STM16
28 LR_Line_OC192_STS192_and_ STM-64 multiplex section

MS_STM64
40 LR_Optical_Channel For WDM wavelength
41 LR_Optical_Multiplex_Section For WDM wavelength bands
42 LR_Optical_Transmission_Sec- For WDM entire optical signal. That is, it is

tion used for OTS and OMS layers of OTM-n.m
(n>)=1.
43 LR_ATM_NI For ATM network interfaces (UNI and

NNI)
44 LR_ATM_VP For ATM virtual paths
45 LR_ATM_VC For ATM virtual channels
46 LR_PHYSICAL_ELECTRICAL Analogue signal on electrical and physical

media
47 LR_PHYSICAL_OPTICAL Analogue signal on optical physical media
48 LR_PHYSICAL_MEDIALESS Specifies physical media for technologies

such as radio

49 LR_OPTICAL_SECTION Represents the wavelength termination for

a non DWDM system, i.e. used for all kinds
of single-lambda ports.
50 LR_DIGITAL_SIGNAL_RATE Raw binary electrical signal of unspecified

rate
51 LR_Async_FOTS_150M 150Mbit/s legacy async optical signal
56 LR_Async_FOTS_1G7 1,7Gbit/s legacy async optical signal
57 LR_Async_FOTS_1G8 1,8Gbit/s legacy async optical signal
58 LR_D1_Video Video capable port
59 LR_ESCON IBM protocol for mainframes
60 LR_ETR IBM protocol for mainframes
61 LR_Fast_Ethernet Fast Ethernet. This layer identifier is not

identified in the TMF standards.
62 LR_FC_12_133M 133Mbit/s Fibre Channel protocol
66 LR_FDDI
67 LR_FICON IBM Protocol for mainframes
68 LR_Gigabit_Ethernet Gigabit Ethernet. This layer identifier is not

identified in the TMF standards.
69 LR_DS0_64K DS0 CTP layer rate
70 LR_ISDN_BRI ISDN Basic Rate Interface PTP layer rate
71 LR_POTS POTS PTP layer rate
72 LR_DSR_OC1_STM0 STM-0 digital signal rate

76 LR_DSR_OC48_and_STM16 STM-16 digital signal rate
79 LR_DSR_1_5M 1,5Mbit/s digital signal rate
80 LR_DSR_2M 2Mbit/s digital signal rate
87 LR_DSR_Gigabit_Ethernet Gigabit Ethernet digital signal rate

RS_STM8

_STM8
90 LR_Section_OC768_STS768_and STM-256 regenerator section

_RS_STM256
91 LR_Line_OC768_STS768_and_ STM-256 multiplex section

MS_STM256
93 LR_DSR_2xSTM1 2 times STM-1 radio multiplexing
96 LR_Ethernet All Ethernet rates
97 LR_DSR_Fast_Ethernet 10/100Mbit/s Ethernet
98 LR_Encapsulation For Ethernet, the following encapsulation

protocols apply: HDLC/PPP, HDLC/
LAPS, ML/PPP, and GFP Transparent or
Frame Mapped types
99 LR_Fragment Used for inverse multiplexing modeling

(virtual concatenation for SONET/SDH
and IMA)
100 LR_STS6c_and_VC4_2c 6xSTS-1/2xVC4 contiguous concatenation
101 LR_STS9c_and_VC4_3c 9xSTS-1/3xVC4 contiguous concatenation

102 LR_STS21c_and_VC4_7c 21xSTS-1/7xVC4 Contiguous

Concatenation
103 LR_STS24c_and_VC4_8c 24xSTS-1/8xVC4 Contiguous

Concatenation
104 LR_OCH_Data_Unit_1 Optical channel Data Unit 1 (trail and

tandem connection monitoring/
termination)

termination)

termination)

termination)
107 LR_OCH_Transport_Unit_1 Optical channel Transport Unit 1 (trail

termination)

termination)

termination)

termination)
110 LR_DSR_OTU1 DSR of Optical channel Transport Unit 1
113 LR_DSR_10Gigabit_Ethernet 10 Gbit/s Ethernet
115 LR_DSR_40Gigabit_Ethernet [Extended by HUAWEI]
201 LR_PON [Extended by HUAWEI]
305 LR_LAG_Fragment Link aggregation
303 LR_DVB_ASI Digital Video Broadcast (ASI)
2001 LR_POTS_USER User on the POTS port
2002 LR_GEM GEM port
8001 LR_Section_and_RS [Extended by HUAWEI]

8002 LR_Line_and_MS [Extended by HUAWEI]
8003 LR_ATM ATM layer rate [Extended by HUAWEI]
8004 LR_Optical_Supervision_Channel Optical monitoring layer rate [Extended by

HUAWEI]
8005 LR_FC_200_2125M 2125 Mbit/s Fibre Channel protocol

[Extended by HUAWEI]
8006 LR_OCH_Data_Unit_5G Optical channel Data Unit 5G (trail and

termination) [Extended by HUAWEI]
8007 LR_OCH_Transport_Unit_5G Optical channel Transport Unit 5G (trail

8008 LR_DSR_10Gigabit_Ethernet_LA [Extended by HUAWEI]

N
8009 LR_DSR_10Gigabit_Ethernet_W [Extended by HUAWEI]

AN
8010 LR_MPLS_Channel [Extended by HUAWEI]
8011 LR_MPLS_Path [Extended by HUAWEI]
8020 LR_DSR_GFP_T [Extended by HUAWEI]
8021 LR_SAN_FC_400 [Extended by HUAWEI]
8023 LR_DVB_SDI Digital video broadcast (SDI) [Extended by

HUAWEI]
8024 LR_FICON_Express [Extended by HUAWEI]
8025 LR_HDTV [Extended by HUAWEI]
8026 LR_ETR [Extended by HUAWEI]
8027 LR_CLO [Extended by HUAWEI]
8028 LR_1G_ISC [Extended by HUAWEI]
8029 LR_2G_ISC [Extended by HUAWEI]
8030 LR_4G_FICON [Extended by HUAWEI]


8032 LR_CPRI [Extended by HUAWEI]
8033 LR_CPRI_CUT [Extended by HUAWEI]
8034 LR_PHY_MEDIA [Extended by HUAWEI]
8035 LR_INFINIBAND_2DOT5G [Extended by HUAWEI]
8036 LR_INFINIBAND_5G [Extended by HUAWEI]
8060 LR_IP_Path [Extended by HUAWEI]
8070 LR_GRE_Path [Extended by HUAWEI]
8071 LR_DSR_32xSTM1 [Extended by HUAWEI]
8072 LR_RS_32xSTM1 [Extended by HUAWEI]
8073 LR_MS_32xSTM1 [Extended by HUAWEI]
299 LR_DSL Digital Subscriber Line
335 LR_OCH_Data_Unit_Flexible Optical channel Data Unit Flexible

XML NBI Developer Guide (Performance) 10 Glossary
10 Glossary
E
Edge Termination An Edge Termination Point (Edge TP) is a Termination Point (TP) that is at an entrance
Point or exit point of a MultiLayer Subnetwork (i.e. add-drop or TPs that terminate topological
links between two Subnetworks).
Element Management The Element Management System (EMS) is used to manage (represent) a portion of a
System network which contains one or more MultiLayer Subnetworks. The EMS is used as the
root of the naming tree in the NML-EML interface.
Equipment An Equipment represents the manageable physical components of a Network Element
such as the circuit packs, the fans and any other type of replaceable unit within the
Network Element.
EquipmentHolder An Equipment Holder shall represent resources of the Network Element that are capable
of holding other physical components.
Specific resources that are represented by an Equipment Holder object shall be for
instance racks (bays), shelves, and slots or sub-slots.
L
Location An area, position, or portion of space that somebody or something can occupy. It is
further decomposed into a geographic place that relates to world-centric places and local
location that relates to locally defined coordinate systems.
M
Managed Element A Managed Element (ME) represents the EMS (management) view of a Network
Element (NE).
MultiLayer A MultiLayer Subnetwork represents the topology provided by the EMS system. The
Subnetwork main services provided within a MultiLayer Subnetwork are the set-up and tear-down
of Subnetwork Connection (SNC).

Network Element A Network Element (NE) is telecommunications hardware equipment that is addressable
and manageable. NEs provide support or services to the user and can be managed through
an Element Management System (EMS).
An NE is a combination of hardware and software that primarily performs a
telecommunications service function. A group of interconnected network elements form
a network.
P
Party Represents an individual, organization or organization unit. Party is an abstract concept
that should be used in places where the business says something.
PartyRole The part played by a party in a given context with any characteristics, such as expected
pattern of behavior, attributes, and/or associations that it entails. PartyRole is an abstract
concept that should be used in places where the business refers to a Party playing a Role.
Physical Termination A Physical Termination Point (PTP) represents the actual or potential endpoint of a
Point Topological Link. Essentially, this is a representation of a physical port.
ProductBundle A type of Product that is comprised of other Product(s). The other Product(s) may be
ProductBundle(s) or ProductComponent(s).
ProductSpecification A detailed description of a tangible or intangible object made available externally in the
form of a ProductOffering to Customers or other Parties playing a PartyRole. A
ProductSpecification may consist of other ProductSpecifications supplied together as a
collection. Members of the collection may be offered in their own right.
ProductSpecifications may also exist within groupings, such as ProductCategories,
ProductLines, and ProductTypes.
R
Route A Route represents the route of a Subnetwork Connection (SNC).
An SNC route is represented as a partially ordered series of Cross Connects through
which the SNC traverses.
S
Service All Services are characterized as either being a realization of a Product
(CustomerFacingService) facing the Customer or how a Service is provisioned within a
provider's infrastructure (ResourceFacingService) facing the resources.
Services are defined by a ServiceSpecification. The purpose of the specification is

twofold. First, it is used to define attributes, methods, and relationships that are common
to all Services. Second, it provides a convenient point to define how Services interact
with other parts business entities.

Service Access Point A point of entry where the service can be accessed. This point of entry is always
associated (directly or indirectly) with a physical resource (such as a PTP, a CTP).
However, sometimes the SAP is an object or a logical resource that contains or identifies
the support of the physical resource. (Customer Premise Equipment, a Mobile Terminal,
a Set-top Box, an internet address).
ServiceCatalog A grouping of Service Specifications that share common characteristics. For example
one catalog could group all internet related Service Specifications.
ServiceCharacteristicV A ServiceCharacteristicValue is a value passed over the Activation Interface to convey
alue an individually set service characteristic (i.e. not reference in a ServiceTemplate) or to
override a globally set characteristic value (present in a ServiceTemplate). A
ServiceCharacteristicValue will apply only to the specific Service instance created.
ServiceDefinition A type of Service Specification (from the SID) introduced for the purposes of Service
Fulfillment. It defines ALL the ServiceSpecCharacteristics that must be used to create
corresponding Service instances:
The ones which are set globally (the corresponding values are defined only in
ServiceTemplates and are sometimes designated as "invariant" ).
the ones which are set individually (the corresponding values can be defined only over
the Activation Interface and are sometimes designated as "variant").
A ServiceSpecCharacteristic specified in a erviceDefinition may be associated with
ServiceSpecCharacteristicValues to restrict the typing information or to specify a default
value.
ServiceOrder A Service Order is a type of request (as defined in the SID model). In particular, a service
order is used to track and control the progress of a request for some action (e.g., provision
or activation) on the services that comprise a given product instance. It should be
mentioned that the OSS/J Order Management API (JSR 264) defines Service Order as
follows: "A type of Request that represents a Customer Order's products decomposed
into the services through which the products are realized. Service Orders are generated
within the confines of the SM&O layer."
ServiceOrderItem Service Order Items are used to represent the order aspects of the services associated
with a given service order. There is one service order item for each service associated
with a service order.
ServiceRequest A request made by the CRM layer to the SM&O layer as defined in the TMForum eTOM
to take an action on one or more CFS instances given a product identifier, a product
specification name and a related set of characteristics. This request can be realized by
Template and by Value.
ServiceSpecCharacteri A characteristic quality or distinctive feature of a Service as represented in a
stic ServiceSpecification (specialized as ServiceDefinition or ServiceTemplate). In
particular it contains typing information which can be arbitrarily complex.
A Service Spec Characteristic can be atomic or composite (also called "packages"). The
components of a composite Service Spec Characteristic can in turn be atomic or
composite.

ServiceSpecCharacteri A value that can be associated with a ServiceSpecCharacteristic in conformance with

sticValue the specified typing information.
l When associated with a ServiceSpecCharacteristic in a ServiceDefinition, it is used

to restrict the typing information (in this case several
ServiceSpecCharacteristicValues may be used) or to specify additional information
(e.g. default value).
l When associated with a ServiceSpecCharacteristic in a ServiceTemplate, it will
apply globally to all the Service instances conformant to this ServiceTemplate.
In this case, the ServiceSpecCharacteristicValue is set at the design stage when the
ServiceTemplate is created, and it cannot be modified afterwards.
A ServiceSpecCharacteristic present in a ServiceTemplate is sometimes qualified as
being "invariant", since it cannot be modified after the creation of the ServiceTemplate
(the term "globally set" can also be used).
A ServiceSpecCharacteristic which value is passed over the Activation Interface is

sometimes qualified as being "variant", since the value must be given for each Service
instance created (the term "individually set" can also be used).
ServiceSpecification Changeable as well as invariant attributes, methods, relationships and constraints which
define a Service. It can be conceptually thought of as a template that different Service
instances can be instantiated from. Each of these Service instances will have the same
invariant characteristics. However, the other characteristics of the instantiated Service
will be specific to each instance.
ServiceSpecificationTy The ServiceSpecificationType class defines a generic category of ServiceSpecifications.
pe
Each ServiceSpecificationType serves to group a set of particular ServiceSpecifications
that share the same behavior and other semantics. One result of this is to be able to more
efficiently define a set of related Services that can be grouped together to form a higher-
level Service.
For example, a given higher-level Service might include VPN and QoS Services. If these
Services are always used together, then they can be categorized using a common type.

ServiceTemplate A type of Service Specification (from the SID) introduced for the purposes of Service
Fulfillment.
It defines specific ServiceSpecCharacteristicsValues for the globally set
ServiceSpecCharacteristics that can be dynamically referenced by multiple Service
instances during their lifecycle span. A ServiceTemplate is checked against its associated
ServiceDefinition by verifying the presence of the ServiceSpecCharacteristics and the
validity of the corresponding assigned ServiceSpecCharacteristicsValues. Each of the
associated Service instances will have the same invariant characteristics which values
are taken from the ServiceTemplate.
However, when activating a Service, it may be possible to specify over the Activation
Interface a ServiceCharacteristicsValue which overrides the corresponding
ServiceSpecCharacteristicValue available in the associated ServiceTemplate.
In this case the new proposed value applies only to the Service instance created, and the
ServiceSpecCharacteristicValue in the ServiceTemplate is not modified.
In order not to descend into sub-classing, the ServiceTemplate is considered to be generic
such that it serves as a framework for defining technology or service specific templates.
Other TMForum groups, or service providers, may use the service template as a
foundation for building or populating service templates.
Subnetwork A Subnetwork Connection (SNC) represents the relationship between two of the
Connection following types on end points:
l Physical Termination Point (PTP)

l Connection Termination Point (CTP)
l Group Termination Point (GTP)
l Floating Termination Point (FTP)
An SNC represents a transparent end-to-end connection or a trail (closed or half-open)

through or within a MultiLayer Subnetwork according to the roles associated to its end
points. If the SNC represents a connection, its end points are CTPs or FTPs with the
SNC's layer rate as connectable layer rate. In the case of GTPs (i.e. a Bundled connection)
the SNC does not have an explicit layer rate. If the SNC represents a trail, its end points
are CTPs, FTPs or PTPs. An SNC shall be contained in a MultiLayer Subnetwork.
Subscriber A Subscriber is an entity (associated with one or more users) that is engaged in a service
subscription with a service provider. The subscriber is allowed to subscribe and
unsubscribe services, to register a user or a list of users authorized to use these services,
and also to set the limits relative to the use that associated users make of these services.

Termination Point A Termination Point (TP) represents a logical abstraction of an endpoint (actual or
potential) of either:
1. A Topological Link
2. A Subnetwork Connection (SNC)
3. A Flow Domain Fragment (FDFr)
4. A Cross Connection (CC)
Topological Link A Topological Link (TL) is a physical link between two Physical Termination Point
(PTP)s or a trail between two Termination Point (TP)s (e.g., an ATM link between two
ATM NI CTPs), which are called aEnd TP and zEnd TP of the TL.
TMD Transmission A Transmission Descriptor (TMD) represents a collection of attributes, which are used
Descriptor to define multi-layered transmission parameters, and additional information parameters
on a Termination Point (TP)

XML NBI Developer Guide (Performance) 11 Acronyms and Abbreviations
11 Acronyms and Abbreviations
A
ABR Asynchronous batch response
AFB Asynchronous file bulk
AID Alarm identifier
ARR Asynchronous request/reply
ASN.1 Abstract Syntax Notation One
AVC Attribute value change
C
CDE Common desktop environment
CPU Central processing unit
E
EdgeTP Edge termination point
EH Equipmen holder
EQT Equipment
EMS Element management system
EOW Ethernet over WDM
F
FIFO First in first out
FTP File Transfer Protocol
G
GE Gigabit Ethernet
GNE Gate network element
GUI Graphical user interface

H
HA High availability
HTTP Hyper-Text Transmission Protocol
HTTPS Hypertext Transfer Protocol Secure
I
ID Identity
IMAP Integrated management application platform
IP Internet Protocol
ITU-T International Telecommunication Union- Telecommunication Standardization Sector
J
JMS Java message service
L
LAN Local area network
M
MAC Media access control MD
Management domain
MDP Message dispatch process
ME Managed element
MEP Message exchange pattern
MLSN Multi-layer sub network
MO Managed object
MTOSI Multi-Technology operations system interface
MTNM Multi-Technology network management
N
NE Network element
NEL Network element level NML
Network management level
NMS Network management system
O
OS Operations system
ONE Optical network element
OTN Optical transport network

OSGI Open services gateway initiative

OSS Operation support system
OSN Optical switch net
OSI Open systems interconnection
P
PC Personal computer
PDH Plesiochronous digital hierarchy
PTP Physical termination point
S
SAP Service access point
SC State change
SDH Synchronous digital hierarchy
SFB Synchronous file bulk
SIT Synchronous iterator pattern
SNC Sub network connection
SOAP Simple Object Access Protocol
SONET Synchronous optical network
SRR Synchronous request response
SSL Security socket layer
SSM Synchronization status message
SFTP SSH FTP
SML Service management layer
SOA Service-oriented architecture
T
TCP Transport Control Protocol
TL Topological link
TMD Transmission descriptor
TMF Telecommunication Management Forum
TMN Telecommunication management network
TP Termination point
TCA Threshold crossed alert
U
UPC Usage parameter control

UTC Coordinated universal time
W
WAN Wide area network
WSDL Web service definition language
WSN Web services notification
X
XML Extensible markup language


03.developer Guide (Performance)

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

03.developer Guide (Performance)

Hochgeladen von

Copyright:

Verfügbare Formate

iManager U2000 Unified Network Management

XML NBI Developer Guide

HUAWEI TECHNOLOGIES CO., LTD.

Trademarks and Permissions

Huawei Technologies Co., Ltd.

Issue 02 (2015-08-15) Huawei Proprietary and Confidential i

About This Document

Product Name Version

iManager U2000 V200R015C50

This document is intended for:

Indicates an imminently hazardous situation

Indicates a potentially hazardous situation

Issue 02 (2015-08-15) Huawei Proprietary and Confidential ii

Indicates a potentially hazardous situation

Indicates a potentially hazardous situation

Calls attention to important information, best

Boldface The keywords of a command line are in boldface.

Italic Command arguments are in italics.

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

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

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

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

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

Issue 02 (2015-08-15) Huawei Proprietary and Confidential 3

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

> Multi-level menus are in boldface and separated by the ">"

Changes in Issue 02 (2015-08-15) Based on Product Version V200R015C50

Changes in Issue 01 (2015-05-25) Based on Product Version V200R015C50

Issue 02 (2015-08-15) Huawei Proprietary and Confidential 4

About This Document.....................................................................................................................ii

2 Message Exchange Pattern...........................................................................................................3

Issue 02 (2015-08-15) Huawei Proprietary and Confidential 5

4.1.7 PerformanceMonitoringDataListType...................................................................................... .................................25

5 Notification Format and Sample..............................................................................................45

Issue 02 (2015-08-15) Huawei Proprietary and Confidential 6

6.1 TCA...................................................................................................................... ........................................................49

7 Object Naming Rules..................................................................................................................52

8 Description of Unimplemented and Customized Interfaces..............................................80

Issue 02 (2015-08-15) Huawei Proprietary and Confidential vii

About This Chapter

Issue 02 (2015-08-15) Huawei Proprietary and Confidential 1

1.2 Introduction to Performance Function

Function Function Description Domains Involved

Querying the historical Querying the historical Router, PTN,Access and

Managing performance Querying, creating, enabling, Router and PTN domains

Reporting performance Reporting threshold-crossing Router, PTN, and transport

Issue 02 (2015-08-15) Huawei Proprietary and Confidential 2

2 Message Exchange Pattern

About This Chapter

l SRR: synchronous request and response pattern.

Issue 02 (2015-08-15) Huawei Proprietary and Confidential 3

Name Type Value Remarks

security String User name:password If the user name is

communicationPat- CommunicationPat- SimpleResponse N/A

communicationStyle CommunicationSty- RPC N/A

Name Type Value Remarks

security String User name:password If the user name is

communicationPat- CommunicationPat- MultipleBatchRes- N/A

communicationStyle CommunicationSty- RPC N/A

Issue 02 (2015-08-15) Huawei Proprietary and Confidential 4

Name Type Value Remarks

requestedBatchSize Long The value is greater This parameter

batchSequenceNum- Long 1 N/A