You are on page 1of 102

OneControl Unified Management System

Optical Service Provisioner and Layer 1 Network and Service Viewer

Custom Topology User Guide


Release 5.0
Whats inside...
Custom
Custom
Custom
Custom

Topology
Topology
Topology
Topology

overview
NDF file description
procedures
scenarios

450-3251-189 - Standard Issue 07.01


August 2015
Copyright 2013-2015 Ciena Corporation
Ciena Confidential and Proprietary

LEGAL NOTICES
THIS DOCUMENT CONTAINS CONFIDENTIAL AND TRADE SECRET INFORMATION OF CIENA CORPORATION
AND ITS RECEIPT OR POSSESSION DOES NOT CONVEY ANY RIGHTS TO REPRODUCE OR DISCLOSE ITS
CONTENTS, OR TO MANUFACTURE, USE, OR SELL ANYTHING THAT IT MAY DESCRIBE. REPRODUCTION,
DISCLOSURE, OR USE IN WHOLE OR IN PART WITHOUT THE SPECIFIC WRITTEN AUTHORIZATION OF CIENA
CORPORATION IS STRICTLY FORBIDDEN.
EVERY EFFORT HAS BEEN MADE TO ENSURE THAT THE INFORMATION IN THIS DOCUMENT IS COMPLETE
AND ACCURATE AT THE TIME OF PRINTING; HOWEVER, THE INFORMATION CONTAINED IN THIS DOCUMENT
IS SUBJECT TO CHANGE.
Any usage in this document of Nortel, Nortel Networks, the Nortel logo, and Globemark now refer to Ciena
Corporation.
Copyright 2013-2015 Ciena Corporation
All Rights Reserved
The material contained in this document is also protected by copyright laws of the United States of America and other
countries. It may not be reproduced or distributed in any form by any means, altered in any fashion, or stored in a data
base or retrieval system, without express written permission of the Ciena Corporation.
Security
Ciena cannot be responsible for unauthorized use of equipment and will not make allowance or credit for
unauthorized use or access.
Contacting Ciena
Corporate Headquarters

410-694-5700 or 800-921-1144

www.ciena.com

Customer Technical Support/Warranty


In North America

1-800-CIENA24 (243-6224)
410-865-4961

In Europe, Middle East,


and Africa

800-CIENA-24-7 (800-2436-2247)
+44-207-012-5508

In Asia-Pacific

800-CIENA-24-7 (800-2436-2247)
+81-3-6367-3989
+91-124-4340-600

In Caribbean and Latin


America

800-CIENA-24-7 (800-2436-2247)
410-865-4944 (USA)

Sales and General Information

410-694-5700

E-mail: sales@ciena.com

In North America

410-694-5700 or 800-207-3714

E-mail: sales@ciena.com

In Europe

+44-207-012-5500 (UK)

E-mail: sales@ciena.com

In Asia

+81-3-3248-4680 (Japan)

E-mail: sales@ciena.com

In India

+91-124-434-0500

E-mail: sales@ciena.com

In Latin America

011-5255-1719-0220 (Mexico City)

E-mail: sales@ciena.com

877-CIENA-TD (243-6283)
or 410-865-8996

E-mail: techtng@ciena.com

Training

For additional office locations and phone numbers, please visit the Ciena web site at www.ciena.com.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

IMPORTANT: PLEASE READ THIS LICENSE AGREEMENT ("AGREEMENT") CAREFULLY BEFORE


INSTALLING OR USING CIENA CORPORATION ("Ciena") SOFTWARE, HARDWARE OR DOCUMENTATION
(COLLECTIVELY, THE "EQUIPMENT").
BY INSTALLING OR USING THE EQUIPMENT, YOU ACKNOWLEDGE THAT YOU HAVE READ THIS
AGREEMENT AND AGREE TO BE BOUND BY ITS TERMS AND CONDITIONS.
1. Right to Use License; Restrictions. Subject to these terms, and the payment of all applicable license fees, Ciena
grants to you, as end user, a non-exclusive license to use the Ciena software (the "Software") in object code form
solely in connection with, and as embedded within, the Equipment,. You shall have the right to use the Software solely
for your own internal use and benefit. You may make one copy of the Software and documentation solely for backup
and archival purpose, however you must reproduce and affix all copyright and other proprietary rights notices that
appear in or on the original. You may not, without Ciena's prior written consent, (i) sublicense, assign, sell, rent, lend,
lease, transfer or otherwise distribute the Software; (ii) grant any rights in the Software or documentation not expressly
authorized herein; (iii) modify the Software nor provide any third person the means to do the same; (iv) create
derivative works, translate, disassemble, recompile, reverse engineer or attempt to obtain the source code of the
Software in any way; or (v) alter, destroy, or otherwise remove any proprietary notices or labels on or embedded within
the Software or documentation. You acknowledge that this license is subject to Section 365 of the U.S. Bankruptcy
Code and requires Ciena's consent to any assignment related to a bankruptcy proceeding. Sole title to the Software
and documentation, to any derivative works, and to any associated patents and copyrights, remains with Ciena or its
licensors. Ciena reserves to itself and its licensors all rights in the Software and documentation not expressly granted
to you. You shall preserve intact any notice of copyright, trademark, logo, legend or other notice of ownership from any
original or copies of the Software or documentation.
2. Audit: Upon Ciena's reasonable request, but not more frequently than annually without reasonable cause, you
shall permit Ciena to audit the use of the Software at such times as may be mutually agreed upon to ensure
compliance with this Agreement.
3. Confidentiality. You agree that you will receive confidential or proprietary information ("Confidential Information")
in connection with the purchase, deployment and use of the Equipment. You will not disclose Confidential Information
to any third party without prior written consent of Ciena, will use it only for purposes for which it was disclosed, use your
best efforts to prevent and protect the contents of the Software from unauthorized disclosure or use, and must treat it
with the same degree of care as you do your own similar information, but with no less than reasonable care. You
acknowledge that the design and structure of the Software constitute trade secrets and/or copyrighted materials of
Ciena and agree that the Equipment is Confidential Information for purposes of this Agreement.
4. U.S. Government Use. The Software is provided to the Government only with restricted rights and limited rights.
Use, duplication, or disclosure by the Government is subject to restrictions set forth in FAR Sections 52-227-14 and
52-227-19 or DFARS Section 52.227-7013(C)(1)(ii), as applicable. The Equipment and any accompanying technical
data (collectively "Materials") are commercial within the meaning of applicable Federal acquisition regulations. These
Materials were developed fully at private expense. U.S. Government use of the Materials is restricted by this
Agreement, and all other U.S. Government use is prohibited. In accordance with FAR 12.212 and DFAR Supplement
227.7202, software delivered to you is commercial computer software and the use of that software is further restricted
by this Agreement.
5. Term of License. This license is effective until terminated. Customer may terminate this license at any time by
giving written notice to Ciena [or] and destroying or erasing all copies of Software including any documentation. Ciena
may terminate this Agreement and your license to the Software immediately by giving you written notice of termination
in the event that either (i) you breach any term or condition of this Agreement or (ii) you are wound up other than
voluntarily for the purposes of amalgamation or reorganization, have a receiver appointed or enter into liquidation or
bankruptcy or analogous process in your home country. Termination shall be without prejudice to any other rights or
remedies Ciena may have. In the event of any termination you will have no right to keep or use the Software or any
copy of the Software for any purpose and you shall destroy and erase all copies of such Software in its possession or
control, and forward written certification to Ciena that all such copies of Software have been destroyed or erased.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

6. Compliance with laws. You agree to comply with all applicable laws, including all import regulations, and to obtain
all required licenses and permits related to installation and use of Equipment. Software, including technical data, is
subject to U.S. export control laws, including the U.S. Export Administration Act and its associated regulations, and
may be subject to export or import regulations in other countries. Customer agrees to comply strictly with all such
regulations and acknowledges that it has the responsibility to obtain licenses to export, re-export, or import Software.
7. Limitation of Liability. ANY LIABILITY OF Ciena SHALL BE LIMITED IN THE AGGREGATE TO THE AMOUNTS
PAID BY YOU FOR THE SOFTWARE. THIS LIMITATION APPLIES TO ALL CAUSES OF ACTION, INCLUDING
WITHOUT LIMITATION BREACH OF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY,
MISREPRESENTATION AND OTHER TORTS. THE LIMITATIONS OF LIABILITY DESCRIBED IN THIS SECTION
ALSO APPLY TO ANY THIRD-PARTY SUPPLIER OF Ciena. NEITHER Ciena NOR ANY OF ITS THIRD-PARTY
SUPPLIERS SHALL BE LIABLE FOR ANY INJURY, LOSS OR DAMAGE, WHETHER INDIRECT, SPECIAL,
INCIDENTAL OR CONSEQUENTIAL INCLUDING WITHOUT LIMITATION ANY LOST PROFITS, CONTRACTS,
DATA OR PROGRAMS, AND THE COST OF RECOVERING SUCH DATA OR PROGRAMS, EVEN IF INFORMED
OF THE POSSIBILITY OF SUCH DAMAGES IN ADVANCE
8. General. Ciena may assign this Agreement to any Ciena affiliate or to a purchaser of the intellectual property rights
in the Software, but otherwise neither this Agreement nor any rights hereunder may be assigned nor duties delegated
by either party, and any attempt to do so will be void. This Agreement shall be governed by the laws of the State of
Maryland (without regard to the conflict of laws provisions) and shall be enforceable in the courts of Maryland. The
U.N. Convention on Contracts for the International Sale of Goods shall not apply hereto. This Agreement constitutes
the complete and exclusive statement of agreement between the parties relating to the license for the Software and
supersedes all proposals, communications, purchase orders, and prior agreements, verbal or written, between the
parties. If any portion hereof is found to be void or unenforceable, the remaining provisions shall remain in full force
and effect.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Publication history

August 2015
Issue 07.01 of the OneControl Unified Management System 5.0 Optical
Service Provisioner and Layer 1 Network and Service Viewer Custom
Topology User Guide.

January 2015
Issue 06.01 of the OneControl Unified Management System 4.2 Optical
Service Provisioner and Layer 1 Network and Service Viewer Custom
Topology User Guide.

August 2014
Issue 05.01 of the OneControl Unified Management System 4.1 Optical
Service Provisioner and Layer 1 Network and Service Viewer Custom
Topology User Guide.

April 2014
Issue 04.01 of the OneControl Unified Management System 4.0 Optical
Service Provisioner and Layer 1 Network and Service Viewer Custom
Topology User Guide.

December 2013
Issue 03.01 of the OneControl Unified Management System 3.2 Optical
Service Provisioner and Layer 1 Network and Service Viewer Custom
Topology User Guide.

August 2013
Issue 02.02 of the OneControl Unified Management System 3.1 Optical
Service Provisioner and Layer 1 Network and Service Viewer Custom
Topology User Guide.

July 2013
Issue 02.01 of the OneControl Unified Management System 3.1 Optical
Service Provisioner and Layer 1 Network and Service Viewer Custom
Topology User Guide.
OneControl - OSP and Layer 1 NSV
Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

vi Publication history

April 2013
Issue 01.01 of the OneControl Unified Management System 3.0 Optical
Service Provisioner and Layer 1 Network and Service Viewer Custom
Topology User Guide.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

vii

Contents

About this document

ix

Custom Topology overview

1-1

OSP components 1-1


Layer 1 NSV components 1-2
Custom Topology architecture 1-3
Topology consolidation by the NDS server 1-6
Custom Topology command line tool overview 1-7
Adding a link 1-8
Deleting a link 1-9
Backing up and restoring topological data 1-9
Exporting topological data 1-10
Listing NEs and ports 1-10
Listing topological links and UDCs 1-10
Auditing custom topological data 1-10
Considerations 1-10
Logs 1-11
Audit logs 1-11
Custom Topology logs 1-14
System responses 1-15
Administrative functions 1-16
Custom Topology installed on an HP workstation 1-16
Custom Topology installed on a Solaris/Linux workstation 1-16

Custom Topology NDF file description

2-1

NDF file name 2-1


NDF file location 2-2
NDF file format 2-2
NES section 2-3
SUBNETS section 2-4
MS section 2-5
OT section 2-6
OP section 2-7
NDF file for UPSR/SNCP configuration: example 2-9
NDF file for user defined configuration: example 2-10
NDF files for the Manager for 6k, OM5k and CPL redundant server configuration:
example 2-10

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

viii Contents

Custom Topology procedures

3-1

Custom Topology command line interface 3-1

List of procedures
3-1
3-2
3-3
3-4
3-5
3-6
3-7
3-8
3-9
3-10
3-11
3-12
3-13
3-14
3-15
3-16
3-17
3-18

Adding topological links 3-6


Deleting topological links 3-9
Displaying topological links 3-11
Exporting topological links to an NDF file 3-14
Displaying the list of NEs managed by the NDS server 3-18
Exporting the list of NEs managed by the NDS server 3-20
Displaying NE endpoint information 3-22
Exporting NE endpoint information 3-24
Displaying link information 3-26
Exporting link information 3-28
Displaying configuration information 3-30
Exporting configuration information to an NDF file 3-32
Clearing data from Custom Topology 3-35
Performing an audit of the Custom Topology links 3-37
Backing up Custom Topology data 3-39
Restoring Custom Topology data 3-42
Synchronizing the preferred and alternate Custom Topology servers 3-45
Displaying help 3-46

