Internal Use Only▲

MAoUE User Guide

All rights reserved. No spreading without permission of ZTE.. 1

 Internal Use Only▲

Revision History
Prepared
Preparation
Version by / Main Contents Revised
File No. / Revision Reason for Revision
No. Revised (Main Points)
Date
by
Zhang 2011-7-19 First published First published
Ping
Zhang 2011-08-23 Add Add appendix
Ping
Zhang 2012-3-31 Modify Divide the upgrade
Gaoke process into 3 phases.
Zhang 2012-09-19 Update Describer clearly for
Ping some ambiguous parts.
Zhang 2012-12-11 Function 1: Support zip
Ping modification, and compressed strategy file
synchronize 2: Support different ports
modification of the same IP to be as
different NE nodes to
process.
Zhang 2013-04-18 Tcl is abnormal, put the
Ping execution file out of DEP
protection range
Zhang 2013-07-24 Add: Manually change
Ping the NE state,
During executing
process, selection
buttons are grey.
Note1: When archiving files (achieved to the Division or the archives room of the company) each time
after modified, the form needs to be filled in.
Note2: When archiving files for the first time, fill in Null in “Reason for Revision”, “Main Contents
Revised”.

All rights reserved. No spreading without permission of ZTE.. 2

 Internal Use Only▲

Contents
1. Introduction of Functions .......................................................................................................... 4

2. Usage Requirements & Other Specification ............................................................................. 4

3. Install Tool ................................................................................................................................ 4

4. Introduction of Steps ................................................................................................................. 6

4.1. Preparation before Upgrade ..................................................................................................... 7

4.1.1. Set Language ................................................................................................................... 7
4.1.2. Set FTP Parameters......................................................................................................... 7
4.1.3. Set Other Parameters ...................................................................................................... 8
4.2. Upgrade Process Operations .................................................................................................... 9
4.2.1. Imput NE Data Files ........................................................................................................ 9
4.2.2. Load Upgrade Strategy File ............................................................................................ 9
4.2.3. Start to Upgrade ............................................................................................................ 10
4.2.4. Control Upgrade Process .............................................................................................. 11
4.2.5. NE Upgrade State Specifications .................................................................................. 11
4.2.6. Manually Change NE Upgrade State ............................................................................ 12
4.2.7. Save Upgrade Progress ................................................................................................. 13
4.2.8. View Upgrade Result ..................................................................................................... 13
4.2.9. Others ............................................................................................................................ 14

5. NE Upgrade Log Operation .................................................................................................... 14

6. Appendix 1: Auxiliary Usage Specifications .......................................................................... 15

7. Appendix 2: Common Problems and Solutions ...................................................................... 15

All rights reserved. No spreading without permission of ZTE.. 3

 Internal Use Only▲

Specification:
This document introduces the installation deployment, operating steps of the MAoUEV1.0.1
version upgrade tool. For specific NE version upgrade strategies, please refer to Upgrade Usage
Specifications of each NE.

1. Introduction of Functions
MAoUE tool is a unified version batch upgrade platform of ZTE. Under the platform, develop
their own upgrade strategies for different NEs, so as to realize the version batch upgrade function
of NEs.
At present, it has covered OLT, MDU, MSAN and other product series.

2. Usage Requirements & Other Specification

⚫ Supported OS Platform
Windows xp, windows server 2003, windows 7 Chinese / English OS Platform

⚫ The upgrade tool is developed, tested and released for a particular version of a specific NE,
that is, a NE version upgrade package released each time has a clear coverage scope,
including the original version, upgrade target version, covered upgrade step strategy of the
NE, all are clearly required.
So before the upgrade tool is used on-site, you need to make clear whether the on-site
environment is consistent with the required conditions. On-site upgrade environments differ
in thousands ways, it is suggested to confirm with engineering and R & D first, and after
there are no errors for R & D to simulate testing on-site, and then use it on-site formally.

⚫ The tool is installed and run independently, and can be used independent from the NMS
system (NE list information generated by the NMS system can be used). It is recommended
to avoid from using the tool on the computer running the NMS system as possible as you can.

