Loopstar Software Download, Backup and Restore Toolkit User Guide

LoopStar® Software Download, Backup
and Restore Toolkit User Guide
LoopStar 800
LoopStar 810
LoopStar 1600
Document Number: LPS-UM-TKTL1-01

REVISION HISTORY
The Revision History provides a summary of any changes in this manual. Please make sure you are using the latest revision
of this manual.
September 15, 2005
Revision Release Date Revisions Made

01 February 9, 2007 Initial release.
This manual is available online at ADC’s website (www.adc.com/documentationlibrary/) or you can order copies of the
manual by contacting your sales representative. Please ask for document LPS-UM-TKTL1-01.
Copyright
©2007 ADC Telecommunications, Inc. All rights reserved.
Trademark Information
ADC and LoopStar are registered trademarks of ADC Telecommunications, Inc. No right, license, or interest to such trademarks is
granted hereunder, and you agree that no such right, license, or interest shall be asserted by you with respect to such trademark.
Other product names mentioned in this practice are used for identification purposes only and may be trademarks or registered
trademarks of their respective companies.
Disclaimer of Liability
Information contained in this document is company private to ADC Telecommunications, Inc., and shall not be modified, used, copied,
reproduced or disclosed in whole or in part without the written consent of ADC.
Contents herein are current as of the date of publication. ADC reserves the right to change the contents without prior notice. In no event
shall ADC be liable for any damages resulting from loss of data, loss of use, or loss of profits, and ADC further disclaims any and all
liability for indirect, incidental, special, consequential or other similar damages. This disclaimer of liability applies to all products,
publications and services during and after the warranty period.
LoopStar Software Download,
Backup and Restore Toolkit User Guide About This Manual
About This Manual
Purpose
This document provides guides for getting the reference information of LoopStar
Toolkit installation and operation.
Related Versions
This document is related to EMS V200R002C01.
Intended Audience
This document is for the reader who wants to know the characteristics and product
specifications of the Toolkit in general.
Organization
This document is organized as follows:
Chapter Description
Chapter 1 System Profiles the Toolkit’s functionality.
Description
Chapter 2 Installation Introduces the installation of the Toolkit.
Chapter 3 Operation Introduces the operations of the Toolkit.
Chapter 4 SONET NEs Introduces the process of the SONET NEs upgrading using
Upgrade Instruction the Toolkit.
Appendix A Glossary Lists the glossary used in the guide.
Appendix B Acronyms Lists the acronyms and abbreviations used in the guide.
and Abbreviations
ADC Proprietary
i
Related Documents
Document Usage
LoopStar Toolkit User Introduces the Toolkit‘s functionality and operations.
Guide for TL1
Conventions
The document uses the following conventions.
Symbol Conventions
Symbol Description
A caution notice with this symbol indicates a risk to equipment
Caution damage or loss of data.
Note: A note notice with this symbol indicates additional, helpful,

non-critical information.
GUI Conventions
Convention Description
<> Button name are inside angle brackets. For example, click the
<OK> button
[] Window names, menu items, data table and field names are inside
square brackets. For example, the [New User] window is displayed.
/ Multi-level menus are separated by forward slashes. For example,

[File/Create/Folder].
Keyboard Operation
Format Description
<Key> Press the key with the key name inside angle brackets. For
example, <Enter>, <Tab>, <Backspace>, or <A>.
<Key1 + Key2> Press the keys concurrently. For example, <Ctrl + Alt + A> means
the three keys should be pressed concurrently.
<Key1, Key2> Press the keys in turn. For example, <Alt, A> means the two keys
should be pressed in turn.
ADC Proprietary
ii
Mouse Operation
Action Description
Select Press and hold the primary mouse button (left mouse button by
default).
Click Select and release the primary mouse button without moving the
pointer.
Double-click Press the primary mouse button twice continuously and quickly
without moving the pointer.
Drag Press and hold the primary mouse button and move the pointer to
a certain position.
Version Control
The documentation version is displayed as:
T2 - 04XXXX - yyyymmdd - C - 1.10
Doc. version
Confidentiality level
Publishing date
Internal code
Code for transmission
English version
If the version is updated, then the last Doc. version 1.10 will be changed to 1.11, and
the Publishing date will be updated.
ADC Proprietary
iii
ADC Proprietary
iv
Backup and Restore Toolkit User Guide Contents
Contents
1 System Description 1-1
1.1 Overview 1-1

1.2 Functionality 1-1
1.3 Features 1-3
1.4 Networking and Communication 1-3
1.4.1 Introduction to ECC Networking 1-3
1.4.2 Introduction to IP Networking 1-4
1.4.3 Introduction to OSI Networking 1-4
1.5 Terminology 1-5
2 Installation 2-1
2.1 Running Independently 2-1

2.2 Precautions 2-2
3 Operation 3-1
3.1 Operation Basis 3-2

3.1.1 Interface Description 3-2
3.1.2 Icon Description 3-3
3.1.3 Selecting an Operation Object 3-3
3.1.4 Setting FTP Parameters 3-4
3.2 Managing Operation Objects 3-6
3.2.1 Adding NEs 3-6
3.2.2 Querying NE Information 3-10
3.2.3 Deleting NEs 3-11
3.3 Managing NE Login 3-12
ADC Proprietary
i
3.3.1 Logging In to an NE 3-12

3.3.2 Logging Out of an NE 3-13
3.3.3 Setting an NE Login User 3-13
3.4 Backing Up/Restoring NE Data 3-15
3.4.1 Backing Up Database Package 3-15
3.4.2 Restoring Database Package 3-18
3.5 Loading Software Package 3-22
3.6 Viewing Log Function 3-28
3.7 TL1 Command Line 3-30
3.7.1 Interface 3-30
3.7.2 Message Dump 3-30
3.7.3 Message Font and Color Settings 3-31
3.7.4 The Shortcut Menu in the Message Pane 3-31
3.7.5 The Shortcut Menu in the Command Pane 3-32
3.7.6 Notes and Cautions 3-34
3.7.7 Command Description 3-34
3.7.8 Inputting TL1 Commands 3-36
4 SONET NEs Upgrade Instruction 4-1
4.1 Interface 4-1

4.2 Notes and Cautions 4-3
4.3 Self-Check Before Upgrade 4-4
4.4 Loading Software Package 4-5
4.5 Verifying the Upgrade of Software Package 4-7
ADC Proprietary
ii
Backup and Restore Toolkit User Guide Figures
Figures
Figure 1-1 Networking diagram through ECC protocol 1-3

Figure 1-2 Networking diagram through IP protocol 1-4
Figure 1-3 Networking diagram through the OSI protocol 1-4
Figure 3-1 Interface 3-2
Figure 3-2 The Operation List for database package backup 3-16
Figure 3-3 Changes of the NE state during database package backup 3-17
Figure 3-4 The Operation List for database package restoration 3-20
Figure 3-5 Changes of the NE state during database package restoration 3-21
Figure 3-6 The Operation List for software package loading 3-25
Figure 3-7 Changes of the NE state during software package loading 3-26
Figure 3-8 The TL1 Command Client window 3-30
Figure 3-9 The shortcut menu in the message pane 3-32
Figure 3-10 The shortcut menu in the command pane 3-33
Figure 4-1 TL1 Command Client 4-2
Figure 4-2 Load Software Package 4-3
ADC Proprietary
iii
Backup and Restore Toolkit User Guide Tables
Tables
Table 3-1 The Toolkit shortcut icons and legends 3-3