Custom Topology scenarios

4-1

List of procedures
4-1
4-2
4-3
4-4
4-5

Cutting in a network element 4-2


Cutting out a network element 4-6
Reconfiguring a link 4-10
Changing an NE name 4-13
Changing an AP NE ID 4-14

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

450-3251-189
ix

About this document

This document describes the Custom Topology component in Optical Service


Provisioner (OSP) and Layer 1 Network and Service Viewer (L1 NSV) and
provides procedures for using the Custom Topology command line tool to
manually create topological links in the network.

ATTENTION
Check for updated versions of this document on the Ciena portal (for
download instructions, see Documentation download on page ix).

ATTENTION
Within this document, the term Manager for 6k, OM5k and CPL should be
interpreted to mean OneControl Manager for the following network elements:
ActivFlex 6110 Multiservice Optical Platform (ActivFlex 6110), ActivFlex
6130 Multiservice Optical Platform (ActivFlex 6130), Optical Multiservice
Edge 6150 (OME6150), 6200 Packet-Optical Platform (6200), 6500
Packet-Optical Platform (6500), 565/5100/5200 Advanced Services Platform
(565/5100/5200), Optical Metro 5040/5080 (OM5040/5080), and Common
Photonic Layer (CPL). The OneControl Manager for 6k, OM5k, and CPL
represents the evolution of the Optical Manager Element Adapter (OMEA).

ATTENTION
Manager for 6k, OM5k and CPL represents the evolution of OMEA;
however, you may still see 'OMEA' in certain commands, menus, and system
prompts. Consider 'OMEA' to mean 'Manager for 6k, OM5k and CPL'.

Documentation download
You can download OSP and Layer 1 NSV documents and other related
OneControl Unified Management System documents from the Ciena portal.
To download a document, perform the following steps:
1

As a registered user with a Ciena portal account, log into the Ciena
Customer Service Center portal at:
https://portal.ciena.com
Once you are logged into this portal, click the Documentation tab.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

x About this document

3
4
5
6

In the Browse list under Product Documentation Search, select


OneControl Unified Management System.
Click on the required Release.
Find the document you want to download and click the link.
Download the document.

Conventions used in this document


Throughout this document you will see system information, such as command
strings and prompts and responses, represented in consistent ways.

Command strings
Command strings you enter appear in bold face courier font as in the following
example:
cd /tmp

You must enter the command string exactly as shown, including spaces, and
press the Enter key, as indicated.
Variable parameters appear in angle brackets, as in the following example:
mkdir /<directory name>

An explanation of the variable may follow the command string, as in the


following example:
where
<directory name>

is the name of the CD-ROM directory

Prompts and responses from the system


System prompts and responses appear in courier font as in the following
example:
Press Enter to continue.

Directory and path names


Directory and path names appear in courier font as in the following example:
/opt/nortel/current_load

Buttons and menu items


Buttons and menu items in the application interface appear in bold face as in
the following example:
Click OK.

In some cases, the user interface supports menu commands and buttons with
equivalent capabilities. In the procedures, we suggest the use of buttons
where they exist. Menu command equivalents have the same or equivalent
name as the button, if you prefer to use them.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

About this document xi

Keyboard keys
Keyboard key names appear in bold face as in the following example:
Press Enter.

Window and field names


Names of objects displayed in windows are written as shown on the screen.
Since these expressions can contain several words, all words in the name
begin with capitals.

Results of an action and comments


Results of an action and comments are printed in italic type, as follows:
The window opens.

When a new window or dialog box opens as a result of a procedure step, the
new context is included in the following step, as follows:
In the Find dialog box, enter a User ID in the Name field.

OneControl NSV related books


The following table lists the books that comprise the OneControl Unified
Management System NSV documentation suite. See OneControl
Engineering Guide, 450-3201-010 for ordering information.
Ciena technical
publication number

Ciena technical publication name

450-3261-201

Layer 1 Network and Service Viewer Installation and


Configuration Guide

450-3261-301

Layer 1 Network and Service Viewer Standard


Operations Guide

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

xii About this document

OneControl OSP related books


The following table lists the books that comprise the OneControl Unified
Management System OSP documentation suite. See OneControl
Engineering Guide, 450-3201-010 for ordering information.
Ciena technical
publication number

Ciena technical publication name

450-3251-028

Optical Service Provisioner Standard Operations Guide

450-3251-189

Optical Service Provisioner and Layer 1 Network and


Service Viewer Custom Topology User Guide

450-3251-201

Optical Service Provisioner Installation and Configuration


Guide

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

450-3251-189
1-1

Custom Topology overview

1-

For information on topology in OSP or in Layer 1 NSV, refer to Optical Service


Provisioner Standard Operations Guide, 450-3251-028, or Layer 1 Network
and Service Viewer Standard Operations Guide, 450-3261-301.
The Custom Topology component in Optical Service Provisioner (OSP) and
Layer 1 Network and Service Viewer (L1 NSV) can consolidate all topological
data for the managed network. The topological data includes all physical
connectivity and the logical connections currently provisioned on the network.
The Custom Topology component provides the ability to manually enter
topological data for adjacency topology that cannot be autodiscovered. The
topological data is stored in the Custom Topology component.
OSP uses its stored topological data when viewing existing connections and
provisioning new connections.
Layer 1 NSV uses stored topological data when viewing existing service
paths.
The Custom Topology component also provides administrative functionality
for managing manually entered topological data: you can back up and restore
the data, export the data to a screen or file, and list network elements and
ports in the network.

OSP components
OSP is composed of two software components:

The Network Data Server (NDS) server is responsible for communicating


with network elements and performing connection management
operations. All topological data is stored in the NDS server. This includes
1) data provided by network elements to the NDS server, and 2)
topological data entered manually in Custom Topology. The Custom
Topology component of OSP is integrated in the NDS server (see Custom
Topology architecture on page 1-3 for details).

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

1-2 Custom Topology overview

The NDS server can be installed co-resident with the Manager for 6k,
OM5k and CPL on a Sun Solaris/Linux workstation or co-resident with AP
on an HP workstation. Additionally, multiple NDS servers can be installed
for redundancy purposes, or for load balancing in large networks.

The OSP client GUI functions as a client of the NDS server and supports
the user interface, where users initiate connection management requests.
The OSP client requests topological data from the NDS server. If NDS is
co-resident with AP, each instance of the OSP GUI must be installed
co-resident with an instance of AP. If NDS is co-resident with the Manager
for 6k, OM5k and CPL, the OSP GUI must be installed co-resident with an
instance of Manager for 6k, OM5k and CPL and NDS, or co-resident with
an instance of AP configured to communicate with the Manager for 6k,
OM5k and CPL / NDS server.

Layer 1 NSV components


Layer 1 NSV is composed of three software components:

The NDS server retrieves the topology information in the network by


connecting to all of the controllers in the network. The Layer 1 NSV server
requests information regarding the network topology or links from the NDS
server. The NDS server can be installed co-resident with the Manager for
6k, OM5k and CPL on a Sun Solaris/Linux workstation or co-resident with
AP on an HP workstation.

The Layer 1 NSV server is the main component of the Layer 1 NSV
application. It manages all communications between the client(s) and
NDS server(s). The Layer 1 NSV server software is installed on a Unix
server running the Sun Solaris operating system (OS). The Layer 1 NSV
server can be installed co-resident with the Manager for 6k, OM5k and
CPL or on its own separate server.

The Layer 1 NSV client is the main graphical user interface (GUI) for Layer
1 NSV, and it is used to connect to the Layer 1 NSV server. The Layer 1
NSV client can be installed on a PC or a Sun Solaris workstation. The
Layer 1 NSV client software can be installed from CD-ROM or by
downloading an installation file from the Layer 1 NSV server. Note that the
Layer 1 NSV client cannot be started from the server itself.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology overview 1-3

Custom Topology architecture


The Custom Topology component is integrated into the NDS server. It is
automatically installed with the NDS server, and must be specifically enabled
during configuration, for relevant NDS servers. Up to two NDS servers in the
network can have Custom Topology enabled, regardless of the number of
NDS servers in your network. Each NDS server must be configured to point
to the Custom Topology component(s) in the network.
Custom Topology scenarios

The Custom Topology component can be deployed in four scenarios. The


scenario you select depends on the ONM applications deployed as well as the
type of the workstation where Custom Topology is installed (HP or
Solaris/Linux).
The type of the workstation where Custom Topology is installed determines
the options required to run Custom Topology procedures.
The Custom Topology component is installed in the following directory:

On an HP workstation:
/opt/nortel/osp

On a Solaris/Linux workstation:
/opt/nortel/applications/nds/current_nds/osp

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

1-4 Custom Topology overview


Figure 1-1
Scenario 1: Custom Topology installed on HP workstation, OSP deployed
custom topology in the network.eps

HP
workstation

OSP client

NDS server

NDS server

Preferred
Custom Topology

Alternate
Custom Topology

AP

NDS server

AP

HP
workstation

AP

HP
workstation

OMgr

Manager for 6k,


OM5k and CPL

OPC

HP
workstation

MS-MOA

EC-1

NEs

Figure 1-2
Scenario 2: Custom Topology installed on Solaris/Linux workstation, OSP deployed for 6k NE
types
CT OSP for omea types.eps

OSP Client

OSP Client

NDS server

NDS server

Preferred
Custom Topology

Alternate
Custom Topology

Manager for 6k, OM5k


and CPL server primary

Manager for 6k, OM5k


and CPL server secondary

Sun/Linux
workstation

Sun/Linux
workstation
NEs

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology overview 1-5


Figure 1-3
Scenario 3: Custom Topology installed on HP workstation, Layer 1 NSV deployment for all NE
types
CT OV for all NE types.eps

Sun
workstation
L1 NSV
client
L1 NSV
server

NDS server

NDS server

Preferred
Custom Topology

Alternate
Custom Topology

AP

NDS server

AP

HP
workstation

AP

HP
workstation

OMgr

Manager for 6k,


OM5k and CPL

OPC

HP
workstation

MS-MOA

EC-1

NEs

Figure 1-4
Scenario 4: Custom Topology installed on Sun workstation, Layer 1 NSV
deployment for 6k NE types
CT OV for omea types.eps

L1 NSV
Client

L1 NSV
Client

L1 NSV
server

L1 NSV
server

NDS server

NDS server

Preferred
Custom Topology

Alternate
Custom Topology
Manager for 6k, OM5k and
CPL server secondary

Manager for 6k, OM5k and


CPL server primary

Sun/Linux
workstation

Sun/Linux
workstation
NEs

Manager for 6k, OM5k and CPL server secondary

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

1-6 Custom Topology overview

For information on Layer 1 NSV deployments, refer to the OneControl


Engineering Guide, 450-3201-010.

Topology consolidation by the NDS server


The NDS server ability to provide certain functionality, such as the ability to
step through the physical connectivity of a network, depends on its knowledge
of how NEs in the network are physically connected to each other. This is
referred to as topology.
For each configuration, the NDS server attempts to assemble a single,
complete configuration view from the various partial views of connectivity data
that it receives from element controllers in the network configuration.
The NDS server infers network topology based on data it obtains from the
following sources, in the following sequence:
1

Configurations defined by the user (stored on a controller, network


processor, or network element)
This includes 2F BLSR/MS-SPRing configurations, OSID configurations,
and also includes 10G Linear configurations between Optical Cross
Connect DX NEs, and 2.5G Linear configurations between OC-48 NEs. In
general, this type of topology can be successfully consolidated by the NDS
server (subject to certain requirements and limitations).

Adjacency information
This includes physical connectivity between NEs that is not defined by the
user (such as UPSRs/SNCPs and all other linear connectivity), on NEs
that support autodiscovery. The ability to consolidate adjacency
information depends on functionality available on the network element
level and on the controller level. Therefore, this type of topology is only
consolidated by the NDS server for certain network element types.

Custom Topology
This includes topological data entered manually into Custom Topology for
adjacent information that cannot be autodiscovered.

For requirements to ensure successful topology consolidation of user defined


configurations, adjacency information, and Custom Topology, see the section
Topology consolidation by the Network Data Server (NDS server) in the
following documents:

Optical Service Provisioner Standard Operations Guide, 450-3251-028


OR

Layer 1 Network and Service Viewer Standard Operations Guide,


450-3261-301

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology overview 1-7

The implications of this specific sequence are as follows: if data for a specific
topological link is available from a configuration defined by the user or from
adjacency information, then any data for this connection, if it exists in Custom
Topology, will not be retrieved. Data obtained from a configuration defined by
the user or autodiscovered from adjacency information take precedence over
data available in Custom Topology. In cases when the NDS server cannot
obtain a complete view of the network using configurations defined by the user
and autodiscovered from adjacency information, Custom Topology supplies
the remaining topological data.
The NDS server can, in many cases, learn the topology for configurations that
are managed by more than one element controller. These are referred to as
split span of control (split-SOC) or mixed configurations. The level of support
provided for a particular mix of network elements is determined by the
topology information it receives from the controllers. Some network element
controllers provide complete information about an entire configuration. Others
provide partial information about element types that they do not manage.
Some do not provide any information about network element types that are
not visible to them.
For information about the type of topology data provided by supported
controllers to the NDS server, see the section Topology consolidation by the
Network Data Server (NDS server) in the following documents:

