ZXSDR OMMB

Version Management Operation Guide

Version: V12.12.30

ZTE CORPORATION
NO. 55, Hi-tech Road South, ShenZhen, P.R.China
Postcode: 518057
Tel: +86-755-26771900
Fax: +86-755-26770801
URL: http://ensupport.zte.com.cn
E-mail: support@zte.com.cn

LEGAL INFORMATION
Copyright 2012 ZTE CORPORATION.
The contents of this document are protected by copyright laws and international treaties. Any reproduction or
distribution of this document or any portion of this document, in any form by any means, without the prior written
consent of ZTE CORPORATION is prohibited.

Additionally, the contents of this document are protected by

contractual confidentiality obligations.

All company, brand and product names are trade or service marks, or registered trade or service marks, of ZTE
CORPORATION or of their respective owners.
This document is provided as is, and all express, implied, or statutory warranties, representations or conditions
are disclaimed, including without limitation any implied warranty of merchantability, fitness for a particular purpose,
title or non-infringement. ZTE CORPORATION and its licensors shall not be liable for damages resulting from the
use of or reliance on the information contained herein.
ZTE CORPORATION or its licensors may have current or pending intellectual property rights or applications
covering the subject matter of this document. Except as expressly provided in any written license between ZTE
CORPORATION and its licensee, the user of this document shall not acquire any license to the subject matter
herein.
ZTE CORPORATION reserves the right to upgrade or make technical change to this product without further notice.
Users may visit ZTE technical support website http://ensupport.zte.com.cn to inquire related information.
The ultimate right to interpret this product resides in ZTE CORPORATION.

Revision History
Revision No.

Revision Date

Revision Reason

R1.0

20120830

First Edition

Serial Number: SJ-20120711145812-005

Publishing Date: 2012-08-30 (R1.0)

SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Contents
About This Manual ......................................................................................... I
Chapter 1 Software Version Management................................................ 1-1
Chapter 2 BS Version Upgrade ................................................................. 2-1
2.1 Upgrade Preparation .......................................................................................... 2-2
2.2 Adding Version Packages ................................................................................... 2-2
2.3 Viewing Version Packages .................................................................................. 2-3
2.4 Creating an Upgrade Task .................................................................................. 2-5

Chapter 3 Common Operations ................................................................ 3-1

3.1 Querying NE Version Packages .......................................................................... 3-1
3.2 Creating a Deactivation Task............................................................................... 3-2
3.3 Creating a Package Deletion Task ....................................................................... 3-4
3.4 Exporting/Importing NE Status Information........................................................... 3-5

Figures............................................................................................................. I
Glossary ........................................................................................................ III

I
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

II
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

About This Manual

Purpose
This manual describes version management operations of the ZXSDR OMMB.

Intended Audience
This manual is intended for:
l
l

Maintenance engineers
Network management engineers

Prerequisite Skills and Knowledge

To use this document effectively, users should have a general understanding of wireless
telecommunications technology. Familiarity with ZXSDR base station and its related
components is helpful.

What Is in This Manual

This manual contains the following chapters:
Chapter

Summary

1, Software Version

Describes the software version management function and how to display

Management

the software version management screen, and terminologies related to

version management also.

3, BS Version Upgrade

Describes the BS version upgrade flow.

4, Common Operations

Describes the common operations for version management.

Related Documentation
The following documents are related to this manual:
l
l
l

ZXSDR OMMB Configuration Management Operation Guide

ZXSDR OMMB General Operation Guide
ZXSDR OMMB Dynamic Data Management Operation Guide

Conventions
This manual uses the following typographical conventions:
Typeface

Meaning

Italics

Variables in commands. It may also refer to other related manuals and documents.

I
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Typeface

Meaning

Bold

Menus, menu options, function names, input fields, option button names, check
boxes, drop-down lists, dialog box names, window names, parameters, and
commands.

Constant width

Text that you type, program codes, filenames, directory names, and function
names.

[]

Optional parameters.

{}

Mandatory parameters.

Separates individual parameters in a series of parameters.