Table 3-2 Description of the parameters in the "Add NE" dialog box 3-9
Table 3-3 Description of parameters in the Operation List for database package backup 3-16
Table 3-4 Description of parameters in the Operation List for database package restoration 3-20
Table 3-5 Description of parameters in the Operation List for software package loading 3-25
Table 3-6 Description of shortcut menu items in the message pane 3-32
Table 3-7 Description of shortcut menu items in the command pane 3-33
ADC Proprietary
iv
Backup and Restore Toolkit User Guide 1 System Description
1 System Description
This chapter introduces the functionality and features of the LoopStar Toolkit (Toolkit
for short). The following topics are covered:
Overview
Functionality
Features
Networking and Communication
Terminology
1.1 Overview
The Toolkit is a graphical management tool used to configure data, NE software and
board software for ADC's optical network products. You can use it instead of the
LoopStar Navigator to upgrade/degrade NE software and board software, and back
up/restore NE data (see the Degrade Guide of the relevant equipment for specific
degrade operation).
The Toolkit can be used in UNIX and Windows. The Toolkit can run independently or
integrated in the LoopStar EMS.
1.2 Functionality
The Toolkit can load software and back up/restore configuration data for equipment. It
has the following functions:
1. Object Management
Adding NEs
Deleting NEs
ADC Proprietary
1-1
Querying NE information
Sorting by NE name
2. Login Management
Logging in to NEs
Logging out NEs
Setting login users
3. Backing Up/Restoring NE Data
Starting/Rolling back backing up of database package

Starting/ Rolling back restoring of database package
Activating database package
Selecting database file to back up/restore
Querying and displaying the loading status of database
4. Loading Software Package
Querying loading attributes

Starting/Rolling back loading of software package
Activating software package
Displaying the loading status of software package
Displaying the software package version
5. Viewing log function
Querying log
Browsing log
Saving log
6. TL1 Command Line
Adding NE command line operation Tab pages

Running/Pausing/Stopping scripts
Issuing TL1 command
Executing "runfile" script file
Displaying the results of executing the command script
Displaying automatic report messages of the NEs
Displaying standard output messages
ADC Proprietary
1-2
Setting variables
Setting timeout for commands
Querying timeout for commands
Saving messages and command scripts
Setting the color of message display
1.3 Features
It supports UNIX and Windows.
It can run independently or be integrated in the LoopStar EMS.
It provides graphical interfaces to enable simple operation.
1.4 Networking and Communication

Generally, three ways of networking exist between Toolkit and equipment: ECC
networking, IP networking and OSI networking.
1.4.1 Introduction to ECC Networking
The communication between NEs is realized through the way of ECC communication,
and the communication between NE and Toolkit uses the TCP/IP protocol. At least
one NE is connected to Toolkit through a network cable. The NE connected with the
network cable is called gateway NE (GNE). Toolkit sends IP message packets to the
GNE, which extracts the content of the message and sends it to the target NE through
the ECC protocol.
Toolkit
IP
GNE 1
1
ECC ECC
ECC ECC
NE2 ECC ECC NE4 NE5 NE6
NE3
Figure 1-1 Networking diagram through ECC protocol
ADC Proprietary
1-3
1.4.2 Introduction to IP Networking
If the equipment supports IP over DCC, the communication between NEs or between
NE and Toolkit uses the TCP/IP protocol, and the whole network is an IP network. The
Toolkit can set up TCP connection with any NE on the network.
Toolkit
IP
NE1
1
IP over IP over
DCC DCC
IP over DCC
NE2 NE4 NE5 NE6
NE3
Figure 1-2 Networking diagram through IP protocol
1.4.3 Introduction to OSI Networking
For the OSI networking, the communication between NEs or between NE and Toolkit
uses the OSI protocol. Toolkit can set up direct TP4 connection with any NE on the
network.
Toolkit
TP4
NE1
1
TP4 TP4 TP4 TP4
NE2 TP4 TP4 NE4 NE5 NE6
NE3
Figure 1-3 Networking diagram through the OSI protocol
ADC Proprietary
1-4
1.5 Terminology
Gateway NE (GNE) and non-gateway NE: The NE that serves as a service agent
for other NEs and has direct transmission connection of the transport layer with the
Toolkit is called a GNE. Other NEs that communicate with the Toolkit through the
GNE are called non-gateway NEs.
Load: The process of copying software to an NE and running the software,
including two sub-processes: copying and activating.
Software package: A file package that defines all the NE software and board
software on NE through a file list. Toolkit can load the defined software within the
package into an NE at one time by loading the software package.
Database package: A file package that defines all kinds of database files on NE
through a file list. Toolkit can implement several database files at one time by
backing up or restoring the database package.
FTP: The standard file transfer protocol in the TCP/IP protocol. In IP networking (for
IP networking, see 1.4.2 ""),
In “Introduction to Networking”, you can load a software package and back up or
restore a database package through FTP.
HFCP: ADC File Copy Protocol. ADC's customized file transfer protocol. In ECC
networking, IP networking and TP4 networking (for details of networking, see
section 1.4 "Networking and Communication"), you can load a software package
and back up or restore a database package through HFCP.
ADC Proprietary
1-5
ADC Proprietary
1-6
Backup and Restore Toolkit User Guide 2 Installation
2 Installation
This chapter describes how to install the Toolkit for:

Running Independently
Precautions
2.1 Running Independently

To run the Toolkit independently, follow the procedure below to install it, and there is no
need for the database and the EMS software.
In Windows, copy the Toolkit folder to the hard disk and double-click \Toolkit\Toolkit.bat
to run the Toolkit.
In UNIX, copy the Toolkit to the computer, decompress it and then decompress the
package. Enter the command lines interface, run toolkit.bat in the directory to start the
Toolkit.
On the UNIX system, make sure to start the Toolkit in the command lines interface. If
the toolkit.bat is clicked directly to run the Toolkit, the command lines window will be
left open after the Toolkit exits.
Note:
The decompression command under UNIX: gunzip + file name.
The package decompression command under UNIX: tar – xvf + file name.
ADC Proprietary
2-1
Backup and Restore Toolkit User Guide 2 Installation
2.2 Precautions
The Toolkit can run on Windows2000 Professional and Windows XP Professional.
For the Windows operation system, it is recommended that you install an antivirus
software program and update it in time. The Norton AntiVirus enterprise version is
recommended.
When the Toolkit is running on the UNIX, ensure the user has the authority of
reading, writing and administering to the Toolkit installation directory, the
subdirectory and the files in them.
When integrated in the EMS, the Toolkit can only run on EMS clients.
ADC Proprietary
2-2
Backup and Restore Toolkit User Guide 3 Operation
3 Operation
This chapter introduces the operations of the Toolkit. The following topics are covered:
Operation Basis
Managing Operation Objects
Managing NE Login
Backing Up/Restoring NE Data
Loading Software Package
Viewing Log Function
Testing LED Indicators
TL1 Command Line
ADC Proprietary
3-1
3.1 Operation Basis

3.1.1 Interface Description
Choose a function from the Main Menu and click it to access the related function
interface. The interface includes an Object Tree, where you can choose an object to
manage.
1. Interface
Figure 3-1 Interface
ADC Proprietary
3-2
3.1.2 Icon Description
Figure 3-1 lists the Toolkit shortcut icons and legends.

Table 3-1 The Toolkit shortcut icons and legends
Category Icon Name Description
Shortcut Exit Exits the current terminal.
Icon
Create NE Adds an NE.
TL1 Terminal Enters the "TL1 Command Line" interface.
Load Software Enters the "Load Software Package" interface.

Package
Backup/Restore Enters the "Back up/Restore Database

Database Package" interface.
Package
Browse Log Enters the "Browse Log" interface.
FTP Setting Opens the "FTP Properties Settings" dialog

box.
Topics Opens the Toolkit help Files.
Legend Available The NE is logged in. The function is available.
Not logged in The NE is not logged in. The function is not

available.
Not supported The NE is logged in. The function is not

available.
3.1.3 Selecting an Operation Object
1. Background
An object (an NE) must be selected in the Object Tree before this object can be
queried and managed.
The following is an operation example of "Loading Software Package".
2. Prerequisite
The user must log in to the related NE in the Toolkit.
3. Procedure
Follow the steps below to select an operation object.
ADC Proprietary
3-3
Step Action
1 Select [Load Software/Load Software Package] from the Main Menu, and the
NEs that have been added into the Object Tree are displayed.
2 Click before an operation object to unfold its sub-level objects.
3 Click the check box to select or deselect an object. The check box changes to
if an object is selected.
4 Click to transfer selected objects to the right-hand operation interface, and