3. Install Tool
The whole system is divided into several parts listed as below: install platform (including GUI
and general library), version upgrade packets of each NE, NE version files and auxiliary tools.

⚫ Install Platform
Unzip and copy the tool installation packet MAoUE_XXXXXXX.7z under the directory
(The directory cannot contain Chinese and Spaces)

Click the setup_init.bat file under the tool directory, to complete the deployment of
installation initialization. If there prompts that tnm3.0.0 directory copy failed, you can
manually copy C:\tcl\lib under D:\MAoUE_V108_20141203\exTools to C:\tcl\lib
(C:\tcl\lib\tnm3.0.0)

All rights reserved. No spreading without permission of ZTE.. 4

 Internal Use Only▲

⚫ Release and deploy version upgrade packet of the NE:

Each sub-directory under the installation directory\tcl\script\ directory represents a kind of
version upgrade project of NE, generally, named with “NE type + Version No. +
Timestamp”, such as C220V113p4_20120101.

The sub-directory contains all the information (upgrade strategy file, input parameters, tcl
script files, etc.) of a certain NE’s version upgrade. When being released, package the
sub-directory and files contained as a whole, releasing as a version upgrade package of the
NE.
When deploying, decompress the version upgrade compressed package received under the
script directory.
Directory example after deployed:

⚫ Prepare the NE version files to copy under the corresponding directory.

Directory to save the NE version files: the requirements of different upgrade projects to FTP
directory may have different rules, for details, refer to Upgrade Usage Specifications of each
NE. It is generally set as: installation directory/tcl/script/upgrade project /ftpdir (that is, the
directory saving path to specify the ftp directory to NE version).

⚫ Install auxiliary tools

Upgrade tool will use the ftp server tool.
Suggest the ftp server to adopt wftpd tool or 3CDaemon ftp tool. The installation packet of the
tool contains [Link] file, which is located under the \exTools sub-directory.
For configuration and usage methods of the ftp server tool, refer to Usage Specifications of
each ftp tool.
Note: At present, the tool only supports local FTP service.

The file directory examples after deployed:

All rights reserved. No spreading without permission of ZTE.. 5

 Internal Use Only▲

⚫ Note: From V1.0.2 version, start to support compressed strategy packets which can be
released as a whole.
The packet released is a zip compression packet which comprises NE version file and other
information.
Such strategy release files can be directly put under the script directory, and there is no need
to decompress manually.

4. Introduction of Steps
Run [Link], and open up the main interface of the tool.
Note: open up the tool via start_debug_mode.bat, there will pop up a window of background
running information print.
Main interface:
Main interface is divided into two areas: 1. Main menu; 2. the left side is NE tree area; 3. the
right side is NE information displaying area.

All rights reserved. No spreading without permission of ZTE.. 6

 Internal Use Only▲

4.1. Preparation before Upgrade

4.1.1. Set Language
Click Menu -【Language】-【Change Language】pops up:

Click 【Yes】, and then restart the tool, to be able to change the language environment.
4.1.2. Set FTP Parameters
Click Menu -【Setting】-【FTP Information Configuration】, the FTP Information Configuration
dialog box will pop up to modify the FTP information.

All rights reserved. No spreading without permission of ZTE.. 7

 Internal Use Only▲

Note:
1) The tool itself doesn’t comprise setting and running of the FTP server. Perform
corresponding setting and running according to the information of the FTP server applied.
2) About FTP path. The requirements of different upgrade projects to FTP directory may have
different rules, for details, refer to Upgrade Usage Specifications of each NE. It is
generally set as: installation directory/tcl/script/upgrade project /ftpdir (that is, the
directory saving path to specify the ftp directory to NE version).
3) The IP address of the FTP only supports to configure as the host’s address at present.

4.1.3. Set Other Parameters

Click Menu -【Setting】-【Upgrade Parameters Setting】, there will pop up Upgrade Parameters
Setting dialog box, to modify information.
Telnet user name/password: user name/password to telnet to the NE. All NEs use the same
information.
Community name: the community password for snmp to access the NE. All NEs use the same
information.
Concurrently Upgrade NE Count: The number of NEs that the tool upgrades concurrently.
Time out (Min): the maximum time for a certain process of the NE to be silent, and without
information interaction with the GUI tool. If it exceeds the time, the tool will
automatically shut down the NE’s upgrade process.