Optical Service Provisioner Standard Operations Guide, 450-3251-028


OR

Layer 1 Network and Service Viewer Standard Operations Guide,


450-3261-301

Custom Topology command line tool overview


The Custom Topology component is managed by the Custom Topology
command line tool (topology_provisioner). You execute commands in the
Custom Topology command line tool to perform the following actions:

add topological links and user defined configuration (UDC) among


network elements

delete topological links and user defined configuration among network


elements

back up and restore the entire custom topology database

export the custom topological links to the screen or a file

list network elements and ports

list topological links and configurations for both network discovered and
user defined

audit the custom topological links

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

1-8 Custom Topology overview

Several commands use a Custom Topology file, which must be defined using
a specific format, as input. You create this file manually to define the
topological links between the network elements. For information on the
required format of this file, see Chapter 2, Custom Topology NDF file
description.
The Custom Topology file is in Network Data Format (NDF), a proprietary
Ciena file format.
The Custom Topology command line tool also supports Trail Manager
Network Builder files as input. This support is available to facilitate the
transition from Trail Manager to OSP. For specific details on transitioning from
Trail Manager to OSP, contact your Ciena representative.

Adding a link
Use the add command to add one or more topological links and user defined
configurations among network elements. Before executing the add command,
you must specify the network elements and define the topological links and/or
user defined configuration by creating the appropriate entries in the NDF file.
Figure 1-5 on page 1-8 shows an example of adding a topological link.
Figure 1-5
Adding a link
NM-50140.2.eps

NM-50140.2.eps

Add

Add
topological
link

NE_A

NE_A

Custom Topology

Custom topology

From

To

NE_B

NE_B

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology overview 1-9

Deleting a link
Use the delete command to delete one or more topological links and user
defined configurations among network elements. Before executing the delete
command, you must specify the network elements and define the topological
links and/or user defined configuration by creating the appropriate entries in
the NDF file.
Figure 1-6 on page 1-9 shows an example of deleting a topological link.
Figure 1-6
Deleting a link
NM-50140.2a.eps

NM-50140.2.eps

Delete
Delete
topological
link
NE_A
NE_A

Custom Topology

Custom Topology

To

From

NE_B

NE_B

Backing up and restoring topological data


Use the backup command and the restore command to back up and restore
all the data stored in Custom Topology on the NDS server.

ATTENTION
Custom Topology does not provide automatic or scheduled backup
functionality. You must explicitly initiate the backup and restore processes.
Since the preferred and alternate Custom Topology servers are not
synchronized automatically, you must use the backup and restore command
to maintain consistency between the redundant servers.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

1-10 Custom Topology overview

Exporting topological data


Use the export command to export topological data to the console (screen
display) or to an NDF file. You can export either the complete topological data
or data for a specific NE.

Listing NEs and ports


Use the listnes command to obtain a list of all the NEs managed by the NDS
server. Use the listports commands to list all the ports based on the NE
name. The lists can be exported to the console (screen display) or to an NDF
file.

Listing topological links and UDCs


Use the listlinks command to list all the links based on the NE name. Use
the listconfigs command to obtain a list of configurations based on the NE
name. The lists can be exported to the console (screen display) or to an NDF
file.

Auditing custom topological data


Use the audit command to audit the custom topological data against the
network discovered topological data. You can audit either the complete
topological data or data for a specific user defined configuration name. The
audit command can also be scheduled automatically. User can specify the
date of a week, time, and occurrence between the auditing. The variables are
defined in the intended.properties file.

Considerations
The following considerations apply to Custom Topology:

Links defined using Custom Topology are applied only when no user
defined configurations or adjacency information exist for the link (see
Topology consolidation by the NDS server on page 1-6).

If network topology changes after you have manually entered Custom


Topology data, you must explicitly update the Custom Topology by
executing the appropriate commands to reflect the changes.

The Custom Topology data for a given server can be managed using the
Custom Topology command line tool (topology_provisioner) that resides
on the same workstation.

You must manually enable the Custom Topology using the osp_admin
script after the completion of new installations for the NDS. If the server is
disabled, you will not be able to add NDF files into the Custom Topology
database.

If you are using a Solaris or Linux CO-resident setup as a standalone with


no redundancy configured, you must set the preferred custom topology
server to the localhost. If this setting is not configured, you will not see the
Custom Topology link that you have added into the database.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology overview 1-11

Once the option to set the IP address for the preferred Custom Topology
server is entered, you will be prompted to enter the server IP address. You
must enter the localhost if you are using a Solaris or Linux CO-resident
setup with no redundancies configured.

The successful addition of NDF file into the database does not mean that
the link/UDCs will be visible in OSP or NSV, even if the preferred server
is properly set.
NDS does not perform any validation on the links or UDCs, while the NDF
files are added. The validation is done when the links/UDCs are retrieved
and shown in OSP or NSV. If the links/UDCs are not created as prescribed
in the description section of the Custom Topology NDF file with
appropriate layer rates, the links/UDCs will be invalidated and will not be
visible in OSP or NSV.

The Custom Topology data for a given server can be managed using the
Custom Topology command line tool (topology_provisioner) that resides
on the same workstation.

Redundancy of Custom Topology data is supported by enabling the


Custom Topology servers on two separate NDS servers. During NDS
server installation, you are prompted for the IP addresses of the servers
where the Custom Topology component is to be deployed. One NDS
server with Custom Topology enabled is configured as the preferred
Custom Topology server and a second is configured as the alternate
Custom Topology server.

The preferred and alternate Custom Topology servers are not


synchronized. You must use the backup and restore command in the
Custom Topology command line tool to maintain consistency between the
redundant servers. You can also use the export and add commands to
facilitate the process.

You must manually back up and restore Custom Topology data when
required. The backup and restore command in the Custom Topology
command line tool provide this functionality.

If the AP NE ID of an NE has changed, and if Custom Topology was used,


ensure the AP NE ID is also changed in the Custom Topology database
by following the procedure, Changing an AP NE ID on page 4-14.

Logs
Custom Topology writes records of activity into a number of audit logs and
Custom Topology logs, as described below.

Audit logs
Custom Topology writes records of user-initiated actions. Audit logs are useful
to administrators who need to know when an action was taken, by whom, and
whether the action was successful.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

1-12 Custom Topology overview

Audit logs are written to the custom-topology-audit.log file in the following


directories on the workstation where the Custom Topology component is
enabled:

On an HP workstation: /opt/nortel/logs

On a Solaris/Linux workstation: /opt/nortel/logs/applications/nds

Up to 5 files of archived logs, each with a maximum size of 5 MB, are retained.
Table 1-1 on page 1-12 lists the Custom Topology audit logs.
Table 1-1
Audit logs
Log text

ID

Custom Topology add links requested

NDS.CT.USR00011

Custom Topology link added successfully

NDS.CT.USR00012

Custom Topology links added successfully

NDS.CT.USR00013

Custom Topology links added partially successfully

NDS.CT.USR00014

Failed to add a Custom Topology Link <Reason>

NDS.CT.USR00015

Failed to add Custom Topology Links <Reason>

NDS.CT.USR00016

Add Custom Topology link request ignored <Reason>

NDS.CT.USR00017

Custom Topology delete links requested

NDS.CT.USR00021

Custom Topology link deleted successfully

NDS.CT.USR00022

Custom Topology links deleted successfully

NDS.CT.USR00023

Custom Topology links deleted partially successfully

NDS.CT.USR00024

Failed to delete a Custom Topology Link <Reason>

NDS.CT.USR00025

Failed to delete Custom Topology Links <Reason>

NDS.CT.USR00026

Delete Custom Topology link request ignored <Reason>

NDS.CT.USR00027

Custom Topology export links requested

NDS.CT.USR00031

Custom Topology links exported successfully

NDS.CT.USR00032

Failed to export Custom Topology links <Reason>

NDS.CT.USR00036

Custom Topology clear database requested

NDS.CT.USR00041

Custom Topology database cleared successfully

NDS.CT.USR00042

Failed to clear database

NDS.CT.USR00046

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology overview 1-13


Table 1-1
Audit logs (continued)
Log text

ID

Custom Topology backup database requested

NDS.CT.USR00051

Custom Topology database backed up successfully

NDS.CT.USR00052

Failed to back up database

NDS.CT.USR00056

Custom Topology restore database requested

NDS.CT.USR00061

Custom Topology database restored successfully

NDS.CT.USR00062

Failed to restore database

NDS.CT.USR00066

Custom Topology audit links requested

NDS.CT.USR00071

Custom Topology links audited successfully

NDS.CT.USR00072

Failed to audit Custom Topology links

NDS.CT.USR00076

The log format is as follows:


<local timestamp> CT <hostname> <process ID> - <message ID>
<message>
For request audit logs, the <message> field contains the following information
for the message text (MSG.TEXT, see the examples that follow for details):

file name

format (Custom Topology file format): NDF or Trail Manager Network


Builder files

NE name (for export request, if applicable)

For link event audit logs, the <message> field contains the following
information for the message text (MSG.TEXT, see the examples that follow for
details):

absolute path name of the file

NE1 name

NE2 name

port1 (in universal format)

port 2 (in universal format)

rate

direction

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

1-14 Custom Topology overview

The following is an example of the log generated when the user attempts to
add links:
2006-08-09 11:21:09.939 EDT CT wcarh11g - - CTALLog: Priority=0
eventType=0 STAT=Custom Topology add links requested SRC.USR=root
MSG.TEXT=File Name=/opt/nortel/osp/example.ndf Format=ndf
MID=NDS.CT.USR00011 ALARM=false
The following is an example of the log generated when an admin user adds a
link:
2006-04-18 17:51:19.215 EST CT wcarh11f 11041 - CTALLog: Priority="0"
eventType="0" STAT="Custom Topology add link request."
SRC.USR="admin" MSG.TEXT=";NE1=Toronto;
NE1RDN=47.130.128.188/0/2901;
Port1=1/3/1;NE2=Montreal; NE2RDN=47.130.25.186:33000/0/2901;
Port2=1/3/2;Rate=MS OC12; Dir=Bi;"MID="NDS.CT.USR00011"
ALARM="false"
The following is an example of the log generated when a link requested by an
admin user cannot be added due to a conflict:
2006-05-26 00:32:08.312 EDT CT wcarh11j - - CTALLog: Priority="0"
eventType="0" STAT="Failed to add a Custom Topology Link." Reason: "ne1
is conflict with the existing tp." SRC.USR="admin"
MSG.TEXT="NE1=Toronto; NE2=EXPGX0001S;
Port1=/rack=1/shelf=3/sub_shelf=0/slot=9/sub_slot=0/port=8;
Port2=/rack=1/shelf=0/sub_shelf=0/slot=4/sub_slot=0/port=2;Rate=24;
Direction=BIDIRECTIONAL" MID="NDS.CT.USR00015" ALARM=false
CTAL refers to Custom Topology Audit Log.

Custom Topology logs


Custom Topology logs are generated when an error occurs for a user initiated
action. Details about these errors are included in the Custom Topology log file.
All Custom Topology logs are written to the custom-topology.log file in the
following directories on the workstation where the Custom Topology
component is enabled:

On an HP workstation: /opt/nortel/logs

On a Solaris/Linux workstation: /opt/nortel/logs/applications/nds

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology overview 1-15

The following is an example of the log generated when a link cannot be added
due to a conflict:
"2006-09-22 17:28:34.085 EDT CT wcarh12y 26852 - Custom topology
WARNING: User provisioned topology is being suppressed because port
/IPC=47.134.24.194-CT=0-NeId=2175
/rack=-1/shelf=2/sub_shelf=0/slot=4/sub_slot=0/port=1(_2/4/1) is not valid.
Reason: PORT NOT FOUND IN CACHE"

System responses
Custom Topology provides system responses to successful command
execution as well as error messages for failed commands. Error and warning
messages are displayed on the console or recorded in the Custom Topology
log, or Custom Topology audit log.
For add, delete, export, and audit commands, the error message contains the
list of links on which the operation failed. The reasons for failures are listed for
the links.
Table 1-2
System responses
Response

Description

Syntax errors
Unknown command

The command entered is not supported.

Invalid option

The option for the given command is invalid.

Missing option

The command expects an option that was not provided. For example,
./topology_provisioner -c add ndf -i ms.ndf
invalid token found on command-line : ndf
usage : ./topology_provisioner -c add -f {tm | ndf}
-i filename

Option appears more


than once

A duplicated option appears in the command.

Command line execution messages


Custom topology server
not available

Unable to connect to the Custom Topology server. Ensure that Custom


Topology is enabled on the server.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

1-16 Custom Topology overview