then you can perform operations on those objects, such as querying information
and loading software package.
3.1.4 Setting FTP Parameters
1. Background
In the Toolkit, uploading and downloading are frequently performed for software and
data packets. Either of the two transmission protocols (FTP and HFCP) is usually
used, depending on whether it is supported by the NE. At present, the FTP protocol is
more frequently used because of its fast transmission speed, but the HFCP protocol is
more widely used.
The Toolkit has its own FTP Server. The FTP Server is not started by default when the
Toolkit is first started. Set FTP parameters, and after the operation succeeds, the
Toolkit automatically starts the FTP Server.
The FTP Server status is displayed to the right of the shortcut buttons.
means the FTP Server is started, and
means the FTP Server is stopped.
ADC Proprietary
3-4
2. Prerequisite
If you reset FTP parameters successfully, the FTP Server is restarted. So before
setting parameters, make sure no operation like uploading, downloading, backing up
and restoring is occurring, which involves the FTP transmission.
3. Procedure
Follow the steps below to set FTP parameters.

Step Action
1 Select [Tools/FTP Setting] from the Main Menu, and the "FTP Properties
Settings" dialog box is displayed.
2 The following are default values, which can be modified. After the settings, click
<Start Up>.
When the "FTP Properties Setting" dialog box is opened for the first time, both
the password and the root directory are default to be empty.
ADC Proprietary
3-5
Step Action
3 A prompt dialog box is displayed. Click <Yes>.
4 Click <OK> when the following prompt is displayed.
3.2 Managing Operation Objects

In the Toolkit, except the Viewing Log Function interface, all the other interfaces
contain an Object Tree that displays the NE list, and provide the refresh button. After
adding or deleting NEs or boards in other interfaces, click to refresh the NE list.
3.2.1 Adding NEs
1. Background
You can implement corresponding operations on an NE only if the NE is added in the

Toolkit interface. After an NE is created, its attributes cannot be modified except the
login user.
ADC Proprietary
3-6
When adding an NE, make sure its ID and name differ from the existing NEs in the
interface. Otherwise, the operation will fail. When the Toolkit is integrated in the EMS,
the Toollkit can get NEs automatically from the EMS, so no NEs need to be added
manually. When adding an NE that cannot communicate with the Toolkit client, the
system prompts a connection failure.
2. Prerequisites
The NE communicates with the Toolkit client correctly.

The NE ID, NE name, gateway address, port, username and password of the NE
are provided.
3. Procedure
Follow the steps below to add an NE.

Step Action
1 Select any function from the Main Menu. The NEs that have been added in the
Object Tree are displayed.
2 Right-click "root" in the Object Tree and select [Add NE].
ADC Proprietary
3-7
Step Action
3 The "Add NE" dialog box is displayed. Enter the information of the NE and NE
user, and click <OK>. The system automatically logs in to the NE and the NE
icon turns green.
The following is the example of the "Add NE" dialog box for SONET NE that
uses ECC networking or IP networking.
Note:
The Gateway Address is the address of the gateway NE connected with the Toolkit.
ADC Proprietary
3-8
4. Parameter Description
The following table describes the parameters in the "Add NE" dialog box.
Table 3-2 Description of the parameters in the "Add NE" dialog box
Parameter Description
NE ID Identifies the NE with a unique number.
For a SONET NE, there is no NE ID, so no NE ID

information is displayed in the Toolkit.
NE Name/NE TID Identifies the NE with a character string.
For a SONET NE, this field is "NE TID". The value must
be the actual NE TID.
Gateway Type Refers to the communication type of the gateway NE in

use.
It can be "IP Gateway" or "OSI Gateway".
Gateway ECC Input the IP address of the GNE.

Address/NSAP Gateway
Address In ECC networking, an NE that connects to network
cables is called a GNE.
IP It is recommended to directly input the IP address of the

Gateway target NE.
OSI Input the NSAP address of the target NE.

Gateway
Port/TSAP Refers to the port used to set up connections.
Usually there is no need to modify this value. In OSI

networking, this field is replaced with "TSAP".
User Name Refers to the user name used to log in to an NE.
Password Refers to the password used to log in to an NE.
Caution:
If NE ID (NE TID for SONET) and Gateway Address are modified by a different tool,
such NE must be deleted and then re-created in the Toolkit before it can be managed
by the Toolkit.
ADC Proprietary
3-9
3.2.2 Querying NE Information
1. Background
For those NEs that have been added in the Toolkit, you can query their information
through NE Properties, such as NE ID, NE type and NE name.
2. Prerequisite
The NE to be queried must created in the Toolkit.
3. Procedure
Follow the steps below to query NE information.

Step Action
2 Right-click an NE in the list, and select [NE Properties] from the shortcut menu.
3 The "NE Properties" dialog box is displayed.
ADC Proprietary
3-10
3.2.3 Deleting NEs
1. Background
To avoid the situation that the NE list shows too many NEs, use this procedure to
delete the NEs needing no operation.
Note:
When the Toolkit is loading the data or software of an NE, the NE cannot be deleted.
2. Prerequisite
None.
3. Procedure
Follow the steps below to delete an NE.

Step Action
2 Right-click an NE in the Object Tree and select [Delete NE].
3 A prompt box is displayed. Click <OK>, and the NE is deleted.
ADC Proprietary
3-11
3.3 Managing NE Login

3.3.1 Logging In to an NE
1. Background
You can manage an NE only when you have logged in to it. The NE icons of the
logged-in NEs are shown in green, and the others are in gray.
2. Prerequisites
The NE communicates with the Toolkit client correctly.

The NE must be created in the Toolkit.
3. Procedure
Follow the steps below to manage NE login.

Step Action
2 Right-click an NE and select [Login NE]. If the NE is logged in successfully, the

NE icon is shown green. Otherwise, it is shown gray.
ADC Proprietary
3-12
3.3.2 Logging Out of an NE
1. Background
Use this procedure to log out of an NE needing no operation. When the Toolkit is
operating the configuration data or software of an NE, the NE cannot be logged out.
The NE is logged out automatically when the Toolkit exits.
Note:
Please log out of the NEs needing no operation in time.
2. Prerequisite
The NE is logged in.
3. Procedure
Follow the steps below to log out of an NE.

Step Action
1 Right-click the logged-in NE and select [Logout]. The NE icon turns gray, which
shows the Toolkit has logged out of the NE.
3.3.3 Setting an NE Login User
1. Background
After an NE is created in the Toolkit, the Toolkit automatically uses the NE user chosen
during the NE creation to log in to the NE. To use other users to log in to the NE, use
this procedure to set an NE login user. If an NE login user is set, it is the default user
for future login.
ADC Proprietary
3-13
When the Toolkit is operating the configuration data or software of an NE, the login
user of the NE cannot be modified.
2. Prerequisite
The NE user is created on the NE.
3. Procedure
Follow the steps below to set an NE login user.

Step Action
2 Right-click an NE and select [Set Login User].
3 The "Set Login User" dialog box is displayed. Enter the new user and password,
and click <OK>.
4 A dialog box is displayed, prompting the operation is successful.
ADC Proprietary
3-14
3.4 Backing Up/Restoring NE Data

3.4.1 Backing Up Database Package
1. Background
This function backs up all NE data to the computer, so that such data can be restored
in case of accidental data loss.
2. Prerequisites
The NE must be created in the Toolkit.

The computer where the Toolkit is installed can communicate with the NE normally.
If the FTP protocol is applied, the FTP server must be started. If the FTP server
owned by the Toolkit is used, the status is displayed in the toolbar.
3. Procedure
Follow the steps below to back up database package.