Danger: indicates an imminently hazardous situation. Failure to comply can result
in death or serious injury, equipment damage, or site breakdown.
Warning: indicates a potentially hazardous situation. Failure to comply can result
in serious injury, equipment damage, or interruption of major services.
Caution: indicates a potentially hazardous situation. Failure to comply can result
in moderate injury, equipment damage, or interruption of minor services.
Note: provides additional information about a certain topic.

II
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Chapter 1

Software Version
Management
Function
Software version management manages board version files on the Operation &
Maintenance Module for BTS, NodeB and eNode (OMMB) server and Network Elements
(NEs). You can perform the following operations:
l
l

Add or delete version files on the OMMB server.

Download, activate, query, or delete NE version file packages.

Software Version Management Screen

All software version management operations are performed on the Software Version
Management screen.
In the main window of the ZXSDR OMMB, select View > Software Version Management
from the menu. The Software Version Management screen is displayed, see Figure 1-1.
Figure 1-1 Software Version Management Screen

Terminology and Operation Descriptions

The terminologies and operations displayed in the ZXSDR OMMB or this manual are
roughly described as follows:
l

Version package
Software package including partial or all board versions of NEs

Add Version Package

To add version packages to the OMMB server

Delete Package
To delete version packages from the version database of the OMMB server

NE
1-1

SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

ZXSDR OMMB Version Management Operation Guide

BS equipment managed by the system

l

Download
To download the version software from the version packages on the OMMB server to
NEs

Create Delete Package Task

To create a task of deleting the deactivated packages on NEs

Check version package

To verify that the versions running on the boards are consistent with the versions in
the target packages

Pre-Activation
To set the target packages as the packages to be loaded in next NE startup

Reset NE
To restart the operating NEs

Deactivate
To deactivate the pre-activated version packages on NEs

Download data
To download the configuration data to NEs before the version packages are activated

1-2
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Chapter 2

BS Version Upgrade
The BS version upgrade flow is as follows:
1. Upgrade preparation: prepare a version package for upgrade and back up the NE
configuration data file of the current version.
2. Add the version package: add the version package to the OMMB server.
3. View the version package: view the version package that is added to the server and
verify that it is proper.
4. Create an upgrade task:
a. Create a download and pre-activation task to download the version package to
the NE and pre-activate it.
b. Create a version package query task to verify that the pre-activated version
package is proper.
c.

Create an effective-activation task to change the pre-activated version to the

running version in a specified time with less users.

Figure 2-1 illustrates package status conversion on the NE during the upgrade.
Figure 2-1 Package Status Conversion

l
l
l

After the Pre-Activation operation is performed, the version package is changed to

activated status, indicating that the NE is ready to load the version package.
After the Activation effective operation is performed, the version package is changed
to running status. The NE is reset, then loads and runs the version package.
After the Create Deactivate Package Task operation is performed, the version
package is changed to deactivated status and can be deleted.

Table of Contents
Upgrade Preparation ..................................................................................................2-2
Adding Version Packages...........................................................................................2-2
Viewing Version Packages .........................................................................................2-3
2-1
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

ZXSDR OMMB Version Management Operation Guide

Creating an Upgrade Task..........................................................................................2-5

2.1 Upgrade Preparation

Before upgrading the NE version, you must perform the following operations:
l
l

Copy the version package file required by OMMB upgrade to the OMMB client.
Back up the NE configuration data of the current version.

2.2 Adding Version Packages

This procedure describes how to upload version packages on the OMMB client to the
OMMB server.

Steps
1. On the Software Version Management screen, expand the Software Version
Management navigation tree in the left pane.
(Add Package List)
2. Select the Version Library Management node, and click the
icon on the right toolbar. The Add Version Package dialog box is displayed, see
Figure 2-2.
Figure 2-2 Add Version Package Dialog Box

3. Select the version package file to be added under the local path, and click the Add
Version Package button. The system automatically analyzes the version package
and displays the process of adding the package.
4. After the version package is successfully added, click the Cancel button to close the
Add Version Package dialog box. The added version package is displayed in Version
Package List, see Figure 2-3.
2-2
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Chapter 2 BS Version Upgrade

Figure 2-3 Version Package List

