Академический Документы
Профессиональный Документы
Культура Документы
V200R008C01
Issue
02
Date
2008-09-05
Part Number
Huawei Technologies Co., Ltd. provides customers with comprehensive technical support and service. For any
assistance, please contact our local office or company headquarters.
Website:
http://www.huawei.com
Email:
support@huawei.com
Notice
The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but the statements, information, and
recommendations in this document do not constitute a warranty of any kind, express or implied.
M2000
Northbound File Interface Developer Guide
Contents
Contents
About This Document.....................................................................................................................1
1 Introduction to Northbound File Interface...........................................................................1-1
1.1 Definition of Northbound Interface.................................................................................................................1-2
1.2 Definition of Northbound File Interface.........................................................................................................1-2
1.3 Parameters for Connecting the Northbound File Interface.............................................................................1-2
Contents
M2000
Northbound File Interface Developer Guide
Index.................................................................................................................................................i-1
ii
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Figures
Figures
Figure 1-1 Location of the Northbound interface.................................................................................................1-2
Figure 2-1 Example of a file in .csv format..........................................................................................................2-4
Issue 02 (2008-09-05)
iii
M2000
Northbound File Interface Developer Guide
Tables
Tables
Table 3-1 File format............................................................................................................................................3-2
Table 4-1 File format of configuration data.........................................................................................................4-2
Table 5-1 Export periods and time ranges............................................................................................................5-6
Table 5-2 Parameters of performance data export tasks.....................................................................................5-15
Table 6-1 Description of the parameters in the configuration file........................................................................6-4
Table 7-1 List of supported NE Types.................................................................................................................7-2
Table 7-2 Format of the export file of inventory management............................................................................7-4
Table 7-3 Rack and its attributes..........................................................................................................................7-9
Table 7-4 Frame and its attributes........................................................................................................................7-9
Table 7-5 Slot and its attributes..........................................................................................................................7-10
Table 7-6 Board and its attributes.......................................................................................................................7-11
Table 7-7 Port and its attributes..........................................................................................................................7-12
Table 7-8 HostVer and its attributes...................................................................................................................7-12
Table 7-9 RNCCell and its attributes.................................................................................................................7-13
Table 7-10 Rack and its attributes......................................................................................................................7-13
Table 7-11 Frame and its attributes....................................................................................................................7-14
Table 7-12 Slot and its attributes........................................................................................................................7-15
Table 7-13 Board and its attributes.....................................................................................................................7-15
Table 7-14 Port and its attributes........................................................................................................................7-16
Table 7-15 Antenna and its attributes.................................................................................................................7-17
Table 7-16 HostVer and its attributes.................................................................................................................7-18
Table 7-17 NodeBCell and its attributes............................................................................................................7-18
Table 7-18 Rack and its attributes......................................................................................................................7-19
Table 7-19 Frame and its attributes....................................................................................................................7-20
Table 7-20 Slot and its attributes........................................................................................................................7-20
Table 7-21 Board and its attributes.....................................................................................................................7-21
Table 7-22 Port and its attributes........................................................................................................................7-22
Table 7-23 HostVer and its attributes.................................................................................................................7-23
Table 7-24 BTS and its attributes.......................................................................................................................7-23
Table 7-25 Rack and its attributes......................................................................................................................7-23
Table 7-26 Frame and its attributes....................................................................................................................7-24
Table 7-27 Slot and its attributes........................................................................................................................7-25
Table 7-28 Board and its attributes.....................................................................................................................7-25
Issue 02 (2008-09-05)
Tables
M2000
Northbound File Interface Developer Guide
Table 7-29 Port and its attributes........................................................................................................................7-27
Table 7-30 HostVer and its attributes.................................................................................................................7-27
Table 7-31 Rack and its attributes......................................................................................................................7-28
Table 7-32 Frame and its attributes....................................................................................................................7-28
Table 7-33 Slot and its attributes........................................................................................................................7-29
Table 7-34 Board and its attributes.....................................................................................................................7-30
Table 7-35 Port and its attributes........................................................................................................................7-31
Table 7-36 HostVer and its attributes.................................................................................................................7-31
Table 7-37 Rack and its attributes......................................................................................................................7-32
Table 7-38 Frame and its attributes....................................................................................................................7-32
Table 7-39 Slot and its attributes........................................................................................................................7-33
Table 7-40 Board and its attributes.....................................................................................................................7-34
Table 7-41 Port and its attributes........................................................................................................................7-35
Table 7-42 HostVer and its attributes.................................................................................................................7-35
Table 7-43 Rack and its attributes......................................................................................................................7-36
Table 7-44 Frame and its attributes....................................................................................................................7-36
Table 7-45 Slot and its attributes........................................................................................................................7-37
Table 7-46 Board and its attributes.....................................................................................................................7-38
Table 7-47 Port and its attributes........................................................................................................................7-39
Table 7-48 HostVer and its attributes.................................................................................................................7-39
Table 7-49 Rack and its attributes......................................................................................................................7-40
Table 7-50 Frame and its attributes....................................................................................................................7-40
Table 7-51 Slot and its attributes........................................................................................................................7-41
Table 7-52 Board and its attributes.....................................................................................................................7-42
Table 7-53 Port and its attributes........................................................................................................................7-43
Table 7-54 HostVer and its attributes.................................................................................................................7-43
Table 7-55 Rack and its attributes......................................................................................................................7-44
Table 7-56 Frame and its attributes....................................................................................................................7-44
Table 7-57 Slot and its attributes........................................................................................................................7-45
Table 7-58 Board and its attributes.....................................................................................................................7-46
Table 7-59 Port and its attributes........................................................................................................................7-47
Table 7-60 HostVer and its attributes.................................................................................................................7-47
Table 7-61 Rack and its attributes......................................................................................................................7-48
Table 7-62 Frame and its attributes....................................................................................................................7-48
Table 7-63 Slot and its attributes........................................................................................................................7-49
Table 7-64 Board and its attributes.....................................................................................................................7-50
Table 7-65 Port and its attributes........................................................................................................................7-51
Table 7-66 HostVer and its attributes.................................................................................................................7-51
Table 7-67 BSCModule and its attributes..........................................................................................................7-52
Table 7-68 BSCFrame and its attributes.............................................................................................................7-52
Table 7-69 BSCBoard and its attributes.............................................................................................................7-52
Table 7-70 BSCBTSEquipment and its attributes..............................................................................................7-52
vi
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Tables
Issue 02 (2008-09-05)
vii
M2000
Northbound File Interface Developer Guide
Purpose
This document provides the information about M2000 Northbound file interface. The document
also provides the operation guide for connecting the NMS.
Related Versions
The following table lists the product versions related to this document.
Product Name
Version
M2000
V200R008C01
Intended Audience
The intended audiences of this document are:
l
Network administrator
Update History
02(2008-08-20)
The second formal release. Added Introduction to Configuration Export Files (Flat Export).
01(2008-03-20)
Initial release. Also, the first formal release.
Organization
1 Introduction to Northbound File Interface
This describes the definition of the Northbound interface, and the definition and parameters of
the Northbound file interface.
2 Introduction to Alarm Export Tool and File
This describes the alarm export tool, the formats of alarm export files, alarm export operations,
and troubleshooting.
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Conventions
1. Symbol Conventions
The following symbols may be found in this document. They are defined as follows
Symbol
Description
DANGER
WARNING
CAUTION
TIP
NOTE
2. General Conventions
Convention
Description
Boldface
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Convention
Description
Italic
Courier New
3. Command Conventions
Convention
Description
Boldface
Italic
[]
{x | y | ...}
[ x | y | ... ]
{ x | y | ... } *
[ x | y | ... ] *
4. GUI Conventions
Convention
Description
Boldface
>
5. Keyboard Operation
Convention
Description
Key
Key1+Key2
Key1,Key2
6. Mouse Operation
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Action
Description
Click
Select and release the primary mouse button without moving the
pointer.
Double-click
Drag
Press and hold the primary mouse button and move the pointer
to a certain position.
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Issue 02 (2008-09-05)
1-1
M2000
Northbound File Interface Developer Guide
In the mobile communication network, the M2000 is an EMS. The M2000 reports the alarm,
configuration, and performance data to the NMS through the Northbound interface.
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
NOTE
You can set the password of ftpuser when installing the M2000 server.
For details about the export tool and export format of alarm files, see 2 Introduction to Alarm
Export Tool and File.
For details about the format of configuration files, see 3 Introduction to Configuration Data
Export File.
For details about the export tool and export format of performance files, see 5 Introduction to
Performance Data Export Tool and File.
For details about the export tool and export format of performance files(by NE), see 6
Introduction to NE-Based Performance Data Export Tool and File.
For details about the Export format of Inventory Management File, see 7 Introduction to Export
File of Inventory Management.
Issue 02 (2008-09-05)
1-3
M2000
Northbound File Interface Developer Guide
Issue 02 (2008-09-05)
2-1
M2000
Northbound File Interface Developer Guide
2-2
Naming Rules
Huawei Proprietary and Confidential
Copyright Huawei Technologies Co., Ltd
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Alarm export files are named in the following format: Date and Time [DST]-Alarm
category-auto-Sequence number.Extension, where:
Date and Time together show the time when the alarms are exported, DST indicates the
daylight saving time is used, [] indicates that the sign is not used in non-DST period.
Alarm category shows the category of the exported alarms. The value can be currentalarm, history-alarm, event-alarm, and shielded-alarm, which represent the current fault
alarm, historical fault alarm, event alarm, and shielded alarm respectively.
A maximum of 5,000 alarms of the same category can be exported to one file. To export
more than 5,000 alarms, the alarms other than the first 5,000 alarms are exported to another
file.
The time duration of the alarm export files being maintained before deletion varies
according to different server model and the number of NEs managed by the M2000.
These files are numbered sequentially from 1. If only one file is enough to store the exported
alarms, the file number is 1.
Extension name indicates the format of a file. The file can be in .xml or .csv format. If you
select compression mode for export, the extension name should be .zip.
l
Examples
The file 20051206120300-current-alarm-auto-1.xml indicates:
CSV
The first row in the CSV file lists the fields recording the alarm information, such as the
NE name, alarm name, and alarm severity. From the second row, each row records an alarm.
The configuration file <M2000 server installation folder>/etc/conf/english/
fmexportsvc_field.xml is used for files in .csv format. This configuration file defines the
name (in the first row), value, and sequence of alarm information fields in the files in .csv
format. You can modify this configuration file. For details, see 2.3.1 Modifying the
Configuration File of the Alarm Export Tool.
Figure 2-1 is an example of a file in .csv format.
Issue 02 (2008-09-05)
2-3
M2000
Northbound File Interface Developer Guide
XML
In an XML file, the <Record name="AlarmRecord"></Record> section records
the information of an alarm. The configuration file <M2000 server installation folder>/
etc/conf/english/fmexportsvc_field.xml is used for the files in .xml format. This
configuration file defines the name, value, and sequence of alarm information fields in the
XML file. You can modify this configuration file. For details, see 2.3.1 Modifying the
Configuration File of the Alarm Export Tool.
The following information is an example of a file in .XML format:
<?xml version="1.0" encoding="utf-8" ?>
<ExportFileInfo name="AlarmRecords">
<Record name="AlarmRecord">
<column name="Csn">1001</column>
<column name="ProductID">NMS</column>
<column name="NEType">OMC</column>
<column name="NEFDNName">iMAP</column>
<column name="DevCsn">5</column>
<column name="Id">Under-voltage with Input -48V</column>
<column name="Type">Internal</column>
<column name="AlmLevel">Critical</column>
<column name="Status">Acknowledged</column>
<column name="OccurDateTime">2006/12/29 12:34:04+08:00</column>
<column name="AckDateTime">2007/1/6 09:14:06+08:00</column>
<column name="ClearDateTime">2007/1/7 09:14:06+08:00</column>
<column name="Operator">< system ></column>
2-4
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
<column name="ClearOperator">admin</column>
<column name="ExtendInfo" />
<column name="LinkFDN" />
<column name="LinkFDNName" />
<column name="LinkType" />
<column name="AlarmIdentifier" />
<column name="AlarmId">12</column>
</Record>
</ExportFileInfo>
Prerequisite
You have logged in to the M2000 server as root.
Procedure
Step 1 Go to the M2000 installation folder.
The default M2000 installation path is /opt/OMC.
By default, run the following command:
# cd /opt/OMC
Step 2 To edit the configuration file, run the following command:
# vi etc/conf/english/fmexportsvc_field.xml
NOTE
Step 3 To make the modified configuration file effective, run the following commands:
# . ./svc_profile.sh
Issue 02 (2008-09-05)
2-5
M2000
Northbound File Interface Developer Guide
Prerequisite
You have logged in to the M2000 client.
Procedure
Step 1 Choose Maintenance > Task Management. The Task Management window is displayed.
Step 2 Click the Alarm Data Export on the navigation tree to view a task record.
Step 3 Double-click the task record. The Attribute window is displayed. Set Common Parameters
and Extended Parameters.
Step 4 Click OK. The automatic export configuration is complete.
----End
Prerequisite
l
Context
After the automatic alarm export is enabled, you can stop it manually at any time.
For details on setting the automatic alarm export, see 2.3.2 Setting Automatic Export of Alarm
Files.
Procedure
Step 1 Choose Maintenance > Task Management. The Task Management window is displayed.
Step 2 Click the Alarm Data Export in the navigation tree to view a task record.
Step 3 Right-click the task record and choose Suspend from the shortcut menu. The automatic export
of alarm files is stopped.
----End
2-6
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Date and time indicate when configuration data is exported. The format is
YYYYMMDD.
For manual export, files are named by the user. Two export formats are available, that is,
XML and CSV.
l
Issue 02 (2008-09-05)
Examples
Huawei Proprietary and Confidential
Copyright Huawei Technologies Co., Ltd
3-1
M2000
Northbound File Interface Developer Guide
If the NE name is test1, the NE IP is 11.11.11.11, and the export time is 2005-06-25, the
file name is CMExport_test1_11.11.11.11_2005062509.xml.
Description
<MOTree>
NE MO Tree.
One exported configuration files corresponds to one NE, and thus only one
pair of <MOTree> exists in a configuration file.
<MO>
Corresponding to one MOI. The hierarchy is consistent with the MIT tree.
The NE instance is at the top. Under the NE instance are equipment instance
and function instance. Under the equipment instance are several frame
instances.
<attr name>
<className>
3-2
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
<attr name="className">MSCServerFunction</attr>
<attr name="fdn">.3221229568.3221233664.3221282816.3221491712</attr>
<attr name="name">MSCServerFunction</attr>
<attr name="neID">0</attr>
<MO className="SRVNODE" fdn=".3221229568.3221233664.3221282816.3221491712.
3221663744">
<attr name="MOIndex">0_LOCAL</attr>
<attr name="SN">LOCAL</attr>
<attr name="SN_IDX">0</attr>
<attr name="className">SRVNODE</attr>
<attr name="fdn">.3221229568.3221233664.3221282816.3221491712.
3221663744</attr>
<attr name="name">Server name=LOCAL</attr>
</MO>
<MO className="MSCServerTimeZone" fdn=".3221229568.3221233664.
3221282816.3221491712.3221352448">
<attr name="MOIndex">.3221229568.3221233664.3221282816</attr>
<attr name="className">MSCServerTimeZone</attr>
<attr name="fdn">.3221229568.3221233664.3221282816.3221491712.
3221352448</attr>
<attr name="name">EMSTZ</attr>
<attr name="neID">0</attr>
</MO>
</MO>
</MO>
</MOTree>
NOTE
In the example, some information is displayed in two lines because of the large quantity of the information.
In actual configuration data files, the information occupies only one line.
IP
InternalId MOIndex className district entityVersionId fdn isLocked
latitude longitude matchVersion medPartition name neID neType neVersion
omcID productID realLatitude realLongitude subnetworkID
100.0.44.122 MSOFTX3000V100R005C10B318 0_1_1 MSCServerNE 110000 3
.3221229568.3221233664.3221282816 FALSE 154 281 iManagerM2000_MSOFTX3000_MATCH_CHS_V200R005C01B0
MSC9880 MSOFTX3000V100R005C10B318 1 2 0DN 0DE 1
CLASSNAME
MOIndex
className
fdn
name
MSCServerFunction
0
MSCServerFunction
.3221229568.3221233664.3221282816.3221491712
neID
MSCServerFunction
MOIndex
SN
SN_IDX
className
fdn
name
0_LOCAL
LOCAL
0
SRVNODE
.3221229568.3221233664.3221282816.3221491712.3221663744
Servername=LOCAL
MOIndex
className
fdn
name
neID
.3221229568.3221233664.3221282816
MSCServerTimeZone
.3221229568.3221233664.3221282816.3221491712.3221352448
EMSTZ
NOTE
In the example, the configuration data files is displayed in more lines because of the large quantity of the
information. In actual configuration data files, the information occupies only one line.
Issue 02 (2008-09-05)
3-3
M2000
Northbound File Interface Developer Guide
Choose Maintenance > Task Management to view the Task Management window.
2.
Click the Configuration Data Export in the navigation tree to view a task record.
3.
Double-click the task record to view the Attribute dialog box. Set common parameters
and extended parameters.
4.
3-4
1.
Choose Configuration > MIT Browsing to view the MIT Browsing window.
2.
Expand the navigation tree and select a physical NE whose configuration data to be
exported.
3.
Right-click the NE and choose Export from the shortcut menu. The Configuration Data
Export dialog box is displayed.
4.
5.
6.
Click Save.
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
In the current version, only BSC6000, RNC, and NodeB supports the flat export. For functions
supported by other NEs, see3 Introduction to Configuration Data Export File .
The differences between flat export and the original configuration export are as follows: configuring
the saving days of export files, compressing export files, and flattening objects of MO instances in
export files.
Naming rule
For automatic export, the files are named in the following format: CMExport_NE
name_NE IP_Export time.xml.
The NE name indicates the name of an NE whose configuration data is exported.
NE IP indicates the IP address of an NE.
Export time indicate when configuration data is exported. The format is YYYYMMDD.
Issue 02 (2008-09-05)
4-1
M2000
Northbound File Interface Developer Guide
For manual export, files are named by the user. Three export formats are available, that is,
xml, csv, and txt.
l
Example
If the NE name is test1, the NE IP address is 10.161.85.204, and the Export time is 15:00
at 2008-05-17,
the file name is CMExport_test1_10.161.85.204_2008051715.xml.
Description
<MOTree>
The NE MO tree
An exported configuration file corresponds to one NE, and thus only one
pair of <MOTree> exists in a configuration file.
<MO>
<attr name>
Attribute of MOI
<className>
4-2
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
<attr name="className">BSC6000CPU</attr>
<attr name="fdn">.3221229568.3221233664.3221282816.3221512192</attr>
<attr name="name">CPU No.=0, Slot No.=4, Subrack No.=0</attr>
<attr name="neID">0</attr>
</MO>
<MO className="BSC6000Cabinet" fdn=".3221229568.3221233664.3221282816.3221364736">
<attr name="CabinetNo">0</attr>
<attr name="CabinetType">False</attr>
<attr name="MOIndex">0_0</attr>
<attr name="className">BSC6000Cabinet</attr>
<attr name="fdn">.3221229568.3221233664.3221282816.3221364736</attr>
<attr name="name">Cabinet No.=0</attr>
<attr name="neID">0</attr>
</MO>
</MO>
</MOTree>
NOTE
In this example, some portions of the export file are displayed in two rows because the export file has large
contents. In the export file, these portions are actually displayed in one row.
neID
NOTE
In this example, some portions of the export file are displayed in multiple rows because the export file has
large contents. In the export file, these portions are actually displayed in one row.
Issue 02 (2008-09-05)
4-3
M2000
Northbound File Interface Developer Guide
Modify the ExpFileReservedDays and SupportGzip parameter items in the configuration file.
NOTE
If you modify ExpFileReservedDays and SupportGzip, you need to restart the CMServer service.
1.
2.
3.
If you set SupportGzip to false, the system does not compress the result file.
If you set SupportGzip to true, the system compress the result file using the UNIX
standard and generates a compressed file with the extension name of gz.
The functions of modifying the saving days and compressing files are applied to only scheduled export.
The manual export does not support these functions.
2.
Click Configuration Data Export in the navigation tree to view a task record.
3.
Double-click the task record to view the Attribute dialog box. Set common parameters
and extended parameters.
4.
Choose Configuration > MIT Browsing to view the MIT Browsing window.
Huawei Proprietary and Confidential
Copyright Huawei Technologies Co., Ltd
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
2.
Expand the navigation tree and select a physical NE whose configuration data to be
exported.
3.
Right-click the NE and choose Export from the shortcut menu. The Configuration Data
Export dialog box is displayed.
4.
5.
6.
Click Save.
Issue 02 (2008-09-05)
4-5
M2000
Northbound File Interface Developer Guide
Issue 02 (2008-09-05)
5-1
M2000
Northbound File Interface Developer Guide
BeginTime
This item sets the start time for exporting results.
EndTime
This item sets the end time for exporting results.
5-2
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
NOTE
The set end time must be later than the start time.
If the span between the start time and the end time is too long, the export function is affected.
Therefore, you are advised to set the span to not more than five days.
If you plan to collect the data of a long period, you can configure the start time and the end time for
several times. For example, if you plan to collect the performance data from 2006-01-01 to
2006-01-10, you can collect the performance data from 2006-01-01 to 2006-01-05 first by setting
BeginTime=2006-01-01 00:00, EndTime=2006-01-05 00:00 in the configuration file. After the
performance data within the period is exported, you can collect the perform data from 2006-01-05
to 2006-01-10 by setting the BeginTime=2006-01-05 00:05, EndTime=2006-01-10 00:00 in the
configuration file.
l
GeneralSet
GeneralSet contains common configuration items, which can be modified as required.
CounterSortMode
This item sets the sequence of counters in the result file.
If the value of CounterSortMode is set to 0, the counters in the exported file are
arranged in ascending order based on the character string sizes of counter names.
If the value of CounterSortMode is set to 1, the counters in the exported file are
arranged in ascending order based on counter IDs.
If the value of CounterSortMode is set to 2, the counters in the exported file are
arranged in ascending order based on the character string ASCII codes of counter names.
CounterValueFormat
This item sets a display mode for counter values in the result file.
If the value of CounterValueFormat is set to 1, all the counter values in the exported
result file are marked with quotation marks.
QueryTimeMode
This item sets a time mode for querying results.
DisplayTimeZone
This item sets whether to display the time zone information.
If the value of DisplayTimeZone is set to 0, the system does not display the time zone
information.
If the value of DisplayTimeZone is set to 1, the system displays the time zone
information.
DisplayDstOffSet
This item sets whether to display the DST offset information.
Issue 02 (2008-09-05)
5-3
M2000
Northbound File Interface Developer Guide
If the value of DisplayDstOffSet is set to 0, the system does not display the DST offset
information.
If the value of DisplayDstOffSet is set to 1, the system displays the DST offset
information.
DeleteFileTime
This item sets the execution time for deleting the overdue exported files.
By default, the system deletes the overdue exported files at 01:30 in the morning every day.
QueryHours
This item sets the number of periods for querying the recollected results.
After this item is set, the system checks whether there is recollected data available within
the set time range once the timer is triggered.
For example, if the value of QueryHours is set to 5, the system checks whether there is
the recollected data available within the time range 10:00 to 15:00 when the timer is
triggered at 15:00. If the recollected data is available, the data is exported to the
corresponding file.
QueryExportFormat
This item sets the implementation mode for exporting the recollected results.
If the value of QueryExportFormat is set to 0, export all the results and re-write the
existing exported files if the recollected data is available.
FileExportMode
This item sets the format of file names.
If the value of FileExportMode is set to 0, a file name does not include the name of
the host or the name of the NE type.
If the value of FileExportMode is set to 1, a file name includes the name of the host
and the name of the NE type. The format of a file name is pmresult_Name of a
host_Name of the NE Type_150999067_5_200710121535_200710121540.xml, such
as pmresult_M2000svrCDMA_HLR_150999067_5_200710121535_200710121540.xml.
OMCServerName
This item sets the name of the server. The value is null by default.
If the value of OMCServerName is not null, the name of the exported file is server
name_pmresult_function subset_measurement period_start time_end time.csv. For
example, if the value of OMCServerName is set to MyServer, the name of an exported
file is MyServer_pmresult_function subset_measurement period_start time_end
time.csv.
RANShared
This item sets whether the RAN sharing mode is used. The value is common mode by
default.
5-4
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
If IsShared is set to 1, you can infer that RANShared is RAN sharing mode.
For the RAN sharing mode, you can set the TransmitMode parameter to determine the
mode to forward non-cell data. TransmitMode = 0 indicates that the data is forwarded
to all operators. TransmitMode = 1 indicates that the data is forwarded to none of the
operators. TransmitMode = 2 indicates that the data is forwarded to only primary
operators.
GZip
This item sets whether to compress the result files.
If the value of GZip is set to 0, the result files are not compressed.
If the value of GZip is set to 1, the result files are compressed according to the UNIX
standard. The extension of the compressed file is gz.
TemplateMode
This item sets the format of the template name.
If the value of TemplateMode is set to 0, the template name is contained in the name
of the result file.
The <EffectiveSet> portion is a parameter for setting the export efficiency. You are not
allowed to modify the parameter because each configuration item is closely related to other
configuration items.
l
PMDBConnNum
This item sets the number of connections allowable for the database.
MethodThreadNum
This item sets the number of threads for initializing the active thread mode.
TableThreadNum
This item sets the number of threads used by the timer for triggering the result processing
table.
BulkReaderNum
This item sets the number of results read in batches at a time when the system queries results
in the database result table.
NOTE
You are not required to restart the export tool after modifying BeginTime and EndTime of
<TimeSegmentSet>. For the modification of other parameters, you must restart the export tool.
This describes how to set the parameters related with the export of the performance results of
integrated task management.
In the version of M2000V200R005, the following parameters are added to the integrated task
management. These parameters can be set directly on M2000 client.
NOTE
The export function is controlled by the administration console and cannot be modified.
The parameters such as saving days, measurement unit, measurement period, and delay can be
directly set on M2000 client.
Issue 02 (2008-09-05)
5-5
M2000
Northbound File Interface Developer Guide
Saving days: 90
You can modify the saving days. After this parameter is set, the system regularly deletes
the overdue exported result files.
The system deletes the overdue exported result files once each day.
Time Ranges
15
30
60
1440
For example, if you set the export period to 60 minutes and the delay to 30 minutes, the
performance export tool exports the performance results of the time range 0:00-1:00 at
1:30, and of the 1:00-2:00 at 2:30.
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
are named in the pmexport_Date of the day format. The files that are generated on the same
day are saved in the same folder.
For example, the pmexport_20060215 folder saves all the performance files exported on
February 15, 2006.
the M2000 automatically creates the FTP user and performance export directory. In addition,
the M2000 binds the directory with user rights to manage performance export files.
The NMS user can access the authorized directory through the FTP to obtain performance export
files.
If function subsets are configured in performance files, save the result of each function
subset to a file.
If templates are configured in performance files, save the result of each template to a file.
.csv
.xml
.txt
Issue 02 (2008-09-05)
5-7
M2000
Northbound File Interface Developer Guide
If a template contains only one function subset and a template name is configured
The name of the file for saving performance results can be pmresult_Function subset
ID_Measurement period_Start time_End time_Template Name.csv or
pmresult_Function subset ID_Measurement period_Start time_End time_Template
Name.xml.
For example, the name of the performance export file
pmresult_67109445_30_200507041030_200507041100_TCPState.csv indicates:
5-8
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
From the third row, the information about the performance results is displayed according
to the field name in the first row. Each result record occupies one row.
For example:
Result Time,Granularity Period
,Object Name,Reliability,"ABNORMAL RELEASE TIMES
","CIRCUIT BLOCKED BY PEER END TIMES","MSG FORMAT ERROR TIMES",
"NO BLA TO T13
TIMES","NO CLF TO T5 TIMES"
,Minutes,,,times,times,times,times,times
2005-12-6 4:30,30,
"softx_test/Office:OFFICEDIR=2/
subRouteNo:SRC=2/Group:TG=22",Reliable,11063,9071,24817,5903,5248
2005-12-6 4:30,30,
"softx_test/Office:OFFICEDIR=3/
subRouteNo:SRC=3/Group:TG=3",Reliable,6724,31445,31621,3221,21711
The second row lists the units. The unit is displayed if the unit exists; otherwise, Null is
displayed. The second row is shown as follows:
Null | Minutes | Null | Null | Unit of Counter 1 | Unit of Counter 2 |
......
From the third row, the information about the performance results is displayed according
to the field name in the first row.
For example:
Result Time,Granularity Period,Object Name,Reliability,"84149755","84149756",
"84149757","84149758","84149759","84149760","84149761","84149762",Minutes,,,ti
mes,times,
times,times,times,times,times,times
2006-05-23 15:00,30,"msc_b035/MSCServer:msc_b035",Reliable,
9460,2824,31106,25564,
5173,19433,16631,20223
l
Issue 02 (2008-09-05)
5-9
M2000
Northbound File Interface Developer Guide
<r>0</r>
<r>0</r>
<r>0</r>
<sf>false</sf>
</mv>
</mi>
</md>
<mff>
<ts>200511200930</ts>
</mff>
</mdc>
<sf></sf> indicates the reliability of the value for a object. sf is the abbreviation of
suspect flag.
For example:
The name of an object with two levels can be RNC4/Cell:Label=Cell22081, CellID=22081.
The name of an object with three levels can be RNC4/
MTP3BLinkSet:Label=LinkSet0,INDEX=0/MTP3BLink:Label=LindSet0,
LKS=0,SLC=0.
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Context
NOTE
You are not required to restart the export tool after modifying BeginTime and EndTime of
<TimeSegmentSet>. For the modification of other parameters, you must restart the export tool.
Procedure
Step 1 Modify BeginTime.
This item sets the start time for exporting results.
Step 2 Modify EndTime.
This item sets the end time for exporting results.
NOTE
The set end time must be later than the start time.
If the span between the start time and the end time is too long, the export function is affected. Therefore,
you are advised to set the span to not more than five days.
If you plan to collect the data of a long period, you can configure the start time and the end time for several
times. For example, if you plan to collect the performance data from 2006-01-01 to 2006-01-10, you can
collect the performance data from 2006-01-01 to 2006-01-05 first by setting BeginTime=2006-01-01 00:00,
EndTime=2006-01-05 00:00 in the configuration file. After the performance data within the period is
exported, you can collect the perform data from 2006-01-05 to 2006-01-10 by setting the
BeginTime=2006-01-05 00:05, EndTime=2006-01-10 00:00 in the configuration file.
If the value of CounterSortMode is set to 0, the counters in the exported file are arranged
in ascending order based on the character string sizes of counter names.
If the value of CounterSortMode is set to 1, the counters in the exported file are arranged
in ascending order based on counter IDs.
If the value of CounterSortMode is set to 2, the counters in the exported file are arranged
in ascending order based on the character string ASCII codes of counter names.
Issue 02 (2008-09-05)
If the value of CounterValueFormat is set to 0, the counter values of the measurement unit
that contains only non-character-string counters are not marked with quotation marks in the
exported result file. The counter values of the measurement unit that contains character-string
counters, however, are marked with quotation marks.
Huawei Proprietary and Confidential
Copyright Huawei Technologies Co., Ltd
5-11
M2000
Northbound File Interface Developer Guide
If the value of CounterValueFormat is set to 1, all the counter values in the exported result
file are marked with quotation marks.
If the value of CounterValueFormat is set to 2, none of the counter values in the exported
result file are marked with quotation marks.
If the value of QueryTimeMode is set to 0, the system queries displayed results in NE time
mode.
If the value of QueryTimeMode is set to 1, the system queries displayed results in server
time mode.
If the value of DisplayTimeZone is set to 1, the system displays the time zone information.
If the value of DisplayTimeZone is set to 0, the system does not display the time zone
information.
If the value of DisplayDstOffSet is set to 1, the system displays the DST offset information.
If the value of DisplayDstOffSet is set to 0, the system does not display the DST offset
information.
5-12
If the value of QueryExportFormat is set to 0, export all the results and re-write the existing
exported files if the recollected data is available.
If the value of QueryExportFormat is set to 1, export the recollected data to another file.
The file name is different, which is pmresult_measurement unit ID_measurement
period_start time_end time_recover_current system time.csv or pmresult_measurement
Huawei Proprietary and Confidential
Copyright Huawei Technologies Co., Ltd
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
If the value of FileExportMode is set to 0, a file name does not include the name of the host
or the name of the NE type.
If the value of FileExportMode is set to 1, a file name includes the name of the host and the
name of the NE type. The format of a file name is pmresult_Name of a host_Name of the
NE Type_150999067_5_200710121535_200710121540.xml, such as
pmresult_M2000svr-CDMA_HLR_150999067_5_200710121535_200710121540.xml.
If the value of OMCServerName is not null, the name of the exported file is server
name_pmresult_function subset_measurement period_start time_end time.csv. For
example, if the value of OMCServerName is set to MyServer, the name of an exported file
is MyServer_pmresult_function subset_measurement period_start time_end time.csv.
If the value of OMCServerName is null, the name of the exported file is pmresult_function
subset_measurement period_start time_end time.csv.
If IsShared is set to 1, you can infer that RANShared is RAN sharing mode.
For the RAN sharing mode, you can set the TransmitMode parameter to determine the mode
to forward non-cell data. TransmitMode = 0 indicates that the data is forwarded to all
operators. TransmitMode = 1 indicates that the data is forwarded to none of the operators.
TransmitMode = 2 indicates that the data is forwarded to only primary operators.
If the value of GZip is set to 0, the result files are not compressed.
If the value of GZip is set to 1, the result files are compressed according to the UNIX standard.
The extension of the compressed file is gz.
If the value of TemplateMode is set to 0, the template name is contained in the name of the
result file.
If the value of TemplateMode is set to 1, the template ID is contained in the name of the
result file.
5-13
M2000
Northbound File Interface Developer Guide
This item sets the number of threads for initializing the active thread mode.
Step 19 Modify TableThreadNum.
This item sets the number of threads used by the timer for triggering the result processing table.
Step 20 Modify BulkReaderNum.
This item sets the number of results read in batches at a time when the system queries results in
the database result table.
In the version of M2000V200R005, the following parameters are added to the integrated task
management. These parameters can be set directly on M2000 client.
NOTE
The export function is controlled by the administration console and cannot be modified.
The parameters such as saving days, measurement unit, measurement period, and delay can be directly
set on M2000 client.
The system deletes the overdue exported result files once for each day.
Step 22 Modify the measurement unit, measurement period, export period , and delay.
Set the number of a function subset, and the measurement period, export period (unit: minute),
and delay (unit: minute; optional) of the function set. The measurement period, export period,
and delay must be integer multiples of five, for example, 5, 15, 30, 60, or 1,440. The delay must
be integer multiples of five. The default delay is used if you do not set DELAY. The delay of
function subsets has higher priority over the default delay.
After you set all the parameters, the performance results of the specified time ranges are exported
to the specified files after the preset delay ends. The time range is divided based on the export
period. Table 5-1 lists the common export periods and time ranges.
----End
Prerequisite
You have logged in to the M2000 client.
Procedure
Step 1 Choose Maintenance > Task Management. The Task Management window is displayed.
Step 2 Choose File Interface > Performance Data Export in the navigation tree to view a
performance data export task.
Step 3 Use either of the following methods to view the Attribute dialog box:
5-14
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Select a performance data export task in the task list. Then click Attribute.
Description
File Format
.csv
.xml
.txt
Hold Days
Sets the hold days of an exported file. For example, if this parameter
is valued 90, you can infer that the file can be saved for 90 days after
the day it is exported and that it is deleted after 90 days.
File Path
Path for saving the exported file, which is set by the system.
This parameter cannot be modified.
Measure Period
Function Subsets
5 minutes
15 minutes
30 minutes
60 minutes
24 hours
Template
NOTE
For measurement subsets with the same measurement period, you can configure only one export period.
5-15
M2000
Northbound File Interface Developer Guide
Then the system saves the export task, according to which the export tool exports files at the
scheduled time.
----End
Prerequisite
Log in to the M2000 server as root.
Context
The performance export tool is a service, PMExport, provided by the M2000. It starts and stops
after the M2000 starts and stops. You can start the performance export tool manually during the
operation of the M2000.
Procedure
Step 1 Go to the M2000 installation folder.
The default M2000 installation path is /opt/OMC.
# cd /opt/OMC
Step 2 Start the performance export tool.
# . ./svc_profile.sh
# svc_adm -cmd startsvc PMExport
The performance export tool starts successfully if the following prompt is displayed:
PMExport
[started
The performance export tool is running properly if the following prompt is displayed:
PMExport
[running
----End
Prerequisite
Log in to the M2000 server as root.
Context
The performance export tool is a service, PMExport, provided by the M2000. It starts and stops
after the M2000 starts and stops. You can stop the performance export tool manually during the
operation of the M2000.
5-16
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Procedure
Step 1 Go to the M2000 installation folder.
The default M2000 installation path is /opt/OMC.
# cd /opt/OMC
Step 2 Stop the performance export tool.
# . ./svc_profile.sh
# svc_adm -cmd stopsvc PMExport
The performance export tool stops if the following prompt is displayed:
PMExport............................stopped
------------cost: 3*1500(msec)-----------svc_adm : info : INDIE_STOP finished
The performance export tool is not running if the following prompt is displayed:
svc_adm:error:service is not running
----End
If some performance export files are missing while others exist, the M2000 automatically conducts
supplementary collection to obtain the lost data.
2.
3.
Issue 02 (2008-09-05)
5-17
M2000
Northbound File Interface Developer Guide
[not running ]
In such a situation, start the performance export tool manually. For details, see 5.4.3
Starting the Performance Data Export Tool.
The performance export tool is running properly if the following prompt is displayed:
PMExport
4.
[running
Check the log file <M2000 server installation folder>/var/logs/pmexport.trace for errors.
Proceed accordingly based on the error information.
NOTE
5.
If the time zone where the NEs are located does not coincide with that of the M2000 server,
set QueryTimeMode to 1 in the PMExpParam.xml file in the directory of /export/home/
omc/var/etc/pm/tool.
Performance Export Tool's Special Treatment to Different Time Zones and DST
1.
The DST offset displayed in the name of an exported file does not refer to the DST.
2.
When you set QueryExportFormat to 0 and QueryTimeMode to 0, you can infer that
the NE and the NM are in different time zones. For instance, if NE1 and NE2 are located
in the time zones GMT+4:00 and GMT+10:00 respectively and the M2000 is in GMT+8:00,
the result file is exported according to the GMT+8:00 of the server and the contents of the
result file are displayed according to NE time.
In this situation, set QueryTimeMode to 1 and export the result according to the server
time.
3.
Take the NM is in GMT-5 for example. The DST rule of 2006 specifies that you should
set the time one hour earlier from 02:00 on April 2nd to 02:00 on October 29th. That is, set
the time 02:00 to 03:00 on April 2nd, and then set the time 02:00 to 01:00 on October 29th.
For the period from 01:00 DST to 02:00 on October 29th, the rule for exporting results of
this repeated period is as follows:
l
For this period, Huawei recommends that you set QueryExportFormat to 0 and
QueryTimeMode to 1. The results are exported based on the server time.
5-18
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Issue 02 (2008-09-05)
6-1
M2000
Northbound File Interface Developer Guide
6-2
CounterSortMode: Indicates the display and sort modes of the counters in the performance
data export file.
Huawei Proprietary and Confidential
Copyright Huawei Technologies Co., Ltd
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
If this parameter is set to 0, the performance data in the exported file is displayed and
sorted by counter name.
If this parameter is set to 1, the performance data in the exported file is displayed and
sorted by counter ID.
By default, this parameter is set to 1, which is recommended for use.
Counterseparator: Indicates the separator, namely, string format, between the counters in
the performance data export file.
By default, Value is set to " ", which indicates that a space is used. If a counter name contains
a space, you are advised to set the space to ";". If a counter ID contains a space, however,
the space can be reserved.
DeleteFileTime: Indicates the time for deleting the performance data export file. The format
is hour : minute, for example, Value = "1:30".
ResultSaveDays: Indicates the time for saving the performance data export file, for
example, Value = "7". This value varies with actual situations.
1: No data is written.
NastarExport: Indicates whether the NodeB results need to be exported for use by the
Nastar.
If IsSupport is set to 1, it indicates that the results need to be exported to a file whose
format is supported by the Nastar.
By default, IsSupport is set to 0.
If the value is 1, compress the result file complying with the UNIX standard. A
compression file with the extension .gz is generated.
Not all the counters being measured on the M2000 are not all provided for the northbound.
Therefore, the M2000 should provide an independent control view for the NMS and thus the
information about the northbound exported counters can be set. The following part describes
how to provide such a control view by using the configuration file.
NOTE
The configuration file provides only one view for obtaining the northbound performance data. Any
modification of the view does not affect the measurement setting performed by the M2000 on NEs.
Therefore, the exported counters and periods set in the configuration file can be used for obtaining the data
only when the M2000 performance management system performs relevant measurement on NEs.
6-3
M2000
Northbound File Interface Developer Guide
The settings in the PMMedExportView.xml configuration file involve counters and periods.
They are set by hierarchy. The hierarchies are respectively NE type, functional subset, and
counter in sequence. The description of the parameters in the configuration file is listed in Table
6-1.
Table 6-1 Description of the parameters in the configuration file
6-4
Parameter
Type
Value
Description
ExportSetting
FileVersion
Unsigned int
0-232-1
FormatVersion
string
String of any
type
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Parameter
Type
Value
Description
enableMedExp
bool
true/false
NEType
id
Unsigned int
0-1000
NodeB: 3
RNC: 4
SGSN: 7
GGSN: 8
BSC6000:76
name
String
String of any
type
exportMode
int
0, 1, and 2
Issue 02 (2008-09-05)
supportPeriods
String
Comprising 5,
15, 30, 60, and
1440
Mu
id
Unsigned int
0-232-1
Identification of a measurement
unit
name
String
String of any
type
6-5
M2000
Northbound File Interface Developer Guide
Parameter
Type
Value
Description
exportMode
int
0, 1, and 2
supportPeriods
String
Comprising 5,
15, 30, 60, and
1440
Counter
id
Unsigned int
0-232 -1
Counter identification
name
String
String of any
type
Counter name
exportMode
int
0-1
supportPeriods
String
Comprising 5,
15, 30, 60, and
1440
If all the data reported by an NE is to be exported and the period is 15 minutes, you can set
the NE type as follows (taking the SGSN for example):
<NEType id="7" name="SGSN" exportMode="1" supportPeriods="15"></NEType>
2.
If all the counters of partial functional sub-items under the SGSN are to be exported and
the period is 15 minutes, you can set in the following way:
l
Change exportMode of NEType to 2, indicating that only the definitely listed functional
sub-items are exported.
Provide the information about the functional sub-items to be exported and set
exportMode to 1.
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
3.
If only the specified counters are to be exported, you can set in the following way:
l
Change exportMode of Mu to 2, indicating that only the definitely listed counters are
exported.
List the information about the counters to be exported and set exportMode to 1.
According to the preceding configuration, If the M2000 obtains the data whose counter IDs
are respectively 117454513, 117454514, and 117454515 from the SGSN, the data is
exported to the performance result file within the 15-min period. The data whose counter
ID is 117454545 cannot be exported because the exportMode value is 0.
4.
If you need to activate the mediation layer to export data, set the value of
enableMedExpto true. Restart all the Mediation services to validate the setting. The
procedure is as follows:
(1) Run commands to query the Mediation service. For example, svc_adm -cmd status|
grep 'MediationService'.
(2) Restart the queried Mediation services. For example, if you query Mediation Service1
and MediationService2, run commands as svc_adm -cmd restartsvc
MediationService1 and svc_adm -cmd restartsvc MediationService2
.
neName: Generally, indicates the name of an NE. For the NodeB, however, this parameter
refers to the corresponding RNC name. If the RNC is not found, the default directory name
is adopted.
Issue 02 (2008-09-05)
6-7
M2000
Northbound File Interface Developer Guide
Type: Indicates whether the measurement results in the performance data export file are
obtained from a single NE or multiple NEs.
l
B refers to multiple NEs and a single measurement period. This scenario is not used at
present.
NOTE
At present, the performance data export file supports only the measurement performed in a single
period.
2.
3.
Startdate: Indicates the start date of a performance measurement period. The format is
YYYYMMDD, which is explained as follows:
l
Starttime: Indicates the start time of a performance measurement period. The format is
HHMMshhmm, which is explained as follows:
l
HH refers to the hour of the local time, comprised by two digits, such as 00-23 on a 24hour basis.
MM refers to the minute of the local time, comprised by two digits. The possible values
are 00, 05, 10, 15, 20, 25, 30, 35, 40, 45, 50, and 55.
s refers to the sign ("+" or "-") marking the difference between the local time and the
UTC time zone. If they are consistent, the sign can either be "+" or "-".
++hh refers to the differential hour between the local time and the UTC time zone,
comprised by two digits, such as 00-23.
mm refers to the differential minute between the local time and the UTC time zone,
comprised by two digits, such as 00-59.
4.
Enddate: Indicates the end date of a performance measurement period. This field is not
contained in the name of the performance data export file. For the measurement performed
within a single period, the value of Enddate is the same as that of Startdate.
5.
Endtime: Indicates the end time of a performance measurement period, which is related to
the start time of a performance measurement period. The permitted minute values are 00,
05, 10, 15, 20, 25, 30, 35, 40, 45, 50, and 55.
6.
Currently, multiple NodeBs cannot be written to the same file. The letter B in the suffix of the performance
data export file indicates that the file containing the data exported by multiple NEs.
6-8
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
7.
RC: Refers to the running statistical parameter starting from 1. If the file name is not unique,
this field is added after the file name. For the measurement performed within a single period,
this field is not required.
Prerequisite
You have logged in to the M2000 server as user root.
Context
The performance data export tool serves as a service, PMMedExportX (X refers to a digit)
provided by the M2000. It starts and stops after the M2000 starts and stops. If required, you can
Issue 02 (2008-09-05)
6-9
M2000
Northbound File Interface Developer Guide
manually start the performance data export tool when the M2000 system runs. In the distributed
mode, PMMedExportX is distributed with Mediation. That is, each slave device distributed with
the Mediation service possesses a PMMedExportX service, for example, PMMedExport1 or
PMMedExport2.
Procedure
Step 1 Switch to the M2000 installation directory. The default installation directory is /opt/OMC.
The default installation directory is /opt/OMC.
By default, run the following command:
# cd /opt/OMC
Step 2 Start the performance data export tool.
# . ./svc_profile.sh
# svc_adm -cmd startsvc PMMedExport1
l
[started
You can infer that the performance data export tool is started successfully.
l
[running
You can infer that the performance data export tool already runs.
----End
Prerequisite
You have logged in to the M2000 server as user root.
Context
The performance export tool serves as a service, PMMedExportX, provided by the M2000. It
starts and stops after the M2000 starts and stops. If required, you can manually stop the
performance data export tool when the M2000 system runs.
Procedure
Step 1 Switch to the M2000 installation directory.
The default installation directory is /opt/OMC.
By default, run the following command:
# cd /opt/OMC
Step 2 Stop the performance data export tool.
# . ./svc_profile.sh
6-10
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
[stopped
You can infer that the performance data export tool is stopped successfully.
----End
In the distribution mode, the relevant operation information is recorded on each master device.
The PMMedExportX service reads the PMMedExportParam.xml file from the the local
server when being initialized. Therefore, if the PMMedExportX file needs to be modified,
you must simultaneously modify the PMMedExportParam.xml file on all the servers
running the PMMedExportX service.
2.
After modifying the configuration file, you must restart the relevant PMMedExportX
service. For details, see 6.4.1 Starting NE-Based Performance Data Export Tool.
2.
MediationServiceX reads the PMMedExportView.xml file from the local server when
being initialized and obtains the enableMedExp field. Therefore, if this field needs to be
modified, you must restart all the MediationServiceX services.
3.
The PMMedExportX service checks the PMMedExportView.xml file on the local server
every five minutes to obtain the FileVersion field. If the field value is modified, the file
must be reloaded. Therefore, if you modify the exported counters and period information,
you must simultaneously modify the FileVersion field. The performance data export task
by NE automatically scans and loads the field. If the FileVersion field is not simultaneously
modified, you need to restart all the PMMedExportX services. For details, see 6.4.1
Starting NE-Based Performance Data Export Tool.
Issue 02 (2008-09-05)
6-11
M2000
Northbound File Interface Developer Guide
Issue 02 (2008-09-05)
7-1
M2000
Northbound File Interface Developer Guide
Supported NE Types
The NE types that are supported by the export file of inventory management are listed in the
following table.
Table 7-1 List of supported NE Types
NE Type
Whether Supported
RNC
Yes
NodeB
7-2
DBS3800
Yes
NodeB3802C
Yes
NodeB3806
Yes
NodeB3806A
Yes
NodeB3812
Yes
NodeB3812A
Yes
NodeB3812AE
Yes
NodeB3812E
Yes
BSC6000
Yes
BSC6000 Site
Yes
Huawei Proprietary and Confidential
Copyright Huawei Technologies Co., Ltd
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
NE Type
Whether Supported
MSC Server
Yes
MGW
Yes
SGSN
Yes
GGSN80
Yes
HLR
Yes
PCU
Yes
BSC(Include BSCBTS)
Yes
ICS
Yes
UAG
Yes
Default path of the export file of inventory management in the manual manner
The inventory management data files that are manually exported are saved in a specified
client directory. Meanwhile, the backup data files are saved in the /export/home/omc/var/
fileint/cm/InvtManualExport/ directory on the M2000 server.
Default path of the export file of inventory management in the scheduled manner
The inventory management data files that are exported at the scheduled time are saved in
the /export/home/omc/var/fileint/cm/InvtTimerExport directory.
7-3
M2000
Northbound File Interface Developer Guide
Naming rule
In automatic export, the export file of inventory management is named W_M2000_NE
type_NE fdn_NE name.file format.
The NE type refers to the actual type of a current NE, such as the RNC and the
BSC6000.
The NE fdn, such as .3221229568.3221233664.3221282816, uniquely identifies an NE in
the M2000 system.
The NE name refers to the NE name that is displayed on a client topology.
The export file of inventory management can be in .xml, .csv, or .txt format.
Example
For example, if the NE type is BSC6000, NE fdn is .3221229568.3221233664.3221282816,
NE name is 211, NE format is in .csv format, then the name of the export file is as follows:
W_M2000_BSC6000_.3221229568.3221233664.3221282816_211.csv.
7-4
Format
Description
<DATAPAC
KET>
<NE>
Is used to record the basic information about existing NEs and supports three
attributes, that is, NEFdn, NEName, and NEType.
<TABLES>
Contains one or more TABLE flags and does not contain any attribute.
<TABLE>
Contains the type of and information about the actual inventory, and the
attrname attribute that is used to indicate the inventory type.
ROWDATA
Contains one or more records of the existing inventory type. The records are
separated by the ROW flag.
ROW
Corresponds to an actual record. The attribute of the flag is the attribute name
and value of each record. For the meaning of each attribute name, see 7.3
The Inventory Types of Each NE.
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
The following part takes the export file of inventory management pertaining to the BSC6000 as
an example:
<?xml version="1.0" encoding="iso-8859-1"?>
<DATAPACKET>
<NE NEFdn=".3221229568.3221233664.3221282816" NEName="211" NEType="BSC6000NE"/>
<TABLES>
<TABLE attrname="Rack">
<ROWDATA>
<ROW DateOfLastService="" DateOfManufacture="" InventoryUnitId="1"
InventoryUnitType="Hardware" ManufacturerData=""
RackNo="1" RackType="Local"
SerialNumber="" UnitPosition="RackNo = 1"
VendorName="Huawei"
VendorUnitFamilyType="Rack"
VendorUnitTypeNumber="0" VersionNumber=""/>
</ROWDATA>
</TABLE>
<TABLE attrname="Frame">
<ROWDATA>
<ROW DateOfLastService="" DateOfManufacture="" FrameNo="1"
FrameType="GTCS" InventoryUnitId="1"
InventoryUnitType="Hardware" ManufacturerData=""
ModuleNo="-1" RackFrameNo="1" RackNo="0"
SerialNumber="" UnitPosition="RackNo = 0,
FrameNo=1" VendorName="Huawei"
VendorUnitFamilyType="Frame" VendorUnitTypeNumber="0"
VersionNumber=""/>
</ROWDATA>
</TABLE>
<TABLE attrname="Slot">
<ROWDATA>
<ROW DateOfLastService="" DateOfManufacture="" FrameNo="1"
InventoryUnitId="14" InventoryUnitType="Hardware"
ManufacturerData="" RackNo="0" SerialNumber=""
SlotNo="14" SlotPos="1" UnitPosition="RackNo = 0,
FrameNo=1,SlotNo=14,SlotPos=1"
VendorName="Huawei"
VendorUnitFamilyType="Slot"
VendorUnitTypeNumber="0" VersionNumber=""/>
</ROWDATA>
</TABLE>
<TABLE attrname="Board">
<ROWDATA>
<ROW BiosVer="" BiosVerEx="" BoardName="GXPUM"
BoardType="" DateOfLastService=""
DateOfManufacture="" FrameNo="3" InventoryUnitId="0"
InventoryUnitType="Hardware" Item="" LANVer=""
LogicVer="" MBUSVer="" ManufacturerData=""
ModuleNo="-1" RackNo="1" SerialNumber=""
SlotNo="0" SlotPos="0" SoftVer="" SubSlotNo="-1"
UnitPosition="RackNo= 1,FrameNo=3,SlotNo=0,
SlotPos=0, SubSlotNo=0" VendorName=""
VendorUnitFamilyType="Board" VendorUnitTypeNumber="0"
VersionNumber=""/>
</ROWDATA>
</TABLE>
<TABLE attrname="Port">
<ROWDATA>
<ROW DateOfLastService="" DateOfManufacture=""
FrameNo="0" InventoryUnitId="14"
InventoryUnitType="Hardware" ManufacturerData=""
RackNo="0" SerialNumber=""
SlotNo="14" SlotPos="0" SubSlotNo="-1"
UnitPosition="RackNo= 0, FrameNo=0,
SlotNo=14, SlotPos=0, SubSlotNo=-1,
PortNo=14" VendorName="Huawei"
VendorUnitFamilyType="E1Port" VendorUnitTypeNumber="0"
VersionNumber=""/>
Issue 02 (2008-09-05)
7-5
M2000
Northbound File Interface Developer Guide
</ROWDATA>
</TABLE>
<TABLE attrname="Antenna">
<ROWDATA/>
</TABLE>
<TABLE attrname="HostVer">
<ROWDATA>
<ROW HostVer="BSC6000V900R003C01B061"
HostVerType="HOSTVER" sDesc=""/>
</ROWDATA>
</TABLE>
<TABLE attrname="BTS">
<ROWDATA>
<ROW SiteIndex="1" SiteName="22c" SiteType="BTS22C"/>
</ROWDATA>
</TABLE>
</TABLES>
</DATAPACKET>
Prerequisite
l
Procedure
Step 1 Choose Maintenance > Task Management. The Task Management window is displayed.
Step 2 Click Inventory Data Export in the navigation tree to view a task record.
Step 3 Double-click the task record to view the Attribute dialog box. Set Common Parameters and
Extended Parameters.
7-6
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Prerequisite
l
The conditions for the automatic inventory management data export are met.
Context
After the export of automatic inventory management files is enabled, you can stop it manually
at any time.
For details on setting the automatic export of inventory management files, see 7.2.1
Automatically Exporting Inventory Management Files.
Procedure
Step 1 Choose Maintenance > Task Management. The Task Management window is displayed.
Step 2 Click Inventory Data Export in the navigation tree to view a task record.
Step 3 Right-click a task record and choose Suspend from the shortcut menu to stop the automatic
exporting of inventory management files.
----End
Prerequisite
l
Procedure
Step 1 Select Configuration . The Inventory Management window is displayed.
Step 2 Right-click an NE node or MO node in the navigation tree and choose Export.
Step 3 Set the file name, save path, and save type of the file in the Save dialog box.
Step 4 Click Save to finish the automatic export configuration.
Issue 02 (2008-09-05)
7-7
M2000
Northbound File Interface Developer Guide
7-8
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Rack
Table 7-3 Rack and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
RackType
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Frame
Table 7-4 Frame and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
RackFrameNo
RackNo
SerialNumber
7-9
M2000
Northbound File Interface Developer Guide
Meaning
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Slot
Table 7-5 Slot and its attributes
7-10
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Board
Table 7-6 Board and its attributes
Issue 02 (2008-09-05)
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
7-11
M2000
Northbound File Interface Developer Guide
Port
Table 7-7 Port and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
HostVer
Table 7-8 HostVer and its attributes
7-12
Meaning
HostVer
HostVerType
sDesc
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
RNCCell
Table 7-9 RNCCell and its attributes
Field Name of the Export File
Meaning
CellId
CellName
Lac
Locell
ManufacturerData
MaxTxPower
NodeBName
PsCrambCode
Rac
Sac
UarfcnUpLink
UarfcnDownLink
UserLabel
Rack
Table 7-10 Rack and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
RackType
7-13
M2000
Northbound File Interface Developer Guide
Meaning
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
VersionNumber
HardwareVersion
Frame
Table 7-11 Frame and its attributes
7-14
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackFrameNo
RackNo
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Slot
Table 7-12 Slot and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Board
Table 7-13 Board and its attributes
Issue 02 (2008-09-05)
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
7-15
M2000
Northbound File Interface Developer Guide
Meaning
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Port
Table 7-14 Port and its attributes
7-16
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Antenna
Table 7-15 Antenna and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
VersionNumber
7-17
M2000
Northbound File Interface Developer Guide
HostVer
Table 7-16 HostVer and its attributes
Field Name of the Export File
Meaning
HostVer
HostVerType
sDesc
NodeBCell
Table 7-17 NodeBCell and its attributes
7-18
Meaning
BbPoolType
CabinetNo1
CabinetNo2
DI
DlFreq
HighSpeedMode
HoRad
Hsdpa
Locell
MaxPower
Radius
SecNo
SiteNo
SlotNo1
SlotNo2
SpeedRate
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
SubRackNo1
SubRackNo2
UlFreq
UlgroupNo
UserLabel
Rack
Table 7-18 Rack and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
RackType
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
7-19
M2000
Northbound File Interface Developer Guide
Frame
Table 7-19 Frame and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackFrameNo
RackNo
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Slot
Table 7-20 Slot and its attributes
7-20
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Board
Table 7-21 Board and its attributes
Issue 02 (2008-09-05)
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
7-21
M2000
Northbound File Interface Developer Guide
Meaning
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Port
Table 7-22 Port and its attributes
7-22
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
HardwareVersion
HostVer
Table 7-23 HostVer and its attributes
Field Name of the Export File
Meaning
HostVer
HostVerType
sDesc
BTS
Table 7-24 BTS and its attributes
Field Name of the Export File
Meaning
SiteIndex
SiteName
SiteType
Rack
Table 7-25 Rack and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
7-23
M2000
Northbound File Interface Developer Guide
Meaning
RackNo
RackType
SerialNumber
SiteIndex
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Frame
Table 7-26 Frame and its attributes
7-24
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackFrameNo
RackNo
SerialNumber
SiteIndex
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
HardwareVersion
Slot
Table 7-27 Slot and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SiteIndex
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Board
Table 7-28 Board and its attributes
Issue 02 (2008-09-05)
Meaning
BiosVer
BiosVerEx
BoardName
7-25
7-26
M2000
Northbound File Interface Developer Guide
Meaning
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SiteIndex
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Port
Table 7-29 Port and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SiteIndex
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
HostVer
Table 7-30 HostVer and its attributes
Issue 02 (2008-09-05)
Meaning
HostVer
HostVerType
sDesc
SiteIndex
7-27
M2000
Northbound File Interface Developer Guide
Rack
Table 7-31 Rack and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
RackType
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Frame
Table 7-32 Frame and its attributes
7-28
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
ModuleNo
RackFrameNo
RackNo
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Slot
Table 7-33 Slot and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
7-29
M2000
Northbound File Interface Developer Guide
Board
Table 7-34 Board and its attributes
7-30
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Port
Table 7-35 Port and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
HostVer
Table 7-36 HostVer and its attributes
Field Name of the Export File
Meaning
HostVer
HostVerType
sDesc
7-31
M2000
Northbound File Interface Developer Guide
Rack
Table 7-37 Rack and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
RackType
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Frame
Table 7-38 Frame and its attributes
7-32
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackFrameNo
RackNo
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Slot
Table 7-39 Slot and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
7-33
M2000
Northbound File Interface Developer Guide
Board
Table 7-40 Board and its attributes
7-34
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Port
Table 7-41 Port and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
HostVer
Table 7-42 HostVer and its attributes
Field Name of the Export File
Meaning
HostVer
HostVerType
sDesc
7-35
M2000
Northbound File Interface Developer Guide
Rack
Table 7-43 Rack and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
RackType
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Frame
Table 7-44 Frame and its attributes
7-36
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackFrameNo
RackNo
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Slot
Table 7-45 Slot and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
7-37
M2000
Northbound File Interface Developer Guide
Board
Table 7-46 Board and its attributes
7-38
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Port
Table 7-47 Port and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
HostVer
Table 7-48 HostVer and its attributes
Field Name of the Export File
Meaning
HostVer
HostVerType
sDesc
7-39
M2000
Northbound File Interface Developer Guide
Rack
Table 7-49 Rack and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
RackType
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Frame
Table 7-50 Frame and its attributes
7-40
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackFrameNo
RackNo
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Slot
Table 7-51 Slot and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
7-41
M2000
Northbound File Interface Developer Guide
Board
Table 7-52 Board and its attributes
7-42
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Port
Table 7-53 Port and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
HostVer
Table 7-54 HostVer and its attributes
Field Name of the Export File
Meaning
HostVer
HostVerType
sDesc
7-43
M2000
Northbound File Interface Developer Guide
Rack
Table 7-55 Rack and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
RackType
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Frame
Table 7-56 Frame and its attributes
7-44
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackFrameNo
RackNo
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Slot
Table 7-57 Slot and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
7-45
M2000
Northbound File Interface Developer Guide
Board
Table 7-58 Board and its attributes
7-46
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Port
Table 7-59 Port and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
HostVer
Table 7-60 HostVer and its attributes
Field Name of the Export File
Meaning
HostVer
HostVerType
sDesc
7-47
M2000
Northbound File Interface Developer Guide
Rack
Table 7-61 Rack and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
RackType
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Frame
Table 7-62 Frame and its attributes
7-48
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackFrameNo
RackNo
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Slot
Table 7-63 Slot and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
7-49
M2000
Northbound File Interface Developer Guide
Board
Table 7-64 Board and its attributes
7-50
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Port
Table 7-65 Port and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
HostVer
Table 7-66 HostVer and its attributes
Field Name of the Export File
Meaning
HostVer
HostVerType
sDesc
7-51
M2000
Northbound File Interface Developer Guide
BSCModule
Table 7-67 BSCModule and its attributes
Field Name of the Export File
Meaning
ModuleNo
ModuleType
BSCFrame
Table 7-68 BSCFrame and its attributes
Field Name of the Export File
Meaning
FrameNo
ModuleNo
BSCBoard
Table 7-69 BSCBoard and its attributes
Field Name of the Export File
Meaning
BoardNo
BoardType
FrameNo
LogicalNo
ModuleNo
BSCBTSEquipment
Table 7-70 BSCBTSEquipment and its attributes
7-52
Meaning
BTSType
ModuleNo
SiteNo
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
BSCBTSFrame
Table 7-71 BSCBTSFrame and its attributes
Field Name of the Export File
Meaning
FrameNo
ModuleNo
SiteNo
BSCBTSBoard
Table 7-72 BSCBTSBoard and its attributes
Field Name of the Export File
Meaning
FrameNo
ModuleNo
SiteNo
SlotNo
BoardNo
BoardType
SerialNumber
SoftVer
Rack
Table 7-73 Rack and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
7-53
M2000
Northbound File Interface Developer Guide
Meaning
ManufacturerData
RackNo
RackType
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Frame
Table 7-74 Frame and its attributes
7-54
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackFrameNo
RackNo
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Slot
Table 7-75 Slot and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Board
Table 7-76 Board and its attributes
Issue 02 (2008-09-05)
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
7-55
M2000
Northbound File Interface Developer Guide
Meaning
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Port
Table 7-77 Port and its attributes
7-56
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
HostVer
Table 7-78 HostVer and its attributes
Field Name of the Export File
Meaning
HostVer
HostVerType
sDesc
Rack
Table 7-79 Rack and its attributes
Issue 02 (2008-09-05)
Meaning
DateOfLastService
DateOfManufacture
InventoryUnitId
InventoryUnitType
7-57
M2000
Northbound File Interface Developer Guide
Meaning
ManufacturerData
RackNo
RackType
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Frame
Table 7-80 Frame and its attributes
7-58
Meaning
DateOfLastService
DateOfManufacture
FrameNo
FrameType
InventoryUnitId
InventoryUnitType
ManufacturerData
ModuleNo
RackFrameNo
RackNo
SerialNumber
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Slot
Table 7-81 Slot and its attributes
Field Name of the Export File
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
RackNo
SerialNumber
SlotNo
SlotPos
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
Board
Table 7-82 Board and its attributes
Issue 02 (2008-09-05)
Meaning
BiosVer
BiosVerEx
BoardName
BoardType
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
7-59
M2000
Northbound File Interface Developer Guide
Meaning
InventoryUnitType
BOMCode
LANVer
LogicVer
MBUSVer
ManufacturerData
ModuleNo
RackNo
SerialNumber
SlotNo
SlotPos
SoftVer
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
IssueNumber
HardwareVersion
Port
Table 7-83 Port and its attributes
7-60
Meaning
DateOfLastService
DateOfManufacture
FrameNo
InventoryUnitId
InventoryUnitType
ManufacturerData
Issue 02 (2008-09-05)
M2000
Northbound File Interface Developer Guide
Meaning
RackNo
SerialNumber
SlotNo
SlotPos
SubSlotNo
UnitPosition
VendorName
VendorUnitFamilyType
VendorUnitTypeNumber
HardwareVersion
HostVer
Table 7-84 HostVer and its attributes
Issue 02 (2008-09-05)
Meaning
HostVer
HostVerType
sDesc
7-61
M2000
Northbound File Interface Developer Guide
Index
Index
A
alarm export
automatic, 2-2
file
category and quantity, 2-2
format, 2-2
naming rule, 2-2
path, 2-2
modifying
configuration file of the alarm export tool, 2-5
configuration file of the performance data export
tool, 5-11
MOI, 3-1
N
NMS, 1-2, 1-2
parameter
password, 1-2
user name, 1-2
performance export
file
category and quantity, 5-6
naming rule, 5-6
path, 5-6
operation
start, 5-16
stop, 5-16
tool, 5-2
configuration file, 5-2
operation log, 5-17
D
DST, 5-11, 5-17
E
EMS, 1-2
F
FDN, 3-1
FTP, 1-2, 1-2
setting
automatic alarm export, 2-6
termination of automatically exporting alarm file,
2-6
interface
Northbound file interface, 1-2
Northbound interface, 1-2
M2000, 1-2
MIT, 3-1
MO, 3-1
Issue 02 (2008-09-05)
i-1