Step Action
1
Choose [Backup/Restore/Backup/Restore Database Package] or click the
icon on the toolbar to access the "Backup/Restore Database Package"
interface.
2 In the left-hand Object Tree, add NEs to which the function applies. For detailed
operations, see 3.3 "Managing NE Login".
3 Select a logged-in NE and click to transfer it to the right-hand Operation

List. You can select more than one NE at the same time.
4 Select an NE in the Operation List, and select [Backup] from the

[Backup/Restore] drop-down menu.
5 Select [FTP] or [HFCP] from the [Protocol] drop-down list.
ADC Proprietary
3-15
Step Action
6 Click the … button behind "File" field.
If the FTP protocol is selected, the FTP dialog box is displayed. Choose a
directory on FTP Server as the backup directory. For FTP settings, refer to 3.1.4
"Setting FTP Parameters".
If the HFCP protocol is selected, the "Open File" dialog box is displayed.
Choose a directory as the backup directory.
7 Click the <Start> button to start the backup. During the process, you can
execute "rollback" operation.
Note:
When backup begins, the NE changes to the copying state, and Step 4 through 8
cannot be performed. The progress bar displays the backup progress, and the
progress bar in the operation results list follows.
8 A message is displayed in the operation results list saying backing succeeded.
Before backing up database package, the user must confirm the following information:
Figure 3-2 The Operation List for database package backup
The following table describes the parameters in the Operation List.

Table 3-3 Description of parameters in the Operation List for database package backup
State Refers to the NE state during database package backup.
This is a read-only parameter.
Process(%) Displays the progress of database package backup. The value

range is 0– 100.
Protocol Sets the protocol (FTP or HFCP) to be applied for database

package backup.
Before backup, this parameter must be set by the user. During

backup, it becomes a read-only parameter.
ADC Proprietary
3-16
Backup/Restore Sets the operation to "Backup" or "Restore".
Before the operation, this parameter must be set by the user.

During the operation, it becomes a read-only parameter.
File Specifies the directory to store the backed up database package.
Before backup, this parameter must be entered by the user.

During backup, it becomes a read-only parameter.
During database package backup, the NE state changes as the following figure shows.
Normal
State
Click
Rollback <Start> Backup
succeeds succeeds
Copying
State
Click Exception
<Rollback> Click occurs
<Start>
Rollback Halt
State Click <Rollback> or State
the Halt State times out
Figure 3-3 Changes of the NE state during database package backup
When the NE is in the normal state, the user clicks <Start>, and the NE changes to the
copying state. When copying succeeds, the NE changes back to the normal state.
The backup process is then finished.
If any exception occurs during copying (for example, an interruption of communication
between the FTP Server and the NE), the NE changes to the halt state. At this time,
the user can click <Start> to restart the backup, or click <Rollback> so that the NE
finally changes back to the normal state.
If the halt state lasts for some time, the NE changes to the rollback state automatically,
and finally returns to the normal state.
When the NE is in the copying state, the user can click <Rollback> to interrupt the
backup. Then the NE changes to the rollback state, and finally returns to the normal
state.
ADC Proprietary
3-17
3.4.2 Restoring Database Package
1. Background
This function restores database files from the computer to the NE.
The restoration process includes copying and activating. Copying supports rollback.
2. Prerequisites
The NE for login must be created in the Toolkit.

The computer where the Toolkit is installed can communicate with the NE correctly.
The database package to be restored is prepared. Only the data backed up from
the specified NE can be restored to the NE.
3. Procedure
Follow the steps below to restore database package.

Step Action
1
Choose [Backup/Restore/Backup/Restore Database Package] or click the
icon on the toolbar to access the "Backup/Restore Database Package"
interface.
2 In the left-hand Object Tree, add NEs to which the function applies. For detailed
operations, see 3.3 "Managing NE Login".
3 Select a logged-in NE and click to transfer it to the right-hand Operation

List. Multiple NEs can be selected and transferred at the same time.
4 Select an NE in the Operation List, and select [Restore] from the

[Backup/Restore] drop-down list.
5 Select [FTP] or [HFCP] from the [Protocol] drop-down list.
ADC Proprietary
3-18
Step Action
6 Click the … button behind "File" field.
If the FTP protocol is selected, the FTP dialog box is displayed. Choose a file on
FTP Server to restore.
If the HFCP protocol is selected, the "Open File" dialog box is displayed.
Choose a file to restore.
7 Click the <Start> button to start restoration.
Note:
When restoration begins, the NE changes to the copying state, and Step 4 through
8 cannot be performed. The progress bar displays the backup progress, and the
progress bar in the operation results list follows.
8 A message saying restoration succeeded is displayed in the operation results

list.
Select the restored NE and click <Activate>. Then click <OK> when the
following prompt message is displayed.
Note:
The progress bar shows the activating progress in real time, and the progress bar
in the operation results list follows.
9 The NE returns to normal state after activation.
ADC Proprietary
3-19
Before restoring database package, the user must confirm the following information:
Figure 3-4 The Operation List for database package restoration

Table 3-4 Description of parameters in the Operation List for database package restoration
State Refers to the NE state during database package restoration.
Process(%) Displays the progress of database package restoration. The

value range is 0– 100.
Protocol Sets the protocol (FTP or HFCP) to be applied for database

package restoration.
Before restoration, this parameter must be set by the user. During

restoration, it becomes a read-only parameter.
Backup/Restore Sets the operation to "Backup" or "Restore".
Before the operation, this parameter must be set by the user.

During the operation, it becomes a read-only parameter.
File Specifies the file name of the backed up database package to be

restored to the NE.
Before restoration, this parameter must be entered by the user.

During restoration, it becomes a read-only parameter.
After the backed up database package is copied to the NE, the package must be
activated. During restoration, the NE state changes as the following figure shows.
ADC Proprietary
3-20
Click <Start>
Normal Copying
State Click <Start> State
Halt Copying
State fails
Rollback Click <Rollback> or the

succeeds Halt State times out
Activating Rollback Copying

succeeds State succeeds
Click
<Rollback>
Click <Rollback> or the state
of to be activated times out
Activating Unactivated
State Click State
<Activate>
Figure 3-5 Changes of the NE state during database package restoration
copying state. When copying is finished successfully, the NE changes to the
unactivated state. At this time, the user clicks <Activate>, and the NE changes to the
activating state. The activating operation will reset the NE, so the icon of the NE in the
Object Tree turns gray. When the NE is reset successfully, its icon returns to green,
and the NE changes back to the normal state. The restoration process is then
finished.
If any exception occurs during copying (for example, an interruption of communication
between the FTP Server and the NE), the NE changes to the halt state. At this time,
the user can click <Start> to restart the backup, or click <Rollback> so that the NE
returns to the normal state. If the halt state lasts for some time, the NE will change to
the rollback state automatically, and finally returns to the normal state.
If the NE is in the state of copying or unactivated, the user can click <Rollback>. Then
the NE changes to the rollback state, and finally returns to the normal state.
ADC Proprietary
3-21
3.5 Loading Software Package
1. Background
NE software and board software are integrated into a single software package, so that
they can be updated at the same time.
The protocol for loading can be FTP or HFCP. To load software package, the NE must
run on OSP5.00.06 or the higher version.
2. Prerequisites
The related NE must be created in the Toolkit.

This function only supports SONET equipment.
If the FTP protocol is applied, the FTP server must be started. If the FTP server
owned by the Toolkit is used, the status is displayed in the toolbar.
3. Procedure
Follow the steps below to load software package.