End of Steps

2.3 Viewing Version Packages

This procedure describes how to view package file details on the OMMB server, including
the file name, software type, mode, version, and applicable scope of a version package.

Steps
1. On the Software Version Management screen, expand the Software Version
Management navigation tree in the left pane.
2. Select the Version Library Management node, and double-click a package record in
Version Package List. The View details dialog box is displayed, see Figure 2-4. For
the version package parameter descriptions, refer to Table 2-1.
Figure 2-4 View details Dialog Box

Table 2-1 Version Package Parameter Descriptions

Name

Description

Package

Package file name with the .pkg suffix

Type

Software type that the package applies to

There are six software types:
l

BBU

BBU Patch

RRU

RRU Patch

Firmware

Hot Patch

2-3
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

ZXSDR OMMB Version Management Operation Guide

Name

Description

Mode

There are two package modes:

l

Plat: the package including the version

files of platform boards and common-mode
boards

UMTS/GSM/TD/CDMA/LTE-FDD/LTETDD/WiMAX/MICROWAVE: the package

including the version files of all product
boards

Version

Package version number

Father Version

Version number of the father package of the

patch package

Create Time

Time of creating the package

Applicable Scope

Indicates the NE modes that the package

applies to. The applicable scope can include
one or multiple NE modes. If the applicable
scope is null, it indicates the package applies
to all modes.
For example, the applicable scope of the
package is TDS and LTE TDD, which means
both the TDS single-mode BS and LTE TDD
single-mode BS can download and activate
the package.

3. In Version Package List, right-click the package record, and select Open from
the shortcut menu. The software version details of the corresponding package are
displayed, see Figure 2-5. View the version numbers of the boards software in the
package.

2-4
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Chapter 2 BS Version Upgrade

Figure 2-5 Package Details

End of Steps

2.4 Creating an Upgrade Task

This procedure describes how to create an upgrade task.

Steps
1. On the Software Version Management screen, expand the Software Version
Management navigation tree in the left pane.
2. Select the Upgrade Task Management node. The Upgrade Task Management
screen is displayed, see Figure 2-6.
Figure 2-6 Upgrade Task Management Screen

3. Click the
(Create Upgrade Task) icon on the toolbar. The Create Upgrade Task
dialog box is displayed, see Figure 2-7.
2-5
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

ZXSDR OMMB Version Management Operation Guide

Figure 2-7 Create Upgrade Task Dialog Box

4. Enter a name in the Task name text box. The task name is set to the current time by
default, for example, 2012-06-27 11:26:27.
5. In the Select NE area, select the NE that requires version upgrade.

l
l

Note:
The system automatically filters version packages inconsistent with the selected
NE mode.
If multiple NEs are selected, import NE status information through an Excel
file. For the operation descriptions, refer to 3.4 Exporting/Importing NE Status
Information.

6. In the Select version package area, select a version package for upgrade.

Note:
Click the Add Version Package button to add version packages to the OMMB server.

2-6
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Chapter 2 BS Version Upgrade

7. In the Select operation box, select upgrade operations as required. For the parameter
descriptions, refer to Table 2-2.
Table 2-2 Parameter Descriptions for Version Upgrade Operations
Parameter

Description

Download

Downloads the version software from the selected

version package to the corresponding NE.

Pre-Activation

Sets the selected version package as the package to be

loaded in next NE startup
After the version package is pre-activated and the NE is
reset, the NE does not run the pre-activated version until
the Activation effective operation is performed.
The Pre-Activation operation helps users check
activated versions before performing the Activation
effective operation.

Activation effective

The version package is changed from activated status to

running status.

Query version

Queries the package version running on the NE.

Download current data

Generates a configuration data file in accordance with

the current OMMB configuration data, and downloads
the file to the NE.

Download off-line data

Obtains the configuration data file saved under the

default path, and downloads the file to the NE.
This operation is used for rollback if a fault occurs during
NE upgrade from a single-mode version to a multi-mode
version.
For example, the NE configuration data file with subnet
ID 101 and nodeB ID 10 is saved in the following default
path on the OMMB server: OMMB installation
path\ums\ums-svr\map\subnet101\nodeb\node
b10\zdb\ActiveData.tar.gz