Table 1-2
System responses (continued)
Response

Description

<command> Request
completed successfully

The command request completed successfully.

<command> Request
failed

The command request, i.e. add, delete, clear, export, audit, etc. failed. User
is required to check the custom topology logs for details.

<command >Request
partially succeeded

The command was partially executed.


Check the Custom Topology logs for details.

Administrative functions
Custom Topology installed on an HP workstation
The Custom Topology functions available to a user depend upon Applications
Platform (AP) user class permissions and access control settings.
To run the Custom Topology command line tool and/or view Custom Topology
data, you require unix nocadm group security privileges.

Custom Topology installed on a Solaris/Linux workstation


To run the Custom Topology command line tool and/or view Custom Topology
data, you require the Manager for 6k, OM5k and CPL user ID with read / write
/ admin access privileges to the Layer 1 NSV or OSP application. These
privileges are set in the Manager for 6k, OM5k and CPL application. For
information for the Manager for 6k, OM5k and CPL access privileges, see
OneControl Security Administration Procedures, 450-3201-351.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

450-3251-189
2-1

Custom Topology NDF file description

2-

Custom Topology files are used to define the topological links between
network elements. This chapter describes the required format and parameters
of the Custom Topology NDF file (see Note).
To run certain Custom Topology commands, you must manually create the
NDF file with the appropriate format and parameters for the links you want to
manipulate using Custom Topology. This is required, for example, when you
are not using the autodiscovery feature, or when you are using autodiscovery
with links that cannot be autodiscovered. You must create and save the NDF
file with a UNIX text editor, such as Vi, Vim, or Emacs.You can also use
Microsoft Excel to create NDF files since NDF files are in a tab-delimited
format.
The Custom Topology command line tool also supports Trail Manager
Network Builder files as input. This support is available to facilitate the
transition from Trail Manager to OSP. For specific details on transitioning from
Trail Manager to OSP, contact your Ciena representative.
The Custom Topology commands that require the NDF file as input are as
follows:

add

delete

NDF file name


The NDF file can have any name that you create.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

2-2 Custom Topology NDF file description

NDF file location


To run the Custom Topology commands that require an NDF file as input, the
NDF file must be located in a directory on the NDS server that has Custom
Topology enabled. The file can be located in any directory; however, Ciena
recommends that you use the following directory, which is manually created
during the OSP or Layer 1 NSV install or upgrade.

On an HP workstation: /opt/nortel/nds_data

On a Solaris/Linux workstation: /opt/nortel/nds_data

You must specify the full path of the topology_provisioner tool when using it
from this directory.
By default, you run the topology_provisioner command line tool from the
/opt/nortel/bin/osp directory.

NDF file format


The Custom Topology file can consist of four sections, as listed in Table 2-1
on page 2-2.
Table 2-1
Sections in the NDF file
Section

Description

NES

Network elements: defines each managed network element.

SUBNETS

Subnets: define network structure and properties. Network


structure is a set of collections of links.

MS

Multiplex section: defines each link between NEs (excluding


regenerators) that terminate MS.

OT

Optical transmission section: defines each link between optical


line amplifiers, or line amplifiers and optical multiplexer
combined ports.

OP

Optical path: defines each link between electro-optical


transmitters and receivers in an optical network.

Note: Intra-shelf links should always be added in the OT section.

The NES section is mandatory. Include the SUBNETS, MS, OT, and OP
sections as required, depending on the links you want to create.
Each section in the NDF file must include a header consisting of two lines: the
first line identifies the section (NES, SUBNETS, MS, OT, or OP), and the
second line lists the names of the parameters in the section.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology NDF file description 2-3

NES section
Table 2-2 on page 2-3 lists the parameters required in the NES section of the
NDF file.
Table 2-2
NES section
Format
Parameter

Description

Example

NE

Customer NE name string in the network

Ottawa

NE.Num

NE identifier on the NE controller (element 2912


manager)

EMS.Addr.IP

IP address of the NE controller and


controller type number

47.134.26.205/0

Rules
The NDF file always includes the NES section.
The first two lines of the NES section define the header of the section. The first
line consists of the section name: NES. The second line lists the names of the
parameters in this section: NE, NE.Num, EMS.Addr.IP.
Each line in the file must represent an NE.
The data for an NE must be on a single line.
The parameters must appear in the order of the format shown above.
Tab must be used as a delimiter. In other words, a tab must be used to separate
parameters. Do not include any spaces between parameters.
The NE parameter is case sensitive. Custom Topology does not support empty
NE names.
The NE identifier must be between 1-65535.
All parameters are required.
Blank lines are ignored.
Figure 2-1
Example of NES section
NES
NE
ARUBA
BONAIRE
LON1050
PAR2020
Ottawa
Toronto

NE.Num
8552
8553
1001
2000
2912
2913

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

EMS.Addr.IP
47.134.26.183:33000/0
47.134.26.183/0
47.135.100.21/0
47.130.23.4/0
47.134.26.205/0
47.134.26.205/0

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

2-4 Custom Topology NDF file description

SUBNETS section
Table 2-3 on page 2-4 lists the parameters required in the SUBNETS section
of the NDF file.
Table 2-3
SUBNETS section
Format
Parameter

Description

Example

Subnet

Subnetwork name

Ontario_East

Type

The type of subnetwork

UPSR

Rate

The layer rate of the subnetwork

MS, OP, OT, or -

Rules
The first two lines of the SUBNETS section define the header of the section. The
first line consists of the section name: SUBNETS. The second line lists the names
of the parameters in this section: Subnet, Type, Rate.
Subnet can be a string of 1 to 255 characters. The subnetwork name must be
unique across the network.
Type can be pre-defined or user defined. For user defined configuration, type can
be a string of 1 to 255 characters. Pre-defined configuration types include: UPSR,
OSID, and MESH.
Do not use the following special characters in the Subnet name or Type:
"`~!@#$%^*='?/]|:
The parameters must appear in the order of the format shown above.
Tab must be used as a delimiter. In other words, a tab must be used to separate
parameters. Do not include any spaces between parameters.
All parameters except Rate are required. Rate is optional.
Blank lines are ignored.
Figure 2-2
Example of SUBNETS section
SUBNETS
Subnet
Ontario_East
Ottawa_East
CanEast

Type
UPSR
MESH
MyConfig

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Rate
MS
MS

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology NDF file description 2-5

MS section
Table 2-4 on page 2-5 lists the parameters required in the MS section of the
NDF file.
Table 2-4
MS section
Format
Parameter

Description

Example

Id

MS identifier

01

NE1

NE name of the source NE

Ottawa

NE1.EMS_Num

<Controller IP address>/<controller type>/<source 47.134.26.205/0/2912


NE ID>

NE2

NE name of the destination NE

Toronto

NE2.EMS_Num

<Controller IP address>/<controller
type>/<destination NE ID>

47.130.26.205/0/2913

Port1

Source port: _<shelf.subshelf>/<slot.subslot>/


<port>

_2.1/2.3/1

Port2

Destination port:
_<shelf.subshelf>/<slot.subslot>/
<port>

_2/2/1

Subnet

Subnetwork name

Ontario_East
Rules

The first two lines of the MS section define the header of the section. The first line consists of the
section name: MS. The second line lists the names of the parameters in this section: Id, NE1,
NE1.EMS_Num, NE2, NE2.EMS_Num, Port1, and Port2.
The MS identifier for each link must be unique.
Each line in the section must represent an MS link.
The data for a link must be on a single line.
The parameters must appear in the order of the format shown above.
Tab must be used as a delimiter. In other words, a tab must be used to separate parameters. Do not
include any spaces between parameters.
The NE parameter is case sensitive. Custom Topology does not support empty NE names.
EMS_Num is used to uniquely identify an NE in the network. If no duplicated NE names exist in the
network, the value can be "-"; otherwise, you must provide the actual value.
All parameters except Subnet are required. Subnet is optional.
Blank lines are ignored.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

2-6 Custom Topology NDF file description


Figure 2-3
Example of MS section
MS
Id
0
1
2
3
4
5

NE1
NE1.EMS_Num
NE2
NE2.EMS_Num
Port1
Port2
Subnet
ARUBA
47.134.26.183/0/8552 BONAIRE 47.134.26.183/0/8553 _1/2/1 _1/2/1 ARUBA
47.134.26.183/0/8552 BONAIRE 47.134.26.183/0/8553 _1/3/1 _1/3/1 LON1050 47.135.100.21/0/1001 PAR2020 47.130.23.4/0/2000
_1/3/1 _1/6/2 ARUBA
47.134.26.183/0/8552 BONAIRE 47.134.26.183/0/8553 _0/4/1 _0/4/1 Ottawa 47.134.26.205/0/2912 Toronto 47.134.26.205/0/2913 _2/2/1 _2/2/1 Ottawa 47.134.26.205/0/2912 Toronto 47.134.26.205/0/2913 _2/4/1 _2/4/1 -

OT section
Table 2-5 on page 2-6 lists the parameters required in the OT section of the
NDF file.
Table 2-5
OT section
Format
Parameter

Description

Example

Id

OT identifier

01

NE1

NE name of the source NE

LON1050

NE1.EMS_Num

<Controller IP address>/<controller
type>/<source NE ID>

47.134.26.205/0/1001

NE2

NE name of the destination NE

PAR2020

NE2.EMS_Num

<Controller IP address>/<controller
type>/<destination NE ID>

47.130.23.4/0/2000

Port1

Source port: _<shelf.subshelf>/<slot.subslot>/


<port>

_1/4/9

Port2

Destination port:
_<shelf.subshelf>/<slot.subslot>/<port>

_0/11/10

Dir

Link direction:

->

Can be one of the following


-> Unidirectional link from NE1 to NE2
<- Unidirectional link from NE2 to NE1
<> A pair of unidirectional links
== Bidirectional link on a single fiber
Subnet

Subnetwork name

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Ontario_East

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology NDF file description 2-7


Table 2-5
OT section (continued)
Rules
The first two lines of the OT section define the header of the section. The first line consists of the
section name: OT. The second line lists the names of the parameters in this section: Id, NE1,
NE1.EMS_Num, NE2, NE2.EMS_Num, Port1, Port2, and Dir.
Each line in the section must represent an OTS link.
The data for a link must be on a single line.
The parameters must appear in the order of the format shown above.
Tab must be used as a delimiter. In other words, a tab must be used to separate parameters. Do not
include any spaces between parameters.
The NE parameter is case sensitive. Custom Topology does not support empty NE names.
EMS_Num is used to uniquely identify an NE in the network. If no duplicated NE names exist in the
network, the value can be "-"; otherwise, you must provide the actual value.
All parameters except Subnet are required. Subnet is optional.
Blank lines are ignored.
Figure 2-4
Example of OT section
OT
Id
0
1
2
3

NE1
GMD1
GMD1
GMD1
GMD1

NE1.EMS_Num
47.134.40.101/0/33
47.134.40.101/0/33
47.134.40.101/0/33
47.134.40.101/0/33

NE2
Mesh
Mesh
Mesh
Mesh

NE2.EMS_Num
47.134.40.101/0/28
47.134.40.101/0/28
47.134.40.101/0/28
47.134.40.101/0/28

Port1
_1/4/9
_1/2/9
_1/1/9
_1/3/9

Port2
_0/11/10
_0/9/10
_0/8/10
_0/10/10

Dir
->
->
==
<-

Subnet
-

OP section
Table 2-6 on page 2-7 lists the parameters required in the OP section of the
NDF file.
Table 2-6
OP section
Format
Parameter

Description

Example

Id

OP identifier

01

NE1

NE name of the source NE

LON1050

NE1.EMS_Num

<Controller IP address>/<controller
type>/<source NE ID>

47.134.26.205/0/1001

NE2

NE name of the destination NE

PAR2020

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

2-8 Custom Topology NDF file description


Table 2-6
OP section (continued)
NE2.EMS_Num

<Controller IP address>/<controller type>/


<destination NE ID>

47.130.23.4/0/2000

Port1

Source port: _<shelf.subshelf>/<slot.subslot>/


<port>

_1/4/9

Port2

Destination port:
_<shelf.subshelf>/<slot.subslot>/<port>

_0/11/10

Dir

Link direction:

->

Can be one of the following


-> Unidirectional link from NE1 to NE2
<- Unidirectional link from NE2 to NE1
<> A pair of unidirectional links
== Bidirectional link on a single fiber
Subnet

Subnetwork name

Ontario_East
Rules

The first two lines of the OP section define the header of the section. The first line consists of the
section name: OP. The second line lists the names of the parameters in this section: Id, NE1,
NE1.EMS_Num, NE2, NE2.EMS_Num, Port1, Port2, and Dir.
Each line in the section must represent an OP link.
The data for a link must be on a single line.
The parameters must appear in the order of the format shown above.
Tab must be used as a delimiter. In other words, a tab must be used to separate parameters. Do not
include any spaces between parameters.
The NE parameter is case sensitive. Custom Topology does not support empty NE names.
EMS_Num is used to uniquely identify an NE in the network. If no duplicated NE names exist in the
network, the value can be "-"; otherwise, you must provide the actual value.
All parameters except Subnet are required. Subnet is optional.
Blank lines are ignored.
Figure 2-5
Example of OP section
OP
Id
0
1
2
3
4