Step Action
1 Select [Load Software/Load Software Package] from the Main Menu, and those
NEs that have been added in the left-hand Object Tree are displayed.
2 Right-click an NE in the NE list and select [Login NE].
ADC Proprietary
3-22
Step Action
3
Click the check box before the NE and then click . Related information of
this NE is displayed in the Operation List. Several NEs can be selected at the
same time.
Note:
If the selected NEs contain NEs that are not logged in or do not support software
package loading, the system prompts that the NE is not logged in or does not
support the function.
4 Select this NE in the Operation List. Select [Yes] or [No] for "Auto-activate", and
select [FTP] or [HFCP] for "Load Protocol". If [FTP] is selected, the "FTP File
Settings" dialog box is displayed.
Note:
Auto-activate means the Toolkit issues the activate command to the NE
automatically after the memory copy is finished. The user does not need to click
<Activate>.
ADC Proprietary
3-23
Step Action
5
Click the button behind the "File" field to select a file.
(1) If the FTP protocol is applied, the "FTP File Settings" dialog box is displayed.
If the computers in use are with multiple network cards and IP addresses, the
FTP Server IP and the Local IP must be on the same network section. Otherwise
the possible abnormal connection may lead to the failure to get the file list.
Enter the correct port, username and password (See 3.1.4 "Setting FTP
Parameters" for details). Click <Browse> to select the software package to load
and then click <OK>.
(2) If the HFCP protocol is applied, the "Open File" dialog box is displayed.
Select the software package file to load. Then click <Open>.
6 Click the <Start> button to start loading the software package. The state
becomes "Copying Files" and then "Copying Memory".
When the state becomes "Unactivated", the copying is finished.
During the process, you can execute "Rollback" operation.
7 After loading succeeds, click <Activate> to activate the software package. A

dialog box is displayed, prompting the risk of activating. Click <Yes> to continue.
8 The user can click <Query> to query load attributes, status, software package
version and software integrity.
ADC Proprietary
3-24
Before loading software package, the user must confirm the following information:
Figure 3-6 The Operation List for software package loading

Table 3-5 Description of parameters in the Operation List for software package loading
State Refers to the NE state during software package loading.
Process(%) Displays the progress of software package loading. The value

range is from 0– 100.
Active Area Version Refers to the version of the software package that is running on
the NE.
Standby Area Refers to the version of the software package stored in the
Version standby area.
Software package is loaded to the standby area automatically.

After the package is activated, the standby area changes to the
active area, and the loaded software package runs.
All Software Displays whether all software is loaded.
Note:
All software means a complete set of software that supports all
boards. If all software is loaded at one time, the NE will find a board
software match automatically when a board is added.
If the value of "All Software" is negative, only software for existing
boards is loaded or no software package is loaded. In this case, the
NE will not be able to match board software automatically, and the
user will have to load related software package again.
ADC Proprietary
3-25
Auto Activate Determines whether to activate the NE automatically after
copying is finished.
Before loading, this parameter must be set by the user. During

loading, it becomes a read-only parameter.
Protocol Sets the protocol (FTP or HFCP) to be applied for software

package loading.
Before loading, this parameter must be set by the user. During

loading, it becomes a read-only parameter.
File Refers to the file name of the software package to be loaded.
Before loading, this parameter must be entered by the user.

During loading, it becomes a read-only parameter.
During software package loading, the NE state changes as the following figure shows.
Copying files
Click <Start>
Normal State Copying Files is finished Copying Memory
State State
Running Exception
stably occurs Click <Start>
Normal-unstable Copying to
Halt State memory is finished
State
Committing is
finished
Commit State Activating State Unactivated State

Submit Click
automatically <Activate>
Note: The rollback state is omitted in this figure. Rollback may take place when the NE is in the state
of halt, copying memory, unactivated or activating. After that, the NE changes to the rollback state
and then to the state of normal-unstable.
Figure 3-7 Changes of the NE state during software package loading
state of copying files, that is, copying selected files from a computer to the NE. When
copying files is finished successfully, the NE changes to the state of copying memory,
that is, copying files inside the NE. When copying memory is finished, the NE changes
to the unactivated state. The copying process is then finished.
ADC Proprietary
3-26
When the NE is in the unactivated state, the user can click <Activate> to activate the
NE. After that, the NE icon turns green and the NE changes to the commit state, that is,
copying software package from the standby area to the active area. When submitting
is finished, the NE changes to the state of normal-unstable. After the NE runs stably
for about five minutes (the duration may vary for different NE versions or types), the
NE returns to the normal state automatically. The software package loading process is
then finished.
If any exception occurs during the process of copying files (for example, an
interruption of communication between the NE and the FTP Server), the NE changes
to the halt state. At this time, the user can click <Start> to restart copying, or click
<Rollback> so that the NE changes to the state of normal-unstable and finally back to
the normal state. If the halt state lasts for some time, the NE changes to the rollback
state automatically, and then back to the state of normal-unstable.
If any exception occurs in the state of copying files, copying memory or unactivated,
the user can click <Rollback> so that the NE changes to the rollback state.
ADC Proprietary
3-27
3.6 Viewing Log Function
1. Background
With the Viewing Log function in the Toolkit, the user can record operations on the NE.
And those important events or operations can be queried and saved.
The time range to select for querying the log cannot exceed one year.
2. Prerequisite
The operation on the NE must be performed by the Toolkit.
3. Procedure
Follow the steps below to view log.

Step Action
1
Select [Tools/Browse Log] from the Main Menu or click the shortcut icon on
the toolbar to access the log function interface.
2 Select or enter an operation object, for example, ALL-NE.
Then select the time range, for example, form 2005-07-15 to 2005-09-15.
3 Click <Refresh> and the log information within the time range is displayed.
ADC Proprietary
3-28
Step Action
4 Double-click a record to display its detailed information, which is shown in the
following figure.
5 Click <Close> to close the "Browse Log" window.
6 Click <Save> in the main interface. A dialog box displays, Select a path to save
the log file. Then click <OK> and the log is successfully saved.
ADC Proprietary
3-29
3.7 TL1 Command Line

3.7.1 Interface
The following figure shows the TL1 Command Client window.
Figure 3-8 The TL1 Command Client window
The TL1 Command Client window mainly consists of three parts:

The Object Tree in the left pane
The message area in the upper right pane
The command line input area in the lower right pane
3.7.2 Message Dump
Messages cannot be edited, but the user can find, clear or save messages. If the
Toolkit runs for a long time, there will be a large quantity of messages. In the case that
messages be overwritten or lost, a dump function is needed to save messages in the
message area as file.
The Toolkit saves messages in the \client\tklog directory automatically. The file format
is:
tktl1+_(underscore) +NE name+_(underscore)+date(year, month and date)
ADC Proprietary
3-30
3.7.3 Message Font and Color Settings
The user can set the message font and color. The settings also apply to message
panes in all NE tabs.
For color settings, the user selects different colors for different types of message, so
that the message types can be distinguished. Presently there are the following types
of message:
Standard Output: The output contents customized by the user through the puts
command
Report Event: Messages reported by the NE automatically
Command Response: The result of commands
Request Command: Issued commands or scripts
1. Procedure
Step Action
1 Right-click in the message pane and select [Set Color] from the shortcut menu.
The following dialog box is displayed.
2 Right-click the color bar behind the message type and select a color in the
pop-up dialog box.
3.7.4 The Shortcut Menu in the Message Pane
The functionality in the message pane is realized through the shortcut menu. See the
following figure.
ADC Proprietary
3-31
Figure 3-9 The shortcut menu in the message pane
The following table describes the function of each shortcut menu item.
Table 3-6 Description of shortcut menu items in the message pane
Menu item Function
Save as… Save messages as a file.
Copy Copy selected texts.
Clear Clear all messages in the message pane, but not those messages in
log files.
Find Search for texts, with options of "Match Whole Word" and "Match
Case".
Set Color Set colors for different types of message. The settings also apply to
message panes in all other NE tabs.
Set Font Set the message font. The settings also apply to message panes in all
other NE tabs.
3.7.5 The Shortcut Menu in the Command Pane
In the command pane, the user can run scripts and edit command lines, including
such operations as opening a script and saving a script.
The functionality in the command pane is realized through the shortcut menu. See the
following figure.
ADC Proprietary
3-32
Figure 3-10 The shortcut menu in the command pane
The following table describes the function of each shortcut menu item.
Table 3-7 Description of shortcut menu items in the command pane
Menu item Function
Open Open a script file and display the script contents in the command pane.
Save Save the script. If the script is saved for the first time, the user will be
prompted to select a directory to save the script file.
Save as Save the script texts as a file to a directory appointed by the user.
Undo Undo the previous operation, such as input, cut, copy and paste.
Caution: You cannot undo the save, open and run operations.
Redo Redo the operation that is undone previously.
Cut Delete the selected contents from the command pane and move them
into the clipboard.
Copy Copy the selected contents from the command pane to the clipboard.
Paste Move the contents from the clipboard to the command pane.
Find Search for texts. This is the same function as in the message pane.
Set Font Set the command font. The settings also apply to command panes in all
other NE tabs.
ADC Proprietary
3-33
Menu item Function

Run selected Run selected texts as commands. This menu item is available only
script when some texts are selected and the script finishes running.
Run Run all texts in the command pane as commands.
When the script is in the pause status, this menu item is displayed as
[Continue], and its function is to resume running the script.
Pause Pause the running script. This menu item is available only when the
script is running.
Stop Stop running the script. This menu item is available only when the
script is running or paused.
The command pane also supports several shortcut keys. See the following table.
Shortcut key Function
Ctrl + C Copy
Ctrl + F Find
Ctrl + O Open
Ctrl + S Save
Ctrl + Z Undo
3.7.6 Notes and Cautions
A maximum of ten TL1 command line windows can be open at the same time in the
Toolkit.
In a message pane, the maximum display capacity is 200 kB. If the contents
exceed this limit, the earliest 100 kB will be cleared.
The message dump function saves all messages. When the contents in the
message pane are cleared manually or automatically, the saved messages are not
affected.
When the NE is in the loading process, try not to issue any commands, especially
settings commands.
Only TL1 commands for the current NE should be issued in the command pane.
Otherwise the display will be chaotic.
3.7.7 Command Description
The TL1 terminal realizes some management functions for SONET products,
including issuing TL1 commands and running TCL scripts. The user can also stop or
pause the script.
ADC Proprietary
3-34
The Toolkit supports ambiguous input of commands.

This tool also supports the following commands.
1. SetValue
Command SetValue
Format SetValue varName varDescription varDeafult
varName is the name of the variable. varDescription is the description of

the variable. varDefault is the default value of the variable.
Function Set variables and prompt the user to enter variable values.
Example SetValue R1 varDescription 5
A pop-up dialog box will prompt the user to enter the R1 value, which is
default to 5.
2. SetTimeout
Command SetTimeout
Format SetTimeout N
N is an integer between 0 and 100.

Function Set timeout.
If the response time N is not input, this command queries the timeout.
Example SetTimeout 5
The timeout is set to 5 seconds.
Set Timeout
The following is the information returned (assuming that the timeout was
set to 5 seconds):
The currently timeout is 5 seconds
ADC Proprietary
3-35
3. runfile
Command runfile
Format runfile
Function Run the script file. The result prompts the user to select a script file to run.
The contents of the script file are not displayed in the result. Any
information, except the puts information, is not displayed either.
Example None.
4. Clear
Command Clear
Format Clear
Function Clear characters in the command pane.
Example None.
3.7.8 Inputting TL1 Commands
1. Background
In the command pane, input a TL1 command, and press <Enter> to issue the
command to the NE. The result will then be displayed in the message pane. If you do
not know the exact command name, add /? after the command, and the Toolkit will
display possible matches of command names. For example, input the following
command and press <Enter>:
user /?
ADC Proprietary
3-36
Then all command names containing "user" are displayed in the message pane as
follows.
"ACT-USER"
"ACT-USER-EMS"
"ALW-USER-SECU"
"CANC-USER"
"DLT-USER-SECU"
"ED-USER-SECU"
"ENT-USER-SECU"
"INH-USER-SECU"
"RTRV-USER-SECU"
>
2. Prerequisites
The NE for login must be created.

This function applies to all SONET NEs.
3. Procedure
Follow the steps below to run TL1 command line.

Step Action
1 Select [Command Line/TL1 Terminal] from the Main Menu or click the shortcut
icon on the toolbar to access the TL1 terminal window.
2 In the left-hand Object Tree, add SONET NEs. For detailed operations, refer to
3.3.1 "Adding NEs".
3 Select one or multiple logged-in NEs and click to transfer to the right-hand
Tab container (one tab for each NE).
4 Enter commands in the lower pane. For example, enter RTRV-INMSG-ALL:::1

to query registered TL1 messages.
5 a. Move the cursor to this command line and press <Enter> to run the current
command.
b. Select some command lines. Right-click them and select [Run Selected
Script] to run the selected command lines.
c. Right click the commend line, and click [Run]. That is to say, run all of the files.
ADC Proprietary
3-37
6 The following information is displayed in the upper result pane, indicating the
commands run successfully:
SONET-NE1 2005-09-02 11:15:29
M 1 RTRV
"ABT-CMD"
"ACT-USER"
"ACT-USER-EMS"
"ALW-LPBK-T1"
"ALW-LPBK-T3"
>
ADC Proprietary
3-38
Backup and Restore Toolkit User Guide 4 SONET NEs Upgrade Instruction
4 SONET NEs Upgrade Instruction
This chapter introduces the process of the SONET NEs upgrading using the Toolkit.
SONET NEs upgrading uses the way of software package loading.
During the loading process, it is recommended to open the TL1 Command Client
interface of the related NE, so that events reported by the NE can be viewed in real
time.
The following topics are covered:
Interface
Notes and cautions
Self-check before upgrade
Loading software package
Verifying the upgrade of software package
4.1 Interface
Figure 4-1 shows the TL1 Command Client interface.
ADC Proprietary
4-1
Figure 4-1 TL1 Command Client
Figure 4-2 shows the "Load Software Package" interface.
ADC Proprietary
4-2
Figure 4-2 Load Software Package
4.2 Notes and Cautions

When the software package is being loaded, it is forbidden to synchronize the
databases of the active SCC and the standby SCC, and settings cannot be
modified. Otherwise, rollback may take place, or the modified settings can be lost.
Before loading software package, check whether the NE software of the active
SCC is consistent with that of the standby SCC. If not, the databases cannot be
synchronized, and the delivery of services will be abnormal. Consequently, the
SCC will be reset and rollback will take place.
Before loading software package, clear alarms on the NE. If there are alarms on
the NE, rollback or service interruption may take place during upgrade. If some
alarms cannot be cleared, confirm their impact one by one. For service alarms that
cannot be excluded before upgrade, the user must decide, according to the
networking, whether the service will be affected during switching. For hardware
alarms and other alarms that cannot be excluded before upgrade, it is
recommended to collect these alarms and feed them back to the R&D staff.
Before loading software package, make sure that there is no switching or lockout
on the NE. A forced switch or lockout may cause rollback. TPS, APS, BLSR or
UPSR switching may cause service interruption.
Before loading software package, make sure that each cold-reset board has a
protection board. Otherwise the service will be interrupted.
ADC Proprietary
4-3
NEs on the same ring are not allowed to be activated at the same time. Otherwise
the service may be interrupted.
During automatic software matching (for boards that go online during the loading
process), the software version may still be the old one if the software version is
queried instantly the NE state changes to "Normal". The version information will be
updated after the board finishes writing the FLASH and is reset.
When the committing operation is performed, the standby SCC (if any) will be reset
if its software is updated. When the standby SCC goes offline and online during the
resetting process, such offline and online events will be reported, but possibly after
the committing operation is reported as finished.
When loading software package, the user is not allowed to unplug a board, reset a
board or an SCC by command, or configure services. Otherwise, exceptions will
occur, loading will fail, and rollback will take place. Boards that go online during the
loading process may not be able to load the new software. After the software
package is loaded, however, these boards will find matching software in the loaded
package and then reset themselves.
4.3 Self-Check Before Upgrade
1. Procedure
Follow the steps below to perform self-check before upgrade.

Step Action
1 Use the RTRV-EQPT command to view the PCB version of the SCC, to confirm
that the SCC is a 64M large-capacity FLASH board.
2 Issue the RTRV-EQPT command and then view the SWVER field, to confirm
that the NE software version of the standby SCC is consistent with that of the
active SCC.
If the software package is loaded and the NE software versions are not
consistent, check whether there is an SWDL_CHGMNG_MISMATCH alarm. If
there is no such alarm, upgrade the software only when software matching of
the standby SCC is finished. If there is such alarm, issue the CPY-MEM:::C;
command to keep the standby SCC board software and other board software
consistent with the software package on the active SCC. In this way, the
SWDL_CHGMNG_MISMATCH is cleared, and then the user can upgrade the
software.
3 Issue the RTRV-COND-ALL command to make sure there are no alarms on the
NE.
4 Query protection groups and view the switching status to make sure there is no
switching or lockout on the NE.
y To query TPS switching status, use the RTRV-EQPT-PG command.
y To query LAPS and BLSR switching status, use the RTRV-FFP-<OCN>

command.
y To query UPSR switching status, use the RTRV-CRS command.
ADC Proprietary
4-4
4.4 Loading Software Package
1. Procedure
Follow the steps below to load software package.

Step Action
1 Start the Toolkit. Select [Load Software/Load Software Package] to access the
"Load Software Package" interface.
2 Right-click the NE to be upgraded and select [Login NE] to log in.
If the NE is not in the Object Tree, add it first. For detailed operations, refer to
3.3.1 "Adding NEs".
3 Select the NE by clicking its check box and then click . The NE is added to
the Operation List
4
Click the button in the "File" field to select the file.
If the FTP is applied, an FTP dialog box is displayed. Select the software
package to be loaded from the FTP Server. For details, refer to section 3.1.4
"Setting FTP Parameters".
If the HFCP is applied, the "Open File" dialog box is displayed. Select the
software package to be loaded.
ADC Proprietary
4-5
Step Action
5 Click <Start> to start copying the file. When copying is finished, the NE state
changes to "Unactivated". The user can perform rollback during loading.
During a normal loading process, the NE state changes as follows: normal state
– copying file state – copying memory state – unactivated state. See Figure 3-7
for details.
Note:
Before copying the file, the Toolkit checks the FLASH space on the NE. If the
FLASH space is not enough to store the whole software package, the Toolkit picks
out related software based on the running boards on the NE, and then customize a
new software package. To confirm whether the software package is complete or
customized, just view the value of "All Software" in the Operation List.
ADC Proprietary
4-6
Step Action
6 When a message saying loading succeeds is displayed in "Operation Result",
select this NE and click <Activate>. The NE changes to the activating state. The
NE will then be reset, and the new software will be running after it is copied from
the standby area to the active area. After that, the NE changes to the normal
state (or to the normal-unstable state and five minutes later to the normal state).
During a normal loading process, the NE state changes as follows: unactivated

– activating – commit – normal-unstable – normal. See Figure 3-7 for details.
Note:
The NE will be in the normal-unstable state under the following conditions:
z After the active SCC is reset
z After the active SCC and the standby SCC are switched
z After software matching for a board or the standby SCC is finished
z After rollback is finished
z After the software is committed
In the normal-unstable state, the <Start> button is not available in the interface.
There is no normal-unstable state in some old versions. In this case, if the user
clicks <Start> within five minutes after the NE returns to the normal state, an error
message will be displayed saying "NOT IN VALID STATE, WAIT FOR SYSTEM
STABLE."
7 The user can click <Query> to query the loading attributes, NE state, software
package version, and "All Software" status.
4.5 Verifying the Upgrade of Software Package

After loading, verify the following to make sure that the upgrade is successful:
Check whether the service is normal.
Check NE alarm performance.
Verify the functionality after the upgrade.
If conditions permit, perform some basic verification of functionality.
ADC Proprietary
4-7
ADC Proprietary
4-8
Contents
A Glossary A-1
ADC Proprietary
i
Backup and Restore Toolkit User Guide A Glossary
A Glossary
Alarm A visible or an audible indication to notify the person concerned that a failure or an
emergency has occurred. See also Event.
APS Automatic Protection Switching. Automatic switching of a failed communication route

to a workable one as a mean of enhancing system reliability.
Client A kind of terminal (PC or workstation) connected to a network that can send
instructions to a server and get results through a user interface. See also server.
Configuration data The data that configures the NE hardware for coordination between this NE and
other NEs in the entire network and operation of specified services. Configuration
data is the instruction file of NEs, and it is the key for efficient network running. The
typical configuration data includes board configuration, clock configuration and
protection relationship.
Configure To set the basic parameters of an operation object.
Connection A "transport entity" which consists of an associated pair of "unidirectional

connections" capable of simultaneously transferring information in opposite
directions between their respective inputs and outputs.
ADC Proprietary
A-1
DCC Within an STM-N signal there are two DCC channels, one is the 192 kbit/s DCC-R
channel composed of bytes D1–D3, and the other is the 576 kbit/s DCC-M channel
composed of bytes D4–D12. All NEs can communicate with one another through the
DCC-R. The DCC-M is not the regenerator section overhead and does not support
communications among regenerators, and it is used to support communication
channels of more universal purpose. For example, it supports TMN as a physical
channel of ECC.
ECC Embedded Control Channel. An ECC provides a logical operations channel between
SDH NEs, utilizing a data communications channel (DCC) as its physical layer.
Failure The fault cause persisted long enough to consider the ability of an item to perform a
required function to be terminated. The item may be considered as failed; a fault has
now been detected.
Forced switch This command performs the ring switch from working channels to the protection
channels. This switch occurs regardless of the state of the protection channels,
unless the protection channels are satisfying a higher priority bridge request.
Gateway NE The NE that communicates with the NMS through an Ethernet line or a serial port
line. The non-gateway NE communicates with the gateway NE through ECC and
communicates with the NMS through the gateway NE. The gateway NE is a
communication route that the EMS must pass through when managing the entire
network.
IP address In the TCP/IP protocol, it is used to uniquely identify the address of the
communication port, which consists of four bytes in decimal digits, for example,
129.9.161.55.
Layer A concept used to allow the transport network functionality to be described

hierarchically as successive levels; each layer being solely concerned with the
generation and transfer of its characteristic information.
ADC Proprietary
A-2
NE ID In a network, each NE corresponds to a unique identifier, that is, the NE ID. In the
LoopStar transmission equipment, it is specified that the NE ID is a 24-bit binary digit,
that is, three bytes. The DIP switch on the SCC board of the NE constitutes the lower
16 bits of the NE ID. The higher eight bits of the NE ID is the extended ID (default
value: 9), which is also called the sub-network number. The extended ID is usually
used to identify different sub-networks.
NE Network Element. NE includes the hardware unit and the software running on it.
Usually, one NE has at least an SCC (system control and communication) board
which responsible for the management and monitoring of the NE. The NE software
runs on the SCC board.
Pane A major separate area of a window or dialog box, usually used for display rather than
data entry.
Path A trail in a path layer.
Procedure A generic term for an action.
Process A generic term for a collection of actions.
Route The IP route selection is in table driving mode. In each host and each router of the
Internet, there is a routing table that contains information about how the service is
transmitted from the source to the sink, providing a basis for route selection. Ethernet
static routing in ET1 refers to the mapping relationship between the Ethernet port
and the bound path. Its routing type includes port routing and VLAN routing. Port
routing: It means configuring a route between the Ethernet port and the bound path
port, which is usually used for point-to-point networking communication; VLAN
routing: It means configuring a route between the Ethernet port and the bound path
port based on the VLAN service. It can be used flexibly in point-to-point,
point-to-multipoint or multipoint-to-multipoint communication. The implementation is
to divide and converge the data stream according to the VLAN flag of the packet. As
a VLAN flag can be added to the Ethernet port, the equipment can be applied more
flexibly.
Script file It is the text file describing the physical information and configuration information of
the entire network, including the NE configuration file, port naming file, end-to-end
configuration file, NE physical view script file, NM information file and service
implementation data script file.
Script A list of instructions for performing a specific task or action, written in a scripting
language.
Section A trail in a section layer.
ADC Proprietary
A-3
Settings Parameters of an operation that can be selected by the user.
Shortcut menu A menu that is displayed when right-clicking an object’s name or icon. Also called a
context menu.
Support The frame on the bottom of a cabinet, when installing the cabinet on the antistatic
floor.
EMS The EMS is a subnetwork management system (SNMS). In the TMN architecture,
the EMS is located between the NE level and network level, which can supports all
function of NE-level and part of the network-level management functions. See also
NM.
ADC Proprietary
A-4
Contents
B Acronyms and Abbreviations B-1
ADC Proprietary
i
ADC Proprietary
ii
Backup and Restore Toolkit User Guide B Acronyms and Abbreviations
B Acronyms and Abbreviations
APS Automatic Protection Switch
DCC Data Communication Channels
ECC Embedded Control Channel
FLASH FLASH memory
FTP File Transfer Protocol
HFCP ADC File Copy Protocol
ID Identity
IP Internet Protocol
NSAP Network Service Access Point
OSI Open Systems Interconnection
OSN Optical Switch Node
ADC Proprietary
B-1
Backup and Restore Toolkit User Guide B Acronyms and Abbreviations
OSP Optical Software Platform
SCC System Control & Communication Unit
SDH Synchronous Digital Hierarchy
SNCP Sub-Network Connection Protection
SONET Synchronous Optical Network
SSM Synchronization Status Message
TCL Tool Command Language
TCP Transmission Control Protocol
TPS Tributary Protection Switching
VRP Versatile Routing Platform
ADC Proprietary
B-2
Backup and Restore Toolkit User Guide
PRODUCT SUPPORT
ADC Customer Service Group provides expert pre-sales support and training for all of its products. Technical support is available 24 hours
a day, 7 days a week by contacting the ADC Technical Assistance Center.
Sales Assistance: 800.366.3891 Quotation Proposals, Ordering and Delivery General, and Product
Information
Systems Integration: 800.366.3891 Complete Solutions (from concept to installation), Network

Design and Integration Testing, System Turn-Up and Testing,
Network Monitoring (upstream or downstream), Power
Monitoring and Remote Surveillance, Service/Maintenance
Agreements, and Systems Operation
ADC Technical Assistance Center: Technical Information, System/Network Configuration, Product

800.366.3891 Specification and Application, Training (product-specific),
Installation and Operation Assistance, and Troubleshooting and
Email: wsd.support@adc.com Repair/Field Assistance
Online Technical Support: www.adc.com/Knowledge_Base/index.jsp
Online Technical Publications: www.adc.com/documentationlibrary/technicalpublications/
Product Return Department: 800.366.3891 ADC Return Material Authorization (RMA) number and
instructions must be obtained before returning products.
Email: repair.return@adc.com
Backup and Restore Toolkit User Guide
CERTIFICATION AND WARRANTY
FCC COMPLIANCE
This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15
of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the
equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio
frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful
interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful
interference in which case the user will be required to correct the interference at his own expense.
LIMITED WARRANTY
Product warranty is determined by your service agreement. Refer to the ADC Warranty/Software Handbook for
additional information, or contact your sales representative or Customer Service for details.
MODIFICATIONS
The FCC requires the user to be notified that any changes or modifications made to this device that are not expressly
approved by ADC voids the user’s warranty.
All wiring external to the products should follow the provisions of the current edition of the National Electrical
Code.
STANDARDS COMPLIANCE
This equipment has been tested and verified to comply with the applicable sections of the following standards:
GR 63-CORE - Network Equipment-Building System Requirements: Physical Protection
GR 1089-CORE - Electromagnetic Compatibility and Electrical Safety
Binational Standard, UL-60950/CSA1459 C22.2 No. 60950-00: Safety of Information Technology Equipment
For technical assistance, refer to Appendix B, Product Support.

World Headquarters
ADC Telecommunications, Inc.
PO Box 1101
Minneapolis, MN 55440-1101 USA
For Technical Assistance:

Tel: 800.366.3891
Document: LPS-UM-TKTL1-01
´-£J¶0~¨
1397420

Loopstar Software Download, Backup and Restore Toolkit User Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Loopstar Software Download, Backup and Restore Toolkit User Guide

Uploaded by

Copyright:

Available Formats

LoopStar® Software Download, Backup

and Restore Toolkit User Guide

Document Number: LPS-UM-TKTL1-01

Revision Release Date Revisions Made

©2007 ADC Telecommunications, Inc. All rights reserved.

About This Manual

Chapter 2 Installation Introduces the installation of the Toolkit.

Chapter 3 Operation Introduces the operations of the Toolkit.

Appendix A Glossary Lists the glossary used in the guide.

Note: A note notice with this symbol indicates additional, helpful,

/ Multi-level menus are separated by forward slashes. For example,

1 System Description 1-1

1.1 Overview 1-1

2.1 Running Independently 2-1

3.1 Operation Basis 3-2

3.3.1 Logging In to an NE 3-12

4 SONET NEs Upgrade Instruction 4-1

4.1 Interface 4-1

Figure 1-1 Networking diagram through ECC protocol 1-3

Table 3-1 The Toolkit shortcut icons and legends 3-3

3. Backing Up/Restoring NE Data

 Starting/Rolling back backing up of database package

4. Loading Software Package

 Querying loading attributes

5. Viewing log function

6. TL1 Command Line

 Adding NE command line operation Tab pages

1.4 Networking and Communication

NE2 ECC ECC NE4 NE5 NE6

Figure 1-1 Networking diagram through ECC protocol

1.4.2 Introduction to IP Networking

Figure 1-2 Networking diagram through IP protocol

1.4.3 Introduction to OSI Networking

TP4 TP4 TP4 TP4

NE2 TP4 TP4 NE4 NE5 NE6

Figure 1-3 Networking diagram through the OSI protocol

This chapter describes how to install the Toolkit for:

2.1 Running Independently

3.1 Operation Basis

Figure 3-1 Interface

3.1.2 Icon Description

Figure 3-1 lists the Toolkit shortcut icons and legends.

TL1 Terminal Enters the "TL1 Command Line" interface.

Load Software Enters the "Load Software Package" interface.

Backup/Restore Enters the "Back up/Restore Database

Browse Log Enters the "Browse Log" interface.

FTP Setting Opens the "FTP Properties Settings" dialog

Topics Opens the Toolkit help Files.

Legend Available The NE is logged in. The function is available.

Not logged in The NE is not logged in. The function is not

Not supported The NE is logged in. The function is not

3.1.3 Selecting an Operation Object

The user must log in to the related NE in the Toolkit.

Follow the steps below to select an operation object.

2 Click before an operation object to unfold its sub-level objects.

4 Click to transfer selected objects to the right-hand operation interface, and

3.1.4 Setting FTP Parameters

Follow the steps below to set FTP parameters.

4 Click <OK> when the following prompt is displayed.

3.2 Managing Operation Objects

You can implement corresponding operations on an NE only if the NE is added in the

 The NE communicates with the Toolkit client correctly.

Follow the steps below to add an NE.

Starting/Rolling back backing up of database package

Querying loading attributes

Adding NE command line operation Tab pages

The NE communicates with the Toolkit client correctly.

The NE communicates with the Toolkit client correctly.

The NE must be created in the Toolkit.

The NE for login must be created in the Toolkit.