Check compatibility

Checks whether the version packages and pre-activated

version packages on the NE are compatible.

Do not check compatibility

Does not check whether the version packages

and pre-activated version packages on the NE are
compatible.

2-7
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

ZXSDR OMMB Version Management Operation Guide

Note:
The Download current data, Download off-line data, Check compatibility, and
Do not check compatibility operations are available only when the Pre-Activation
operation is selected.

8. Click OK to create the upgrade task.

The successfully created upgrade task is displayed in Task List, and the upgrade
process is displayed in the Process column in real time.
To easily view the upgrade task information in future, click the
toolbar to save the file in HTML or Excel format.

(Save) icon on the

9. (Optional) Re-perform the upgrade tasks for the failed NEs.

Right-click a failed upgrade task in Task List, and select Redo Failed NE from the
shortcut menu. The system performs the upgrade task only for the failed NE.
10. (Optional) Create an active package task.
Right-click a successfully downloaded task in Task List, and select Create Active
Package Task from the shortcut menu. The Create Active Package Task dialog box
is displayed. In the Select NE area, the system automatically selects the NE nodes
of the task displayed in Task List. You can perform the Pre-Activation, Activation
effective, or Query version operation.
11. (Optional) Redo a task.
Right-click a task in Task List, and select Redo from the shortcut menu. The system
re-performs the operation for the task.
End of Steps

2-8
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Chapter 3

Common Operations
Table of Contents
Querying NE Version Packages .................................................................................3-1
Creating a Deactivation Task ......................................................................................3-2
Creating a Package Deletion Task..............................................................................3-4
Exporting/Importing NE Status Information .................................................................3-5

3.1 Querying NE Version Packages

This procedure describes how to query the details of the version packages running on the
NE boards, and how to check the difference between the packages running on the NEs
and the target packages. This operation helps you check the version packages before
performing the Activation effective operation.

Steps
1. On the Software Version Management screen, expand the Software Version
Management navigation tree in the left pane.
2. Select the Query Task Management node, and click the
(Create Query Version
Package Task) icon on the right toolbar. The Create Query Version Package Task
dialog box is displayed, see Figure 3-1.

3-1
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

ZXSDR OMMB Version Management Operation Guide

Figure 3-1 Create Query Version Package Task Dialog Box

3. Enter a name in the Task name text box. The task name is set to the current time by
default.
4. In the Select NE area, select the NE that requires version query.

Note:
If multiple NEs are selected, import NE status information through an Excel file. For
the operation descriptions, refer to 3.4 Exporting/Importing NE Status Information.

5. (Optional) To check the version packages on the NE, select the Check version
package check box in the Select version package area, and select the target
packages in the version package list.
6. Click OK to create the query task.
The successfully created query task is displayed in Task List, and the query process is
displayed in the Process column in real time. The task execution results are displayed
on the Package Query Result, Package Status, and Board Running Version tabs.
End of Steps

3.2 Creating a Deactivation Task

This procedure describes how to create a deactivation task to deactivate the pre-activated
version packages on the NEs. If the pre-activated packages are faulty, you must change
3-2
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Chapter 3 Common Operations

the packages from pre-activated to deactivated through this operation, and then delete the
packages.

Prerequisite
The version package is downloaded and pre-activated.

Steps
1. On the Software Version Management screen, expand the Software Version
Management navigation tree in the left pane.
2. Select the Special Task Management node, and click the
(Create Deactivate
Task) icon on the right toolbar. The Create Deactivate Task dialog box is displayed,
see Figure 3-2.
Figure 3-2 Create Deactivate Task Dialog Box

3. Enter a name in the Task name text box. The task name is set to the current time by
default, for example, 2012-06-29 09:36:45.
4. In the Select NE area, select the NE that requires the version packages to be
deactivated.

Note:
If multiple NEs are selected, import NE status information through an Excel file. For
the operation descriptions, refer to 3.4 Exporting/Importing NE Status Information.

3-3
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

ZXSDR OMMB Version Management Operation Guide