NE1
Mesh
5k10
5k10
5k10
Mesh

NE1.EMS_Num
47.134.40.101/0/28
47.134.25.153/0/10
47.134.25.153/0/10
47.134.25.153/0/10
47.134.40.101/0/28

NE2
GMD1
5k20
5k20
5k20
GMD1

NE2.EMS_Num
47.134.40.101/0/33
47.134.25.153/0/12
47.134.25.153/0/12
47.134.25.153/0/12
47.134.40.101/0/33

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Port1
_0/9/10
_0/11/11
_0/13/1
_0/14/1
_0/9/10

Port2
_1/2/9
_0/15/11
_0/5/1
_0/13/1
_1/2/9

Dir
==
==
==
==
==

Subnet
-

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology NDF file description 2-9

NDF file for UPSR/SNCP configuration: example


The following example shows the NDF file entries required to add the
topological links for the UPSR/SNCP displayed in Figure 2-6 on page 2-9.
Figure 2-6
UPSR/SNCP configuration
UPSR example.eps

311 Halifax
x

Near-end
network element
w

x
Pass-through
network element 1

444 Baddeck

Pass-through
network element 2

441 Louisbourg
w

x
Far-end
network element
w
x

Switch
mate

Legend
= Optical interface
443 Sydney

= Signal
= Path selector

Note: w and x represent line slot numbers (slots 11 and 12) for the optical
interfaces.

Figure 2-7
Required NDF file entries:
NES
NE
Halifax
Baddeck
Sydney
Louisbourg
MS
Id
0
1
2
3

NE.Num
311
444
443
441

NE1
Halifax
Halifax
Baddeck
Louisbourg

EMS.Addr.IP
47.134.26.183/0
47.134.26.183/0
47.134.26.183/0
47.134.26.183/0

NE1.EMS_Num
47.134.26.183/0/311
47.134.26.183/0/311
47.134.26.183/0/444
47.134.26.183/0/441

NE2
Louisbourg
Baddeck
Sydney
Sydney

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

NE2.EMS_Num
47.134.26.183/0/441
47.134.26.183/0/444
47.134.26.183/0/443
47.134.26.183/0/443

Port1
_0/11/1
_0/12/1
_0/12/1
_0/11/1

Port2
_0/12/1
_0/11/1
_0/11/1
_0/12/1

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

2-10 Custom Topology NDF file description

NDF file for user defined configuration: example


Figure 2-8 on page 2-10 shows the NDF file entries required to add a user
defined configuration. The configuration is based on the example shown in
Figure 2-6 on page 2-9 and is defined with a UDC name of CanEast.
Figure 2-8
Required NDF file entries:
NES
NE
Halifax
Baddeck
Sydney
Louisbourg

NE.Num
311
444
443
441

EMS.Addr.IP
47.134.26.183/0
47.134.26.183/0
47.134.26.183/0
47.134.26.183/0

SUBNETS
Subnet
CanEast

Type
MyRing

Rate
MS

MS
Id
0
1
2
3

NE1
Halifax
Halifax
Baddeck
Louisbourg

NE1.EMS_Num
47.134.26.183/0/311
47.134.26.183/0/311
47.134.26.183/0/444
47.134.26.183/0/441

NE2
Louisbourg
Baddeck
Sydney
Sydney

NE2.EMS_Num
47.134.26.183/0/441
47.134.26.183/0/444
47.134.26.183/0/443
47.134.26.183/0/443

Port1
_0/11/1
_0/12/1
_0/12/1
_0/11/1

Port2
Subnet
_0/12/1 CanEast
_0/11/1 CanEast
_0/11/1 CanEast
_0/12/1 CanEast

NDF files for the Manager for 6k, OM5k and CPL redundant server
configuration: example
The following example shows the entries in NDF file 1 and NDF file 2 that are
required for the Manager for 6k, OM5k and CPL redundant server
configuration.
The Manager for 6k, OM5k and CPL redundant server configuration requires
the addition of a link between two network elements (NE). To add this link,
create two NDF files with the appropriate IPs (both primary and secondary
controller IPs) and add the NDF files to both NDS servers. The addition of the
NDF files to both NDS servers allows the Layer 1 NSV and OSP to display the
link details.
In the Manager for 6k, OM5k and CPL redundant server configuration, the
NDS servers communicate with the Manager for 6k, OM5k and CPL master
server (see Figure 2-9 on page 2-11). In the event of a mastership switch, both
NDS servers communicate with the Manager for 6k, OM5k and CPL
secondary server which has now become the Manager for 6k, OM5k and CPL
master server (see Figure 2-10 on page 2-11).
In this example, the first Manager for 6k, OM5k and CPL IP is 1.1.1.1 and the
secound Manager for 6k, OM5k and CPL IP is 2.2.2.2. NEA and NEB are the
NEs managed by the Manager for 6k, OM5k and CPL. For examples of the
required NDF file entries, see Required entries in NDF file 1 and Required
entries in NDF file 2.
OneControl - OSP and Layer 1 NSV
Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology NDF file description 2-11


Figure 2-9
Manager for 6k, OM5k and CPL redundant server configurationbefore mastership switch

NDS1

NDS2

OMEA1
(primary)
Master

OMEA2
(secondary)
Slave

Figure 2-10
Manager for 6k, OM5k and CPL redundant server configurationafter mastership switch

NDS1

NDS2

OMEA1
(primary)
Slave

OMEA2
(secondary)
Master

Figure 2-11
Required entries in NDF file 1
NES
NE
1
2

MS
Id
1

NE.Num
NEA
NEB

NE1
NEA

EMS.Addr.IP
1.1.1.1/0
1.1.1.1/0

NE1.EMS_Num
1.1.1.1/0/1

NE2
NEB

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

NE2.EMS_Num
1.1.1.1/0/2

Port1
<port1>

Port2
Subnet
<port2> <UDC name, if any>

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

2-12 Custom Topology NDF file description


Figure 2-12
Required entries in NDF file 2
NES
NE
1
2

MS
Id
1

NE.Num
NEA
NEB

NE1
NEA

EMS.Addr.IP
2.2.2.2/0
2.2.2.2/0

NE1.EMS_Num
2.2.2.2/0/1

NE2
NEB

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

NE2.EMS_Num
2.2.2.2/0/2

Port1
<port1>

Port2
<port2>

Subnet
<UDC name, if any>

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

450-3251-189
3-1

Custom Topology procedures

3-

This chapter describes basic Custom Topology procedures. These


procedures form the building blocks for using the Custom Topology command
line tool to manually define topological links. Administrative procedures for
backing up and restoring data, exporting data to a screen or file, and listing
network elements and ports in the network are also provided.

Requirements
To perform the procedures in this chapter, you must:

read Chapter 1, Custom Topology overview

read Chapter 2, Custom Topology NDF file description to ensure that you
have a good understanding of the NDF file

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

know how to use UNIX commands

Custom Topology command line interface


The Custom Topology user interface is the topology_provisioner
command line tool.
Run the topology_provisioner tool from the following directory:

On an HP workstation: /opt/nortel/nds_data

On a Solaris/Linux workstation: /opt/nortel/nds_data

From the above directory, use the following path to run the
topology_provisioner command:
/opt/nortel/bin/osp/topology_provisioner

Table 3-1 on page 3-2 describes the syntax of topology_provisioner


command line tool. It is provided here as a reference. This chapter provides
detailed usage instructions for the topology_provisioner commands.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-2 Custom Topology procedures


Table 3-1
Syntax and description
Syntax
topology_provisioner -c <command> [-f ndf] [-n <ne_name>] [-s <sn_name>]
[-i <file_name>] [-o <file_name>] [-l <user_name>]
To display usage information for the topology_provisioner command line tool on the screen,
enter: topology_provisioner -h
Legend:
<> indicates variable parameters
[ ] indicates options
Parameter/Option Description
<command>

-f ndf

Specify the command to execute:


add

Add the links defined in the specified NDF file.

delete

Delete the links defined in the specified NDF file.

clear

Clear the data stored in Custom Topology.

export

Output the data stored in Custom Topology. The data can be


output to the screen or to a user-readable NDF file with a
specified file name.

listnes

List information about each managed NE in the AP federation.

listports

List information about each port for the specified NE.

listlinks

List information about each link for the specified NE.

listconfigs

List information about each configuration for a specified NE,


including 2F BLSR, linear 1+1, OSID, and user defined
configurations.

backup

Output all data stored in Custom Topology to a format applicable


for backup and restore purposes (this format is not user
readable).

restore

Import data stored in a backup file.

audit

Audit the links against network learned links for a specific user
defined configuration name or all custom topology links.

Indicate that the command must process a file in NDF format.


This option is used with the add and delete commands.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-3


Table 3-1
Syntax and description (continued)
Syntax
topology_provisioner -c <command> [-f ndf] [-n <ne_name>] [-s <sn_name>]
[-i <file_name>] [-o <file_name>] [-l <user_name>]
To display usage information for the topology_provisioner command line tool on the screen,
enter: topology_provisioner -h
Legend:
<> indicates variable parameters
[ ] indicates options
Parameter/Option Description
-n <ne_name>

List the links or ports or configurations specific to a single NE. The NE name value
can be enclosed in quotations to accommodate names with spaces. Custom
Topology does not support empty NE names.
This option is used with the export, listports, listlinks, and
listconfigs command.

-s <sn_name>

List or audit the links specific to a single user defined configuration name. The user
defined configuration name value can be enclosed in quotations to accommodate
names with spaces.
This option is used with the export and audit commands.

-i <file_name>

Specify the name of an input file.


This option is used with the add, delete, and restore commands.

-o <file_name>

Specify the name of an output file.


This option is used with the export, listnes, listports, listlinks,
listconfigs, and backup commands.

-l <user_name>

When running Custom Topology from a Sun workstation, this option is required.
Specify a valid Manager for 6k, OM5k and CPL user ID that has read / write / admin
security privileges to the Layer 1 NSV or OSP application. For more information,
see Administrative functions on page 1-16.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-4 Custom Topology procedures

Table 3-2 on page 3-4 provides a quick reference of the usage for each
supported topology_provisioner command.
Table 3-2
Options applicable for each command
Command

Usage

add

topology_provisioner -c add -f ndf -i <file_name>


[-l <user_name>]

delete

topology_provisioner -c delete -f ndf -i <file_name>


[-l <user_name>]

clear

topology_provisioner -c clear [-l <user_name>]

export

topology_provisioner -c export [-n <ne_name>|-s <sn_name>]


[-o <file_name>] [-l <user_name>]

listnes

topology_provisioner -c listnes [-o <file_name>]


[-l <user_name>]

listports

topology_provisioner -c listports -n <ne_name>


[-o <file_name>] [-l <user_name>]

listlinks

topology_provisioner -c listlinks -n <ne_name> [-o <file_name>] [-l


<user_name>]

listconfigs

topology_provisioner -c listconfigs [-n <ne_name>]


[-o <file_name>] [-l <user_name>]

backup

topology_provisioner -c backup -o <file_name> [-l <user_name>]

restore

topology_provisioner -c restore -i <file_name> [-l <user_name>]

audit

topology_provisioner -c audit [-s <sn_name>] [-l <user_name>]

help

topology_provisioner -h [-l <user_name>]

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-5

Procedures

Procedure 3-1, Adding topological links

Procedure 3-2, Deleting topological links

Procedure 3-3, Displaying topological links

Procedure 3-4, Exporting topological links to an NDF file

Procedure 3-5, Displaying the list of NEs managed by the NDS server

Procedure 3-6, Exporting the list of NEs managed by the NDS server

Procedure 3-7, Displaying NE endpoint information

Procedure 3-8, Exporting NE endpoint information

Procedure 3-9, Displaying link information

Procedure 3-10, Exporting link information

Procedure 3-11, Displaying configuration information

Procedure 3-12, Exporting configuration information to an NDF file

Procedure 3-13, Clearing data from Custom Topology

Procedure 3-14, Performing an audit of the Custom Topology links

Procedure 3-15, Backing up Custom Topology data

Procedure 3-16, Restoring Custom Topology data

Procedure 3-17, Synchronizing the preferred and alternate Custom


Topology servers

Procedure 3-18, Displaying help

ATTENTION
The procedures in this chapter refer to the nds_data and the nds_backup
directories. These directories should have been created during OSP or Layer
1 NSV installation. However, if these directories were not created during
installation, you must create them now. For more information, refer to the
Optical Service Provisioner Installation and Configuration Guide,
450-3251-201, or the Layer 1 Network and Service Viewer Installation and
Configuration Guide, 450-3261-201.

ATTENTION
Make sure that the server and all the services are running before executing
any operation for the Topology Provision.

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-6 Custom Topology procedures

Procedure 3-1
Adding topological links
Use this procedure to add one or more topological links.
Link conflicts