All rights reserved. No spreading without permission of ZTE.. 8

 Internal Use Only▲

4.2. Upgrade Process Operations

4.2.1. Input NE Data Files
Select 【Load NE List】menu, to specify NE data file or upgrade process files saved before, the NE
will display on the left area in a tree mode.
Note: 1) NE data file: CSV/xls format files, which can be exported from NMS, and can be edited
manually.

For methods to export NE files from NMS, refer to the contents in No. 2 in Appendix 1.

For file format, refer to: MAoUE\tcl\script\ NeList_demo_full.csv and

Nelist_demo_minimum.csv.

⚫ NeList_demo_full.csv comprises complete NE information files, including the NE’s all

information which needs to be filled in, which is applicable to the situation when NE
parameters are not unified, for example, telnet user names and passwords are not unified, if
not filled in, adopt globally defined values of the system.

⚫ Nelist_demo_minimum.csv is the most concise NE file template, just comprise NE type and
IP address, other information adopts globally defined values of the system.

⚫ Meanings of the head information of the NE list:

➢ netype: NE type (Necessary)

➢ ip: ip address (Necessary)

➢ community: community name (Optional)

➢ telnetUser: telnet user name (Optional)

➢ telnetPassword: telnet password (Optional)

➢ location: NE location (Optional)

➢ label: NE name (Optional)

➢ ID: NE node ID, unique (Optional)

➢ port: NE port name (Optional)

Note: The types of parameters supported by different project upgrade strategies will be
different.
2) Files during the upgrade process: CSV-format files, saved during previous upgrade process,
and the format is similar to NE’s data format.
3)NEs can be filtered according to the drop-down box of 【NE Type】.

4.2.2. Load Upgrade Strategy File

Mode 1: CSV strategy file mode
Click【Load Upgrade Strategy File】menu to specify the upgrade strategy files needed by upgrade.
Strategy files adopt CSV format, generally named like xxx_UpgradeStrategy_yyyymmdd.csv.
If the strategy file is correct, 【Health Check】
【Download Software】
【Software Activation】buttons

All rights reserved. No spreading without permission of ZTE.. 9

 Internal Use Only▲
will be in normal state and can be selected.
(Note: Corresponding buttons will become normal state and can be selected according to step
phase state comprised in the upgrade strategy. If corresponding step phase is not comprised, for
example, if there is no phase of Health Check step, the button will be grey and cannot be selected.)

Mode 2: ZIP compress strategy file mode

From V1.0.2 version, start to support compressed strategy packets which can be released as a
whole.
Select 【Load ZIP Strategy File】 menu, to select suitable zip compressed file under the script
directory.

4.2.3. Start to Upgrade

On the left NE tree, tick the NE needed, check 【Health Check】, 【Download Software】and
【Software Activation】 as needed, and click the 【Execute】 button, to start to perform
corresponding upgrade operations.
For different upgrade results, there will show different icons to represent on the NE tree.

Right side will use list to output rather specific information of NE upgrade; at the same time, show
the upgrade progress, the progress bar shows the percentage of completion (Percentage: Number
of NEs completing upgrade / Total number of NEs to be upgraded)
At the same time, during the upgrade process,【Pause】 【Resume】 【Stop】 buttons can be used to
control the upgrade process.

Specification: The whole upgrade steps of an NE are divided into 3 phases.

All rights reserved. No spreading without permission of ZTE.. 10

 Internal Use Only▲