5. In the Select version package area, select the version packages to be deactivated.
6. Click OK to create the deactivation task.
The successfully created deactivation task is displayed in Task List, and the
deactivation process is displayed in the Process column in real time. The task
execution results are displayed in the Result Information list.
End of Steps

3.3 Creating a Package Deletion Task

This procedure describes how to delete the deactivated version packages from the NEs.

Prerequisite
The version packages are deactivated.

Steps
1. On the Software Version Management screen, expand the Software Version
Management navigation tree in the left pane.
2. Select the Special Task Management node, and click the
(Create Delete
Package Task) icon on the right toolbar. The Create Delete Package Task dialog
box is displayed, see Figure 3-3.
Figure 3-3 Create Delete Package Task Dialog Box

3. Enter a name in the Task name text box. The task name is set to the current time by
default.
4. In the Select NE area, select the NE that requires the version packages to be deleted.
3-4
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Chapter 3 Common Operations

Note:
If multiple NEs are selected, import NE status information through an Excel file. For
the operation descriptions, refer to 3.4 Exporting/Importing NE Status Information.

5. In the Select version package area, select the version packages to be deleted.
6. Click OK to create the package deletion task.
The successfully created package deletion task is displayed in Task List, and the
deletion process is displayed in the Process column in real time. The task execution
results are displayed in the Result Information list.
End of Steps

3.4 Exporting/Importing NE Status Information

This procedure describes how to export and import NE status information for upgrade task
management. If multiple NEs are selected, you can export the NE status information to
an Excel file to upgrade or query versions in batches. The NE status information can be
edited and saved in the Excel file. If required, you can import the Excel file to the OMMB.

Steps
1. On the Software Version Management screen, expand the Software Version
Management navigation tree in the left pane.
2. Select the Upgrade Task Management node, and click the (Create Upgrade Task)
icon on the right toolbar. The Create Upgrade Task dialog box is displayed.
3. In the Select NE area, click the Export button to export the NE list and NE status
information to an Excel file.
4. Open the exported Excel file, and modify the corresponding value in the Y/N column
of the NE. If the value in the Y/N column is Y, the corresponding NE node is selected
in the Select NE area after the Excel file is imported to the system. For the Excel file,
see Figure 3-4.
Figure 3-4 Exported Excel File

3-5
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

ZXSDR OMMB Version Management Operation Guide

Note:
l
l

The NE sequences in the Excel file can be modified, which does not affect the
imported NE status results.
The NE nodes manually added to the Excel file cannot be imported.

5. In the Select NE area, click the Import button to import the NE list and NE status
information. The NE selection status is upgraded in the Select NE area in accordance
with the imported Excel file.
End of Steps

3-6
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Figures
Figure 1-1 Software Version Management Screen .................................................... 1-1
Figure 2-1 Package Status Conversion ..................................................................... 2-1
Figure 2-2 Add Version Package Dialog Box............................................................. 2-2
Figure 2-3 Version Package List ............................................................................... 2-3
Figure 2-4 View details Dialog Box............................................................................ 2-3
Figure 2-5 Package Details....................................................................................... 2-5
Figure 2-6 Upgrade Task Management Screen ......................................................... 2-5
Figure 2-7 Create Upgrade Task Dialog Box ............................................................. 2-6
Figure 3-1 Create Query Version Package Task Dialog Box...................................... 3-2
Figure 3-2 Create Deactivate Task Dialog Box .......................................................... 3-3
Figure 3-3 Create Delete Package Task Dialog Box.................................................. 3-4
Figure 3-4 Exported Excel File .................................................................................. 3-5

I
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Figures

This page intentionally left blank.

II
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential

Glossary
BBU
- BaseBand Unit
CDMA
- Code Division Multiple Access
GSM
- Global System for Mobile Communications
NE
- Network Element
OMMB
- Operation and Maintenance Module for BTS, NodeB and eNodeB
RRU
- Remote Radio Unit
UMTS
- Universal Mobile Telecommunication System
WiMAX
- Worldwide Interoperability for Microwave Access

III
SJ-20120711145812-005|2012-08-30 (R1.0)

ZTE Proprietary and Confidential