If a link end specified in the NDF file you created is already in use, an error
message will be displayed when you execute the add command. Also, the
following two NDF files will be automatically generated:
<file_name>.<timestamp>.del and <file_name>.<timestamp>.add
To clear the link conflict, first delete the duplicated link by executing the delete
command using the <file_name>.<timestamp>.del NDF file as input.
Then, execute the add command using the <file_name>.<timestamp>.add
NDF file as input.

Requirements
To perform this procedure, you must:

define the links in an NDF file. For more information on creating an NDF
file, see Chapter 2, Custom Topology NDF file description.

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-7


Procedure 3-1 (continued)
Adding topological links
Step

Action

Execute the add command by entering:


/opt/nortel/bin/osp/topology_provisioner -c add -f ndf -i
<file_name>
where
<file_name>

is the file name of the NDF file you created that


defines the topological links to add.

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

If an error message specifies that a link conflict exists, see Link conflicts
on page 3-6 at the beginning of this procedure for more information.

The topological links are added.


You have completed this procedure.
4

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the add command by entering:


/opt/nortel/bin/osp/topology_provisioner -c add -f ndf -i
<file_name> -l <user_name>
where
<file_name>

is the file name of the NDF file you created that defines
the topological links to add.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that


has read / write / admin security privileges to the Layer
1 NSV or OSP application.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-8 Custom Topology procedures


Procedure 3-1 (continued)
Adding topological links
Step

Action

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

If an error message specifies that a link conflict exists, see Link conflicts
on page 3-6 at the beginning of this procedure for more information.

The topological links are added.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-9

Procedure 3-2
Deleting topological links
Use this procedure to delete one or more topological links.

Requirements
To perform this procedure, you must:

define the links in an NDF file. For more information on creating an NDF
file, see Chapter 2,Custom Topology NDF file description.

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the delete command by entering:


/opt/nortel/bin/osp/topology_provisioner -c delete -f ndf
-i <file_name>
where
<file_name>

is the file name of the NDF file you created that


defines the topological links to delete.

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The topological links are deleted.


You have completed this procedure.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-10 Custom Topology procedures


Procedure 3-2 (continued)
Deleting topological links
Step

Action

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the delete command by entering:


/opt/nortel/bin/osp/topology_provisioner -c delete -f ndf
-i <file_name> -l <user_name>
where

<file_name>

is the file name of the NDF file you created that


defines the topological links to add.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that


has read / write / admin security privileges to the
Layer 1 NSV or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The topological links are deleted.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-11

Procedure 3-3
Displaying topological links
Use this procedure to display custom topological links on the console
(screen). You can display either all links or links that include a specific network
element or user defined configuration.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-12 Custom Topology procedures


Procedure 3-3 (continued)
Displaying topological links
Step

Action

Execute the export command by entering:


/opt/nortel/bin/osp/topology_provisioner -c export
[-n <ne_name>|-s <sn_name>]
where
-n

is the option for specifying a specific NE. If you want to


display all custom topological links, omit -n.

<ne_name>

is the name of NE for which you want to display links. If the


NE name includes spaces, enclose ne_name in double
quotation marks (). If you want to display all custom
topological links, omit ne_name.

-s

is the option for specifying a specific user defined


configuration. If you want to display all custom topological
links, omit -s.

<sn_name>

is the name of user defined configuration for which you


want to display links. If the name includes spaces, enclose
sn_name in double quotation marks (). If you want to
display all custom topological links, omit sn_name.

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The topological links are displayed.


You have completed this procedure.
4

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-13


Procedure 3-3 (continued)
Displaying topological links
Step

Action

Execute the export command by entering:


/opt/nortel/bin/osp/topology_provisioner -c export
[-n <ne_name>|-s <sn_name>] -l <user_name>
where

-n

is the option for specifying a specific NE. If you want to


display all custom topological links, omit -n.

<ne_name>

is the name of NE for which you want to display links. If the


NE name includes spaces, enclose ne_name in double
quotation marks (). If you want to display all custom
topological links, omit ne_name.

-s

is the option for specifying a specific user defined


configuration. If you want to display all custom topological
links, omit -s.

<sn_name>

is the name of user defined configuration for which you


want to display links. If the name includes spaces, enclose
sn_name in double quotation marks (). If you want to
display all custom topological links, omit sn_name.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that has
read / write / admin security privileges to the Layer 1 NSV
or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The topological links are displayed.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-14 Custom Topology procedures

Procedure 3-4
Exporting topological links to an NDF file
Use this procedure to export custom topological links to an NDF file. You can
export either all links or links that include a specific network element or user
defined configuration.
Exporting links for a specific network element or user defined configuration is
useful for isolating the topological links for network element cut-in, cut-out,
and topology reconfiguration scenarios.
Duplicate NE names

If duplicate NE names exist in the network, an NDF file is created for each NE
with the same name. The file name for the multiple NDF files have the
following format:
<file_name>.<ne_name>.<controller_IP>_<controller_type>_
<ne_id>.<time_stamp>.ndf
where
<file_name>

is the NDF file name you specify in this procedure


(see below for details)

<ne_name>

is the NE name you specify in this procedure


(see below for details)

<controller_IP>

is the IP address of the controller (element


manager)

<controller_type>

is the number of the controller type

<ne_id>

is the network element ID

<time_stamp>

is the time stamp

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-15


Procedure 3-4 (continued)
Exporting topological links to an NDF file

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the export command by entering:


/opt/nortel/bin/osp/topology_provisioner -c export
[-n <ne_name>|-s <sn_name>] -o <file_name>
where
-n

is the option for specifying a specific NE. If you want


to export all custom topological links, omit -n.

<ne_name>

is the name of NE for which you want to export links.


If the NE name includes spaces, enclose ne_name in
double quotation marks (). If you want to export all
custom topological links, omit ne_name.

-s

is the option for specifying a specific user defined


configuration. If you want to export all custom
topological links, omit -s.

<sn_name>

is the name of user defined configuration for which


you want to display links. If the name includes
spaces, enclose sn_name in double quotation marks
(). If you want to export all custom topological links,
omit sn_name.

<file_name>

is the NDF file name for the exported data. By


default, the NDF file is created in the
/opt/nortel/nds_data
directory. However, if you want to create the NDF file
in another directory, you must specify the full path
and the file name.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-16 Custom Topology procedures


Procedure 3-4 (continued)
Exporting topological links to an NDF file
Step

Action

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The topological links are exported to the specified NDF file.


You have completed this procedure.
4

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-17


Procedure 3-4 (continued)
Exporting topological links to an NDF file
Step

Action

Execute the export command by entering:


/opt/nortel/bin/osp/topology_provisioner -c export [-n
<ne_name>|-s <sn_name>] -o <file_name> -l <user_name>
where

-n

is the option for specifying a specific NE. If you want to


export all custom topological links, omit -n.

<ne_name>

is the name of NE for which you want to export links. If the


NE name includes spaces, enclose ne_name in double
quotation marks (). If you want to export all custom
topological links, omit ne_name.

-s

is the option for specifying a specific user defined


configuration. If you want to export all custom topological
links, omit -s.

<sn_name>

is the name of user defined configuration for which you


want to display links. If the name includes spaces, enclose
sn_name in double quotation marks (). If you want to
export all custom topological links, omit sn_name.

<file_name>

is the NDF file name for the exported data. By default, the
NDF file is created in the /opt/nortel/nds_data
directory. However, if you want to create the NDF file in
another directory, you must specify the full path and the file
name.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that has
read / write / admin security privileges to the Layer1 NSV
or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The topological links are exported to the specified NDF file.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-18 Custom Topology procedures

Procedure 3-5
Displaying the list of NEs managed by the NDS server
Use this procedure to display the list of the network elements managed by the
NDS server on the console (screen).

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the list NEs command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listnes

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The NE information is displayed.


You have completed this procedure.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-19


Procedure 3-5 (continued)
Displaying the list of NEs managed by the NDS server
Step

Action

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the list NEs command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listnes -l
<user_name>
where
<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that has
read / write / admin security privileges to the Layer 1 NSV
or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The NE information is displayed.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-20 Custom Topology procedures

Procedure 3-6
Exporting the list of NEs managed by the NDS server
Use this procedure to export the list of the network elements managed by the
NDS server to an NDF file.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the list NEs command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listnes -o
<file_name>
where
<file_name>

is the NDF file name for the exported data. By default, the
NDF file is created in the /opt/nortel/nds_data
directory. However, if you want to create the NDF file in
another directory, you must specify the full path and the file
name.

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The NE information is exported.


continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-21


Procedure 3-6 (continued)
Exporting the list of NEs managed by the NDS server
Step

Action
You have completed this procedure.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the list NEs command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listnes -o
<file_name> -l <user_name>
where

<file_name>

is the NDF file name for the exported data. By default, the
NDF file is created in the /opt/nortel/nds_data
directory. However, if you want to create the NDF file in
another directory, you must specify the full path and the file
name.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that has
read / write / admin security privileges to the Layer 1 NSV
or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The NE information is exported.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-22 Custom Topology procedures

Procedure 3-7
Displaying NE endpoint information
Use this procedure to display port information for a specific NE on the console
(screen).

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listports command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listports -n
<ne_name>
where
<ne_name>

is the name of NE for which you want to export port


information. If the NE name includes spaces, enclose
ne_name in double quotation marks ().

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The port information is displayed.


You have completed this procedure.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-23


Procedure 3-7 (continued)
Displaying NE endpoint information
Step

Action

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listports command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listports -n
<ne_name> -l <user_name>
where

<ne_name>

is the name of NE for which you want to export port


information. If the NE name includes spaces, enclose
ne_name in double quotation marks ().

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that


has read / write / admin security privileges to the Layer 1
NSV or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The port information is displayed.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-24 Custom Topology procedures

Procedure 3-8
Exporting NE endpoint information
Use this procedure to export port information for a specific NE to an NDF file.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listports command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listports -n
<ne_name> -o <file_name>
where
<ne_name>

is the name of NE for which you want to export port


information. If the NE name includes spaces, enclose
ne_name in double quotation marks ().

<file_name>

is the NDF file name for the exported data. By default,


the NDF file is created in the /opt/nortel/nds_data
directory. However, if you want to create the NDF file in
another directory, you must specify the full path and the
file name.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-25


Procedure 3-8 (continued)
Exporting NE endpoint information
Step

Action

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The port information is exported.


You have completed this procedure.
4

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listports command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listports -n
<ne_name> -o <file_name> -l <user_name>
where

<ne_name>

is the name of NE for which you want to export port


information. If the NE name includes spaces, enclose
ne_name in double quotation marks ().

<file_name>

is the NDF file name for the exported data. By default,


the NDF file is created in the /opt/nortel/nds_data
directory. However, if you want to create the NDF file in
another directory, you must specify the full path and the
file name.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that


has read / write / admin security privileges to the Layer 1
NSV or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The port information is exported.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-26 Custom Topology procedures

Procedure 3-9
Displaying link information
Use this procedure to display link information for a specific NE on the console
(screen).

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:.

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listlinks command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listlinks -n
<ne_name>
where
<ne_name>

is the name of NE for which you want to export link


information. If the NE name includes spaces, enclose
ne_name in double quotation marks ().

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The link information is displayed.


You have completed this procedure.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-27


Procedure 3-9 (continued)
Displaying link information
Step

Action

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listlinks command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listlinks -n
<ne_name> -l <user_name>
where

<ne_name>

is the name of NE for which you want to export link


information. If the NE name includes spaces, enclose
ne_name in double quotation marks ().

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that


has read / write / admin security privileges to the Layer 1
NSV or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The link information is displayed.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-28 Custom Topology procedures

Procedure 3-10
Exporting link information
Use this procedure to export link information for a specific NE to an NDF file.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listlinks command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listlinks -n
<ne_name> -o <file_name>
where
<ne_name>

is the name of NE for which you want to export link


information. If the NE name includes spaces, enclose
ne_name in double quotation marks ().

<file_name>

is the NDF file name for the exported data. By default,


the NDF file is created in the /opt/nortel/nds_data
directory. However, if you want to create the NDF file in
another directory, you must specify the full path and the
file name.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-29


Procedure 3-10 (continued)
Exporting link information
Step

Action

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The link information is exported.


You have completed this procedure.
4

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listlinks command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listlinks -n
<ne_name> -o <file_name> -l <user_name>
where

<ne_name>

is the name of NE for which you want to export link


information. If the NE name includes spaces, enclose
ne_name in double quotation marks ().

<file_name>

is the NDF file name for the exported data. By default,


the NDF file is created in the /opt/nortel/nds_data
directory. However, if you want to create the NDF file in
another directory, you must specify the full path and the
file name.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that


has read / write / admin security privileges to the Layer 1
NSV or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The link information is exported.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-30 Custom Topology procedures

Procedure 3-11
Displaying configuration information
Use this procedure to display configuration information on the console
(screen). You can display either all configurations or configurations that
include a specific network element.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listconfigs command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listconfigs
[-n <ne_name>]
where
-n

is the option for specifying a specific NE. If you want to display


all configuration, omit -n.

<ne_name> is the name of NE for which you want to display


configurations. If the NE name includes spaces, enclose
ne_name in double quotation marks (). If you want to display
all configurations, omit ne_name.

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-31