⚫ Health Check
State check before upgrading some versions, to judge whether it meets the conditions of
version upgrade
⚫ Download Software
Download software phase: generally including configuration detection, version file
downloading process before upgrade. It is made up of step functions marked as “Before
Upgraded”in the phase column in the strategy file.
⚫ Software Activation
Software activation phase: generally including the process of NE restarting version and
making it effective, state detection process after the NE is restarted. It is made up of step
functions marked as “After Upgraded”in the phase column in the strategy file.
⚫ Users can select different actions and action combination to upgrade as needed, for example,
you can execute the three steps separately to upgrade, or combine 【Health Check】 and
【Download Software】 to upgrade, or【Health Check】 【Download Software】 【Software
Activation】simultaneously to upgrade.
4.2.4. Control Upgrade Process
After you start to upgrade, you can control the upgrade process via several buttons at the right
side.
⚫ Click 【Pause】 to pause the upgrade process, the NEs being upgraded will continue to the
end of upgrade, the NEs ticked but not started to upgrade won’t be upgraded, and at the
same time, the【Resume】 button will be on;
⚫ Click 【Resume】 to resume the upgrade process, the NEs ticked but not started to upgrade
will be upgraded;
⚫ Click 【Stop】 to stop the upgrade process, the NEs being upgraded will continue to the
end of upgrade, the NEs not started to upgrade won’t be upgraded. When the operations
being executed finish, these buttons will be used.

4.2.5. NE Upgrade State Specifications

The upgrade status of the NE is made up of 3 steps: 【Health Check】
【Download Software】
【Software Activation】.
Each step contains 4 states:

Not start

Terminated

Failed

Succeeded
A combination of states of three steps represents the current status of a certain NE, for example:

Represent that the NE’s health check is succeeded,

download software is terminated, and software activation isn’t started.

All rights reserved. No spreading without permission of ZTE.. 11

 Internal Use Only▲
4.2.6. Manually Change NE Upgrade State
The upgrade status of the NE is made up of 3 steps:【Health Check】 【Download Software】
【 Software Activation 】 , and the state of each phase is determined by running results
automatically.
During the upgrade process, sometimes you need to intervene the state manually; for example, if
problems are found at the stage of Health Check, later, it is confirmed manually that the problems
are solved, but you don’t want to run the step of Health Check, you can modify the NE upgrade
state via the following mode.
(Note: Intervening the state manually is a special proceesing, we do not suggest it as a
routine operation mdoe. If you have any problems, contact the project team in time.)

Select manual setting state, after clicking OK, view that there will show the state manually
changed in NE Detailed Upgrade Result.

All rights reserved. No spreading without permission of ZTE.. 12

 Internal Use Only▲

4.2.7. Save Upgrade Progress

If the upgrade tool needs to be shut down during the upgrade process, you can save the current
upgrade process via Save Current Progress, so as to resume the upgrade when opened next time.
1).Click Menu -【File】-【Save Current Progress】 to save the current upgrade process in the file.
2).Click Menu -【File】-【Save NEs Currently Selected】 to save the currently selected NE in a
certain status in the file separately.
4.2.8. View Upgrade Result

1) Click 【NE Upgrade Log】 to be able to open the upgrade log of current NEs;
2) Click 【Open Log File Dir】 to be able to open the directory where the NE upgrade log resides;
3) Click 【Telnet NE】 to pop up a dos window for you to type telnet user name and password;
4) Double click Upgrade Result, there will pop up Detailed Upgrade Result window.

All rights reserved. No spreading without permission of ZTE.. 13

 Internal Use Only▲

4.2.9. Others
⚫ During the upgrade process, it is not allowed to change strategy file and NE data file. You can
change them only after the progress reaches 100% or pause or stop the task manually by the
user.

⚫ During the upgrade process, it is not allowed to change the selected status of the NE via
left-clicking the mouse, but only through right-clicking the menu to remove a certain NE
from the waiting queue, or add the NEs not selected to join the waiting queue.

⚫ During the running process of the tool, it will automatically save the upgrade process, as a
data protection in special circumstances (for example, the equipment is powered off, or the
tool exits abnormally), but it is just a protection tool in special circumstances. Generally, it is
strongly recommended that users save progress appropriately according to their own
situations.

5. NE Upgrade Log Operation

Sub-directory under log directory (its name is consistent with NE upgrade strategy sub-
directory), save all the NE upgrade log information under the NE’s version upgrade project.
Each sub-directory contains three sub-directories: error, log, processInfo.
⚫ log directory: Contain the log information during the NE upgrade process. Each NE runs
a file each time.
⚫ error directory: Contain the error information during the NE upgrade process. If there
are errors during the NE upgrade process, there will generate a file. The timestamp in
the file name is consistent with that of the log file. If there are no errors during the NE
upgrade process, there won’t generate a file.
⚫ processInfo directory: Contain the process information during the upgrade process of
each NE, and each NE has a file, for internal usage of scripts.