Procedure 3-11 (continued)
Displaying configuration information
Step

Action

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The configuration information is displayed.


You have completed this procedure.
4

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listconfigs command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listconfigs
[-n <ne_name>] -l <user_name>
where

-n

is the option for specifying a specific NE. If you want to


display all configurations, omit -n.

<ne_name>

is the name of NE for which you want to display


configurations. If the NE name includes spaces, enclose
ne_name in double quotation marks (). If you want to
display all configurations, omit ne_name.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that has
read / write / admin security privileges to the Layer 1 NSV
or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The configuration information is displayed.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-32 Custom Topology procedures

Procedure 3-12
Exporting configuration information to an NDF file
Use this procedure to export configuration information to an NDF file. You can
export either all configurations or configurations that include a specific
network element.
Exporting configurations is useful for checking what configuration names have
been used.
Duplicate NE names

If duplicate NE names exist in the network, an NDF file is created for each NE
with the same name. The file name for the multiple NDF files have the
following format:
<file_name>.<ne_name>.<controller_IP>_<controller_type>_
<ne_id>.<time_stamp>.ndf
where
<file_name>

is the NDF file name you specify in this procedure


(see below for details)

<ne_name>

is the NE name you specify in this procedure


(see below for details)

<controller_IP>

is the IP address of the controller (element manager)

<controller_type>

is the number of the controller type

<ne_id>

is the network element ID

<time_stamp>

is the time stamp

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-33


Procedure 3-12 (continued)
Exporting configuration information to an NDF file

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listconfigs command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listconfigs
[-n <ne_name>] -o <file_name>
where
-n

is the option for specifying a specific NE. If you want to


export all configurations, omit -n.

<ne_name>

is the name of NE for which you want to export


configurations. If the NE name includes spaces, enclose
ne_name in double quotation marks (). If you want to
export all configurations, omit ne_name.

<file_name>

is the NDF file name for the exported data. By default, the
NDF file is created in the /opt/nortel/nds_data
directory. However, if you want to create the NDF file in
another directory, you must specify the full path and the
file name.

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The configuration information is exported to the specified NDF file.


You have completed this procedure.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-34 Custom Topology procedures


Procedure 3-12 (continued)
Exporting configuration information to an NDF file
Step

Action

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the listconfigs command by entering:


/opt/nortel/bin/osp/topology_provisioner -c listconfigs
[-n <ne_name>] -o <file_name> -l <user_name>
where

-n

is the option for specifying a specific NE. If you want to


export all configurations, omit -n.

<ne_name>

is the name of NE for which you want to export


configurations. If the NE name includes spaces, enclose
ne_name in double quotation marks (). If you want to
export all configurations, omit ne_name.

<file_name>

is the NDF file name for the exported data. By default, the
NDF file is created in the /opt/nortel/nds_data
directory. However, if you want to create the NDF file in
another directory, you must specify the full path and the file
name.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that has
read / write / admin security privileges to the Layer 1 NSV
or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The configuration information is exported to the specified NDF file.


end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-35

Procedure 3-13
Clearing data from Custom Topology
Use this procedure to clear all data from Custom Topology.

Requirements
To perform this procedure, you must:

log on to the workstation with root security privileges. See Administrative


functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 5.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the clear command by entering:


/opt/nortel/bin/osp/topology_provisioner -c clear

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

You are prompted to confirm this action:


Warning: this operation will clear the contents of the
custom topology database.
Do you wish to continue [y/n]?
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-36 Custom Topology procedures


Procedure 3-13 (continued)
Clearing data from Custom Topology
Step

Action

Confirm the action by entering:


y
The data is cleared.
You have completed this procedure.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the clear command by entering:


/opt/nortel/bin/osp/topology_provisioner -c clear -l
<user_name>
where
<user_name>

is a valid Manager for 6k, OM5k and CPL user ID


that has read / write / admin security privileges to the
Layer 1 NSV or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

You are prompted to confirm this action:


Warning: this operation will clear the contents of the
custom topology database.
Do you wish to continue [y/n]?
8

Confirm the action by entering:


y
The data is cleared.
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-37

Procedure 3-14
Performing an audit of the Custom Topology links
Use this procedure to perform an audit of the Custom Topology links. You can
audit the links against network learned links for a specific user defined
configuration name or all custom topology links.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 5.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the audit command by entering:


/opt/nortel/bin/osp/topology_provisioner -c audit [-s
<sn_name>]
where
-s

is the option for specifying a user defined configuration name.


If you want to audit all links, omit -s.

<sn_name>

is the name of the user defined configuration for which you


want to audit. If the name includes spaces, enclose sn_name
in double quotation marks (). If you want to audit all links,
omit sn_name.

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-38 Custom Topology procedures


Procedure 3-14 (continued)
Performing an audit of the Custom Topology links
Step

Action

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

You can verify the audit results by checking the link reliability status and user
defined configuration status in Layer 1 NSV.
You have completed this procedure.

Change to the directory where the ndf input files are normally created by
entering:
cd /opt/nortel/nds_data
If your ndf input files are not in the nds_data directory, then change to the
directory (cd command) in which you created the ndf files.

Execute the audit command by entering:


/opt/nortel/bin/osp/topology_provisioner -c audit [-s
<sn_name>]-l <user_name>
where

-s

is the option for specifying a user defined


configuration name. If you want to audit all links,
omit -s.

<sn_name>

is the name of the user defined configuration for


which you want to audit. If the name includes
spaces, enclose sn_name in double quotation
marks (). If you want to audit all links, omit
sn_name.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID


that has read / write / admin security privileges to the
Layer 1 NSV or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

You can verify the audit results by checking the link reliability status and user
defined configuration status in Layer 1 NSV.
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-39

Procedure 3-15
Backing up Custom Topology data
Use this procedure to back up Custom Topology data to a file that can later be
used to restore the data.
The data is backed up to a file that is readable by the restore executable only
(it is not an NDF file).

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 4.

Change to the directory where the backup files are normally stored by
entering:
cd /opt/nortel/nds_backup
If your ndf input files are not in the nds_backup directory, then change to the
directory (cd command) in which you stored your backup files.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-40 Custom Topology procedures


Procedure 3-15 (continued)
Backing up Custom Topology data
Step

Action

Execute the backup command by entering:


/opt/nortel/bin/osp/topology_provisioner -c backup -o
<dirname>
where
<dirname>

is the directory name for the backup files. By default, the


backup files will be created in the
/opt/nortel/nds_backup directory. However, if
you want to create the backup files in another directory,
you must specify the full path.

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The following message is displayed:


Custom Topology backup database requested.
Backing up data...
Exporting DB Data...
Exporting of DB data completed.
Custom Topology database backed up successfully.
4

Change to the directory where the backup files are normally stored by
entering:
cd /opt/nortel/nds_backup
If your ndf input files are not in the nds_backup directory, then change to the
directory (cd command) in which you stored your backup files.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-41


Procedure 3-15 (continued)
Backing up Custom Topology data
Step

Action

Execute the backup command by entering:


/opt/nortel/bin/osp/topology_provisioner -c backup -o
<dirname> -l <user_name>
where

<dirname>

is the directory name for the backup files. By default, the


backup files will be created in the
/opt/nortel/nds_backup directory. However, if you
want to create the backup files in another directory, you
must specify the full path.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that


has read / write / admin security privileges to the Layer
1 NSV or OSP application.

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The following message is displayed:


Custom Topology backup database requested.
Backing up data...
Exporting DB Data...
Exporting of DB data completed.
Custom Topology database backed up successfully.
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-42 Custom Topology procedures

Procedure 3-16
Restoring Custom Topology data
Use this procedure to restore Custom Topology data from a backup file.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 5.

Change to the directory where the backup files are normally stored by
entering:
cd /opt/nortel/nds_backup
If your backup files are not in the nds_backup directory, then change to the
directory (cd command) in which you stored your backup files.

Execute the restore command by entering:


/opt/nortel/bin/osp/topology_provisioner -c restore -i
<dirname>
where
<dirname>

is the directory name for the backup files. By default, the


backup files will be created in the
/opt/nortel/nds_backup directory. However, if
you want to create the backup files in another directory,
you must specify the full path.

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-43


Procedure 3-16 (continued)
Restoring Custom Topology data
Step

Action
The following message is displayed:
You are about to overwrite your existing database with
data from dir '<dirname>'.
Do you wish to proceed [y/n]?

Confirm the action by entering:


y
The following message is displayed:
Restoring data...
Start importing DB data...
DB data imported successfully.
Custom Topology database restored successfully

Change to the directory where the backup files are normally stored by
entering:
cd /opt/nortel/nds_backup
If your backup files are not in the nds_backup directory, then change to the
directory (cd command) in which you stored your backup files.

Execute the restore command by entering:


/opt/nortel/bin/osp/topology_provisioner -c restore -i
<dirname> -l <user_name>
where
<dirname>

is the full path name to the backup file. By default, the


backup file is stored in /opt/nortel/nds_backup.

<user_name>

is a valid Manager for 6k, OM5k and CPL user ID that


has read / write / admin security privileges to the Layer 1
NSV or OSP application.
continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-44 Custom Topology procedures


Procedure 3-16 (continued)
Restoring Custom Topology data
Step

Action

When prompted for a password, enter the password for the user name you
specified above:

If the command includes a syntax error, the errors will be displayed on the
screen to indicate the source of the errors. In this case, correct the errors,
then run this procedure again.

If a warning message is generated, check the custom-topology.log for


further information. For more information on logs, see Logs on
page 1-11.

The following message is displayed:


You are about to overwrite your existing database with
data from dir '<dirname>'.
Do you wish to proceed [y/n]?
8

Confirm the action by entering:


y
The following message is displayed:
Restoring data...
Start importing DB data...
DB data imported successfully.
Custom Topology database restored successfully
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology procedures 3-45

Procedure 3-17
Synchronizing the preferred and alternate Custom
Topology servers
Use this procedure to synchronize the preferred and the alternate Custom
Topology servers. The Custom Topology servers are not synchronized
automatically. You must follow this procedure to maintain consistency
between the redundant Custom Topology servers.

Requirements
To perform this procedure, you must:

have appropriate security privileges to log on to the workstation. See


Administrative functions on page 1-16.

Action
Step

Action

Log on to the workstation that has the most current Custom Topology data.

Back up the Custom Topology data by performing procedure Procedure 3-15,


Backing up Custom Topology data.

Copy or ftp the backup file created in step 2 to the Custom Topology server
you want to update with the latest data.

Log on to the workstation that you want to update with the latest data.

Restore the Custom Topology data by performing procedure Procedure 3-16,


Restoring Custom Topology data.
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

3-46 Custom Topology procedures

Procedure 3-18
Displaying help
Use this procedure to display usage information for the
topology_provisioner command line tool to the console (screen).

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Select your first step:

If you are running Custom Topology from

Then go to

an HP workstation

step 2.

a Solaris/Linux workstation

step 3.

Execute the help command by entering:


/opt/nortel/bin/osp/topology_provisioner -h
Usage information for the topology_provisioner command line tool is
displayed on the screen.
You have completed this procedure.

Execute the help command by entering:


/opt/nortel/bin/osp/topology_provisioner -h -l
<user_name>
where
<user_name>

is a valid Manager for 6k, OM5k and CPL user ID


that has read / write / admin security privileges to the
Layer 1 NSV or OSP application.

Usage information for the topology_provisioner command line tool is


displayed on the screen.
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

450-3251-189
4-1

Custom Topology scenarios

4-

This chapter describes advanced procedures for Custom Topology. The


following scenarios are covered in this chapter:

cutting-in a network element

cutting-out a network element

reconfiguring a link

changing an NE name

changing an AP NE ID

Procedure 4-1, Cutting in a network element

Procedure 4-2, Cutting out a network element

Procedure 4-3, Reconfiguring a link

Procedure 4-4, Changing an NE name

Procedure 4-5, Changing an AP NE ID

Procedures

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

4-2 Custom Topology scenarios

Procedure 4-1
Cutting in a network element
Use this procedure to manually insert a network element within an existing link
(could be in a user defined configuration) and update the links in Custom
Topology.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.
know the name of the network element to cut-in

Action
Step

Action

The following example is used to illustrate a cut-in. In Figure 4-1 on page 4-2,
the network element Ottawa is cut-in. The links in Figure 4-1 on page 4-2 can
also be in a user defined configuration, with a UDC name of CanEast, for
example.
Figure 4-1
Cutting in a network element
figure 4-1.jpg

continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology scenarios 4-3


Procedure 4-1 (continued)
Cutting in a network element
Step

Action

Create two NDF files. NDF files are required to 1) delete the current link 2)
add the new links which include the network element to cut-in.
The first NDF file must contain:

An entry for each network element that the deleted link(s) are associated
with

An entry for each deleted topological link

The second NDF file must contain:

An entry for each network element added to the network as well as the
NEs associated with the links

An entry for each network element that the added links are associated
with

You can use the export command to create an NDF file that includes all
topological links, and then edit the file to isolate the topological links to delete.
2

Select your next step:


If the example illustrated in
Figure 4-1 on page 4-2 is

Then go to

not in a user defined configuration

step 3.

in a user defined configuration

step 4.

If the example illustrated in Figure 4-1 on page 4-2 is not in a user defined
configuration, the following two NDF files are required.
For the deleted links (NDF file 1):

NES
NE
Montreal
Toronto
MS
Id

NE.Num
2908
2905

EMS.Addr.IP
47.134.26.217/0
47.134.26.190/0

NE1
NE1.EMS_Num
NE2
NE2.EMS_Num
Port1
Port2
MS01 Montreal 47.134.26.217/0/2908 Toronto 47.134.26.190/0/2905 _1/2/1 _1/2/1

continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

4-4 Custom Topology scenarios


Procedure 4-1 (continued)
Cutting in a network element
Step

Action
For the new links (NDF file 2):

NES
NE
Montreal
Toronto
Ottawa

NE.Num
2908
2905
20006

EMS.Addr.IP
47.134.26.217/0
47.134.26.190/0
47.134.26.217/0

MS
Id

NE1
NE1.EMS_Num
NE2
NE2.EMS_Num
Port1
Port2
MS02 Montreal 47.134.26.217/0/2908 Ottawa 47.134.26.217/0/20006 _1/2/1 _2/2/1
MS03 Ottawa
47.134.26.217/0/20006 Toronto 47.134.26.190/0/2905
_2/4/1 _1/2/1

Go to step 5.
4

If the example illustrated in Figure 4-1 on page 4-2 is in a user defined


configuration, with a UDC name of CanEast, the following two NDF files are
required.
For the deleted links (NDF file 1):

NES
NE
Montreal
Toronto

NE.Num
2908
2905

EMS.Addr.IP
47.134.26.217/0
47.134.26.190/0

SUBNETS
Subnet
CanEast

Type
Linear

Rate
MS

MS
Id

NE1
NE1.EMS_Num
NE2
NE2.EMS_Num
Port1
Port2
Subnet
MS01 Montreal 47.134.26.217/0/2908 Toronto
47.134.26.190/0/2905 _1/2/1 _1/2/1
CanEast

continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology scenarios 4-5


Procedure 4-1 (continued)
Cutting in a network element
Step

Action
For the new links (NDF file 2):

NES
NE
Montreal
Toronto
Ottawa

NE.Num
2908
2905
20006

EMS.Addr.IP
47.134.26.217/0
47.134.26.190/0
47.134.26.217/0

SUBNETS
Subnet
CanEast

Type
Linear

Rate
MS

MS
Id

NE1
NE1.EMS_Num
NE2
NE2.EMS_Num
Port1
Port2
Subnet
MS02 Montreal 47.134.26.217/0/2908
Ottawa
47.134.26.217/0/20006 _1/2/1 _2/2/1
CanEast
MS03 Ottawa
47.134.26.217/0/20006 Toronto 47.134.26.190/0/2905
_2/4/1 _1/2/1
CanEast

Execute the delete command, using NDF file 1 as input. See


Procedure 3-2, Deleting topological links.

Execute the add command, using NDF file 2 as input. See Procedure 3-1,
Adding topological links.
The network element is cut in. Two new topological links are added and one
new network element is added to Custom Topology.

Execute the audit command. See Procedure 3-14, Performing an audit of


the Custom Topology links.
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

4-6 Custom Topology scenarios

Procedure 4-2
Cutting out a network element
Use this procedure to manually remove a network element and all topological
links extending from it, and update the links in Custom Topology.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

know the name of the NE to cut-out

Action
Step

Action

The following example is used to illustrate a cut-out. In Figure 4-2 on page 4-6,
the network element Ottawa is cut-out. The links in Procedure 4-2, Cutting
out a network element can also be in a user defined configuration, with a
UDC name of CanEast, for example.
Figure 4-2
Cutting out a network element
figure4-2.jpg

continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology scenarios 4-7


Procedure 4-2 (continued)
Cutting out a network element
Step

Action

Create two NDF files. NDF files are required to 1) delete the current links
extending from the network element to cut-out 2) add the new link between
the network elements that were adjacent to the cut-out network element.
The first NDF file must contain:

An entry for each network element that the deleted link(s) are associated
with

An entry for each deleted topological link

The second NDF file must contain:

An entry for each network element that the added links are associated
with

An entry for each topological link added to the network

You can use the export command to create an NDF file that includes all
topological links, and then edit the file to isolate the topological links to delete.
2

Select your next step:


If the example illustrated in
Figure 4-2 on page 4-6 is

Then go to

not in a user defined configuration

step 3.

in a user defined configuration

step 4.

If the example illustrated in Figure 4-2 on page 4-6 is not in a user defined
configuration, the following two NDF files are required.
For the deleted links (NDF file 1):

NES
NE
Montreal
Toronto
Ottawa

NE.Num
2908
2905
20006

EMS.Addr.IP
47.134.26.217/0
47.134.26.190/0
47.134.26.217/0

MS
Id

NE1
NE1.EMS_Num
NE2
NE2.EMS_Num
Port1
Port2
MS01 Montreal 47.134.26.217/0/2908
Ottawa
47.134.26.217/0/20006 _1/2/1
_2/2/1
MS02 Ottawa
47.134.26.217/0/20006 Toronto
47.134.26.190/0/2905
_2/4/1 _1/2/1

continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

4-8 Custom Topology scenarios


Procedure 4-2 (continued)
Cutting out a network element
Step

Action
For the new link (NDF file 2):

NES
NE
Montreal
Toronto

NE.Num
2908
2905

EMS.Addr.IP
47.134.26.217/0
47.134.26.190/0

MS
Id
NE1
NE1.EMS_Num
MS03 Montreal 47.134.26.217/0/2908

NE2
Toronto

NE2.EMS_Num
47.134.26.190/0/2905

Port1
_1/2/1

Port2
_1/2/1

Go to step 5.
4

If the example illustrated in Figure 4-2 on page 4-6 is in a user defined


configuration, with a UDC name of CanEast, the following two NDF files are
required.
For the deleted links (NDF file 1):

NES
NE
Montreal
Toronto
Ottawa

NE.Num
2908
2905
20006

EMS.Addr.IP
47.134.26.217/0
47.134.26.190/0
47.134.26.217/0

SUBNETS
Subnet
CanEast

Type
Linear

Rate
MS

MS
Id

NE1
NE1.EMS_Num
NE2
NE2.EMS_Num
Port1
Port2
Subnet
MS01 Montreal 47.134.26.217/0/2908
Ottawa
47.134.26.217/0/20006 _1/2/1 _2/2/1
CanEast
MS02 Ottawa
47.134.26.217/0/20006 Toronto 47.134.26.190/0/2905 _2/4/1 _1/2/1
CanEast

continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology scenarios 4-9


Procedure 4-2 (continued)
Cutting out a network element
Step

Action
For the new link (NDF file 2):

NES
NE
Montreal
Toronto

NE.Num
2908
2905

EMS.Addr.IP
47.134.26.217/0
47.134.26.190/0

SUBNETS
Subnet
Type
Rate
CanEast
Linear
MS
MS
Id
NE1
NE1.EMS_Num
MS03 Montreal 47.134.26.217/0/2908

NE2
Toronto

NE2.EMS_Num
47.134.26.190/0/2905

Port1
_1/2/1

Port2
Subnet
_1/2/1 CanEast

Execute the delete command, using NDF file 1 as input. See


Procedure 3-2, Deleting topological links.

Execute the add command, using NDF file 2 as input. See Procedure 3-1,
Adding topological links.
The network element is cut out. One topological link is added and one
network element is removed from Custom Topology.

Execute the audit command. See Procedure 3-14, Performing an audit of


the Custom Topology links.
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

4-10 Custom Topology scenarios

Procedure 4-3
Reconfiguring a link
Use this procedure to:

Change the endpoint of a link to another circuit pack/port in a network


element

Change the endpoint of a link from one network element to another


network element

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

The following example is used to illustrate a link reconfiguration. In Figure 4-3


on page 4-10, the endpoint of a link is changed to another network element.
Figure 4-3
Reconfiguring a link
figure 4-3.jpg

continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology scenarios 4-11


Procedure 4-3 (continued)
Reconfiguring a link
Step

Action

Create two NDF files. NDF files are required to 1) delete the current link 2)
redefine the link with the new endpoint.
The first NDF file must contain:

An entry for each network element that the deleted link(s) are associated
with

An entry for the topological link to delete

The second NDF file must contain:

An entry for each network element that the added links are associated
with

An entry for each topological link added to the network

You can use the export command to create an NDF file that includes all
topological links, and then edit the file to isolate the topological links to delete.
In the example illustrated in Figure 4-3 on page 4-10, the following two NDF
files are required.
For the deleted links (NDF file 1):
NES
NE
Toronto
Ottawa

NE.Num
2905
20006

MS
Id
NE1
MS01 Ottawa

NE1.EMS_Num
47.134.26.217/0/20006

EMS.Addr.IP
47.134.26.190/0
47.134.26.217/0

NE2
Toronto

NE2.EMS_Num
47.134.26.190/0/2905

Port1
_2/4/1

Port2
_2/4/1

NE2.EMS_Num
47.134.26.190/0/2905

Port1
_2/4/1

Port2
_2/4/1

For the new link (NDF file 2):


NES
NE
Montreal
Toronto

NE.Num
2908
2905

EMS.Addr.IP
47.134.26.217/0
47.134.26.190/0

MS
Id
NE1
NE1.EMS_Num
MS02 Montreal 47.134.26.217/0/2908

NE2
Toronto

continued

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

4-12 Custom Topology scenarios


Procedure 4-3 (continued)
Reconfiguring a link
Step

Action

Execute the delete command, using NDF file 1 as input. See


Procedure 3-2, Deleting topological links.

Execute the add command, using NDF file 2 as input. See Procedure 3-1,
Adding topological links.
The existing topological link is removed. A topological link is added, if
applicable, and one network element is added to Custom Topology.
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

Custom Topology scenarios 4-13

Procedure 4-4
Changing an NE name
Use this procedure to update the name of a network element in Custom
Topology after an NE name change.
The topology_provisioner command line tool does not provide automatic
NE name updates after an NE name change. You must use the delete and
add commands to update Custom Topology after an NE name change.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Use the export command to create an NDF file that defines all the existing
links that include the network element that was updated. See Procedure 3-4,
Exporting topological links to an NDF file, and use the
-n <ne_name> option to specify the network element that was updated.

Edit the generated NDF file to isolate the topological links that refer to the
network element that was updated, and save the NDF file as
<file_name>.NE_A.del.
where
file_name

is the file name of the NDF file created in step 1

Edit the file you saved in step 1 to replace all instances of the network
element name to the new network element name. Save the edited NDF file to
a new file <file_name>.NE_B.add.

Execute the delete command, using <file_name>.NE_A.del as input.


See Procedure 3-2, Deleting topological links.

Execute the add command, using <file_name>.NE_B.add as input. See


Procedure 3-1, Adding topological links.
The existing topological links that refer to the old network element name are
replaced with new links that refer to the new network element name.
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

4-14 Custom Topology scenarios

Procedure 4-5
Changing an AP NE ID
Use this procedure to update the identifier (ID) of a network element in
Custom Topology after an Applications Platform (AP) NE ID change.
The topology_provisioner command line tool does not provide automatic
NE ID updates after an NE ID change. You must use the delete and add
commands to update Custom Topology after an NE ID change.

Requirements
To perform this procedure, you must:

log on to the workstation with appropriate security privileges. See


Administrative functions on page 1-16.

Action
Step

Action

Use the export command to create an NDF file that defines all the existing
links that include the network element that was updated. See Procedure 3-4,
Exporting topological links to an NDF file, and use the
-n <ne_name> option to specify the network element that was updated.

Edit the generated NDF file to isolate the topological links that refer to the
network element that was updated, and save the NDF file as
<file_name>.NE_A.del.
where
<file_name>

is the file name of the NDF file created in step 1

Edit the file you saved in step 1 to replace all instances of the network
element ID with the new network element ID. Save the edited NDF file to a
new file <file_name>.NE_B.add.

Execute the delete command, using <file_name>.NE_A.del as input.


See Procedure 3-2, Deleting topological links.

Execute the add command, using <file_name>.NE_B.add as input. See


Procedure 3-1, Adding topological links.
The existing topological links that refer to the old network element ID are
replaced with new links that refer to the new network element ID.
end

OneControl - OSP and Layer 1 NSV


Release 5.0
Copyright 2013-2015 Ciena Corporation

Custom Topology User Guide


450-3251-189
Standard Issue 07.01
August 2015

OneControl Unified Management System


Optical Service Provisioner and Layer 1 Network and
Service Viewer
Custom Topology User Guide
Copyright 2013-2015 Ciena Corporation. All rights reserved.
Release 5.0
Publication: 450-3251-189
Document status: Standard
Issue 7.01
Document release date: August 2015
CONTACT CIENA
For additional information, office locations, and phone numbers, please visit the Ciena
web site at www.ciena.com

You might also like