In GUI upgrade status column, you can directly open corresponding files via right-click
menu.

All rights reserved. No spreading without permission of ZTE.. 14

 Internal Use Only▲

Specification: For different strategies, their locations of the logs will differ a bit. NE log files
may be directly put under each above-mentioned directory, or may be put under the sub-directories
lower than above-mentioned directory, for example, each NE creates sub-directory according to IP
addresses, for saving log of each NE respectively. The GUI tool will automatically locate under
corresponding directory.

Suggestions: under error, log directories, there will save too many log information files of the
NEs upgraded before. To facilitate maintenance, we suggest clearing log files after backup in time
at the end of the upgrade.

6. Appendix 1: Auxiliary Usage Specifications

⚫ There is a zip_log.bat under the upgrade tool directory, run the script, to package the running
log (including upgrade tool running log and tcl script running log), to facilitate develop
personnel to locate faults.

⚫ Method to export NE data from the NMS:

4x NMS, use ems\tools\n3common-datamigrate\bin\[Link](sh)
3x NMS, use netnumen\tools\datamigrate\bin\[Link](sh)
After it is run, select the data file under the same-level directory: NeExport*****.xls

⚫ When you unzip and copy the tool installation packet MAoUE_XXXXXXX.7z to the
directory, do not put it under the directory path containing Chinese or spaces.

⚫ Numbers in a save progress file:

Status Value Meaning

0 Not upgrade
1 Failed
2 Succeeded
4 Terminated

7. Appendix 2: Common Problems and Solutions

⚫ Some Windows computers will run script abnormally, and TCL exception prompt box will
appear.
Solution 1: Disable the DEP protection function
Add or modify the noexecute value into AlwaysOff in [Link] under C:\, restart the
computer, and then run the tool once again.

Solution 2: Put the execution file out of the DEP protection range
Via the following path: My Computer - Properties - Advanced - Performance (Setting) –
Performance Options window – Data Execution Protection Prevention page. Add
[Link] [Link] under the maoue\tcl\bin\ directory out of the DEP protection range;

All rights reserved. No spreading without permission of ZTE.. 15

 Internal Use Only▲
after confirmed, it may prompt to restart the computer, but there is no need to restart it.
The path to add the program: [Link] and [Link] under the
MAoUE_V108_20141203\tcl\bin:

All rights reserved. No spreading without permission of ZTE.. 16

 Internal Use Only▲

All rights reserved. No spreading without permission of ZTE.. 17

 Internal Use Only▲

⚫ Telnet client tool parameter setting

Through changing the content of the file
MAoUE\tcl\lib\zteshtestlib\ztecmnlib\spawn_type.tcl, set to select different telnet clients,
configuration command delivery speed and other parameters.

1) The spawn_telnet parameter is to specify which type of telnet client is used.

If the OS is XP, suggest setting the spawn_telnet value as 0 (the system’s own telnet
mode).
If the OS is win7, set spawn_telnet value as 1 (plink telnet mode).
2) Set g_ifSendFlow as 1, representing to set the speed of delivering a configuration
command via g_send_slow parameter.
Set is as 0, it represents that do not use g_send_slow parameter, but use the default value of

All rights reserved. No spreading without permission of ZTE.. 18

 Internal Use Only▲
the telnet client.
3) The default value of g_send_slow is {1 .3}, representing the speed of delivering a
configuration command (1 character is sent per 0.3s).
Adjust the value according to the configuration of the PC being used and number of NEs
concurrently upgraded by the tool.
If the PC has a better configuration / number of NEs concurrently upgraded is small, set it
faster.
For example:
{1 .1} (Represent that 1 character is sent per 0.1s).
If lack of characters when delivering a configuration command during the usage process of
the tool, set it slower.
For example:
{1 .4} , (Represent that 1 character is sent per 0.4s).

All rights reserved. No spreading without permission of ZTE.. 19